Documentation Index

Fetch the complete documentation index at: https://docs.lobstersoftware.com/llms.txt

Use this file to discover all available pages before exploring further.

System variables

Prev Next

System variables are variables provided by the system that supply values for processing within a Profile.

Scope/Lifetime: Live within the profile (and not in other profiles) during the profile run/test.

Most system variables are automatically populated with a value and – unlike profile variables – are already set starting from Phase 2, not just during Mapping. The prerequisite is that the system variable is defined in the profile. In new profiles, many, but not all, are already created by default. They are defined in the same place as profile variables.

NOTE:

When the Transport of profiles system variables are not transferred to the target system.

AMQP variables

AMQP implementation (1.0)

These variables belong to the AMQP implementation (1.0). There are two types of message properties:

  • Fixed properties (outbound AMQP_FIXED_PROPERTY_*, inbound MSG_CALL_AMQP_FIXED_PROPERTY_*): fixed, predefined properties that every message has, e.g. Message ID, Correlation ID, or Time to live.

  • Application properties (outgoing AMQP_APPLICATION_PROPERTY_*, incoming MSG_CALL_AMQP_APPLICATION_PROPERTY_*): freely selectable data encryption key; you determine the key and value yourself (case-sensitive). Referred to as "header" in the legacy implementation.

When receiving, all application properties are provided, but fixed properties only if set.

Variable name

Type

Contents

AMQP_APPLICATION_PROPERTY_<key>

String

Sets a custom application property in a Response AMQP. <key> is the key of the property (case-sensitive), the variable value is the value of the property.  

AMQP_FIXED_PROPERTY_CONTENT_TYPE

AMQP_FIXED_PROPERTY_SUBJECT

AMQP_FIXED_PROPERTY_GROUP_ID

AMQP_FIXED_PROPERTY_TTL

AMQP_FIXED_PROPERTY_MESSAGE_ID

AMQP_FIXED_PROPERTY_CORRELATION_ID

AMQP_FIXED_PROPERTY_BODY_TYPE

String

Set the respective predefined property (Content type, Subject, Group ID, Time to live, Message ID, Correlation ID, Body type) in a Response AMQP.

Body type: values data, sequence, value (default: value). If Message ID and Correlation ID are not set, they are automatically generated as a UUID – "Replication ID".

AMQP_SYS_MESSAGE_CORRELATION_ID_FORMAT

String

Sets the format of Message ID and Correlation ID in an AMQP response. Values: string, long, binary. If the variable is not set or contains a different value, Message ID and Correlation ID are generated as UUID – "Replication ID"; only with one of the three specified values is the corresponding format used. If only the type is set without specifying a Message ID or Correlation ID, the respective ID is automatically generated in the corresponding type.

MSG_CALL_AMQP_APPLICATION_PROPERTY_<key>

String

Contains the value of the received application property <key> in the Input agent AMQP. All application properties are collected.

MSG_CALL_AMQP_FIXED_PROPERTY_MESSAGE_ID

MSG_CALL_AMQP_FIXED_PROPERTY_CORRELATION_ID

MSG_CALL_AMQP_FIXED_PROPERTY_USER_ID

MSG_CALL_AMQP_FIXED_PROPERTY_TO

MSG_CALL_AMQP_FIXED_PROPERTY_SUBJECT

MSG_CALL_AMQP_FIXED_PROPERTY_REPLY_TO

MSG_CALL_AMQP_FIXED_PROPERTY_CONTENT_TYPE

MSG_CALL_AMQP_FIXED_PROPERTY_CONTENT_ENCODING

MSG_CALL_AMQP_FIXED_PROPERTY_ABSOLUTE_EXPIRY_TIME

MSG_CALL_AMQP_FIXED_PROPERTY_CREATION_TIME

MSG_CALL_AMQP_FIXED_PROPERTY_GROUP_ID

MSG_CALL_AMQP_FIXED_PROPERTY_GROUP_SEQUENCE

