Skip to Content

Environment Information Functions

Environment information functions provide information about the agent, environment, and operation that the script is running in.

GetAgentGroupID

Declaration

int GetAgentGroupID()

Syntax

GetAgentGroupID()

Description

Returns the ID of the agent group that the operation or expression is currently running in.

Examples

GetAgentGroupID();
// Returns an integer ID

GetAgentGroupName

Declaration

string GetAgentGroupName()

Syntax

GetAgentGroupName()

Description

Returns the name of the agent group that the operation or expression is currently running in.

Examples

GetAgentGroupName();
// Returns "Jitterbit Production Cloud Agent Group"

GetAgentID

Declaration

int GetAgentId()

Syntax

GetAgentId()

Description

Returns the ID of the agent that is running the operation or expression.

Examples

GetAgentID();
// Returns an integer ID

GetAgentName

Declaration

string GetAgentName()

Syntax

GetAgentName()

Description

Returns the name of the agent that the operation or expression is currently running in.

Examples

GetAgentName();
// Returns "Jitterbit Cloud Agent 2_1_1"

GetAgentVersionID

Declaration

int GetAgentVersionID()

Syntax

GetAgentVersionID()

Description

Returns the version ID of the agent that the operation or expression is currently running in.

Examples

GetAgentVersionID();
// Returns 80160000000015 (depending on the current agent version)

GetAgentVersionName

Declaration

string GetAgentVersionName()

Syntax

GetAgentVersionName()

Description

Returns the version name of the agent that the operation or expression is currently running in.

Examples

GetAgentVersionName();
// Returns "8.16.0.15" (depending on the current agent version)

GetEnvironmentID

Declaration

int GetEnvironmentID()

Syntax

GetEnvironmentID()

Description

Returns the ID of the environment that the operation or expression is currently running in.

Examples

GetEnvironmentID();
// Returns an integer ID

GetEnvironmentName

Declaration

string GetEnvironmentName()

Syntax

GetEnvironmentName()

Description

Returns the name of the environment that the operation or expression is currently running in.

Example

GetEnvironmentName();
// Returns a string with the environment name

GetOrganizationID

Declaration

int GetOrganizationID()

Syntax

GetOrganizationID()

Description

Returns the ID of the organization that the operation or expression is currently running in.

Examples

GetOrganizationId();
// Returns an integer ID

GetOrganizationName

Declaration

string GetOrganizationName()

Syntax

GetOrganizationName()

Description

Returns the name of the organization that the operation or expression is currently running in.

Examples

GetOrganizationName();
// Returns a string with the name of the organization