Please enable JavaScript to view this site.

The manual for the JobRouter developer

Navigation: System activities > Description of the .NET API for system activities

API methods and properties

Scroll Prev Top Next More

The following methods and properties can be used during the implementation of the execution logic in order to process data

Signature

Description

InputParameter GetInputParameter(

    string id, InputParameterKind kind

)

Returns an object of the InputParameter type.

OutputParameter GetOutputParameter(

    string id, OutputParameterKind kind

)

Returns an object of the OutputParameter type.

List<InputParameter> GetInputParameterList(

    string id

)

Returns a list of objects of the InputParameter type.

List<InputParameter> GetInputPosdataParameterList(

    string id

)

Returns a list of objects of the Posdata type.

List<OutputParameter> GetOutputParameterList(

    string id

)

Returns a list of objects of the OutputParameter type.

List<OutputParameter> GetOutputPosdataParameterList(

    string id

)

Returns a list of objects of the Posdata type.

object GetInputParameterValue(

    InputParameter inputParameter

)

Returns the value (or a list of values in case of a subtable) of an input parameter. Variables included in the parameter value will be already solved in the return value.

object GetInputParameterValue(

    string id, InputParameterKind kind

)

Returns the value (or a list of values in case of a subtable) of an input parameter. Variables included in the parameter value will be already solved in the return value.

This overloading of the method is useful for situations in which only the value and no parameter properties are needed.

string GetFullAttachmentPath(

    string relativeAttachmentPath

)

Returns the full path to a file of an attachment field.

void SetOutputParameterValue(

    OutputParameter outputParameter, object value

)

Sets the value of an output parameter. In case of an attachment field, the attachment will be generated.

void SetOutputParameterValue(

    string id, OutputParameterKind kind, object value

)

Sets the value of an output parameter. In case of an attachment field, the attachment will be generated.

This overloading of the method is useful for situations in which only the value and no parameter properties are needed.

void WriteNewSubtableRow(

    string subtableName,

    Dictionary<OutputParameter,

    object> items

)

Writes the output parameter values in a new row in a subtable..

string GetSystemSetting(string name)

 

Returns a JobRouter system setting that is stored in the database table JRSETTINGS.

string Function

Returns the ID of the selected function in the system activity.

string LicensedModuleName

The module name can be entered here, as it is written in the JobRouter license.

bool Simulation

Returns true if it is a simulated step, otherwise false.

string Processname

Returns the process name of the current step.

string Version

Returns the process version of the current step.

string Step

Returns the step number of the current step.

string ProcessId

Returns the process ID of the current step.

string WorkflowId

Returns the workflow ID of the current step.

string StepId

Returns the step ID of the current step.

int StepStatus

Sets or returns the step status of the current step (see The status model).

IJobRouterDbConnection DbConnection

Returns an object of the IJobRouterDbConnection type. This object can be used to execute SQL queries directly on the database (see Direct database access).

string ReplaceProcessMessages(

    string inputText, string language

)

Resolves all process messages within the inputText for the given language.

int GetTranslationStorageType()

Returns the translation storage type of the process.

Returns 0 if translations are stored at each element;

Returns 1 if translations are stored as process messages.

void SetResubmission(DateTime resubmissionDate)

Determines the resubmission date of the step. This date is saved after the system activity was performed. The next execution of this system activity will take place at this stored date.

void SetResubmission(string resubmissionTime, string resubmissionType)

Determines the resubmission date of the step. The parameter resubmissionType may contain the value s for second, m for minute, h for hour, or d for date.
The parameter resubmissionTime contains for the resubmissionType d the date in the form of a string, which has the format yyyy-MM-dd HH:mm:ss. Alternatively it can have JobRouter system format. The   resubmissionType s, m, or h contain resubmissionTime the number of units (second, minute, or hour).
The next execution of this system activity will take place at this date or after the given period of time.

Please note: The SetOutputParameterValue and WriteNewSubtableRow methods take into account the system-wide list of forbidden or allowed file extensions for the fields of type File.