Configuration
The Configuration tab in the AutomatR Orchestrator application is a crucial section that allows users to manage and organize configurations for their automation processes. Configurations are sets of predefined parameters or settings that can be applied to different automation tasks, facilitating flexibility and reusability in the automation workflow. Let's explore the details of each section and option available in the Configuration tab:
| Field | Description |
|---|---|
| Name | The Name section displays the names of the configurations created in the AutomatR Orchestrator. Each configuration is assigned a unique name that serves as an identifier. |
| Flow | The Flow section indicates the automation flow or process associated with each configuration. Configurations can be linked to specific automation processes to ensure that the appropriate settings are applied when running the automation. |
The Configuration tab in the AutomatR Orchestrator application offers a comprehensive platform for managing and organizing configurations. By providing features for editing, deleting, cloning, and searching configurations, users can efficiently customize settings for their automation processes, ensuring consistent and streamlined execution across various tasks. The Configuration tab plays a vital role in promoting reusability, enhancing efficiency, and maintaining consistency in automation processes within the Orchestrator environment.
Add configuration
Here's a brief step-by-step procedure to add a configuration in the AutomatR Orchestrator application:
Log in to the AutomatR Orchestrator application using valid credentials.
Once logged in, navigate to the Configuration section or tab where users can manage and create new configurations.
Look for an Add button to initiate the process of creating a new configuration.
Click on the Add button to proceed with adding a new configuration.
In the Add Configuration form, you will find the following options to enter configuration details:
Name: Provide a unique name for the configuration. This name will serve as an identifier for the configuration and must be distinct from other configurations in the Orchestrator.
Select a Flow: From the drop-down list, choose the automation flow or process that will be associated with this configuration. The selected flow will use the configuration's settings during execution.
In the Details section of the Add Configuration form, you can add specific configuration settings:
Type: Select the type of the configuration value. It can be either Text or SecureText. Text denotes a plain text value, while SecureText represents a sensitive value that will be encrypted and securely stored.
These configuration types determine how the configuration values are handled and stored within the Orchestrator environment. Let's look into more details about each configuration type:Type Description Text - The Text configuration type is used for storing plain text values, such as strings, numbers, or other non-sensitive data.
- When a configuration setting is designated as Text, the value entered for that configuration is stored in its original, human-readable form.
- Text configurations are typically used for storing parameters or settings that do not contain sensitive information, and their values can be openly displayed and accessed within the Orchestrator.
- Ex.: API keys, file paths, email addresses, or any non-confidential data that is required for the automation process.
SecureText - The SecureText configuration type is used for storing sensitive information that needs to be securely encrypted and protected.
- When a configuration setting is marked as SecureText, the value entered for that configuration is encrypted before being stored in the Orchestrator database.
- SecureText configurations are employed for safeguarding confidential data, such as passwords, access tokens, or any sensitive information that should not be directly visible within the Orchestrator.
- Unlike Text configurations, SecureText configurations display masked values (e.g., * * * * * * * * *) when viewed within the Orchestrator to prevent unauthorized access.
The choice between Text and SecureText configuration types in the Orchestrator application allows users to manage their configurations effectively. Text configurations are used for non-sensitive data, while SecureText configurations ensure that sensitive information is encrypted and protected. By appropriately assigning configuration types, users can enhance security, maintain data confidentiality, and ensure smooth execution of their automation processes.
Key: Enter the key name for the configuration setting. The key is used to identify and reference the value associated with this setting during the automation process.
Value: Provide the actual value for the configuration setting. The value will be utilized by the associated automation flow when executing the process.
Delete Option: If you need to remove a specific configuration detail, you can use the Delete option associated with each detail.
Before proceeding, review all the entered details in the Add Configuration form to ensure accuracy and completeness.
After confirming that the configuration details are correct, click on the Add button to create the new configuration. The Orchestrator will process the request and add the configuration to the configuration repository.
Once the configuration is successfully added, a confirmation message will appear, indicating that the configuration has been added to the Orchestrator. The new configuration will now be visible in the list of available configurations in the Configuration tab.
You have now successfully added a new configuration in the Orchestrator application by entering the Name, selecting a Flow from the drop-down list, and adding configuration details with options for Type, Key, and Value. The configuration is ready to be utilized by the associated automation flow during its execution, streamlining the process and ensuring the correct settings are applied for a smooth automation workflow.
Update configuration
The Actions column in the Configuration table provides options to interact with individual configurations and allows you to modify the settings or parameters of an existing configuration and update it as needed.
In the Actions column associated with the configuration, click on the Edit option.
Upon clicking Edit, a form will appear displaying the selected configuration information.
Enter the necessary details for updating the configuration:
Name: Update the name of the configuration.
Flow: From the drop-down list, choose the automation flow or process that you want to update and to associate with this configuration.
Type: Update the type of the configuration value.
Key: Update the key name for the configuration setting.
Value: Provide the actual value for the configuration setting.
Double-check the information you entered for accuracy, ensuring that the configuration name, flow and details are correct.
Once you are satisfied with the configuration information, click on the Update button to finalize the configuration update.
Upon successful addition, you will receive a confirmation message or notification stating that the configuration is updated. Navigate back to the Configuration tab and review the table to ensure that the updated configuration appears with the name and flow you provided.
Delete configuration
The Actions column in the Configuration tab provides options to interact with individual configuration, the Delete option from the Actions column of Configuration table allows you to remove the configuration from the AutomatR Orchestrator. Use this action for permanently removing the configuration from Orchestrator or when it is no longer required in your automation infrastructure.
Clone configuration
AutomatR Orchestrator's Configuration Tab allows users to clone the configuration, the Clone option under Actions allows users to duplicate an existing configuration. Cloning a configuration creates a new configuration with identical settings, which users can then modify as needed, saving time in configuration creation. Here's a step-by-step guide on how to clone the configuration:
Log in to AutomatR Orchestrator and navigate to the Configuration tab, which displays a list of configurations and their related details.
In the Configuration Tab, locate the specific configuration you want to clone from the Configuration table.
Find the Actions column associated with the configuration and click on the Clone option.
Clicking on the Clone option opens a form. Enter a unique name for the configuration. This name will serve as an identifier for the configuration and must be distinct from other configurations in the AutomatR Orchestrator.
After entering the name, click on the Clone button to initiate the cloning process.
The system will create a new configuration with the same configuration and settings as the original one.
Upon successful cloning, you will receive a confirmation message indicating that the configuration has been cloned.
The cloned configuration will now be available in the list of configurations, ready for execution. You can click on the Edit option of the specific configuration to update the configuration details further if required.
Cloning the configuration in the AutomatR Orchestrator Configuration Tab is a convenient feature that allows users to replicate automation processes quickly and efficiently. By following these steps, users can create copies of existing configurations, making it easier to rerun tasks with the same configuration and settings, ultimately streamlining the automation workflow.