Page tree

Text parameter values consist of literal text, possibly mixed with references to variables and with escape sequences.

The following table lists these parameters. 

Gateway Configuration Parameter Text Values

Character

Name

\

Backslash

\s

Space

\n

New line

\r

Carriage return

\t

Tab

\0ddd

Character code in octal (0, 1, 2, or 3 digits d)

References to variables that are not followed by punctuation or space characters must be enclosed in curly brackets ( { } ). For example, $NAMEabc is invalid; ${NAME}abc is correct. Non-printable characters and hard spaces must be expressed with an escape sequence. String values for parameters are considered from the first non-white space character up to the first (non-escaped) white space character.

The following table lists the gateway.export file parameters.

gateway.export file parameters

 ParameterDescription
Communication parametersprotocol

Sets the communication protocol. Cell communication uses a proprietary, bidirectional protocol on top of TCP that expects acknowledgements for delivered messages. TCP communication is connection-oriented, which can cause problems for one-way transfer devices when the connection is broken at the destination side.

Making the connection ephemeral using EIF protocol allows the connection to be closed as soon as the event is transmitted.

Possible values for this parameter are:

  • MCELL—(Default) native cell communication protocol
  • EIF-EIF—Communication protocol with connection-oriented transport
  • EIFCL-EIF—Communication protocol with connectionless transport

When a gateway is configured withprotocol=EIFCL, the connection to that destination is disconnected after all pending events have been transmitted.Both categories, new event and modification, use the same protocol. The last one specified is used. The default value is MCELL.

Contents parameterscondSets the condition for a slot to be included in the$ALL variable. Use always to always include the slot. Use propagate to include the slot if its value is different from the default value for the slot and it is able to be parsed. The default value ispropagate for new, and always for mod.
dropLists slots that must be dropped from the $ALLand $MODS variable. List of comma separated slot names. Only real slot names can be used. The default value is [], so no slot is dropped.
addLists additional new slot definitions. List of comma separated settings in the formatslotname=slotvalueslotname represents the name for the new defined slot and slotvaluedefines the value of the new slot. The default value is [], so no slot is added.
slotsSets and orders the slot names to be included. Non-base class slots must be prefixed withClassName: . The list can also contain variable references to include those values among regular slots. 
The default value is [], so no slots are exported.
modifyLists slots whose modifications result in a message. Modifications of slots that are not included in this list are ignored. The default value is [], which means that every slot modification is included.
map.nameDefines the map table with the name name
List of comma separated settings in the formatoriginal_value=converted_value 
original_value represents a value that has to be replaced and converted_value is the replacement value. Both values must be literal values.
Format parametersinitText or value to be printed at the beginning of each export message. The default value is blank. At least one of the initbody, or term parameters must be specified to populate the export file.
bodyText or value to be printed for every slot to be included; can use the variable, $NAME (name of the slot) and $VALUE (value of the slot). The default value is blank. At least one of the init,body, or term parameters must be specified to populate the export file.
termText or value to be printed at the end of each event. The default value is blank. At least one of the initbody, or term parameters must be specified to populate the export file.
separatorSets the separator character or string to use between slot values. The default value is nothing.
quotableSets the characters leading to quotation when appearing in a slot value. If the parameter value is empty, slot values are never quoted. The default value is standard MRL quotation rules.
openquoteSets the opening quotation character to use for values that must be quoted. The default value is a single quote ().
closequoteSets the closing quotation character to use for values that must be quoted. The default value is a single quote ().
escapequoteDetermines how to escape a quotation mark inside a quoted value. The default value is a single quote ().