Introduction

The BusinessCraft Service provides an extensible & flexible framework for automating a range of tasks including:

  • Automated Sending of Emails (SMTP)

  • Automated Sending of Text Messages (SMS)

The BusinessCraft Service also provides supported plugins that can be configured and executed on a periodic or scheduled basis. Available Plugins currently include:

  • Connectors

  • Scheduled Reports

  • File Manager

The following topics are covered:

  • Installing the BusinessCraft Service

  • BusinessCraft Service Overview

  • Service Settings Tab

  • SMTP Logging Tab

  • Remote Procedures Tab

  • Plugins Tab

  • Service Status Panel

  • Uninstalling the BusinessCraft Service

  • Repairing the BusinessCraft Service

Installing the BusinessCraft Service

The BusinessCraft Service is a windows service provided to all BusinessCraft customers that needs to be installed on the server that will hosting the service.

Open Windows Explorer and go to ftp1://bizcraft.com/Products/BusinessCraft Service:

Archive Contains old versions of the BusinessCraft Service and associated files.
DotNetFramework Contains the prerequisite Microsoft DotNetFramework installation files. Check the ReadMeFirst file to see what version is required and ensure it is installed prior to installing the BusinessCraft Service.
BusinessCraft Service Setup Contains the full installation files for the BusinessCraft Service. If a full installation is carried out, any existing BusinessCraft Service must be uninstalled first.
BusinessCraft Service Update Contains the necessary files to carry out an update by copying the required files to the required the designated BusinessCraft Service folder. This option should not be carried out other than by experienced users.

The installation process that follows is for a full installation:

  1. Download the BusinessCraft Service Setup zip, saving the file to BusinessCraft\MapDr\Releases\BusinessCraftService or an equivalent location as defined by company policy.

  2. Check if the BusinessCraft Service is already installed and if so uninstall using the steps explained in the Uninstalling BusinessCraft Service section of this article.

  3. Check any pre-requisites for installation by reviewing the ReadMeFirst file and ensure any prerequisite installation is carried out.

  4. Go to the location holding the downloaded BusinessCraft Service Setup zip and unzip the file to a temporary folder.

  5. Go to the temporary folder and run the setup.exe file. Read the BusinessCraft Service Setup Wizard screen and to proceed, click Next:

  1. Ensure the default installation folder is correct or click Browse to select the required folder. Ensure Everyone is selected.

The Disk Cost Button opens the BusinessCraft Service Disk Space screen that displays available drives, disk size, available space, required space and difference for installation purposes.

To proceed, click Next. Buttons are provided to go Back a step or to Cancel the installation.

  1. The Confirm Installation screen is displayed:

To proceed, click Next. Buttons are provided to go Back a step or to Cancel the installation.

  1. The Installing BusinessCraft Service screen is displayed. The option to Cancel is provided to quite the installation.

  1. The Installation Complete screen is displayed. Click Close to exit the installation:

If errors are encountered, screen shot the error and create a Service Request so that a BusinessCraft Team member can provide the required assistance to complete the installation.

  1. The BusinessCraft Service Maintenance icon should be displayed on the Windows Desktop:

This completes the installation process.

BusinessCraft Service Overview

The BusinessCraft Service Maintenance application is used to configure the settings for the service, stop & start the service and configure and administer required plugins for the service. Separate product guides explain the configuration and administration of each available BusinessCraft Service plugin.

To open the BusinessCraft Service Maintenance application click the icon on the desktop or select the BusinessCraft Service Maintenance menu item from the Windows Programs menu.

The BusinessCraft Service Maintenance application provides the following components:

Service Tab The Service Tab contains general settings for the BusinessCraft Service with sections for Service Settings, Progress Reporting and Progress Messages.
SMTP Logging Tab The SMTP Logging Tab contains settings used for progress and error reporting.
Remote Procedures Tab The Remote Procedures Tab contains settings so that Remote Procedures using xfServerPlus can be carried out. A Test option is provided to ensure the settings are valid.
Plugins Tab

Provides the ability to configure and maintain a range of plugins available for the BusinessCraft Service.

Each plugin can be started and stopped independently of the BusinessCraft Service, however for a plugin to function the plugin must be enabled and both the plugin and the BusinessCraft Service must be running.

