Listen
Translate
Settings
This section cover settings regarding Product, Credential Vault, Email Notifications, Client Configuration, Version Control, Audit Logs, etc.
Audit log: Change Credential Vault configuration mode
- Audience & purpose
-
As an Product Administrator you want to see when "Credential Vault" mode was changed from "Express" to "Manual" and by whom. This will:
- Record point-in-time data of Credential Vault settings from its creation to deletion.
- Help understand what changed in the Credential Vault settings and by whom.
Changing settings and modes
Use the following guidelines regarding Credential Vault configuration and mode change.
- The breadcrumb trail will show "Audit log" → "View action".
- In the "Audit Log" page, an Audit entry will be logged when:
- A Credential Vault mode is changed by a Product Admin on the "Product Settings" page.
- In both of the above cases, the following entry will be logged. See the following data table.
Status Time Action Object name Action taken by Device Source Successful <date/time> Edit settings Credential Vault Master Key <username> <device> Product Note: If an error occurs during the "Edit" operation, the "Status" value of the Audit entry will be set to "Unsuccessful". - Select an Audit entry and click "View action".
- The "Details" page of the Audit entry will be displayed.
- For the "Edit" settings user actions, the Details page will show whether the action was "Successful" or "Unsuccessful". See the following screenshot.
- If the action was unsuccessful, it will also display the exact error message in the "Results" frame. See the following screenshot.
- The entire Audit log page will be read-only. Users can only act on the page-level toolbar.
- The lower half of the page will show details of the "Credential settings object" when the action was performed.
- It will not show data of the date when this page is being accessed, unless there was absolutely no change in the user object.
- For "Edit settings" actions, the lower-half of the page will display a data table with fields for "Old" and "New" values.
- It will only display the fields that are modified. See the following data table.
What changed? Old value New value Credential configuration mode Express Manual - Click the "Back" button to return to the previous page.
Security
Only authorized users will be allowed to view ALL the Audit entries and their details.
Audit log: Details page of Client configuration settings
- Audience & purpose
-
As an Automation Administrator you want to see the details of Client Application configuration settings on a particular day, and track changes to Client Application Configuration settings. This will:
- Record point-in-time data of Client Application configuration settings from its creation to deletion.
- Help to understand all that has changed in Client Application configuration settings and by whom.
Functional aspects
Use the following guidelines regarding Client configuration settings.
- The breadcrumb trail will show "Audit log" → "View action"
- The "Action details" group box contains:
- Status = Successful/Unsuccessful.
- Item name = Client Application configuration settings.
- Action taken by = <username>.
- Start time = N/A
- Object type = Action
- Action type = Edit settings
- Time = <update date and time>
- The "Settings details" group box contains:
- Whatever is in the "View" mode.
- Click the "Back" button to return to the previous page.
- The system will show the Successful / Unsuccessful type of details pages as shown in the following screenshots.
Successful Client configuration settings update:
Unsuccessful Client configuration settings update:
- The entire Audit log entry will be Read-Only. Users can only act on the page-level toolbar.
- The lower-half of the page will show details of the user object when the action was performed. It will not show data of the date when this page is being accessed, unless there was absolutely no change in the user object.
- For an "Unsuccessful" action of the edit settings, the lower half of the page shows the entries made by the user, even if the entries are incorrect.
Security
This page will not be accessible to unauthorized users.
Audit log: Details page of Email settings
- Audience & purpose
-
As an Automation Administrator you want to see the details of email settings on a particular day and track changes to those email settings. This will:
- Record point-in-time data of email settings since its creation till deletion.
- Help understand all changes made in email settings and by whom.
Functional aspects
Use the following guidelines regarding the details of email settings.
- The breadcrumb trail will show the Audit log → View action page.
- The "Action details" group box contains:
- Status = Successful/Unsuccessful.
- Item name = Email notification settings.
- Action taken by = <username>
- Start time = N/A
- Object type = Action
- Action type = Edit settings
- Time = <update date and time>
- The "Settings details" group box contains:
- Whatever is in the "View" mode, except:
- As title, show path: Email → Notifications.
- The "last updated" and "updated by" fields.
- Click the "Back" button to return to the previous page.
- The system will show the Successful / Unsuccessful type of Details pages, as shown in the following screenshots.
Successful settings update:
Unsuccessful settings update:
- The entire Audit log entry will be read-only. Users can only act on the page-level toolbar.
- The lower-half of the page will show details of the user object when the action was performed.
- It will not show data of the date when this page is being accessed unless there was absolutely no change in the user object.
- For an "unsuccessful" action of edit settings, the lower-half of the page shows the entries made by user even if the entries are incorrect.
Security
This page will not be accessible to unauthorized users.
Audit log: Details page of VCS Settings
- Audience & purpose
-
As an Automation Administrator you want to see the details of "Version Control" settings on a particular day and to track the changes to VCS settings. This will:
- Record point-in-time data of the VCS settings from its creation to deletion.
- Help understand what has changed in the VCS Settings and by whom.
Functional aspects
Use the following guidelines regarding the details of VCS settings.
- The breadcrumb trail will show the "Audit log" → "View action" page.
- The "Action details" group box contains:
- Status = Successful/Unsuccessful.
- Item name = Client application configuration settings.
- Action taken by = <username>
- Start time = N/A
- Object type = Action
- Action type = Edit settings
- Time = <update date and time>
- The "Settings details" group box contains:
- Whatever is in the "View" mode.
- Clicking the "Back" button will return the user back to the page they came from.
- The system will show the successful / unsuccessful type of Details pages, as shown in the following screenshots.
Successful settings update:
Unsuccessful settings update:
- The entire Audit log entry will be read-only. Users can only act on the page-level toolbar.
- The lower-half of the page will show details of the user object when the action was performed.
- It will not show data of the date when this page is being accessed unless there was absolutely no change in the user object.
- For an "Unsuccessful" action of edit settings, the lower half of the page shows the entries made by user even if the entries are incorrect.
Security
This page will not be accessible to unauthorized users.
Client configuration
- Audience & purpose
-
As an Automation Admin, you want to ensure that application images are not captured when we are automating our application. It:
- Allows enabling/disabling of secure recording.
- Users can customize the Product Help-related URLs.
Secure recording
Use the following guidelines regarding Secure Recording.
- Users will be allowed to enable or disable Secure Recording.
- When Secure Recording is enabled, application images and control values will not be captured anywhere using Task Automation (commands such as Object Cloning, IR, etc.).
- By default, Secure Recording will be disabled.
- When Secure Recording mode is on, Client-side behavior will not change.
- When a user changes the Secure Recording mode, the corresponding entry will appear in the Audit Trail. For example:
- Action: "Client Setting"
- Description: "Secure Recording Enabled/Disabled"
- When the "Secure Recording" is enabled in the Product, new security settings will immediately (with an acceptable buffer of 3 to 4 seconds) be applied without user having to re-login or restart the Product Client.
- When the "Secure Recording" mode is on, the Client-side behavior will not change.
Help URLs
Use the following guidelines regarding Help URLs.
- The user will be allowed to redirect Product Help URLs to his/her organization's custom URLs.
- The following URLs are allowed to be redirected:
- 1. "Live Chat with Support"
- Mouseover: This will be accessed when the user:
- Clicks "Chat" (if licensed).
- Clicks "Talk to an Expert" (shown on the Task runtime error dialog).
- 2. "Examples Online"
- Mouseover: Accessed when the user clicks "Help → Examples online" in the Product Client.
- 3. "Request live 1-on-1 Demo"
- Mouseover: Accessed when the user clicks "Help → Request live 1-on-1 demo" in the Product Client.
- 4. "Technical Support"
- Mouseover: Accessed when the user clicks "Help → Technical Support" in the Product Client.
- 5. "Ask the Expert"
- Mouseover: Accessed when the user clicks "Help → Ask the Expert" in the Product Client.
- Users must be mandated to enter the customizable URL in following format: http://www.example.com
- Users will not be allowed to save the customized URLs unless they are in above format.
- It will not be mandatory for users to customize all of the preceding five URLs. Users will be allowed to customize just one URL.
- Whatever URLs are not customized by a user, those URLs will direct to their default Product URLs.
- When users change Help URLs, the corresponding entries will appear in the Audit trail table.
- If a user disables the Custom URL field, the previously entered URL will not be visible.
Note: Product Settings will only be available to Admin roles. Other users will not be able to see the Administration → Settings option.
Product configurations (distributed)
- Audience & purpose
-
As an Automation Product Admin, you want to save your centralized automation data from a server local machine to a shared drive. This enables:
- Flexibility to change the Product repository path to a network D drive.
- Users to use any port which is opened in their firewall.
Configure a repository path
Use the following guidelines to configure a repository path.
- You will be shown the default repository path with an option to edit it.
- You will be allowed to enter Network Drive folders while also choosing the Repository Path.
- The system will append "Product Server Files" to the repository path if this folder already exists at the new path given by the you.
- Note: If you just enter a path up to "Product Server Files", then it will not be appended.
- If an "Product Server Files" folder does not exist, then the system will not allow an update of the repository path.
- The system will show an error message if the folder structure given for the new repository path is not valid.
- The following error message will be shown.
Unable to update the repository path to <new path>. New repository path is not a valid file path. Try again with a valid file path.
- When you save the changes to the Product configurations, the system will validate the repository path.
- If the repository path is not reachable, the user will not be allowed to save the changes.
- The following error message will be shown if the repository path is not correct.
Unable to connect to Repository Path <entered path>. Please check your path configuration.
- After changing the repository path, all the Product-related operations (such as Upload, Download, Deploy, VCS related operations) will continue to work seamlessly.
- Audit trail entries
The following entries will be saved in the Audit trail regarding an update of the repository path.
- Status: Successful
- Action: Update Configuration.
- Description: Repository path updated from <old repository path> to <new repository path>.
- Status: Unsuccessful
- Action: Update configuration.
- Description: Unable to connect to repository path <entered path>. Please check your path configuration.
- Status: Unsuccessful
- Action: Update configuration.
- Description: Unable to change the current repository path since it is mapped to server path <entered path> for Version Control.
Configure a client service port
Use the following guidelines to help configure a client service port.
- You will be shown the default client service port with an option to edit it.
- The default client service port will follow from what you selected at the time of the Product installation.
- You will be able to update the client service port.
- The minimum value of the port will be 1.
- Port validation messages:
- Port must not be blank.
- Port must be a number.
- Port cannot contain decimals.
- Port number must be between 1 and 65535.
- Audit trail entries
The following entries will be saved in the Audit trail regarding an update of the client service port:
- Status: Successful
- Action: Update configuration
- Description: Client Service Port updated from <old port> to <new port>.
- Status: Unsuccessful
- Action: Update configuration
- Description: <New Port> is not accessible. Please enter a port which is accessible.
Product access URL
Use the following guidelines to help configure the Product access URL.
- The current Product URL will be shown as blank by default.
- You will be able to update the Product access URL.
- If the Load Balancer could not be connected, the following error message should be shown:
Load Balancer not reachable: Unable to connect to <full name: port>. Please check your Product connection.
- In case of any errors, the previous settings will be maintained.
- Audit trail entries
The following entries should be saved in the Audit trail regarding an update of the Product Access URL details:
- Status: Successful
- Action: Update configuration.
- Description: Load balancer updated from <old value> to <new value>.
- Status: Unsuccessful
- Action: Update configuration.
- Description: Unable to connect to load balancer "https://….". Please check your load balancer connection.
- While saving, the system will ask you for confirmation:
- Are you sure you want to update the Product configuration settings?
- If you say "Yes", the following toast message will be shown:
Product Configuration Settings updated successfully
- If you say "No", the system will go back to read-only mode with the old values.
Product configurations (standalone)
- Audience & purpose
-
As an Automation Product Admin, you want to save your centralized automation data from a local server machine to a shared drive.
- This gives you the flexibility to change the Product repository path to a network drive.
- You can use any port which is opened in your firewall.
Configure a repository path
Use the following guidelines to configure a repository path.
- You will be shown the default repository path with an option to edit it. See the following screenshot:
- The default repository path will follow from what you had selected at the time of the Product installation.
- You will be allowed to select network drive folders while also choosing a repository path.
- The system will append "Product Server Files" to the repository path if this folder already exists at the new path given by you.
- Note: If you enter a path just up to "Product Server Files", then it will not be appended.
- If the "Product Server Files" folder does not exist, then the system will not allow the update of the repository path.
- The system will show the following error message if the folder structure given for new repository path is not valid:
Unable to update the repository path to <new path>. New repository path is not a valid file path. Try again with a valid file path.
- When a user saves the changes to Product configurations, the system will validate the repository path.
- If the repository path is not reachable, the user will not be allowed to save the changes.
- The following error message will be shown if the repository path is not correct:
Unable to connect to Repository Path <entered path>. Please check your path configuration.
- After changing the repository path, all the Product-related operations (such as Upload, Download, Deploy, VCS related operations) will continue to work seamlessly.
Audit trail entries
The following entries should be saved in the Audit trail regarding the update of the repository path:
- Status: Successful
- Action: Update configuration.
- Description: Repository path updated from <old repository path> to <new repository path>.
- Status: Unsuccessful
- Action: Update configuration.
- Description: Unable to connect to repository path <entered path>. Please check your path configuration.
- Status: Unsuccessful
- Action: Update configuration.
- Description: Unable to change the current repository path since it is mapped to server path <entered path> for Version Control.
.
Configure client service port
Use the following guidelines to configure the client service port.
- You will be shown the default client service port with an option to edit it. See the following screenshot:
- The default client service port will follow what you selected at the time of the Product installation.
- You will be able to update the client service port.
- Port validation messages:
- Port must not be blank.
- Port must be a number.
- Port cannot contain decimals.
- Port number must be between 1 and 65535
- Minimum value of a port can be 1.
Audit trail entries
The following entries will be saved in the Audit trail regarding the update of the client service port:
- Status: Successful
- Action: Update configuration.
- Description: Client service port updated from <old port> to <new port>.
- Status: Unsuccessful
- Action: Update configuration.
- Description: <New port> is not accessible. Please enter a port which is accessible.
- While saving, the system will ask you for confirmation:
- Are you sure you want to update the Product configuration settings?
- If you select "Yes", the following toast message will be shown:
Product configuration settings updated successfully.
- If you select "No", the system will go back to read-only mode with the old values.
Credential Vault configuration
- Audience & purpose
-
As an Automation Product Administrator, you want to switch your Credential Vault from Express mode to Manual mode. This will:
- Provide flexibility to change the Credential Vault mode.
- You can install Product in any mode and are allowed to change it later from this place.
Product settings
Use the following guidelines to configure Credential Vault.
- You will be allowed to change the Credential Vault configuration from Express mode to Manual mode and vice versa.
- Switching from Express to Manual mode:
- When you switch from Express mode to Manual mode or vice versa, the system will ask for the "Master Key" of the Credential Vault.
- When you enter the Master Key and save the changes, the system will check if the Master Key entered is valid or not.
- You will not be allowed to save the changes if the Master Key entered is not valid.
- Note: In case of failure, an error message will come from the Credential Vault module.
- If the master key entered is valid and when saving the changes, you will not be logged out of Product. The following toast message will be shown:
Credential Vault Configuration Updated successfully
- You will be allowed to switch back to Express mode, even after he has switched to Manual mode.
Audit log
Use the following guidelines to effect the Manual mode and Express mode switches.
- Manual mode → Express mode switch:
- Action: Configure Credential Vault.
- Mode: Express (to be shown in the Audit details page).
- Action: Connect to Credential Vault.
- Mode: Express (to be shown in audit details page).
- Express mode → Manual mode switch:
- Action: Configure Credential Vault.
- Mode: Manual (to be shown audit details page).
- Action: Connect to Credential Vault.
- Mode: Express (to be shown in audit details page).
Email notifications
- Audience & purpose
-
As an Automation Admin, you want to be notified every time the "Bank Account Reconciliation" automation fails. It enables:
- Email alerts for important events.
- Taking prompt action.
Managing email notifications
Use the following guidelines to manage email notifications.
- You will be able to:
- Configure an email notification only when at least one mail server is configured for the Product.
- Enable or disable an email notification every time a user account is updated in Product (information such as firstname, lastname, role, etc.).
- Enable or disable an email notification every time any user is activated or deactivated.
- Enable or disable an email notification showing task execution status (aborted, failed, timeout, and unknown status. Note: In version 10.3, notifications were available only for aborted and failed statuses.
- Enable or disable email notification for ALM Export and Import.
- When you change any of the email notification settings, the following entries will fall in Audit logs as in:
- Email settings enabled/disabled.
- Other Product features will be able to use these settings.
- When no email notifications are selected, show a message in read only view, per the attached UI (No notification view).
Email service to send mail
- Audience & purpose
-
As a Product Admin you want to notify users about executed activities:
- Provide a service to send email based on different Email Notification types.
- Based on the email notification type, a template will be fetched and the email will be sent.
- Other modules are required to set the "Email notification" type and the data to parse the template.
Product Settings
- The email needs to be sent as per the
EmailNotificationTemplateType
.- The email content will be as expected in the template.
- The Email links work.
Mail server configuration
- Audience & purpose
- As an Product Administrator, you want to manage the way system-generated emails are sent.
Managing the mail server
Use the following guidelines to manage mail settings.
- You:
- Can "Turn on" or "Turn off" email configuration for a particular Product.
- Can configure the email server over Secure or Non-Secure mode.
- Can save their credentials to connect to the mail server.
- Credentials are saved in the Credential Vault.
- Can discard the changes they made in a particular attempt.
- The system will allow the "Save" action only if a valid connection is established with the SMTP server with the information entered by you.
- Upon disabling, previously entered information will not be lost. Upon re-enabling, the same information will be available for editing.
- For any change you want to make in the existing settings, you must be authenticated (for example, you must enter the SMTP password).
- The "Mail Settings" page will only be available to "Admin" users.
- SMTP:
- The minimum value of a port will be "1".
- If the SMTP server requires a "secure" connection and you have not chosen "secure" connection, the system will not save the settings.
- The following error message will be shown:
Configured SMTP server requires a secure connection. Please configure SMTP in "secure" mode and try again.
- If the SMTP server does not require a "secure" connection and you have chosen "secure" connection, the system will not allow the saving of settings.
- The following error message will be shown:
Configured SMTP server requires a non-secure connection. Please configure SMTP in "non-secure" mode and try again.
- When you create/update SMTP settings:
- You will see the following toast message:
Mail Server Settings Configured successfully
- You will be able to choose whether the SMTP server requires a secure connection. Only when SMTP server requires authentication will you be allowed to enter credentials.
- When the create/update was unsuccessful, show the error message about what went wrong.
- If SMTP configuration is done successfully, an email notification as shown in the following screenshot will be sent to the admin user's email address.
Audit log
Use the following Audit log information regarding email settings.
- 1. Enabling of email settings
- Status: Successful.
- Activity: Email settings.
- Description: Email settings enabled.
- 2. Disabling of email settings
- Status: Successful.
- Activity: Email settings.
- Description:Email settings disabled.
- 3. Updating an email setting
- Status: Successful.
- Activity:Email settings.
- Description: Email settings updated successfully.
- 4. Failure to update Email setting
- Status: Unsuccessful.
- Activity:Email settings.
- Description: Failed to connect to the server.
- 5. Failure to update email setting when port is invalid
- Status: Unsuccessful.
- Activity: Email settings.
- Description: Port is invalid.
- 6. Failure to update email setting when username or password is invalid
- Status: Unsuccessful.
- Activity: Email settings.
- Description: Username or password is invalid.
- 7. SMTP connectivity problem
- An Audit entry will be logged if SMTP connectivity fails and the validation email could not be sent to the user.
Validation Messages
Note the following validation messages.
- Port validation messages:
- Port must not be blank.
- Port must be a number.
- Port cannot contain decimals.
- Port number must be in between 1 and 65535.
- Validation error messages will be specific to the kind of error encountered (for example, as per the preceding Audit log descriptions).
- If you enter white space, alone, in a mandatory field, it will not enable the "Save" button.
- There will be no validation for emails in the "From" and "Username" fields.
Move Product Client-side settings to Product
- Audience & purpose
-
As an Automation Admin you want to govern Robot creator and Robot runner settings from Product. You want to decide:
- Default settings for the users.
- Which settings can be seen and changed from Product Clients.
Product Settings
All settings will be stored in the Product database.
- No setting will be stored locally on an Product Client machine.
- The following matrix will be available for each of the settings:
- Setting name
- Default Value (Editable)
- Modifiable by User (Y/N)
- You will be allowed to only see those settings which you can modify.
Password Policy for Non-AD Product: Product Settings
- Audience & purpose
-
For Product Admins, this enforces a strong password security policy in Non-AD Product environments.
- All the following options will ONLY be shown when Product is hosted in Non-AD mode.
- These options (the entire password policy panel) will be hidden for an AD (Active Directory) mode of installation.
Strong policy options
The Non-AD Product will have the following options for a strong password policy.
- 1. Minimum password length
- This will be enabled by default (for backward compatibility); this cannot be disabled.
- By default, the minimum password length is 8 characters.
- It can be any number between 8 and 64 characters.
- 2. Maximum password length
- This will be enabled by default (for backward compatibility); this cannot be disabled.
- By default, the minimum password length is 15 characters.
- It can be any number between 8 and 64 characters.
- The number cannot be less than the minimum password; however, it can be equal to minimum password.
- If you try to put in a number less than the minimum password length, you will get an error:
The maximum password length should not be less than the minimum password length.
- 3. Password mix
- By default, this policy will be disabled.
- If this policy is enabled, an Admin can choose to have a combination of at least one alphabet, number, capital/uppercase letter and/or special character.
- Special Characters allowed: See the Create Non-AD user topic.
- 4. Number of attempts to account lockout
- By default, this policy is disabled.
- If this policy is enabled, an Admin will get an option to provide the number of consecutive unsuccessful login attempts before the user's account is locked out.
- The attempts can be any number between 1 and 99 attempts.
- When the user's account is locked out, it is disabled in Product.
- Important notes:
- All of the above options will ONLY be shown when Product is hosted in Non-AD mode.
- The above options (the entire password policy panel) will be hidden for the AD mode of installation.
- What happens if the password policy is changed?
- See the Enforce password policy change topic.
Version control
- Audience & purpose
- As an Automation Product Admin, you want to configure "Version Control" for your Robots in a particular Product.
Configuring Version Control
Use the following guidelines to configure version control.
- You will be able to "Turn on" or "Turn off" version control for a particular Product.
- You will have an option to enable or disable the "Secure Connection" for the Version Control Repository.
- You will be shown a Read-Only path of the Product Repository from the VCS Settings page.
- You will not be able to configure three (3) levels of repository path names.
- For example, "/svn/WebProduct" will be allowed, but "/svn/WebProduct/Citi" will not be allowed.
- Note: For your guide, Visual server does not allow the creation of a repository at a 3rd level.
- A 3rd level given in a path is considered a subfolder of an existing repository.
- You will be able to test the connection to the VCS Repository.
- When you change any VCS related setting(s), the corresponding entries will fall in the Audit Trail.
Port validation messages
- A port must be a number.
- A port cannot contain decimals.
- A port number must be between 1 and 65535.
The Save button
The "Save" button will not be enabled if any mandatory field is not completed/filled in.
- When you click the "Save" button, the following will be shown:
- "Connecting to SVN Repository" before the SVN connection is successfully established (authentication).
- Once a connection is established, a progress message will be shown with following information:
- The number of files transferred vs the number left to be transferred.
- The size of the data transferred vs the size of the data left to be transferred.
- The time left to finish SVN syncing.
Robot syncing
You will be able to run the syncing of Robots in the background.
- When you start the syncing process, it will move them to the "Activity"" → "In Progress" page.
- While syncing is in progress, if you close the browser or logout, you will be able to re-login and see the syncing detail in the "Activity"" → "In Progress" page.
- During the syncing process, the system will not allow any upload operation by you. However, the "Download" and "Deploy" functions will continue to be allowed during syncing.