MSG_CALL_AMQP_FIXED_PROPERTY_REPLY_TO_GROUP_ID

String

Contains the respective predefined property of a received message in the AMQP input agent, if set (when the property is not set, no variable is created). MSG_CALL_AMQP_FIXED_PROPERTY_GROUP_SEQUENCE only if a group ID is present.

For more information, see:

AMQP legacy implementation (AMQP 1.0, AMQP 0.9.1, JMS)

These variables belong to the previous legacy implementation, which covers AMQP 1.0, AMQP 0.9.1, and JMS. It is not deprecated and exists in parallel with the new implementation.

Variable name

Type

Content

AMQP_091BASIC_CONTENT_TYPE

AMQP_091BASIC_CONTENT_ENCODING

AMQP_091BASIC_MESSAGE_ID

AMQP_091BASIC_TIMESTAMP

AMQP_091BASIC_EXPIRATION

AMQP_091BASIC_APP_ID

AMQP_091BASIC_USER_ID

AMQP_091BASIC_TYPE

AMQP_091BASIC_PRIORITY

AMQP_091BASIC_CORRELATION_ID

String

Only relevant for AMQP 0.9.1. See Response AMQP (legacy).

MSG_CALL_CONTENTTYPE_091BASIC

MSG_CALL_CONTENTENCODING_091BASIC

MSG_CALL_MESSAGEID

MSG_CALL_TIMESTAMP_091BASIC

MSG_CALL_EXPIRATION_091BASIC

MSG_CALL_APPID_091BASIC

MSG_CALL_USERID_091BASIC

MSG_CALL_TYPE_091BASIC

MSG_CALL_PRIORITY_091BASIC

MSG_CALL_CORRELATIONID

String

Only relevant for AMQP 0.9.1. See section AMQP (Input agent).

AMQP_<Name of the Message Property>

String

With these variables, message properties (for JMS and AMQP) can be set in a Response AMQP/JMS.

AMQP_JMS_TEXTMESSAGE

Boolean

By default, the Response AMQP/JMS passes data to the receiving network server as a byte message. To change this, since some servers cannot handle it, the variable AMQP_JMS_TEXTMESSAGE can be created in the profile with the value true; the data will then be passed as a text message. In addition, the encoding must be set to UTF-8 in the response.

AMQP_JMS_CORRELATIONID

String

Sets the JMS message header JMSCorrelationID.

NOTE:  This variable only works with the AMQP connections (legacy).

AMQP_JMS_EXPIRATION

String

Sets the JMS message header JMSExpiration.

NOTE: This variable only works with the AMQP connections (legacy).

AMQP_JMS_PRIORITY

String

Sets the JMS message header JMSPriority.

NOTE:  This variable only works with the AMQP connections (legacy).

AMQP_JMS_REPLYTO

String

Sets the JMS message header JMSReplyTo.

NOTE: This variable only works with the JMS connection method.

AMQP_TTL

String

Sets the JMS message header JMSTimeToLive.

NOTE: This variable only works with the AMQP connections (legacy).

AMQP_TYPE

String

Sets the JMS message header JMSType.

NOTE: This variable only works with the JMS connection method.

AMQP_<Name of the Message Header>

String

For AMQP connections (legacy) of version 1.0 (and only there), these variables can be used to set AMQP message headers in a Response AMQP/JMS.

AMQP_SYS_BodyType

String

Sets the body type in the Response AMQP/JMS. Allowed values: data, sequence, value. Default: value.

AMQP_SYS_ContentType

AMQP_ContentType

String

For AMQP connections (legacy) of version 1.0 (and only there), the message header ContentType is set with the value of the system variable AMQP_SYS_ContentType. The message property ContentType is set with the value of the system variable AMQP_ContentType. Example value: application/json

(JMS_JMSCorrelationID)

String

(Deprecated). It can be used to set the corresponding JMS message header JMSCorrelationID .

(JMS_JMSExpiration)

String

(Deprecated). It can be used to set the corresponding JMS message header JMSExpiration (timestamp in ms).

