Robot Auto Login
Latest Version | 1.0.0.0 |
Latest Release Date | 09.01.2024 |
By | Nirosh Srinivasalu |
Supports Automation Studio Versions | From 7.9 |
Description
Automation Package for retrieving the credentials from Automation Portal CCM and logging on to the Robotic workstations as scheduled or via invoker.
Summary of Contents
-
Several Workflows.
-
Couple of User Defined Functions.
Summary of Use
-
Import the Robot Auto Login Package.
-
Consume the "LogonToMyRobot" User Defined Function.
-
Add the required details like (Host, Port, Admin User, Admin Password etc.)
-
Verify the status using "GetRAClientStatus" User Defined Function.
Functions
After importing the package, this function is found under IMPORTED PACKAGES > ROBOTAUTOLOGIN.
Assets prefixed with '#donotuse' are not intended for end-use.
Function |
Description |
Parameters |
Return | |||
---|---|---|---|---|---|---|
Log on to my robot |
This function or workflow is designed to facilitate logging into a robotic system (robot) using various input fields to authenticate and configure settings. |
Text Parameter |
None | |||
Get Robotic Clients Status | This workflow is responsible for retrieving the current status of a robotic client, ensuring that the system is functioning properly, and providing real-time insights into the robot’s operational state. | Text Parameter | None |
Types
After importing the package, the type is found on the Variables and Types panel, under IMPORTED PACKAGES > ROBOTAUTOLOGIN.
Property |
Input Type |
Description |
---|---|---|
Host | Text |
The IP address or hostname of the robot's server. This specifies the location where the robot is hosted and where the login attempt will be made. |
Port | Text |
The communication port used to connect to the robot. This ensures that the connection is made via the correct network port for successful communication. |
Admin User | Text | The administrative username required for logging into the robot’s management system. This is necessary for accessing administrative privileges and controlling the robot. |
Admin Password | Text | The corresponding password associated with the Admin User. This is required to authenticate the administrative login and provide secure access to the robot. |
Robot | Text | The specific robot or instance to which you wish to connect. This field identifies which robot within the system should be targeted for the login. |
Email DL (Distribution List) | Text |
A list of email addresses or a distribution list that may be notified upon a successful or failed login attempt. This field ensures that the appropriate team members are informed of the connection status. |
Close RDP (Remote Desktop Protocol) | Boolean | A toggle or option that, when enabled, ensures that the RDP session closes after the login process is complete. This helps in maintaining system security by terminating unnecessary remote access once the robot is logged in. |
Step Timeout Limit | Number | The maximum time (seconds) RTClient can stay on a step. |