3.1.7 Workflow Table

Owned by Jenni Wallin
Last updated: Jul 05, 2024 by Yuri Au Yong
7 min read

The workflow table is located at the bottom of the workflow configuration.

There must always be at least one runnable workflow per workflow configuration, otherwise it will not be valid.

The three leftmost columns gather the workflow meta data: Valid, ID, and Name. A workflow table always contains these columns. The ID is automatically generated starting at 1. The ID is unique within the workflow configuration. The Name will be generated based on the ID, for example 'Workflow_1'. The names can be edited, however, if two workflows have exactly the same name a validation error will occur.

The workflow table will be populated depending on settings made in the Workflow Properties dialog, in the Workflow Table tab. For example adding rows and field type settings is done there and will propagate changes in the workflow table.

Apart from the three first columns, columns in the table represent fields of Default and Per Workflow type. See 3.1.8 Workflow Properties for further information about the field types.

You can also configure your own fields to be referenced by your APL code, which can be updated. The fields are configured in the Workflow Properties and referenced by the APL command dynamicFieldGet. The fields can be of either boolean, int, or string type, and you can configure different categories for the fields, for an easier overview. This may look like this, for example: 


Example of a workflow table

Default fields have the default value displayed in the instance table as <Val> , where Val represent the actual default value. If no default value is set in the agent in the template, < > is displayed. If the field is of a Per Workflow type and not yet defined, an error message is shown in the cell pointing out that the cell is not valid.

Note!

When using an External Reference profile or a SAP RFC profile, all workflows in the table must use the same profile.

Different icons that can appear in the workflow table:

IconDescription

Workflow is not yet validated

Workflow is valid and runnable

Workflow is invalid

The cell is invalid.

Click this button within the cell; the Edit Execution Settings dialog box opens.

The field contains an External Reference.

The rows can be rearranged by clicking the column heading. Both headings for one single column, and ones that collect a number of headings can be used to change the order, either descending or ascending.

Right-Click Menu


ItemDescription

Edit cell

The command is used to put the cell in edit mode if the content is allowed to be altered. If it is not, the Edit Cell command will be grayed out and not possible to select. You can enable editing either by double-clicking in the cell or by typing any key on the keyboard.

A cell can be locked to a certain input type and some cells only accept numbers or a string.

Clear cell

The command is used to remove the content of the selected cell. If it is a field of default type, this command will change the cell content to the default value set in the template. If the cell content must not be cleared, the command will be grayed out from the menu and will not be possible to select.

Edit from default

The command is used to edit the cell by inserting the default value for that field that you set in the template. The command is only available for cells that render from fields of Default type.

Note!

The default value inserted is considered to be a changed value. If the reason to set the value is to return to the template default value mode, Clear Cellis the appropriate choice.

Enable External Reference

Select this to mark the field as an External Reference. Then, with Edit Cell, you enter the Local Key reference. The value is applied during the workflow runtime. For further information see 8.11 External Reference Profile.

Disable External Reference

Select this to remove the External Reference value as well as mode. For further information see 8.11 External Reference Profile.

Add Workflow

The command adds a workflow (a row) to the bottom of the table. The added workflow instantly gets an ID and Name.

Add Workflows

Use this command to add more than one workflow at the same time. The command adds the number of workflows (rows) that you specify.

Note!

The maximum number of rows in a table is 500.

Delete Workflow

The command removes the entire Workflow that is associated with the marked cell. If removed, the ID number of that workflow will never again return within that workflow configuration. To remove more than one workflow, select all the relevant cells.

Duplicate Workflow

The command duplicates the entire workflow that is associated with the marked cell. The new workflow is added to the bottom of the table. More than one cell can be marked to enable duplication of several workflows at a time. Note: New IDs and Names are generated.

Show Validation Message

The command will open an information dialog were a message regarding the validity of the template, workflow and cell is stated. The dialog must be closed to return to the configuration.

Show Specific References

Select to see the references of the specific workflow.

Note: Selecting Show References from the View menu, displays references that are relevant to the workflow configuration.

Open Monitor

Opens the Workflow Monitor if the selected workflow is valid.

Run in MonitorOpens the Workflow Monitor and starts the workflow.
Debug in Monitor

Opens the Workflow Monitor and starts the workflow with debugging enabled. Events for all agents will be monitored.

Export Table

Opens an export dialog where you select and save workflow configurations in a file. With this export file you transfer and update workflow table data either on your current machine or on a different client. The export file can be created in any of the following formats:

  • .csv - Contains a header row, uses comma (,) as field delimiter and quotation mark (") as text values delimiter. Uses newline as record delimiter.

  • .ssv - Uses ASCII Unit Separator (US) and Record Separator (RS) characters. 

  • .tsv - Contains a header row, uses tab as field delimiter and newline as record delimiter.

Exported fields that contain profiles are given a unique string identifier. The ID and Name fields are exported as well.

In the export file, External References are enclosed in braces ({}) and preceded by a dollar symbol ($). For example: ${mywf_abcd}. For further information see External Reference Profile.

Import Table

Opens an import dialog where you import an export file. This file might contain, for example, data that has been saved in the workflow table, locally or on a different client. This command supports, the following file formats:

  • .csv - Contains a header row, uses comma (,) as field delimiter and quotation mark (") as text values delimiter. Uses newline as record delimiter.

  • .ssv - Uses ASCII Unit Separator (US) and Record Separator (RS) characters. 

  • .tsv - Contains a header row, uses tab as field delimiter and newline as record delimiter.

Importing a table may result in any of the following scenarios:

  1. If the ID number of the imported workflow (a table row), is identical to the ID number of one of the rows that are already in the table, the imported entry overwrites the existing one.
     

  2. If the ID number of the imported workflow is -1, the imported entry is added to the bottom of the table.

    Note!

    keeps track of the number of rows that you add to the workflow table using a row counter. If the row counter number is 98, and the imported Workflow's ID is -1, the imported workflow is stored with 99 as the ID number.

  3. If the ID number of the imported workflow does not exist in the table and is not equal to -1, the imported entry is added to the table. The ID number remains the same number as it was in the import file.

Filter and Search

The command opens a search and filter bar below the workflow table. The search can be performed for all columns. In the search field the search words or numbers can be entered. When Find next is selected the search starts. The filter feature works on workflow name only. The workflow table is updated as you are typing text in the Filter Name field.

Using all lower case letters in the search and filter text field will result in case insensitive search and filtering. If upper case letters are used anywhere in the text field the search will be case sensitive.

The search and filter bar is closed by selecting the x symbol to the left of the bar.

Next subsection:
3.1.8 Workflow Properties