(JMS_JMSPriority)

String

(Deprecated). It can be used to set the corresponding JMS message header JMSPriority (0–9).

For more information, see:

Further system variables

The following system variables relate to other channels and features (Kafka, MQTT, HTTP) as well as general profile values.

Variable name

Type

Content

KAFKA_<keyname>

String

Allows passing header properties (Key, Value) in a response of the Kafka type and in the send Kafka message() feature.

NOTE:  Since only byte arrays can be specified as the value for a header property, UTF-8 is always used as the encoding!

KAFKA_PARTITION

Integer

If the variable is defined and has a value >=0, this is passed as the partition of the topic to be used in the response of the Kafka type.

KAFKA_TOMBSTONE

Boolean

If the variable is set to true, a tombstone record is sent (this can be used to delete records prematurely in certain topics).

MQTT_<keyname>

String

Applies to MQTT version 5. Allows passing user properties (Key, Value) in a Response MQTT.

MQTT_SYS_CONTENTTYPE

String

Applies to MQTT version 5. Allows setting the (optional) content type in a Response MQTT, for example plain/text.

MQTT_SYS_CORRELATIONDATA

String

Applies to MQTT version 5. Sets the correlation ID in a Response MQTT. This allows the assignment of requests and responses. For details, please refer to the documentation of your MQTT server.

MSG_CALL_<Name of the parameter in uppercase>

String

In Lobster Integration's role as HTTP server, this can be used to read HTTP request parameters. See also call SOAP-WebService without template().

MSG_CALL_HEADER_HTTP_<Name of the header in uppercase>

String

In Lobster Integration's role as HTTP server, this can be used to read HTTP request headers. See also call SOAP-WebService without template().

MSG_CALL_HEADER_HTTP_METHOD

String

In Lobster Integration's role as HTTP server, this can be used to read the method of the HTTP request (for example GET or POST). See also call SOAP-WebService without template().

MSG_CALL_HEADER_HTTP_PROTOCOL

String

In Lobster Integration's role as HTTP server, this can be used to read whether the request was sent via HTTP or HTTPS. See also call SOAP-WebService without template().

MSG_CALL_HEADER_HTTP_QUERY

String

In Lobster Integration's role as an HTTP(S) server, this variable is filled with the query parameters of the request. Example: Suppose the complete request is http://example.com/dw/Request/get_orders?from=20170101&to=20170630. The variable would then have the value from=20170101&to=20170630.

See also call SOAP-WebService without template().

MSG_CALL_HEADER_HTTP_REMOTE_HOST

String

In Lobster Integration's role as an HTTP(S) network server, this variable is filled with the client's address. See also call SOAP-WebService without template().

MSG_CALL_HEADER_HTTP_URI

String

In Lobster Integration's role as an HTTP(S) network server, this variable is filled with the sub-path after /dw/Request or /dw/Trigger of the called resource.

Example: Suppose the complete request is http://example.com/dw/Request/get_orders?from=20170101&to=20170630. The variable would then have the value get_orders.

See also call SOAP-WebService without template().

MSG_CALL_HTTP_AUTH_USER

String

In Lobster Integration's role as an HTTP(S) network server, this variable is filled with the username used if authentication has taken place. See also:

  • VAR_SYS_TRIGGER_HTTP_CHANNEL_ID

  • VAR_SYS_COMM_CHANNEL_ID

  • VAR_SYS_COMM_CHANNEL_TYPE

See also call SOAP-WebService without template().

MSG_CALL_HTTP_MULTIPARTn_NAME

String

Name of part n + 1. See HTTP (Input agent) (→ Multipart).

MSG_CALL_HTTP_MULTIPARTn_VALUE

String

Content of part n + 1. See HTTP (Input agent) (→ Multipart).

MSG_CALL_HTTP_MULTIPARTS

Integer

Number of parts. See HTTP (Input agent) (→ Multipart).

MSG_CALL_HTTP_PATH_DATA

String

