- 18 Oct 2023
- 5 Minutes to read
- Print
- DarkLight
Add custom row-level action buttons
- Updated on 18 Oct 2023
- 5 Minutes to read
- Print
- DarkLight
You can configure custom actions for each record in a worksheet, and then load these actions with desired parameters. This feature provides flexibility when defining business processes. For example, you can apply a variety of targeted updates and calculations to a specific row without impacting an entire worksheet data set.
To configure your own custom actions, ask your Zilliant representative to provide the following information:
- List of available job workflows configured for that purpose
- Descriptions or guidance about the proper scoping values to use
Row-level actions appear in a specially designated Actions worksheet column. This column is automatically pinned to the right of the worksheet. Use the drag-and-drop feature to display row-level actions in your preferred order.
Users can see the configured row-level action buttons only when they have the RowActionExecute permission enabled.
Configure a new action button
- Use the Configuration interface to define a job workflow that will perform the desired IQ Interface action.
- From the IQ Interface worksheet where you want to add actions, select Properties.
- In the leftmost panel, select Row Level Actions.
- In the Row Level Actions area, select New.
- Enter or select values to add the action:
Label—Describe the purpose of the action. If you enter a name that exceeds a 20 characters, the system automatically truncates it. Hover over the button on the toolbar to see the full name of the action.
(Optional) Icon—Select an icon to display instead of the label.
Job Workflow—Enter the Automation ID of the job workflow that you defined in Step 1.
Scope—Enter a value to make the job independent from all other jobs. For more information on the Scope attribute, refer to the Scoped actions below.
Disable Scope—Optional. If selected, jobs won't be queued by the system but will run in parallel. For more information, refer to the Unscoped actions below.
Tip- If you specify the Scope field, the Disable Scope checkbox will be inactive.
- If you select the Disable Scope checkbox, the Scope field will be inactive.
In the Workflow Type dropdown, select Platform.
The Visible checkbox gives you the option to toggle visibility of the new action button.
The Track Execution History checkbox gives you the option to view an execution log of this action. This can be helpful since the jobs can take some time to complete and might be queued up temporarily behind other scheduled jobs.
The Set Schedule or Confirmation checkbox gives you the option to delay the action's execution and to specify an additional message for the user when prompting an action.
(Optional) Confirmation Message—Enter a user-oriented message that will appear in either a Confirmation or Schedule an Action modal dialog upon clicking the action from the Actions dropdown.
(Optional) Actions Parameters—Select Add Parameters, and then:
- In the left-most box, enter the name of a supported action parameter.
- In the Select source dropdown, enter the column name from the IQ Interface worksheet that contains the value that will be passed as that specific action parameter.
- (Optional) Use the Disable Action Conditions section to conditionally disable the action button.
- Select Save.
- Select Go back to Workbook.
Scoped actions
To use the Scope attribute successfully, you must contact your Zilliant representative requesting that they enable the feature flag in your environment. This will make possible for two jobs with the same Scope value to be queued by the system.
You must be careful when using Scope values across all action buttons that act on the same entity. If two destructive actions try to act in parallel on the same entity at the same moment, there is a potential for collision that might result in data loss or data corruption.
For example, some job steps (such as Import CSV from S3) can perform destructive actions on the target entity as part of their processing. If you have an unscoped job workflow and a uniquely scoped job workflow operating on the same target entity, then destructive actions from both jobs could collide and corrupt the target entity.
Therefore, you need to ensure that all job workflows that affect the same target entity share the same scope. This way, all job workflows will run in serial order and will not conflict with each other.
To achieve this, do one of the following:
- Leave all such job workflows unscoped
- Ensure that all such job workflows use the same string for their Scope value.
The Scope attribute accepts any string value up to 18 characters long. It can be, for example, a uniquely generated value or a short description of the job that will be invoked by that component.
- If you enter a unique value, the job won't be queued with other jobs.
- If you enter a non-unique value, the job will be queued and run in sequential order with all other jobs that share the same Scope value.
- If you provide no value, or the string UNSCOPED, then the first 18 characters from the Job Workflow field will be used as a scope attribute. In this case, a job such as Import CSV from Salesforce can be queued and run in a sequential order with all other unscoped jobs (for example, Optimization, Publishing, or a custom job workflow).
Unscoped actions
You can run row-level or toolbar actions without providing a scope. This allows the same action to be run by different users at the same time. Ultimately, this ability enables the multi-user capabilities in the IQ Interface platform.
When you select Save on the toolbar or row-level action properties dialog with the Disable Scope checkbox selected, you will see a warning message.
- Select Cancel to go back to the action's properties dialog.
- Select Yes to save the action without the scope.
Edit existing row-level actions
- Use the Configuration interface to define a job workflow that will perform the desired IQ Interface action.
- From the IQ Interface worksheet, select Properties.
- In the leftmost panel, select Row Level Actions.
- In the Row Level Actions area, you can:
- Select an existing action to edit its properties or delete it.
- Drag existing actions in the order you would like to appear in the worksheet.
- Select Save.
- Select Go back to Workbook.