The Scenario Editor is one of the most commonly used component of Alaya Connector. It is a visual, drag-and-drop editor which allows users to create and edit scenarios.
Access this editor by navigating to Dashboard and click on the button Create a new scenario at the top right-hand corner. Click "Edit" to amend an existing scenario, or click on the icon for more details to the scenario. The below are the options available to you within the scenario editor.
- Scenario Schedule
- Setting Up a Route
- Adding/Removing a Module
- Run Once
- Schedule Settings
- Scenario Settings
- Explain Flow
- More options
- Exit Editing
- Scenario Name
The scenario schedule is represented by the clock icon. Click on it to schedule a scenario; users can decide when and how often the activated scenario is to be executed.
If this is the first time you are creating a module for your scenario, you will see an empty module, or a circle with a ➕ sign instead. Click on the empty module to search for the desired third-party app or service. Search through the selected app/service's list of modules and add the desired one to your scenario. Please note that as third-party apps and services may vary, modules cannot always be placed at the desired location. In some instances, modules can only be placed as a connector between other modules, or it can only be placed at the beginning or end of a scenario. Click on the module to see customizable settings such as rename, clone, add or delete module.
Setting Up a Route
Clicking on the gear icon ⚙️ to set up routes or settings accordingly.
Adding/Removing a Module
Right click on the module to add or remove it to/from the scenario.
Once a scenario is configured, users can run it by clicking the play icon ▶️. We recommend that users run your scenario at least to ensure that the desired results can be achieved. Users can then activate the scenario when test results come back as favourable. Refer to this article for more support on how to handle errors in the event that the scenario did not execute properly.
To deactivate the scenario, navigate to the Scenario toolbar, find your scenario and turn it OFF. Refer to this article for more information between active and inactive scenarios.
This setting allows you to select the interval to which your activated scenario should run. You can navigate to the scenario to review the schedule at the bottom of the page, or click on the gear icon ⚙️ to set it up accordingly.
This option allows you to save entered data in the scenario fields without executing the scenario. If you forget to click on "OK" and closed a dialog box by mistake, autosave will preserve all previous changes and display an asterisk * on top of the module to show that the changes are saved. Please note that this option only preserves your changes and not apply them. You can always click on "Cancel" to delete your last changes and revert to your previous configurations.
When you finish editing a scenario, click on "Save" to save the current scenario settings. You may also manually save your scenario during editing.
Access this option to adjust your advanced scenario settings. This option is typically for users with advanced and complexed modules and scenarios. More instructional articles will soon be available for this feature.
Click on the page icon to display or hide notes that have been added to modules in the scenario. Right click to add as many notes as you want and delete as needed.
Click the magic wand icon to adjust the overall visual layout of the modules in the scenario and see its content clearer. This option will be highly beneficial to users with complex modules.
Observe data flow by clicking on the airplane icon. We recommend doing this prior to executing your scenario.
Within your scenario, hover to the left side and click on "More" with the three dots to open the menu with the following options. For more information, please contact your account manager.
Allows users to save the scenario blueprint in the JSON format. This feature is available for paid plans only.
Allows users to load the scenario blueprint in the JSON format. This feature is available for paid plans only.
Allows users to restore a previous version of the scenario.
This section allows users further customize your scenario by providing more advanced features.
This section archives your most commonly used third-party apps or services. It will expand as you add more apps to your scenario. You can also click on the plus sign ➕ to add apps or services directly.
Click the left arrow icon next to the scenario name to close the editor and return to the previous page, where you can activate your scenario.
This option allows you to change the name of your scenario.
A log records every event that occurs during a single run of a scenario and records it for the scenario execution history. The log contains information about errors encountered during the execution of the scenario.