The variable is filled when the option Treat as REST interface is used in the HTTP input agent. If, for example, the URL of the input agent is http://localhost/dw/Request/example, then for a request http://localhost/dw/Request/example/orders or http://localhost/dw/Request/example/invoice/test, the value orders or invoice/test would be stored in the variable.

See also HTTP (Input agent).

MSG_CALL_KAFKA_KEY

String

If this variable is created, then when a message is received in the input agent of the Kafka type, the key of the message is stored in this variable.

See also Kafka (Input agent).

MSG_CALL_MQTT_CONTENTTYPE

String

Applies to MQTT version 5. When using an input agent of type MQTT, contains the content type, for example plain/text. See also MQTT (Input agent).

MSG_CALL_MQTT_CORRELATIONDATA

String

Applies to MQTT version 5. When using an input agent of the MQTT type that contains the correlation ID, this allows the assignment of requests and responses. For details, please refer to the documentation of your MQTT server.

See also MQTT (Input agent).

MSG_CALL_REF_IDS

String

If this variable is created, it contains the Interchange Control References (ICR) of all EDIFACT documents merged with the Content inspection module.

Example: 339;338;337

See also Merger.

MSG_CALL_HTTP_REST_API_PATH_<Name of the path parameter>

String

Contains the value of the path parameter defined in the event based input agent HTTP (→ see API variables).

See also HTTP (Input agent).

MSG_CALL_var__ci_filename_to_use

(var__ci_filename_to_use)

String

If this variable is set, its value is used to overwrite the file name that is sent to CI (Content Inspection) in the classes ContentInspectionResponse, ContentInspectionResponseAsync, ContentInspectionResponseUTF8 and ContentInspectionResponseUTF8Async.

MSG_CALL_VAR_SYS_PORTAL_LANG

String

The variable (if created) contains the selected language of the DataCockpit. Language/Code: German: de English: en French: fr Italian: it Spanish: es Danish: da Dutch: nl

MSG_CALL_VAR_SYS_WF_ID

String

Only relevant in connection with the Workflow module (see there).

MSG_CALL_VAR_SYS_WF_LINK

String

Only relevant in connection with the Workflow module (see there).

MSG_CALL_VAR_HTTP_<Name of the header in uppercase>

String

In Lobster Integration's role as HTTP client, these variables can be used to read the HTTP response headers from the server's response. See also call SOAP-WebService without template().

MSG_CALL_VAR_HTTP_STATUS_CODE

Integer

In Lobster Integration's role as HTTP client, this variable is filled with the HTTP status code of the server's response. See also call SOAP-WebService without template().

MSG_CALL_VAR_HTTP_STATUS_LINE

String

In Lobster Integration's role as HTTP client, this variable is filled with the HTTP status line of the server's response. See also call SOAP-WebService without template().

VAR_AUTH_CERT_ID

String

The non-empty content of this variable is interpreted as the ID of an own certificates in partner management. See Certificates and HTTP.

VAR_AUTOSERIALIZE_DATA

String

See the features serialize map/list() and deserialize map/list().

VAR_ERROR

String

Error message in case of error.

VAR_FILENAME

String

Original file name. If no file name is available, the variable is assigned one of the following values:

  • db_query, if the scheduled input agent with data source DB is used in the profile.

  • The name of the class used, if the scheduled input agent with data source API is used in the profile.

  • unknown in all other cases.

See also VAR_FILENAME_PREFIX, VAR_FILENAME_SUFFIX and VAR_SYS_ATTACHMENT_NAME.

VAR_FILENAME_PREFIX

String

Original file name without file extension.

Example: Contains the value test for original file name test.txt. See also VAR_FILENAME, VAR_FILENAME_SUFFIX.

VAR_FILENAME_SUFFIX

String

File extension of the original file name.

Example: Contains the value txt for original file name test.txt. See also VAR_FILENAME, VAR_FILENAME_PREFIX.

VAR_FILESIZE

Integer

Number of bytes of the input data.

