Module - Information
Collection of activities to retrieve environment information
Activities
Get Username
| Technical Name |
Type |
Minimal Agent Version |
| getUserName |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Output Parameters:
| Name |
Type |
Description |
| userName |
string |
Retrieve the username. |
Get Computer Name
| Technical Name |
Type |
Minimal Agent Version |
| getComputerName |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Output Parameters:
| Name |
Type |
Description |
| computerName |
string |
Retrieve the computer name. |
Get Full Username
| Technical Name |
Type |
Minimal Agent Version |
| getFullUserName |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Output Parameters:
| Name |
Type |
Description |
| fullUsername |
string |
Retrieve the full username. |
Get Agent Version
| Technical Name |
Type |
Minimal Agent Version |
| getAgentVersion |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Output Parameters:
| Name |
Type |
Description |
| agentVersion |
string |
Retrieve the version of a Desktop Agent. |
Get platform: win32 / darwin / ..
| Technical Name |
Type |
Minimal Agent Version |
| getPlatform |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Output Parameters:
Get architecture: ia32 / x64 / arm / arm64 / mips / ..
| Technical Name |
Type |
Minimal Agent Version |
| getArchitecture |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Output Parameters:
Get Project Name
| Technical Name |
Type |
Minimal Agent Version |
| getProjectName |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Output Parameters:
| Name |
Type |
Description |
| projectName |
string |
Retrieve the project name. |
Get Project UID
| Technical Name |
Type |
Minimal Agent Version |
| getProjectUid |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Output Parameters:
| Name |
Type |
Description |
| projectUid |
string |
Retrieve the project UID. |
Get Project Version
| Technical Name |
Type |
Minimal Agent Version |
| getProjectVersion |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Output Parameters:
| Name |
Type |
Description |
| projectVersion |
string |
Retrieve the project version. |
Get Version
| Technical Name |
Type |
Minimal Agent Version |
| getVersion |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Input Parameters:
| Name |
Type |
Attributes |
Default |
Description |
| componentName |
string |
mandatory
|
|
Name of the component whose version you want to retrieve. |
Output Parameters:
| Name |
Type |
Description |
| componentVersion |
string |
Retrieve the component version. This activity can also be used to retrieve an array of all versions. |
Sample Code:
//Return the irpa_excel dependency's version const version = irpa_core.infos.getVersion('irpa_excel);
Sample Code:
//Return the project version const version = irpa_core.infos.getVersion('myProjectName');
Sample Code:
//Return the agent version const version = irpa_core.infos.getVersion('Agent');
Get Versions
| Technical Name |
Type |
Minimal Agent Version |
| getVersions |
synchronous
|
WIN-3.24, MAC-3.24, CLOUD-3.34
|
Output Parameters:
| Name |
Type |
Description |
| versionsArray |
Array.<irpa_core.versions> |
This activity returns an array containing all the versions of project components (project, agent, SDK dependencies, etc.). |
Sample Code:
//Return an array with all the versions related to the current project const versionsArray = irpa_core.infos.getVersions();
