Administration
(Available from version 7.0 onwards.)
The Administration built-in service provides both events and functions.
The Administration events allow you to condition workflows and create event handlers based on events related to the Real-Time Client.
The Administration functions allow you to automate the management of automation solutions at the client, for example, to download new solutions or to remove a solution.
Video Demonstration
For a video demonstration of how many of the functions in the Administration built-in service work, see below.
Events
RT-Client Shutting Down
Fires an event as soon as the system detects that the Real-Time Client is about to shut down.
Example
The event handler below will show Callout - 1 if the system detects that the Real-Time Client is about to shut down.
Solution Loaded
Fires an event when the automation solution is loaded by the Real-Time Client.
You can create an event handler based on this event to perform actions as soon as the solution is loaded, for example, to start a workflow or show a callout.
Example
The event handler below will start Workflow - 1 as soon as the solution is loaded.
Functions
Archive Log Files
Archives all log files that are located in the specified directory.
Parameters
|
Parameter |
Input Type |
Description |
|---|---|---|
|
directory |
text |
The directory that stores the log files to be archived |
Returns
Nothing
Download New Solutions
Downloads new solutions assigned to the user's team from the SVN and stores them locally.
Parameters
This function does not have any parameters.
Returns
Returns Boolean value of True if solutions were downloaded successfully.
Download New Solutions Asynchronous
Downloads new solutions assigned to the user's team from the SVN asynchronously and stores them locally. Optionally updates recent solutions.
Parameters
|
Parameter |
Input Type |
Description |
|---|---|---|
|
Update recent solutions |
Boolean |
Indicate whether to update recent solutions (True) or not (False) |
Returns
Nothing
Download Solutions
Downloads the specified solutions from the repository. The latest version of each specified solution assigned to the user's team will be downloaded.
Parameters
|
Parameter |
Input Type |
Description |
|---|---|---|
|
solutions |
List of text |
A list of the names of the solutions to download |
Returns
Returns a Boolean value of True if solutions were downloaded successfully.
Get Names of Running Solutions
Retrieves a list of the names of all solutions that are currently running.
Parameters
This function does not have any parameters.
Returns
Returns a text list
Load New Solutions
Downloads new solutions assigned to the user's team from the SVN, stores them locally, and loads them into memory to start using them.
Parameters
This function does not have any parameters.
Returns
Returns a Boolean value of True if solutions were downloaded successfully.
Load Solution
Loads the specified solution into memory to start using it. If a new version of the solution is available, it will be downloaded and then loaded.
Parameters
|
Parameter |
Input Type |
Description |
|---|---|---|
|
solution |
text |
The name of the solution to download |
Returns
Returns a Boolean value of True if successful.
Load Solution from Path
Loads a solution from a specified path.
Parameters
|
Parameter |
Input Type |
Description |
|---|---|---|
|
full path |
text |
The full path to the .xml file of the solution, including the file name and the .xml extension. |
Returns
Returns a Boolean value of True if successful.
Example
The action below loads a solution stored on the client's local drive.
New Solutions Available
Returns True if new solutions that have been assigned to the user's team are available on the SVN.
Parameters
This function does not have any parameters.
Returns
Returns a Boolean value of True if new solutions that have been assigned to the user's team are available on the SVN.
Remove Solution
Unloads a solution from memory to stop using it.
Parameters
|
Parameter |
Input Type |
Description |
|---|---|---|
|
solution |
text |
The name of the solution to remove |
Returns
Returns a Boolean value of True if successful.
Restart Real-Time Client
Restarts the Real-Time client application.
Parameters
This function does not have any parameters.
Returns
Nothing
Set Log Level for Logger
Sets the log level for a specified logger.
Parameters
|
Parameter |
Input Type |
Description |
|---|---|---|
|
logger name |
text |
The name of the logger |
| logger level | text | The name of the logger level to apply |
Returns
Nothing
Shut Down Real-Time Client
Shuts down the Real-Time client application.
Parameters
This function does not have any parameters.
Returns
Nothing
Write Text to Log
Writes a line of text to the Real-Time log.
Parameters
|
Parameter |
Input Type |
Description |
|---|---|---|
|
text |
text |
The text to write to the log |
Returns
Nothing