NOTE:  When testing a profile, the variable is assigned the value 0.

VAR_IS_NOT_TEST

Boolean

Is false during a test run. See also VAR_IS_TEST.

VAR_IS_TEST

Boolean

Is true during a test run. If it is a test run of the profile (rerun dialog, Upload file and checkbox is a test run), the variable is assigned the value true (this does not happen in the rerun dialog and the Start cron button). Otherwise, the variable has the value false.

NOTE:  The variable is also assigned the value true during the mapping test.

See also VAR_IS_NOT_TEST.

VAR_JOBNR

(MSG_CALL_VAR_JOBNR)

String

Current job number.

NOTE:  When testing a profile, the variable is assigned the value -1. In sub-profile calls using the functions call profile() and trigger profile(), the job number of the calling profile can be retrieved in the called profile using the system variable MSG_CALL_VAR_JOBNR.

VAR_MAILSUBJECT

String

Contains the content of the subject if the input data of the current job is an e-mail, an X.400 mail, or an AS2 message. In case of a rerun of an already completed profile, the variable can only be assigned the content of the subject if the checkbox Retain input information in the profile was already set during the first run of the profile (see General (Main settings)).

NOTE:  When testing a profile, the variable is not assigned a value.

VAR_ORIGINATOR_JOBNR

String

If data is delivered in an archive, each of the files unpacked from the archive is processed in its own job. In this case, the system variable contains the job number of the originating job in all subsequent jobs. If a profile with the time-controlled Mail input agent is triggered by another profile, the subsequent jobs also receive the job number of the originating job (that triggered it).

See also:

VAR_PROFILENAME

String

Is populated with the name of the profile.

VAR_PROFILE_VERSION

String

Is populated with the version of the profile.

VAR_RECORDS

Integer

The variable is filled with the number of data records. The variable can only be used if it is also mapped. If the data is only passed through by a profile without mapping, the variable has the value 0. See also Parsing.

VAR_RESPONSE_HTTP_HEADER_<Name of the response header>

String

In Lobster Integration's role as an HTTP(S) network server, these can be used to set HTTP response headers. See call SOAP-WebService without template() (see details for the respective variants).

VAR_RESPONSE_HTTP_HEADER_RESP_STATUS

String

In Lobster Integration's role as an HTTP(S) network server (see details for the respective variants), this can be used to set the HTTP response status. See also call SOAP-WebService without template().

VAR_RESPONSE_MAIL_HEADER_<Name of the mail header>

String

If the corresponding variables are assigned values, the corresponding mail headers are set with these values for a Response mail.

NOTE:  Case sensitivity is observed here. The e-mail header is therefore adopted exactly as written in the variable. You should adhere to the RFC notation of the header. If sending via ASM, these variables are forwarded to ASM and used there.

VAR_SENDER

String

Contains the sender of the input data if the input data of the current job is an e-mail, an X.400 mail, an (S)FTP(S), an OFTP, a fax, an AS2, or an SMS message. For form profiles, the variable is assigned the value WebMonitor:<Login-Name>. In running workflows, the variable contains the name of the Lobster Integration or DataCockpit user (prefix WebMonitor:) who started the workflow.

NOTE:

  • Before sending an error e-mail, the variable is re-evaluated.

  • In case of a rerun of an already completed profile, the variable can only be assigned to the sender if the checkbox Retain input information in the profile was already set during the first run of the profile.

  • When testing a profile, the variable contains no value. On a restart, the variable is assigned the username.

See also Forms (DataCockpit) and Workflow overview.

VAR_SYS_ARCHENTRY_PATH

String

Is populated with the path of the current archive entry (if it is located in a subfolder of the received archive).

VAR_SYS_ARCHIVE_NAME

String

Is populated with the name (without a path) of a received archive file (e.g. MyZip.zip).

VAR_SYS_ARCHIVE_ENTRY_n

String

The name of the file in an archive of the response with the position number n (in the list of responses) can be set using the system variable VAR_SYS_ARCHIVE_ENTRY_n. See also Content settings.

