Skip to main content

Business Object Workflow - Knowledgebase / SalesPad / Setup - Cavallo Technical Support

Business Object Workflow

Authors list

Table of Contents

Overview

Business object workflow is used to create custom workflows for supported business objects in SalesPad Desktop. Users can add rules, conditions, and actions that govern how business objects are handled in workflow. This document will go over general workflow configuration and functionality.

Security Editor

To access the Security Editor, go to Modules -> System -> Security Editor, filter to "Workflow" and make sure all of the following security options are enabled for the group(s) responsible for configuring/maintaining workflow.gcaR0qaF5c2Xmwb986HUTvQgcqo9LAXU.png?access_token=snx3ud-tddzyxwrtn-8b2d006cebcc918077b229003ed2097a66ab0906

Note: Securities with an asterisk (such as Workflow Monitor) have sub-securities that are listed in the middle section of the Security field. Sub-security descriptions appear in the bottom section of the field

Log off and log back on to SalesPad. Workflow Setup and Workflow Monitor options should now be available on the ribbon.

YIgGOgKQfsD67xrfJ1le3U9qEdc42tg3.png?access_token=snx3ua-mtxgxgvwyy-fd976c1a811723e836a90c66ef1c50acb9a6c6f8

Workflow Setup

The Workflow Setup screen is used to configure workflows for a desired business object. It displays all workflows at a glance under the All tab or groups them under individual business object tabs. For example, clicking the CaseTrackerCase tab will show only CaseTrackerCase workflows.

s7PCIciAXdS3gzIxzc2p0sGwDtH9WCES.png?access_token=snx3u9-peuxhghplp-cdbc36efc3febfeac36e38d05164043f03a1480e

Add New Workflow

To create a new workflow, click the New button. Workflow Card will open, allowing the user to set workflow batches, rules, conditions, and actions. If a specific business object tab was selected prior to clicking the New button, that business object will be pre-selected on the Workflow Card.

Note: If a particular business object is not available for selection, it will have to be added by the SalesPad development team.

Delete Existing Workflow

To delete an existing workflow, click the Delete button.

Note: Workflow cannot be deleted from the Workflow Setup screen if the Workflow Card for that workflow is currently open in SalesPad.

4OfAHo07iayGVcRNM4Zu3bGiTencAl7c.png?access_token=snx3u7-clqbvoxqmb-c47e33915354920816503c644582198f924b204e

Edit Existing Workflow

To modify an existing workflow, click the Edit button. The Workflow Card will open, allowing the user to modify workflow batches, rules, conditions, and actions.

Workflow Card

Workflow Card is used for workflow configuration. Users can enable or disable workflow, edit batches and rules, and set conditions and actions.

EwrWNTpz4rn41pY3SeeP352vjL1ThIax.png?access_token=snx3u8-zisvdsgwoz-87d20c37dd1ca84d384b0d1b339a60644a416263

Workflow Properties

Workflow properties apply to the entire workflow. Property fields are:

Business Object – Name of the business object to which the workflow will be applied. Once this field is set and workflow saved, it cannot be changed.

Key – Workflow key is optional and is not required for most business objects. Please see the Workflow Key section for more details.

Name – Custom name for the workflow. This name will be used to identify the workflow on the Workflow Setup screen.

Description – Workflow’s purpose can be specified here. This field is optional.

Enabled – Sets the workflow as enabled or disabled.

Workflow Key

Workflow keys allows the user to create multiple workflows for the same business object. Workflow keys are optional.

For example, a workflow key for the Purchase Order business object could be the PO Type field. Purchase order types in Dynamics GP are STANDARD, DROPSHIP, BLANKET, and DROPSHIPBLANKET. This means that theoretically four different workflows can be created for the Purchase Order business object. That being said, SalesPad currently supports only STANDARD and DROPSHIP types so two different workflows can be created.

WCaZvPQfi3MSEadGJHa0Jkg53xjYdkUM.png?access_token=snx3uc-nppfnyxqsa-4429ec907d22c91b96d84bcae69a91c9122dff79

Queues

Users can add workflow batches on the Queues tab.

giCEGUs13am2UFysn3aM98FnvcE8FZP9.png?access_token=snx3ub-kwwkigvnmp-93b6cd00dc5193bc727acda3cb5aa5f851186a62

To add a new queue to the workflow, click the New button.

Sequence
Assigned automatically and determines queue order (clicking the Resequence button will auto-assign a sequence number to each queue)
Queue Name
The name of the queue (must be unique and is required)
Forward Label
The text of the button used to forward business objects through workflow
Auto Forward Checking this means the document/object will forward through the queue automatically without user intervention (commonly used to check rules or fire a plugin)
Disable Printing Checking this disallows printing in that queue
Enabled Enabled means the queue is active. If this is not checked, the queue is not apart of the workflow
Read-Only Security Groups Security groups added here can only view objects/documents in the queue, not edit
Next Queue(s)
Designate which queue(s) documents can be forwarded to (if more than one queue is selected here, SalesPad will prompt the user to manually select the desired queue before forwarding)

