The CoPilot Command Control allows designers to add a simple button to the Workflow that executes a CoPilot Helper Function, which can either be click by the agent or triggered by some other automatic process.
This Control is part of the CoPilot Control pack, and will only be available if your System has the appropriate licence.
How To
Add a CoPilot Command to the Page. The options and style can be configured in the Options tab and Styling tab of the Field Properties.
CoPilot Command Fields can be styled in a Stylesheet by referencing the control-copilot-command class.
Once the CoPilot Command has been configured as desired, clicking the Advanced Options tab will allow the configuration of the CoPilot Helper Function to execute.
The CoPilot Helper Function to be executed is chosen from the list at the top, and, depending on which CoPilot Helper Function is selected, other parameters may be offered below:
Next, it is possible to choose to map any of the response data to Fields or Variables within your Workflow. Also included is the ability to map any error response, which may be useful in detecting or troubleshooting errors.
Finally, it is possible to specify for a different Field to be triggered when the CoPilot Command Field has finished its action via Update Links.
Notes
Parameters can either be populated with static text, or linked to a Field or Variable that will contain the value to be used during the record.
If the configured CoPilot Helper Function is successful, then the returned data is assigned to the value of the CoPilot Command Field.
Any error messages raised during the execution of the Helper Function will be alerted to the agent as a Toast.