VAR_SYS_AS2_MIME_TYPE

String

MIME type of received AS2 message.

VAR_SYS_ASM_RESPONSE[1..n]

String

If one of these variables is assigned a value, the name of the ASM entry in the response is overwritten by the corresponding variable value for the respective response with the number [1..n]. Example: VAR_SYS_ASM_RESPONSE1 overwrites the ASM entry in response number 1 with the value of the variable.

See also ASM settings.

VAR_SYS_ATTACHMENT_NAME

String

If a scheduled input agent of type Mail (POP3, IMAP, X.400) or an event based input agent of type SMTP is used, the variable contains the "original name" of the attachment file. This is useful because the variable VAR_FILENAME would only return asdf.pdf for an attachment named test/asdf.pdf.

VAR_SYS_BACKUP

String

The variable is assigned the name of the backup file of the input data of the current job, for example Job_25995.

NOTE:  When testing a profile, the variable is assigned the value Job_-1.

See also the features get path of backup-file() and read env-file().

VAR_SYS_CHANNEL_NAME_RESPONSE[1..n]

String

Name of a partner Channel. See also the description of the variable VAR_SYS_CHANNEL_RESPONSE[1..n].

See also Channels.

VAR_SYS_CHANNEL_RESPONSE[1..n]

String

If the variable is assigned a value > 0, the ID of a set partner channel of the response [1..n] is overwritten by the content of the variable. This applies to all response types that can define a partner channel. See also find channel(a,b,[c,d]). If the variable has no value > 0, an attempt is made to determine a matching partner channel from the combination of the values of the variables VAR_SYS_CHANNEL_NAME_RESPONSE[1..n] and VAR_SYS_PARTNER_NAME_RESPONSE[1..n]. This only happens if these variables are assigned values (i.e., a partner or partner channel name). The partner channel is determined using a case-sensitive search. If no valid partner channel is found, the partner channel set in the response is used. See also VAR_SYS_TRIGGER_CHANNEL_ID.

See also Channels.

VAR_SYS_CLIENTNAME

String

Name of the currently selected tenant.

VAR_SYS_COLLECTED_MSGS

String

This variable accumulates the content of the variable VAR_SYS_MESSAGE for each faulty/skipped data record. See Checkbox "Continue with new record on SQL error".

VAR_SYS_COMM_CHANNEL_ID

BigInteger

If authentication took place in an input agent via a channel, you will find the ID of the channel here.

NOTE:  Does not apply to profiles with a scheduled input agent that were triggered via HTTP. See VAR_SYS_TRIGGER_HTTP_CHANNEL_ID and MSG_CALL_HTTP_AUTH_USER.

VAR_SYS_COMM_CHANNEL_TYPE

String

If authentication took place in an input agent via a channel, you will find the type of the channel here, for example the value HTTP.

NOTE:  Does not apply to profiles with a scheduled input agent that were triggered via HTTP.

See also MSG_CALL_HTTP_AUTH_USER.

VAR_SYS_CTRL_FILE

String

The variable is assigned the content of the control file during a data transfer via FTP. See FTP/FTPS/SFTP (cron input agent) for scheduled input agents.

VAR_SYS_CURRENT_RECORD

String

The variable contains the number of the current data sheet in the event of an error in Phase 3, otherwise always 0.

VAR_SYS_DMZ_ID

String

If defined, this contains, if applicable, the factory ID of the DMZ server (from ./etc/factory.xml) that received the message. This is helpful if several DMZ servers are present. It also lets you see whether the message came via DMZ or not. Does not apply to pure HTTP requests (/dw/Request/).

VAR_SYS_ENABLE_SEMANTIC_CHECK

Boolean

See the section Semantic check.

VAR_SYS_EXCEL_SHEET_NAMES

String

List of all Excel table names, separated by \n. See Excel

VAR_SYS_EXCEPTION

(MSG_CALL_VAR_SYS_EXCEPTION)