Service Status Panel

The Service Status Panel is displayed at the bottom of the screen regardless of the tab selected.

The panel displays the status of the service, options to stop and start the service, as well the ability to Save or Apply changes.

Service Tab

The Service tab is displayed by default when the BusinessCraft Service Maintenance application is opened:

Service Settings

Check Frequency Specifies the number of seconds to wait between each processing cycle. Defaults to 15 seconds.
User Name Specify a user name if a user account other than the Windows Services Account is to be used by the BusinessCraft Service. The Test Cred button tests the User Name and Password supplied.
Password Specify the password for the User Name supplied. The Test Cred button tests the User Name and Password supplied.
Verify User A Verify User button is provided to test the User Name and Password.
Service Folder Specifies the folder containing the folders used by the BusinessCraft Service. Buttons are provided to select the folder and to open the logging folder.
BC System Folder Not Implemented.
Log Enabled When checked, enables the writing of log files.
Debug Enabled When checked, enables the writing of information to a debug file for development & testing purposes.
Log to ISAM Not Implemented.
Log Expiry Specifies the number of days to keep log files before they are purged by the service. Value of Zero indicates no purging required.
Purge Expired Initiates the Purge Expired Log Files option. The Purge Expired Option goes through the logging folder and purges any log files that are older than the number of days specified to keep.

Progress Reporting

Progress Email The email addresses (separated by a semi colon) to which the status of the BusinessCraft Service and implemented plugins is sent either as Progress Report emails or Error Report emails.
Error Email The email addresses (separated by a semi colon) to which Progress Email Warnings and Errors are sent.
Report Frequency The frequency of sending progress reports to the Progress Email addresses.
Verbose Indicates if Progress and Error reports contain additional detail (ticked) or not.
Error Frequency The elapsed time before an error report is sent to the Progress Email addresses.
Progress Message A simple status update of Progress and Error report emails sent including a log of BusinessCraft Service stoppages.

Example of a Progress Report Email with verbose not ticked

Example of a Progress Report Email with verbose ticked

SMTP Logging Tab

The SMTP Logging Tab is used to define the email settings used to provide progress and error reporting emails.

Host The SMTP mail server.
Port The port used for sending email.
User Secure Connection Indicates whether SSL or TLS is used.
Timeout The time allowed before a timeout is assumed.
From Email Where supported by the host mail server, the Sender Email address that will be displayed on outgoing emails.
From Name Where supported by the host mail server, the Sender Name that will be displayed on outgoing emails.
Reply To Email The email address to which replies are to be directed.
User Name The User Account to log on to the host mail server
Password The Password to log on to the host mail server.
CC Email When emails are sent, copies will be sent to these addresses. Multiple addresses can be recorded separated by a semi colon.
BCC Email When emails are sent, blind copies will be sent to these addresses. Multiple addresses can be recorded separated by a semi colon.
Failed Email Failed emails are directed to this address when the Send Failed Emails to Failed Email Address box is ticked.
Test Email When the Send Test button is activated, a test email will be sent to this address.
List ID Specify a mailing list ID for progress and error emails so that those emails can be easily found without relying on sender name or emails address type searches.
Image Folder The folder containing an image that will be sent with test emails.

Enable Delivery

Notification

When ticked and an email is delivered, a confirmation email will be sent to the sender.
Send Failed Emails to Failed Email Address When ticked and an email fails delivery, an email will be sent to the failed email address.
Send Failed Emails to the Sender When ticked and an email fails delivery, an email will be sent to the sender.
Send Test When activated, a test email will be sent to the Test Email address.

Remote Procedures Tab

Click on the Remote Procedures tab. If xfServer Plus has not previously been installed, please ensure this is carried out before proceeding further in accordance with the xfServer Plus Installation Guide.

Server The server name on which xfServer+ is installed (in most cases this will be the server on which BusinessCraft is installed)
Port The port number designated for use by xfServer+ (usually 2340)
Timeout Used to indicate how long the BusinessCraft Service will wait for a result from an xfServerPlus call. If 0, then the default Synergex Setting of 120 seconds is used.
BC User Name The BusinessCraft User Name that will be used by the Sugar Connector to create/update records in BusinessCraft.
BC Password The BusinessCraft Password for the User Login that will be used by the Sugar Connector to create/update records in BusinessCraft.
Company The default BusinessCraft dataset to be used by all plugins using the xfServer+ service. BusinessCraft datasets can be defined on a plug in by plug in basis if required.
xfSvr+ Environment Variables A list of xfSvr+ variables to assist when the Test Button results in a failure.

