Sequence Generators
The Sequence Generator property lets you create unique record IDs which can help administrators differentiate between different workflows. Without a custom sequence generator, workflow "names" in the Dashboard will display e.g. Workflow Record 12345. With a custom sequence generator, for example tied to an NDA request, the Dashboard will display NDA 00001, NDA 00002, etc. This is helpful for ticketing cases and keeping different workflows sequenced in order.
Accessing the Sequence Generators Page
To access the Sequence Generators page:
- Hover your mouse over Business Automation and select Sequence Generator from the drop down.
- The Sequence Generators list displays.
Working with Sequence Generators
The Sequence Generators list shows an alphabetical listing of all currently defined sequence generators. Each entry in the list shows the Name and Format String for the associated sequence generator. The list is initially sorted in alphanumeric order, by Name. If desired, you can sort the list according to a selected sort key or filter the list to display a subset of documents.
From the Sequence Generators list, you can choose to:
- Add a new sequence generator
- Edit an existing sequence generator
- Delete an existing sequence generator
Adding a Sequence Generator
You can add a new sequence generator to the list of available sequence generators.
To add a new sequence generator:
- From the Sequence Generators list, click the New Generator button
- The Manage Sequence Generator form displays.
- The Manage Sequence Generator form displays.
- Enter a name for the sequence generator in the Name of Generator text box
- Enter the desired format for the sequence generator in the Format String text box.
- Enter the Format String using the format "AAA{#:D#}" (e.g., DOC{0:D3}), where:
- AAA is a unique alphabetic string, such as an abbreviation of the sequence generator name
- # is the starting value for the sequence, and
- D# is the number of digits in the ID
- Enter the Format String using the format "AAA{#:D#}" (e.g., DOC{0:D3}), where:
- Select the starting number for the sequence from the Seed value menu
- Enter the desired value, or use the buttons to increment the Seed value up or down by one unit.
- The default Seed value is 1
- When all necessary information has been entered, click the Save button to save the sequence generator
The Manage Sequence Generator form closes, and the Sequence Generator list refreshes to display the new sequence generator
NOTE
- If you omit a value for the Name of Generator or Format String, an advisory message displays, and the missing field is highlighted in red. Enter the required information, then click the Save button to save the sequence generator
- Once the sequence generator reaches the the maximum limit mentioned by the string, it will automatically generate the next number based on the sequence
Editing a Sequence Generator
You can edit an existing sequence generator in the Sequence Generators list.
To edit a sequence generator:
- Locate the sequence generator you wish to edit in the Sequence Generators list.
- Click the Actions Button and select "Edit" for the desired sequence generator.
- The Manage Sequence Generator form displays.
- The form is pre-filled with the current values for the selected sequence generator.
- Edit the Name of Generator, Format String and/or Seed Value, as desired.
- When all desired values have been edited, click the Save button to save your changes.
- The Manage Sequence Generator form closes, and the Sequence Generators list refreshes to display your changes.
Deleting a Sequence Generator
You can delete an existing sequence generator from the Sequence Generators list.
To delete a sequence generator:
- Locate the sequence generator you wish to delete in the Sequence Generators list.
- Click the Actions drop down and select "Delete."
- A confirmation dialog displays the message "Are you sure you want to remove selected generator?"
- A confirmation dialog displays the message "Are you sure you want to remove selected generator?"
- Click the OK button to delete the selected sequence generator
- The confirmation dialog closes, and the selected sequence generator is removed from the Sequence Generators list
Applying a Sequence Generator to a Workflow
Sequence Generators are built in Business Designer> Sequence Generator but distributed to a workflow within the workflow in question.
To apply a sequence generator to a workflow:
1. Navigate to Designer>Workflow>Options>Sequence Generator
- If you want to replace the "Workflow Name" as it appears in the dashboard with your custom Sequence Generator ID, select "Use ID as Workflow Name." This is what most customers do
- If you want to have a sequence ID associated with your workflow transactions in addition to the "Workflow Nam" as it appears in the dashboard, select "Add ID to Dashboard"
-
If the workflow has a sequence generator assigned to it then it can be added to notifications or thank you page