String

The variable contains the error message of the exception in case of an error. If an exception occurs during profile calls using the functions call profile() and trigger profile() because the MessageService is not reachable, the functions merely return false. The exception error message can be retrieved via the system variable MSG_CALL_VAR_SYS_EXCEPTION (if it is created). See also call SOAP-WebService()

VAR_SYS_EXCEPTION_STACKTRACE

String

This variable is filled if an error occurs in Phase 4 (SQL) or in the features call db procedure a, alias b,c,d,e,f, select-statement a [[param &1 is c], d,e, f,g,h,i,j], default k,l,m,n dbAlias is b, select into map(a,b,[param &1 equals c], d,e, f,g,h,i,j], delimiter k, map l,m,n,o,p).

VAR_SYS_FILE_PATH

String

For profiles with a scheduled input agent with the data source File, the variable is assigned the path of the read input file without the file name. The value of the variable corresponds to the entry in the Directory field of the configuration screen for the input agent.

VAR_SYS_HAS_INVALID_RECORD

Boolean

The variable has the value true if an error occurred in Phase 3 for at least one data sheet.

VAR_SYS_HAS_SQL_ERROR

Boolean

The variable has the value true if an SQL error occurred during processing of at least one data record in Phase 4.

VAR_SYS_LAST_IN_ARCHIVE

Boolean

The variable has the value true if this is the last file of an archive (e.g. a zip file).

VAR_SYS_LASTINBULK

Boolean

The variable has the value true if the file was the last file of an SSH, OFTP, or FTP transfer. The variable is only set if the checkbox Process data only on logout is set for the input agent in Phase 1. The module CI (Content Inspection) also sets this variable to true when the last file of a File compound is processed.

VAR_SYS_LINES

Integer

The variable is assigned the number of processed lines of input files of CSV, Excel, IDoc, and Fixed Length type.

VAR_SYS_MAIL_ARCHIVE

String

With active archiving of e-mails and X.400 mails, the variable is populated with the path of the archived mail file.

VAR_SYS_MAIL_ATTACHMENTS

Integer

Number of attachments of an (X.400) mail.

VAR_SYS_MAIL_BODY

String

The variable is assigned the mail body when receiving mail, if there is no profile with the active option Process message text (mail body). See also Mail (SMTP) (Input agent)

VAR_SYS_MAIL_HEADER_<Name of the mail header in uppercase>

String

The variable is set for the Mail (Imap/Pop3) and SMTP input agents. See Mail/X.400 (cron input agent) and Mail (SMTP) (Input agent).

NOTE:  Only capital letters may be used here. Example: The variable VAR_SYS_MAIL_HEADER_DATE receives the original string value of the mail header Date. From the mail header line Date: Wed, 6 Sep 2017 13:50:01 +0300, the variable content becomes Wed, 6 Sep 2017 13:50:01 +0300.

VAR_SYS_MAIL_HEADER_RECEIVED_ALLB64

String

If the system variable VAR_SYS_MAIL_HEADER_RECEIVED is used, it contains only the first "Received" mail header. To get all of them, use VAR_SYS_MAIL_HEADER_RECEIVED_ALLB64. This variable contains all Received mail headers, comma-separated and Base64-encoded.

VAR_SYS_MAIL_RECIPIENTS

String

The variable contains a list of recipients (and CCs, but not BCCs) if the input data of the current job is an e-mail or an X.400 mail. In case of a rerun of an already completed profile, the variable can only be assigned a value if the checkbox Retain input information in the profile was already set during the first run of the profile.

NOTE:

  • The variable must be explicitly defined. When testing a profile, the variable is not assigned a value.

  • Only the simple e-mail addresses are entered into the variable. If the full e-mail addresses are to be used, the Integration Server must be started with the startup option -Dhub.datawizard.fullMailAddress=true.

VAR_SYS_MESSAGE

String

Relevant information for the data sheet whose processing caused an error is collected in this variable.

VAR_SYS_MESSAGE_ID

String