Once the Default Settings have been configured, click the Test button to ensure that the settings enable xfServer Plus to operate successfully.

The Log Form screen displays the results of the test:

Options are provided to copy the Log Form details to the Clipboard or to Save the Log Form details to a text file.

Plugins Tab

Click on the Plugins tab to display currently installed plugins, add new plugins or update configurations for existing plugins.

+ Add Plugin Click the + add Plugin button to add a new plugin.
Testing Mode The Testing Mode check box allows the BusinessCraft Development team to test plugins without updating records.
Attempt Plugin Restarts Indicates whether the BusinessCraft Service will automatically attempt to restart stopped plugins.
Enabled Indicate whether BusinessCraft Service plugins are enabled or not.
Sort Name Provides the option to sort the plugins by ascending or descending order. The Sort column is populated with the Display Name by default but can be overwritten if required. Normally leave this column blank and it will be populated automatically.
Enabled A check box that indicated whether the plugin is enabled or not.
Sts The operational status of the plugin – Running (Green), Starting, Stopping or Scheduled to Start (Orange), Stopped (Red), Disabled (Black). Hovering over the indicator provides additional information related to the status.
Display Name A unique user defined name for the plugin if a name other than the actual name of the plugin is preferred.
Plugin Type The system defined type for the plugin. Select the plugin from the dropdown list – in this case the Email/SMS Plugin.
Company Not applicable to the Email/SMS Plugin – leave blank.
Frequency The polling frequency for this plugin. The Every Poll setting will poll in accordance with the Check Frequency in the Service Settings on the Service Tab. If required, other frequencies can be selected per plugin including an advanced option providing for a customised polling frequency.
Log Indicates whether a log is to be maintained of activities for the plugin.
Settings Filename The name and location of the file containing the settings for this plugin. This field should be left blank and will automatically populate after the Email/SMS Plugin has been configured.
? Opens BusinessCraft Service Plugin Help.
Summary Opens the BusinessCraft Service Configuration Summary for Plugins.

Service Status Panel

Service Status
  • Green Running

  • Orange Starting

  • Black Disabled

  • Red Stopped

Version The current build version for the BusinessCraft Service.
Stop Stops the BusinessCraft Service.
Start Starts the BusinessCraft Service.
Emulate The Emulate Button provides the ability to operate the plugin using the current user login credentials rather than being run as a service. In all other respects, clicking on the Emulate Button is equivalent to enabling the plug in and restarting the service. When the user logs off the emulation stops.
Restart Stops and starts (restarts) the BusinessCraft Service.
Save Will save any changes made to the current settings and close the BusinessCraft Service.
Close Will close the BusinessCraft Service without saving any changes made since the last save was performed.
Apply Will save any changes made to the current settings and leave the BusinessCraft Service open.

Uninstalling the BusinessCraft Service

To uninstall the BusinessCraft Service, go to the location holding the downloaded BusinessCraft Service Setup files and run the setup.exe file. Read the BusinessCraft Service Setup Wizard screen, select Remove BusinessCraft Service and click Finish:

The Removing BusinessCraft Service screen is displayed. On completion, the Installation Complete screen is displayed. Click Close to exit.

If errors are encountered, screen shot the error and create a Service Request so that a BusinessCraft team member can provide the required assistance to complete the removal of the businessCraft Service.

Repairing the BusinessCraft Service

To repair the BusinessCraft Service, go to the location holding the downloaded BusinessCraft Service Setup files and run the setup.exe file. Read the BusinessCraft Service Setup Wizard screen, select Repair BusinessCraft Service and click Finish:

The Repairing BusinessCraft Service screen is displayed. On completion, the Installation Complete screen is displayed. Click Close to exit.

If errors are encountered, screen shot the error and create a Service Request so that a BusinessCraft team member can provide the required assistance to complete the removal of the businessCraft Service.

Revision 2

8th February 2018