Workflow Table(3.1)

Owned by Jenni Wallin
Last updated: Jun 15, 2023
6 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 Workflow Properties(3.1) for further information about the field types.

Note!

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 dialog and referenced by the APL command dynamicFieldGet. These fields support boolean, int or string formats. You can also configure different categories for the fields, for an easier overview.


Example:

Default fields have the default value displayed in the workflow 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 appears showing that the cell is not valid, if the intended value is blank you must manually set it as such.

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 columns 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

The following options are available if you right-click a cell of the workflow table:  

ItemDescription

Edit cell

Select this option to edit the content of the selected cell. The Edit Cell option is grayed out and not possible to select if the content is not allowed to be altered. You can edit the cell content either by double-clicking in the cell or by typing any key on the keyboard.

Note!

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

Clear cell

Select this option to remove the content of the selected cell. If it is a field of default type, this option will change the cell content to the default value set in the template. The Clear Cell option is grayed out and not possible to select if the content is not allowed to be altered.

Edit from default

Select this option 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 Cell is the appropriate choice.

Enable External Reference

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

Disable External Reference

Select this option to remove the External Reference value and mode. For further information, see External Reference Profile.

Add Workflow

Select this option to add a workflow (a row) to the bottom of the table. The added workflow instantly gets an ID and Name.

Add Workflows

Select this option 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

Select this option to remove 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

Select this option to duplicate 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

Select this option to view information regarding the validity of the template, workflow and cell. Close the dialog to return to the configuration.

Show Specific References

Select this option to see the references of the specific workflow.

Note!

You can also click on the References button available in the toolbar to view references that are relevant to the workflow configuration.

Open Monitor

Select this option to open the Workflow Monitor. This option opens the Workflow Monitor if the selected workflow is valid.

Run in MonitorSelect this option to start the workflow in the Workflow Monitor.
Debug in Monitor

Select this option to start the workflow, in the Workflow Monitor, in debug mode. Events for all agents will be monitored.

Export Table

Select this option to save the workflow configurations in a file. With this export file you transfer and update the 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

  • .ssv

  • .tsv

The .csv export file contains a header row, comma (,) delimited fields, and text values that are delimited by a quotation mark(").

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 (3.0).

Import Table

Select this option to 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. The file can be imported in any of the following file formats:

  • .csv

  • .ssv

  • .tsv

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!

    Usage Engine 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 option opens a filter and search bar below the workflow table.

  • Filter: The filter feature works on workflow name only. The workflow table is updated as you are typing text in the Filter field.
  • Search: The search can be performed for all columns. You can enter the search words or numbers in the Search field. Click Find Next to start the search.

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.

Note!

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