This variable stores the message ID of a received e-mail, or one retrieved by a scheduled input agent with the data source Mail, an X.400 mail, an AS2 message, or an OFTP message. For an SAP ALE (Input agent), the variable contains the value <DOCNUM>@<TID>. For grouped IDocs, this is always the last received DOCNUM. For an event-driven HTTP (Input agent), the variable contains a UUID.

NOTE:  The variable must be explicitly defined.

VAR_SYS_MTS_ID

String

Contains the MTS identifier of X.400 messages.

VAR_SYS_OFTP_FILE_COUNTER

String

OFTP file counter. See OFTP (Input agent).

VAR_SYS_OFTP_ORIGINATOR

String

The variable is filled with the originator of the OFTP message. This may differ from the sender of the message. See also OFTP (Input agent).

VAR_SYS_OFTP_DESTINATION

String

The variable is populated with the target address of the OFTP message. This may differ from the recipient of the message.

VAR_SYS_OFTP_SFID

String

The variable is filled with the destination address of the OFTP message. This may differ from the recipient of the message. See also OFTP (Input agent).

VAR_SYS_PARTNER_NAME_RESPONSE[1..n]

String

Name of a partner channel. See the description of the variable VAR_SYS_CHANNEL_RESPONSE[1..n].

VAR_SYS_PROFILECALL_PATH

String

Used internally when calling sub profiles in the target structure. See Profile in target structure (sub profile).

VAR_SYS_RESPONSE_WORKFLOW_<Antwortwegs-Positionsnummer>Response position number<0>

String

These variables can be used to set the display name of workflows that are started with one of the classes WorkflowResponse or WorkflowResponseWithoutAttachment (see there). See also Variables (Workflows).

VAR_SYS_RESTART

Boolean

The variable has the value true if the current job was started by restarting a faulty job.

VAR_SYS_SAP_TID

String

For a response of theSAP ALE type, the variable (if defined) contains the TID used for sending (automatically generated). The TID can also be generated manually using the feature create-sap-tid(), in order to then assign it to the variable.

VAR_SYS_SEMANTIC_FORMAT

String

See Semantic check.

VAR_SYS_SEMANTIC_TYPE

String

See Semantic check.

VAR_SYS_SOAP_FAULT

String

Contains a web service error message. See parameter i in function call SOAP-WebService() and parameter g in the featurecall SOAP-WebService without template().

VAR_SYS_SYSTEM_TYPE

Integer

The value encodes the type of Lobster system (0 = Prod, 1 = Test, 2 = Standby, 3 = DMZ). See also select-statement a [[param &1 is c], d,e, f,g,h,i,j], default k,l,m,n dbAlias is b.

VAR_SYS_TRIGGER_CHANNEL_ID

or

MSG_CALL_VAR_SYS_TRIGGER_CHANNEL_ID

Integer

If > 0, the channel in a scheduled input agent is replaced by the channel with this ID. If the value is 0 or the variable is not defined, the channel stored in the input agent is used (or none if no channel is set). See also find channel(a,b,[c,d]). See also variables with Prefix MSG_CALL_ and the variables VAR_SYS_CHANNEL_RESPONSE[1..n].

VAR_SYS_TRIGGER_HTTP_CHANNEL_ID

String

In profiles with a scheduled input agent that was triggered via HTTP, this variable is filled with the ID of the channel if authentication took place via this channel. See also MSG_CALL_HTTP_AUTH_USER.

VAR_SYS_VALIDATION_ERRORS

Integer

The feature dump validation data () stores the number of errors (errors) in this variable.

VAR_TIMESTAMP

TimeStamp

Timestamp of the backup file or e-mail. If the checkbox Retain input information is not set, the timestamp of the backup file is used. On first execution, this is the start time of the job, but on rerun, the time of the original job. If the checkbox is set, when processing an e-mail or X.400 mail, the send time of the message is used. For data source File, the last modification of the file is used, and in all other cases, the start time of the original job. See also General (Main settings)