Skip to content
View as markdown Ask ChatGPT Ask Claude

Create Automation Business Scenario#

🔒 AutomationBusinessScenario.Create

Overview#

This operation allows creating a new Automation Business Scenario in the system.

Sequence of Steps#

Step 1: General Data#

  1. Enter a unique Name.
  2. Provide a Description.
  3. Specify whether the scenario is Enabled. Enabled scenarios are available for selection in Cortex, subject to their scopes and conditions.
  4. Scopes will specify from where the scenario is available, for example if the user opens the chat from the page of <URL>/Entity/AutomationManager, the scenario will only be showed if it has a scope Entity/AutomationManager. The user can define multiple scopes, separated by a comma.
  5. The Condition Type (currently only JSONata is supported) and the Condition allow for further specification of when to show the scenario. For example, the user can specify that a scenario is to be shown in the scope 'AutomationController' but only if the Condition entityInstance.UniversalState = 0 is met. In this case the entity is in the state Created.
  6. Select Next to continue the operation.

Screenshot showing a form with fields for creating an automation business scenario, with "Next" button selected to continue.

Step 2: Metadata#

The metadata definition contained in the Automation Business Scenario will be displayed. This is shown as a text box with JSON-formatted content. The metadata field will inform all steps and actions declared in the business scenario.

Screenshot showing the "Create a UIOMANION Business Scenario" dialog box with fields for metadata entry.

Info

A Visual Studio Code extension for language formatting and for creating a visual rendering for Automation Business Scenarios is available at Automation Business Scenarios Renderer ↗.

Select Create to complete the operation.

Validation and Intellisense#

The Metadata editor validates the JSON content against the Automation Business Scenario schema as you type, providing inline markers, hover descriptions, and auto-completion (Ctrl+Space) for every property and allowed value.

For more information, see JSON Schema Validation in Editors.