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_*, inboundMSG_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_*, incomingMSG_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 |
|---|---|---|
| String | Sets a custom application property in a Response AMQP. |
| 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 |
| String | Sets the format of Message ID and Correlation ID in an AMQP response. Values: |
| String | Contains the value of the received application property |
| 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). |
For more information, see:
Inbound: AMQP (Input agent)
Outbound: Response AMQP
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 |
|---|---|---|
| String | Only relevant for AMQP 0.9.1. See Response AMQP (legacy). |
| String | Only relevant for AMQP 0.9.1. See section AMQP (Input agent). |
| String | With these variables, message properties (for JMS and AMQP) can be set in a Response AMQP/JMS. |
| 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 |
| String | Sets the JMS message header NOTE: This variable only works with the AMQP connections (legacy). |
| String | Sets the JMS message header NOTE: This variable only works with the AMQP connections (legacy). |
| String | Sets the JMS message header NOTE: This variable only works with the AMQP connections (legacy). |
| String | Sets the JMS message header NOTE: This variable only works with the JMS connection method. |
| String | Sets the JMS message header NOTE: This variable only works with the AMQP connections (legacy). |
| String | Sets the JMS message header NOTE: This variable only works with the JMS connection method. |
| 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. |
| String | Sets the body type in the Response AMQP/JMS. Allowed values: |
| String | For AMQP connections (legacy) of version 1.0 (and only there), the message header |
| String | (Deprecated). It can be used to set the corresponding JMS message header |
| String | (Deprecated). It can be used to set the corresponding JMS message header |
| String | (Deprecated). It can be used to set the corresponding JMS message header |
For more information, see:
Inbound: AMQP/JMS (Input agent)
Outbound: Response AMQP (legacy)
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 |
|---|---|---|
| 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! |
| 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. |
| Boolean | If the variable is set to true, a tombstone record is sent (this can be used to delete records prematurely in certain topics). |
| String | Applies to MQTT version 5. Allows passing user properties (Key, Value) in a Response MQTT. |
| String | Applies to MQTT version 5. Allows setting the (optional) content type in a Response MQTT, for example plain/text. |
| 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. |
| 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(). |
| 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(). |
| 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(). |
| 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(). |
| 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(). |
| 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(). |
| 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(). |
| 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:
See also call SOAP-WebService without template(). |
| String | Name of part n + 1. See HTTP (Input agent) (→ Multipart). |
| String | Content of part n + 1. See HTTP (Input agent) (→ Multipart). |
| Integer | Number of parts. See HTTP (Input agent) (→ Multipart). |
| 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). |
| 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). |
| 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). |
| 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). |
| 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. |
| String | Contains the value of the path parameter defined in the event based input agent HTTP (→ see API variables). See also HTTP (Input agent). |
| 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. |
| 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 |
| String | Only relevant in connection with the Workflow module (see there). |
| String | Only relevant in connection with the Workflow module (see there). |
| 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(). |
| 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(). |
| 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(). |
| String | The non-empty content of this variable is interpreted as the ID of an own certificates in partner management. See Certificates and HTTP. |
| String | See the features serialize map/list() and deserialize map/list(). |
| String | Error message in case of error. |
| String | Original file name. If no file name is available, the variable is assigned one of the following values:
See also |
| String | Original file name without file extension. Example: Contains the value test for original file name test.txt. See also |
| String | File extension of the original file name. Example: Contains the value txt for original file name test.txt. See also |
| Integer | Number of bytes of the input data. NOTE: When testing a profile, the variable is assigned the value 0. |
| Boolean | Is false during a test run. See also |
| 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 |
| 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 |
| 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. |
| 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: |
| String | Is populated with the name of the profile. |
| String | Is populated with the version of the profile. |
| 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. |
| 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). |
| 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(). |
| 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. |
| 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 NOTE:
See also Forms (DataCockpit) and Workflow overview. |
| String | Is populated with the path of the current archive entry (if it is located in a subfolder of the received archive). |
| String | Is populated with the name (without a path) of a received archive file (e.g. MyZip.zip). |
| 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. |
| String | MIME type of received AS2 message. |
| 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. |
| 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 |
| 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(). |
| String | Name of a partner Channel. See also the description of the variable See also Channels. |
| 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 See also Channels. |
| String | Name of the currently selected tenant. |
| String | This variable accumulates the content of the variable |
| 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 |
| 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 |
| 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. |
| String | The variable contains the number of the current data sheet in the event of an error in Phase 3, otherwise always 0. |
| 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/). |
| Boolean | See the section Semantic check. |
| String | List of all Excel table names, separated by \n. See Excel |
| 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 |
| 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). |
| 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. |
| Boolean | The variable has the value true if an error occurred in Phase 3 for at least one data sheet. |
| Boolean | The variable has the value true if an SQL error occurred during processing of at least one data record in Phase 4. |
| Boolean | The variable has the value true if this is the last file of an archive (e.g. a zip file). |
| 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. |
| Integer | The variable is assigned the number of processed lines of input files of CSV, Excel, IDoc, and Fixed Length type. |
| String | With active archiving of e-mails and X.400 mails, the variable is populated with the path of the archived mail file. |
| Integer | Number of attachments of an (X.400) mail. |
| 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) |
| 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 |
| String | If the system variable |
| 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:
|
| String | Relevant information for the data sheet whose processing caused an error is collected in this variable. |
| 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 NOTE: The variable must be explicitly defined. |
| String | Contains the MTS identifier of X.400 messages. |
| String | OFTP file counter. See OFTP (Input agent). |
| 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). |
| String | The variable is populated with the target address of the OFTP message. This may differ from the recipient of the message. |
| 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). |
| String | Name of a partner channel. See the description of the variable |
| String | Used internally when calling sub profiles in the target structure. See Profile in target structure (sub profile). |
| 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). |
| Boolean | The variable has the value true if the current job was started by restarting a faulty job. |
| 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. |
| String | See Semantic check. |
| String | See Semantic check. |
| 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(). |
| 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. |
| 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 |
| 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 |
| Integer | The feature dump validation data () stores the number of errors (errors) in this variable. |
| 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) |