Note: If more than one batch is selected under Next Queue(s) and the business object is being forwarded from the Workflow Monitor screen, SalesPad will not prompt for the forward batch and will instead forward to the first available batch.

Rules

Users can add workflow rules on the Rules tab. Workflow rules determine how business objects are forwarded through workflow.

5lxzGhDVLpADIsZOxv1dOYnAuZ2CJiib.png?access_token=snx3ug-ttpycpmava-c94f201604c61e829cac6055dc6d15c1932e2817

The Rules tab is split into three separate sections - Rules, Conditions, and Actions. To add a new rule, click the New button.

Sequence
Assigned automatically and determines the order in which the rules will be evaluated (clicking the Resequence button will auto-assign a sequence number to each queue)
Name
The name of the rule (this is a required field)
Description
A description of the rule (optional)
Evaluate
Determines when the rule will be evaluated ('On Enter Queue' or 'On Exit Queue')
Applies To Queue(s)
Determine which queue(s) this rule will apply to
Enabled
Enable or disable a rule
Prevents Movement
Allow a rule to prevent a business object from continuing through the workflow if it does not evaluate as 'True'


Conditions

Conditions are conditional statements used to determine if a rule has been satisfied. A rule can have more than one condition, but all conditions must evaluate to true in order for the rule to be satisfied.

Available condition types:

  • Value Comparison
  • Field Comparison
  • SQL Procedure
  • C# Script

Value Comparison

Value comparison condition compares a business object field (including user fields) to a static value.

rwMVyc7PEoxnK4brWsQvrPGcVZKCDkxj.png?access_token=snx3ug-gwzdoumxex-77e3c9beaf247100aaf902d3780490f4e090e216

If the field value matches the value entered, the condition will evaluate to true.

Note: Field data type must match the value data type. For example, if the field is of type string, then value must also be string.

Field Comparison

Field comparison condition compares a business object field (including user fields) to another business object field.

URBnXXcRl6bbqLZzt6rSO6Fadolt9nN8.png?access_token=snx3ue-hfkrfsjkaw-4050c9e9b65ba1ea8469babc9ce7e44e4cdc5b75

If the field value matches the second field value, the condition will evaluate to true.

SQL Procedure

SQL procedure condition uses a SQL stored procedure to compare values.

uPWSSmxhvGHYm8CcBuhTWolHLQIwDIlU.png?access_token=snx3u9-khwoloebjo-c235a78abc1eceabfd2ae184a0e58d523c0eb08a

SQL procedure does not exist in the database by default, but clicking the Generate button will create it. For example, SQL procedure for CaseTrackerCase business object will be generated as spcpCaseTrackerCaseWorkflowEvalRuleCondition.

Generated SQL procedure is empty by default and will need to be edited in Microsoft SQL Server Management Studio by adding desired conditions. Once the conditions are added, the user can then specify them in the Condition ID field.

C# Script

The C# script condition uses a C# script to compare values.

5UwVfj0Ra8eKCXAeNkwst2vBlQRRpsU7.png?access_token=snx3u9-yrewuahsve-6121e8d84c98cb6656d0e86be7492d5ec9560520

The C# script is the most versatile condition type. It allows the user to write complex conditions in the form of an executable script. The available script parameters are:

Apollo.Data.BusinessObjectWithWorkflow businessObject
Apollo.Data.ValueWrapper conditionMatched

The businessObject parameter is the generic business object that is being forwarded through workflow and will need to be cast to the appropriate business object.

For example; if the business object that is being forwarded is CaseTrackerCase, then the cast would look like this:

SalesPad.Bus.CaseTrackerCase ctc = (SalesPad.Bus.CaseTrackerCase)businessObject;

The conditionMatched parameter is a Boolean value wrapper that determines if the condition is true. To make the condition true in the script, set:

conditionMatched.Value = true

To make the condition false, set:

conditionMatched.Value = false

Actions

Actions are operational statements that are executed when the rule is evaluated. A rule can have more than one action. If the rule does not have any conditions, all actions are executed. If the rule does have condition(s), all conditions must be true before actions are executed.

Note: Conditions are not required to execute actions. If conditions are not set, all actions will execute.

Available actions:

  • Email
  • Print
  • Run Script
  • Move To Batch
  • Run Plugin

Email

Email action is used to send email messages. Email settings will need to be configured in SalesPad before this action can be used. Please see the Settings section of the Emailing in SalesPad Desktop documentation for more information.

BNBWUG8Z6B2CSRTJ7qMTcZJQvRajH6Az.png?access_token=snx3uh-rntvprfxfs-4fd9b32bb8624e768eb41db48edda67204a51372

Report Name – Name of the printed report that will be sent as an attachment in the email message. If the business object does not support printing, this field will be blank.

Subject – Email subject.

Send To – Email address to which email will be sent. Multiple email addresses can be entered in a semicolon delimited list.

CC – Carbon copy email address. Multiple email addresses can be entered in a semicolon delimited list.

