Workflow Manager

Database Settings

You can define the SQL settings required for SYSPRO Workflow Services to persist, track and deploy workflow information to SQL Server in this pane.

Field	Description
Save Database Settings	Select this to save the settings. The company settings are reloaded by the SYSPRO Workflow Service without having to restart the service.
SQL Server Details
SQL Server	Select the SQL server instance that will host the workflow database.
Authentication method	Specify the authentication method to use when connecting to the selected SQL server instance.
User name	Provide a user name to use for SQL authentication.
Password	Enter a user name password.
Test SQL Connection	Select this to verify your settings.
Database Details
Database name	This displays the name of the database to be used by the workflow host.
Database collation	Select the database collation for the workflow database.
Workflow Service Connection Settings
Base address	Enter the base address to which the SYSPRO Workflow Service must connect.
Soap binding	Enter the soap binding to be used to communicate with the SYSPRO Workflow service. NetTcp is recommended for clients using .Net 3.0 and above.
Server instance	Enter the SYSPRO Instance (basedir entry on the server) used by the SYSPRO Workflow service.
Service version	This displays the version of the SYSPRO Workflow service that is in use.
Rest Address	This displays the current REST address that can be used to communicate with the SYSPRO Workflow service.
Deployment Details
Server workflow deployment path	Enter the path on the server to where the workflows must be deployed. A deployment folder will be created if none exists.
Notification Options
Notification Level	Select the types of messages for which notifications will be sent.
Email notification
Method of sending email notification	Select the method in which notification emails must be sent by the workflow service.
General notification of email addresses	Enter the email address (separate addresses with a semicolon) to which general workflow notification emails will be sent.
Security notification email addresses	Enter the email address (separate addresses with a semicolon) to which security workflow notification emails will be sent.
From address	Enter the email address from which emails will be sent for workflow notifications.
Default SMTP Settings
SMTP host	Enter the IP address of the host SMTP server.
SMTP port	Enter the port used to connect to the host SMTP server.
SMTP username	Enter the username that is used to connect to the SMTP server.
SMTP password	Enter the user password to connect to the SMTP server.
Use SSL	Enable this option if communication with the SMTP server requires SSL encryption.
Send Test	Select this to test whether the notification settings are working. If successful, you will receive a notification in your Inbox.
Default Exchange Settings
Exchange server version	Enter the version of Exchange to be used (Exchange 2008 or higher).
Exchange server address	Enter the asmx Exchange server address.
Exchange user domain	Enter the domain of the user connecting to the Exchange server.
Exchange username	Enter the user name connecting to the Exchange server.
Exchange password	Enter the user password required to connect to the Exchange server.
Validate Certificate	Enable this option to perform certificate validation for the Exchange server.
Send Test	Select this to test whether the notification settings are working. If successful, you will receive a notification in your Inbox.
SYSPRO user notification	Enable this option if you require workflow notifications to be sent to a SYSPRO user's Inbox.

Purge Manager

The Purge Manager allows you to purge old or obsolete workflow instances, and remove all tracking and persistence data. This is typically used to keep your system running efficiently, as workflow instances can take up large amounts of disc space (especially if you are running many workflows).

Field	Description
Start Search	Select this to filter the data using the filter criteria.
Previous Filters
Filter	Select this to filter the content based on a filter you have already created.
Filter Criteria
Filter Parameter	Select the parameter that you would like to filter.
Operator	Select an operator to refine your filter.
Value	Select the value attached to the parameter to reduce the information that will be returned from the filter.
Modifier	Enter the required expression.
Add Expression	Select this to add the expression into the Statement field.
Filter Summary
Statement	The expression is added into this field.
Save this filter	Select this if you want to reuse the filter.
Workflow Purge Manager
Bulk Resume	Select this to resume all failed or faulted workflows at once.
Purge Selection	Select this to purge the data based on your selections.
Select All	Select this to include all the workflows displayed in the listview in the purge.
Deselect All	Select this to deselect all workflows in the listview.
View Instance	This opens the selected instance and shows the tracking data for that workflow. It can be used when the performance of the Workflow Monitor is slow due to a large amount of tracking data.
Refresh	Select this to refresh the information displayed.

Workflow Manager

In the Workflow Manager, you can select a workflow instance, check the parameters and variables and how long the process has taken to execute, and then manually manage the instance of the workflow in the Workflow Manager.

The Workflow Instances pane is displayed when you select the workflow from the Workflow Manager pane on the left-hand side.

Field Description

Send Message Select this to start a test instance of a workflow. Once the workflow is started it waits for the entry of an integer. If the integer is positive the workflow will be completed. If negative, an exception is logged and an error is displayed.

Abandon

Select this to move the workflow instance back to the last point of persistence, where it can then be resumed automatically.

A workflow is persisted (i.e. taken out of memory and placed into the database, available to be run at a later stage) when it is idle for longer than the configured amount of time. For example: A workflow will be persisted if it has a delay of more than 10 seconds.

You can configure this time period in the config file against the persistencedelay key. The key defaults to 10 seconds.

Terminate Select this to terminate an instance. This will ensure that the instance is stopped. The KeyID cannot be used again until the instance is purged.

Suspend Select this to temporarily suspend a workflow. This allows you to continue the workflow using the same KeyId after suspending it.

Resume Select this to roll back the workflow to the last instance that was successfully executed. This allows users to enter values which will ensure the successful execution of the workflow.

Refresh Select this to refresh the information displayed.

Notes and warnings

Security considerations

Ensure that the operator setting: SWS Allow workflow manual override is enabled.
Ensure that your system has sufficient SQL credentials to manage the workflows in the SQL server.
Ensure that a workflow database has been created for each SYSPRO company for the SYSPRO Workflow Service to track and persist information.

Config file considerations

You can use the serviceexternalbaseaddress key in the SYSPRO Workflow Service config file to specify the external address of the workflow service when sending email templates containing links.

Hints and tips

You can use this program to terminate or resume the process in cases where there is an interruption or delay in the workflow process, such as a server crashing or if someone is absent from work and cannot perform an activity in the process.