Add FlowGenie in a Process

Add a FlowGenie to a Process

Permissions

Your user account or group membership must have the following permissions to configure a FlowGenie element in the Process model unless your user account has the Make this user a Super Admin setting selected:

• Processes: Edit Processes

• Processes: View Processes

See the Process permissions or ask your Administrator for assistance.

Add a FlowGenie object from one of the following locations in Process Modeler:

• Object Panel: Located to the left of the Process Modeler canvas, the Object Panel contains various process model objects.

• Object Bar: Located at the bottom of the Process Modeler canvas, the Object Bar contains pinned Process model objects, which are easy accessible.

Add from the Object panel

Follow these steps to add a FlowGenie from the Object panel to the Process model:

1. Ensure that the Object panel is visible. If not, click the Add icon from the Object bar at the bottom.
2. Click the FlowGenie object from one of the following sections:

   • Pinned Objects: The FlowGenie object appears in the Pinned Objects section when it is pinned.

   • Object Category: The FlowGenie object appears in the Object Category section when it is not pinned.
3. Click the location in the Process model to place this element. Follow these guidelines when placing this element:

   • Optionally place this element between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.

   • If a Pool element is in your Process model, the FlowGenie element cannot be placed outside of the Pool element.

Add from the Object bar

Follow these steps to add a FlowGenie object from the Object bar to the Process model:

1. Ensure that the object is pinned to the Object bar. If not, pin it.

2. In the Object bar at the bottom center, click the object's icon. This object's icon displays adjacent to the mouse icon to indicate this FlowGenie may be placed into the Process model.

3. Click the location in the Process model to place this object. Follow these guidelines when placing this element:

   • Optionally place this element between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.

   • If a Pool element is in your Process model, the FlowGenie element cannot be placed outside of the Pool element.

Add boundary events

After adding the Object Element, consider adding the following Boundary-type Process model elements to design business solutions when your best-case scenarios don't happen:

• Boundary Timer Event element

• Boundary Error Event element

• Boundary Signal Event element

• Boundary Conditional Event element

• Boundary Message Event element

• Move a Process Model Object.

• Connect Two Process Model Objects with a Sequence Flow Element.

• Customize the Appearance of a Process Model Object.

• Copy Process Model Objects into the Clipboard.

• Clone Process Model Objects Without the Clipboard.

• Delete Process Model Objects.

Configure a FlowGenie

Follow these steps to configure a FlowGenie:

1. Select the object from the Process Model, then click the Show Configuration button in the upper right corner of the Modeler to view the Configuration panel.
2. In the Genie Name setting, enter a name for this object.

3. In the Prompt setting, enter a prompt for the FlowGenie to use. Case data can be used in prompts through mustache syntax.
4. In the Variable Mapping section, configure the input and output setting for the FlowGenie.

5. In the Genie Input section, optionally select the Input File option to provide a file for the Genie to process.
6. In the Genie Output section, select a Response Format for the Genie's response. Choose from one of these options:

   • Text: Use this option to get the response as plain text.

   • JSON: Use this option to get the response formatted as a JSON object.

   • Table: Use this option to get the response formatted as an HTML table.

7. In the Output Variable Name setting, use mustache syntax to specify a request variable for storing the response returned by the Genie. This variable can then be referenced elsewhere in the process to utilize the Genie's response.
8. Click Preview to access the FlowGenie Studio. Here, you can test and preview the Genie's response, as well as adjust the configuration as necessary.

   

   The FlowGenie Studio

FlowGenie Studio

The FlowGenie Studio provides an interface to preview, test and adjust Genie configurations. Follow these steps to use the Studio:

1. In the Prompt setting, enter a new prompt or edit the current one.

2. From the Response Format setting, select one of the available formats.

   • Text: Use this option to get the response as plain text.

   • JSON: Use this option to get the response formatted as a JSON object.

   • Table: Use this option to get the response formatted as an HTML table.

3. In the Test Data setting, input data in JSON format for the Genie to utilize in executing the task outlined in the prompt.

   
4. Select the Include File settings to upload a file for processing, and use the Browse button to upload the file.

   
5. Click Run to test the FlowGenie. The response generated by the Genie will be displayed in the Response section.

   
6. Click Ok to save the FlowGenie configuration, otherwise click Cancel.