Process functions
AbortProcess
Declaration
void AbortProcess(string message)
Description
Aborts a process immediately with a specific message.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
message
|
Message explaining why the process was aborted. |
Return Value
Does not return a value.
CV
Declaration
string CV(string configurationValue)
Description
Returns a configuration value having a certain name.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
configurationValue
|
Name of the configuration value to be returned. |
Return Value
The configuration value requested. Returns an empty string, if the configuration value does not exist.
CV
Declaration
string CV(string configurationValue, string defaultValue)
Description
Returns a configuration value having a certain name.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
configurationValue
|
Name of the configuration value to be returned. |
defaultValue
|
Default value to be returned, if the configuration value does not exist. |
Return Value
The configuration value requested. Returns defaultValue, if the configuration value does not exist.
ExecuteProcess
Declaration
int ExecuteProcess(string command, string arguments)
Description
Executes the specified command with the given arguments.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
The command to execute. |
arguments
|
The arguments for the command. |
Return Value
The exit code of the process.
ExecuteProcessAsynchronously
Declaration
int ExecuteProcessAsynchronously(string command, string arguments)
Description
Executes the specified command with the given arguments asynchronously.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
The command to execute. |
arguments
|
The arguments for the command. |
Return Value
The exit code of the process.
ExitProcess
Declaration
void ExitProcess(string message)
Description
Exits a process immediately with a specific message.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
message
|
Message explaining why the process was exited. |
Return Value
Does not return a value.
GetCurrentTenantName
Declaration
string GetCurrentTenantName()
Description
Returns the name of the current tenant.
Supported Runtime Versions
4.0, 5.0
Parameters
The function has no parameters.
Return Value
The name of the current tenant.
GetCurrentUserId
Declaration
string GetCurrentUserId()
Description
Returns the current user Id.
Supported Runtime Versions
4.0, 5.0
Parameters
The function has no parameters.
Return Value
The current user Id.
GetCurrentUserName
Declaration
string GetCurrentUserName()
Description
Returns the current user name.
Supported Runtime Versions
4.0, 5.0
Parameters
The function has no parameters.
Return Value
The current user name.
GetGlobalDataSourceConnectionString
Declaration
string GetGlobalDataSourceConnectionString(string name)
Description
Returns a global data source connection string identified by its name.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description |
|---|---|
name
|
Name of the global data source connections string to be returned. |
Return Value
The global data source connection string identified by name.
GetProcessCategory
Declaration
string GetProcessCategory()
Description
Returns the category of the current process as defined with the @Category tag.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
The category of the current process.
GetProcessDescription
Declaration
string GetProcessDescription()
Description
Returns the description of the current process as defined with the @Description tag.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
The description of the current process.
GetProcessMinVersion
Declaration
string GetProcessMinVersion()
Description
Returns the minimum version of the Application Engine that is required to run the current process.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
The minimum version of the Application Engine that is required to run the current process.
GetProcessParameterDescription
Declaration
string GetProcessParameterDescription(string parameterName)
Description
Returns the description of a certain parameter of the current process.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
parameterName
|
The name of the process parameter to return the description for. |
Return Value
The description of a certain parameter of the current process.
GetProcessParameterNames
Declaration
StringArray GetProcessParameterNames()
Description
Returns the names of all parameters of the current process.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
The names of all parameters of the current process.
GetProcessReturnValueDescription
Declaration
string GetProcessReturnValueDescription()
Description
Returns the description of the return value of the current process as defined with the @Returns tag.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
The description of the return value of the current process.
RaiseError
Declaration
void RaiseError(string message, int errorCode)
Description
Raises an error that can be handled in a try statement.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
message
|
A message describing the error's cause. |
errorCode
|
A code representing the error. |
Return Value
Does not return a value.
Sleep
Declaration
void Sleep(int milliseconds)
Description
Puts the current process to sleep for a certain number of milliseconds.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
milliseconds
|
Duration of the sleeping period measured in milliseconds. |
Return Value
Does not return a value.