BCC – Blind carbon copy email address. Multiple email addresses can be entered in a semicolon delimited list.

From – From email address.

Display Name – Display name that will be shown in the email message.

Reply To – Reply to email address.

Body – Body of the email message. Click the ellipsis button to open the Email Body Editor. If email template is being used, this field will be inaccessible.

Template – Email template. If email body is being used, this field will be inaccessible.

Note: Email templates are not available for all business objects. If email template is not available for a selected business object, the Template field will not be available.

Users can edit email body text using the Email Body Editor.

AX4HcSNZTScqeJgYfNVBbYDEUd6K35sq.png?access_token=snx3uj-hrrqjffifm-450c9a7e69737c1704b383f5e22efa4b1d0cd85a

Email Body Editor is similar to the Email Template Editor in terms of functionality. The user can type the email body text and even insert merge fields by clicking the Insert Merge Field button.

Print

Print action is used to print reports.

wp9aH5jSykpOln0XkdRnulArUIZtnleg.png?access_token=snx3ub-kfdmlujeki-b81fab817f30b7bd0b94ae81a8f1088becef8572

Report Name – Name of the report to be printed.

Printer Name – Name of the printer that will print the report.

Copies – Number of copies to be printed.

Note: SalesPad will let the user know if the business object does not support printing in workflow.

SX5WwdX4O0vFFUsvHe5JnOEjU3jRCIIm.png?access_token=snx3ug-doxxwjlfzp-abac7faa9948c381078afcff7adf6baabe9491aa

Run Script

Run script action is used to execute a C# script.

QOTThM7g5UvxZlaaDb5cYZJDL6UWwGH5.png?access_token=snx3uf-adwahfeurd-d3d11369e32f5f242ce439e36729a950b4dfe32c

The Run script allows the user to write complex actions in the form of an executable script.

The businessObject parameter is the business object that is being forwarded through workflow. Just like the condition script, it will need to be cast to the appropriate business object before it can be used. Please see the Conditions section for more information.

Move To Batch

Move to batch action is used to send the business object to a specific workflow batch.

7oRwxxYuBm55HOEj0KArAZKlAZgshk0T.png?access_token=snx3uc-keooanmbcu-3ac7feeef1bf93f58d12d0d0c2a79921d73c8f0a

Run Plugin

Run plugin action is used to execute a business object-specific plugin.

076DEJIRvgGLXBhMEVK0qgmwvnKpYa7U.png?access_token=snx3ud-dyggzsalyo-318315eb9f7719faf7498d848195ad6fcb0e3687

Note: SalesPad will let the user know if the business object does not support plugins in workflow.

Z50yfszQhQ7WeUuA2IlTEmj9gn9kz5Yg.png?access_token=snx3ud-pgcoliwrur-d4e0339c8713485b7611f36850448d6b7132d0a9

Workflow Monitor

Workflow Monitor is used to view business object workflows and queues at a glance. It also allows users to forward business objects through workflow or send them to a specific queue.

E8xepUsJsKDkHzwSsHubD0gEUiMoZiai.png?access_token=snx3ui-codtgaivyb-065f3760ecdeb6e7e54e0b1195e296056865b43f

The Workflow Monitor screen has a tab for each business object, such as PurchaseOrder and CaseTrackerCase. Every business object tab has a sub-tab for each workflow. If business object does not support multiple workflows, sub-tabs will not be shown. For example, CaseTrackerCase business object does not support multiple workflows.

617iLF5o3DqPtQv3fwTmX6bHFZBupzTV.png?access_token=snx3uj-zjqczlpxaj-a76f54b6fb67052e7886068779ca23ab8299a903

Forwarding

To forward business objects through workflow, select one or more (CTRL + click to multiselect) from the grid on the right and click the Forward button. SalesPad will ask the user to confirm the forward action. Clicking Yes will forward the selected business objects through workflow.

After the forward action is complete, the Summary window is displayed.

FbrCKBO7NoQFMiuXFfJ4iN189p0U119Y.png?access_token=snx3ui-ftbxsehxhu-7f55d421889e14fbc492cab7f0894b704ddcbb66

Send To Batch

Send to batch is used to send business objects to a queue/batch without actually forwarding them through the workflow. Sending business objects directly to a batch will not trigger workflow rules, conditions, and actions.

To send business objects to a batch, select one or more from the grid on the right and click the Send To Batch button. SalesPad will ask the user to select the desired batch. Clicking OK will send the selected business objects to the selected batch.

2pFNGMO04n4IcfcMnQZtaxkcvg9PXUat.png?access_token=snx3uk-ashhsgwxpb-fe6d14637897b0b3cec408259a44917585ae0160

Note: If multiple business objects are selected from two or more workflows, SalesPad will not be able to send to batch and will inform the user accordingly.

BAOqmvbd95SMYme3WiK02vwmTdAe5hpk.png?access_token=snx3ug-ytkeyvlzob-78bb88e0f0cd5db8838f1dd8b8d3a4bca887da80



Helpful Unhelpful