The commands below are available when creating workflows for Personify Enterprise to be incorporated into forms created through the Personify Application Designer. These commands are the actions (i.e., results) executed by a workflow when a specific user-action occurs in the back-office.
This command collects input parameters for Master Customer ID, and Product ID, as well as Sub Customer ID (optionally), then makes the correct call to open Order Entry before passing the input parameters to the screen to create a new order for the customer.
The command returns either CommandResult.Success or CommandResult.Failure depending on whether or not the command executes successfully or encounters any exceptions.
Action Icon Name: Create New Order
Command Name: CreateNewOrder_Base
Target Form: None
How to call: "cmd://Main/CreateNewOrder_Base?MasterCustomerId=" & $MasterCustomerId$ & " &SubCustomerId=" & $SubCustomerId$ & “&ProductId=” & $ProductId$
Parameter Name |
Required? |
Default Value (if parameter doesn’t pass) |
|---|---|---|
MasterCustomerID |
Yes |
|
SubCustomerID |
No |
0 |
ProductIDList |
Yes |
|
This command collects input parameters for Master Customer ID, Activity Code, and Activity Text, as well as (optionally), Sub Customer ID, Subsystem, Activity SubCode, and Activity Date, then inserts a new record into the appropriate table to create the activity record for the specified customer
The Master Customer ID, Activity Code, and Activity Text input parameters are all required for the system to create the activity record.
Action Icon Name: Create Activity
Command Name: CreateActivity_Base
Target Form: None
How to call: "cmd://Main/CreateActivity_Base?MasterCustomerId=" & $MasterCustomerId$ & “&SubCustomerId=” & $SubCustomerId$ & “&Subsystem=” & $Subsystem$ & “&ActivityCode=” & $ActivityCode$ & “&ActivitySubCode=” & $ActivitySubCode$ & “&ActivityText=” & $ActivityText$ & “&ActivityDate=” & $ActivityDate$”
Parameter Name |
Required? |
Default Value (if parameter doesn’t pass) |
|---|---|---|
MasterCustomerID |
Yes |
|
SubCustomerID |
No |
0 |
SubSystem |
No |
CUS |
ActivityCode |
Yes |
|
ActivitySubCode |
No |
|
ActivityText |
Yes |
|
ActivityDate |
No |
Current Date |
Similar to the Create Personify Activity command, this command collects input parameters for Master Customer ID, Call Topic Code, and Activity Text, as well as (optionally), Sub Customer ID, Call Topic Type, Call Topic Sub Code, and Follow Up Date, then inserts a new record into the appropriate table to create the contact tracking record.
The Master Customer ID, Call Topic Code, and Activity Text input parameters are all required for system to create the contact tracking record.
Command Name: CreateContactTracking_Base
Target Form: None
How to call: "cmd://Main/CreateContactTracking_Base?MasterCustomerId=" & $MasterCustomerId$ & “&SubCustomerId=” & $SubCustomerId$ & “&CallTypeCode=” & $CallTypeCode$ & "&CallTopicCode=" & $CallTopicCode$ & "&CallTopicSubCode=" & $CallTopicSubCode$ & "&ActivityText=" & $ActivityText$ & "&FollowupDate=" & $FollowupDate$
Parameter Name |
Required? |
Default Value (if parameter doesn’t pass) |
|---|---|---|
MasterCustomerID |
Yes |
|
SubCustomerID |
No |
0 |
CallTypeCode |
No |
|
CallTopicCode |
Yes |
|
CallTopicSubCode |
No |
|
ActivityText |
Yes |
|
FollowUpDate |
No |
|
This command is nearly identical to the Create Contact Tracking Record command above. Contact tracking records and follow-up activity records are stored in the same location in the database and are only differentiated by the values stored in specific columns. The same functionality should be applied here as applied to contact tracking records. The FollowUpDate parameter is not required for this command.
Action Icon Name: Create Followup Activity
Command Name: CreateFollowupActivity_Base
Target Form: None
How to call: "cmd://Main/CreateFollowupActivity_Base?MasterCustomerId=" & $MasterCustomerId$ & "&SubCustomerId=" & $SubCustomerId$ & "&ParentActivityId=" & $ParentActivityId$ & "&ActivityText=" & $ActivityText$ & "&FollowupDate=" & $FollowupDate$
Parameter Name |
Required? |
Default Value (if parameter doesn’t pass) |
|---|---|---|
MasterCustomerID |
Yes |
|
SubCustomerID |
No |
0 |
ParentActivityID |
Yes |
|
ActivityText |
Yes |
|
FollowupDate |
No |
CurrentDate |
Sets a control’s Visible property to False.
Action Icon Name: Hide a Control
Command Name: ControlInvisible_Base
Target Form: None
How to call: ""cmd://Main/HideControl_Base?ControlName=" & $ControlName$
This command opens Create New Customer (CUS001SF), so the user can create a customer. Once a user creates the new customer, the Customer Central screen opens.
The command returns either CommandResult.Success or CommandResult.Failure depending on whether or not the command executes successfully or encounters any exceptions.
Action Icon Name: Create a Customer
Command Name: CreateNewCustomer_Base
Target Form: CUS001SF
How to call: "cmd:// Main/ CreateNewCustomer_Base”
This command collects input parameters for Master Customer ID and (optionally) Sub Customer ID, then makes the correct call to open Customer Central before passing the input parameters to the screen, thereby rendering the customer details page of that specific customer.
If a Master Customer ID does not pass, then the Customer Central screen opens to the Search screen. If the Master Customer ID passes and the Sub Customer ID does not pass, the Sub Customer ID defaults to “0” (zero) and the customer details page opens with a list of all orders created with that Master Customer ID.
Action Icon Name: Open Customer Central
Command Name: OpenCustomerCentral_Base
Target Form: CUSCentral
How to call: "cmd://Main/OpenCustomerCentral_Base?MasterCustomerId=" & $MasterCustomerId$ & "&SubCustomerId=" & $SubCustomerId$
Parameter Name |
Required? |
Default Value (if parameter doesn’t pass) |
|---|---|---|
MasterCustomerID |
Yes |
|
SubCustomerID |
No |
0 |
Opens a form as a modal dialog.
Action Icon Name: Open a Dialog
Command Name: OpenDialog
How to call: "cmd://Main/OpenADialog_Base?Name=" & $Name$
This command collects input parameters for Master Customer ID as well as (optionally) Sub Customer ID and Product ID List, then makes the correct call to open Order Entry before passing the input parameters to the screen, thereby rendering the Order Entry page and creating a new order for that customer. Users would then need to enter the product(s) for that order.
If a Master Customer ID does not pass, then the Order Entry screen opens to the Search screen. If the Master Customer ID passes and the Sub Customer ID does not pass, the Sub Customer ID defaults to “0” (zero) and the Order Entry screen opens with a new order created for that Master Customer ID. If the Product ID List passes, the Order Entry screen opens with
Command Name: CreateNewOrder_Base
Target Form: Ord001
How to call: "cmd://Main/CreateNewOrder_Base?MasterCustomerId=" & $MasterCustomerId$ & " &SubCustomerId=" & $SubCustomerId$ & "&ProductId=" & $ProductId$
Parameter Name |
Required? |
Default Value (if parameter doesn’t pass) |
|---|---|---|
MasterCustomerID |
Yes |
|
SubCustomerID |
No |
0 |
ProductIDList |
No |
|
This command collects an input parameter for Order Number, then makes the correct call to open Order Entry before passing the Order Number input parameter to the screen, thereby rendering the Order Detail page of that specific order.
If a Order Number does not pass, then the Order Entry screen opens to the Search screen.
Command Name: OpenOrderEntry_Base
Target Form: ORD001
How to call: "cmd://Main/OpenOrderEntry_Base?OrderNumber=$OrderNumber$
Parameter Name |
Required? |
Default Value (if parameter doesn’t pass) |
|---|---|---|
OrderNumber |
Yes |
|
This command collects input parameters for Master Customer ID and (optionally) Sub Customer ID, then makes the correct call to open Order Entry before passing the input parameters to the screen, thereby rendering the Order Entry page and listing all orders created with that customer ID.
If a Master Customer ID does not pass, then the Order Entry screen opens to the Search screen. If the Master Customer ID passes and the Sub Customer ID does not pass, the Sub Customer ID defaults to “0” (zero) and the Order Entry screen opens with a list of all orders created with that Master Customer ID.
Command Name: OpenCustomerOrderEntry_Base
Target Form: Ord001
How to call: "cmd://Main/OpenCustomerOrderEntry_Base?MasterCustomerId= $MasterCustomerId$ &SubCustomerId=$ SubCustomerId$
Parameter Name |
Required? |
Default Value (if parameter doesn’t pass) |
|---|---|---|
MasterCustomerID |
Yes |
|
SubCustomerID |
No |
0 |
Opens a form as a modeless dialog.
Action Icon Name: Open a Form
Command Name: OpenAForm_Base
How to call: "cmd://Main/OpenAForm_Base?Name=" & $Name$
Saves all changes to the bound collection.
Action Icon Name: Save
Command Name: Save_Base
Target Form: None
How to call: "cmd://Form/Save"
Saves all changes to the bound collection and closes the form. It is important to note, however, that once a form closes, the workflow for that form is complete, so make sure to only use this command as a final step in a workflow.
Action Icon Name: Save and Close
Command Name: SaveAndClose_Base
Target Form: None
How to call: "cmd://Main/OpenWindow?Name=" & $Name$ & "&Type=" & $Type$ "&Maximize=" & $Maximize$
This command creates a record in the NOTIFY_WORKFLOW_CHRONICLE table, which is queued to send an additional e-mail to the EmailAddress paramter value passed for NotificationId.
There are some additional named / unnamed parameters which will be used to compute the WorkflowKey, in case the passed WorkflowKey is not correct.
The command returns either CommandResult.Success or CommandResult.Failure depending on whether or not the command executes successfully or encounters any exceptions
Action Icon Name: Send an Email
Command Name: SendEmailNotification_Base
Target Form: None
How to call: "cmd://Main/SendEmailNotification_Base?NotificationId =$NotificationId$ &EmailAddress=$EmailAddress$
Parameter Name |
Required? |
Parameter Description |
|---|---|---|
Notification ID |
Yes |
Notification Event To Fire. |
EmailAddress |
Yes |
An Email Address that you would prefer to use for sending the email notification. |
TemplateKey |
No |
Alternate Template Key to use when sending this notification. |
WorkflowKey |
No |
Workflow Key (combination of parameters with '|') to use when sending this notification. |
MasterCustomerID |
No |
The Master Customer Id to use when sending this notification. |
SubCustomerID |
No |
The Sub Customer Id to use when sending this notification. |
CusAddressID |
No |
The Customer Address Id to use when sending this notification. |
ProductID |
No |
The Product Id to use when sending this notification. |
OrderNumber |
No |
The Order Number to use when sending this notification. |
<parameter 1> |
No |
The parameter 1 to use when sending this notification. |
<parameter 2> |
No |
The parameter 2 to use when sending this notification. |
<parameter n> |
No |
The parameter n to use when sending this notification. |
This command collects the input parameters for Control Name and (optionally) New Value, then finds the Personify controller for a control by the Control Name input parameter before setting the value of that controller/control to the New Value input parameter.
If the Control Name passes, and the New Value does not pass, the system sets the control’s value to an empty string, a zero, an empty date, etc., depending on the control.
Action Icon Name: Set Control Value
Command Name: SetControlValue_Base
Target Form: None
How to call: "cmd://Main/ SetControlValue_Base?ControlName=$ControlName$ &NewValue= $NewValue$"
Parameter Name |
Required? |
Default Value (if parameter does not pass) |
|---|---|---|
ControlName |
Yes |
|
NewValue |
No |
|
Sets a control’s Visible property to True.
Action Icon Name: Show a Control
Command Name: ShowControl_Base
Target Form: None
How to call: "cmd://Main/ShowControl_Base?ControlName=" & $ControlName$