xBus

standard.conf
System Definitions

System definitions configure all necessary data for the interfaces, e.g. the names of definition files, names of data files, type of the message, etc. All entries in this section are system-specific and must be defined for each system. Each system gets a logical name, which is the section part of the configuration entry:

System_logical name of the system_Key = Value

Depending on their functionality, you can distinguish two types of the "System definitions":

  • standard - entries, which are required for each system.
  • specific - entries, required for specific protocols (eg. MQ Receiver) or data formats (eg. Record Types) only.

    The explanation of some protocols with the same properties are grouped together. These groups are:
     
    File Receiver   File Sender
    FileReceiver Text
    FileByteArrayListReceiver Object
    FileLineReaderReceiver Object
    FileStreamReceiver Object
    FileReceiverThread Text
    FileByteArrayListReceiverThread Object
    FileLineReaderReceiverThread Object
    FileStreamReceiverThread Object
     
    FileSender Text
    FileByteArrayListSender Object
    FileLineWriterSender Object
    FileStreamSender Object
    SimpleFileSender Text
     
    AS/400 Receiver   AS/400 Sender
    AS400FileReceiver Text
    AS400ByteArrayListReceiver Object
    AS400LineReaderReceiver Object
     
    AS400FileSender Text
    AS400ProgramSender Object
     
    HTTP Receiver   HTTP Sender
    HTTPReceiver Text
    HTTPStreamReceiver Object
     
    HTTPSender Text
    HTTPByteArrayListSender Object
    HTTPStreamSender Object
     
    Message Queue Receiver   Message Queue Sender
    MQReceiverThread Text
     
    MQSender Text
     
        SMTP Sender
       
    SMTPSender Text
     
        Socket Sender
       
    SocketSender Text
     
        Database Sender
       
    DatabaseSender Object
     
    Java Receiver   Java Sender
    JavaReceiver Object
     
    JavaSender Object
     
        Misc Sender
       
    PingSender Object
    ProgramSender Text

Note that for each system standard + specific parameters must be defined in the configuration file.

 
 Standard

system-specific    required

chapter section key example
System logical name of the system Message System_PartsOrderAutoline_Message=RecordTypeMessage

For the creation of the appropriate message object for the given source or destination.

Note that this the message object and the receiver/sender must support the same type or a suitable transformation must be defined as default for the involved messages or as individually declared for the concrete systems

source destination
System Message
AS400ByteArrayListReceiver RecordTypeMessage, ByteArrayListMessage
AS400LineReaderReceiver SimpleObjectMessage
FileByteArrayListReceiver RecordTypeMessage, ByteArrayListMessage
FileLineReaderReceiver SimpleObjectMessage
System Message
AS400FileSender ByteArrayListMessage, RecordTypeMessage
FileSender ByteArrayListMessage, RecordTypeMessage
FileLineWriterSender SimpleObjectMessage

 
 Journal

The following entries define, which activities for which systems will be written to the journal. An activity can be:

  • Receive - a message has been received and processed.
  • Send - a message has been send to a neighbor-system.
The parameters apply for all system declarations. But they are optional. When no entry is configured for an activity and a system, no journal is written for such an event.


system-specific    optional

chapter section key example
System logical name of the system Journal.Receive System_PartsOrderAutoline_Journal.Receive=true

Define this parameter with true, if an entry in the journal shall be written whenever data is received from this system.


 

system-specific    optional

chapter section key example
System logical name of the system Journal.Send System_PartsOrderWholesale_Journal.Send=true

Define this parameter with true, if an entry in the journal shall be written whenever data is sent to this system.

 
 Receiver Threads

system-specific    optional

chapter section key example
System logical name of the system Timeout System_StockCheckAutolineRequest_Timeout=15

You can define (but not have to) this parameter for each your FileReceiverService-processed interfaces if you want to specify its own timeout.

Note that this value is optional. If you do not configure a system-specific timeout, the global value will be used.

 
 Receiver

The following entries influence the call to a receiver. They apply to all receivers.


system-specific    required

chapter section key example
System logical name of the system Receiver System_PartsOrderAutoline_Receiver=FileReceiver

Use this parameter to define name of the receiver that will read data from your system. Possible values are:

  • FileReceiver
  • FileByteArrayListReceiver
  • FileLineReaderReceiver
  • FileStreamReceiver
  • FileReceiverThread
  • FileByteArrayListReceiverThread
  • FileLineReaderReceiverThread
  • FileStreamReceiverThread
  • AS400FileReceiver
  • AS400ByteArrayListReceiver
  • AS400LineReaderReceiver
  • HTTPReceiver
  • HTTPStreamReceiver
  • MQReceiverThread
  • JavaReceiver
For information on the different renders, please refer to the corresponding chapter Technical Functions.


system-specific    required

chapter section key example
System logical name of the system OnEmpty System_PartsOrderAutoline_OnEmpty=Error

The purpose of this parameter is to determine the action when an empty request (like content of an empty file) was encountered. You can specify three actions:

  • Error - throw an exception and report an error
  • Ignore - do not process the file but do not report an error
  • Process - process the empty file normally
In the Error case, the action specified under OnError is taken.
In the Ignore case, the action specified under FinalResolution for file receivers or FinalResolution for AS400 receivers is taken. Furthermore, the post processing is started.
In the Process case, the message processing determines the transaction closing action because it is just treated as any other data transfer.


global    optional

chapter section key example
System logical name of the system PreProcessor Base_ReceiverService_PreProcessor=FolderPreparator
Base ReceiverService PreProcessor1..n Base_ReceiverService_PreProcessor1=FolderPreparatorIn
Base_ReceiverService_PreProcessor2=FolderPreparatorOut

The configured pre-processor(s) is(are) executed directly when the receiver service is started.
Using the PreProcessor notation without index number allows declaring just one pre-processor. This possibility is still in after the extension to multiple pre-processors for compatibility reasons.


system-specific    optional

chapter section key example
System logical name of the system PostProcessor.System System_WarrantyClaimsDMS_PostProcessor.System=WarrantyClaimsCdCall

A post processor is executed after successful data transmission. Its execution is not within the xBus transaction control. Even if the post processor fails, the data transmission is treated as successful.
The PostProcessor.System parameter defines the sender system, which is used as post processor. The system itself is configured like al other destination systems.


system-specific    optional

chapter section key example
System logical name of the system PostProcessor.Modus System_WarrantyClaimsAutoline_PostProcessor.Modus=final

A post processor may be executed

  • for each single system, which was started after replacing the Variables Keyword: perSystem
  • once after the processing for all single systems
    Keyword: final


system-specific    optional

chapter section key example
System logical name of the system PostProcessor.Asynchronous System_WarrantyClaimsAutoline_PostProcessor.Asynchronous=true

Determines if a post processor is executed a asynchronous or a synchronous way. Values true and false.

 
 Sender

The following entries influence the call to a sender. They apply to all senders.


system-specific    required

chapter section key example
System logical name of the system Sender System_PartsOrderAutoline_Sender=FileSender

Use this parameter to define name of the sender that will write data to your system. Possible values are:

  • FileSender
  • FileByteArrayListSender
  • FileLineWriterSender
  • FileStreamSender
  • SimpleFileSender
  • AS400FileSender
  • AS400ProgramSender
  • HTTPSender
  • HTTPByteArrayListSender
  • HTTPStreamSender
  • MQSender
  • SMTPSender
  • SocketSender
  • DatabaseSender
  • JavaSender
  • PingSender
  • ProgramSender
For information on the different senders, please refer to the corresponding chapter Technical Functions.


system-specific    optional

chapter section key example
System logical name of the system Type System_WarrantyClaimsGISTransform_Type=XML

Each Sender has one of two general types. This type determines as default how the content of the message is accessed by the sender. Sometimes this way of accessing the message content is not convenient. By the above parameter the behavior is changed. It does not only allow the two sender types but the three message types. These form a superset to the sender types.


system-specific    optional

chapter section key example
System logical name of the system OnEmpty System_MiscInformationAutolineBuffered_OnEmpty=Ignore

The purpose of this parameter is to determine the action when empty data is send to the sender. You can specify two actions:

  • Ignore - do not process the empty data
  • Process - process the empty data normally (default)
If the parameter is not specified, the sender is called in case if empty data normally.

 
 
 File Receiver,   FileByteArrayListReceiver,   FileLineReaderReceiver,   FileStreamReceiver,
 FileReceiverThread,   FileByteArrayListReceiverThread,   ,FileLineReaderReceiverThread,
 FileStreamReceiverThread

system-specific    required

chapter section key example
System logical name of the system Filename System_PartsOrderAutoline_Filename=Autoline/common/Input/DEALERNUMBER_WILDCARD.xml

This parameter specifies the absolute path that represents a file in the file system to be read. Use a forward slash as the path separator.

File names may contain markers for additional address information.


system-specific    optional

chapter section key example
System logical name of the system MinAge System_PartsOrderDMS_MinAge=60

With this parameter set only files not modified in the specified time frame are processed. This mechanism may be used for synchronising read and write access on the file. The value is in seconds.


system-specific    optional

chapter section key example
System logical name of the system MaxAge System_PartsOrderDMS_MinAge=60

With this parameter set only files modified in the specified time frame are processed. This mechanism may be used for ignoring old files. The value is in seconds.


system-specific    required

chapter section key example
System logical name of the system FinalResolution System_PartsOrderAutoline_FinalResolution=Preserve

This parameter defines the resolved action with the file after it was read and the message was successfully send to the neighbor-systems. There are three operations you can specify:

  • Preserve - file is remained without modifications
  • Rename - file is renamed by addition of the actual date at the end of the name
  • Delete - file is deleted from the file system
Note that this action will only be processed when all transactions are committed. Otherwise no modifications of the original file are done.


system-specific    required

chapter section key example
System logical name of the system OnError System_PartsOrderAutoline_OnError=Preserve

As it was explained in Base definitions, in case of an error, the receiver automatically retries to process the message some defined times und in defined time intervals.

The purpose of this parameter is to determine the action with the file if the error is still appearing after all attempts and the file could not be processed. You can specify the following three actions:

  • Preserve - file is remained in the file system without modifications
  • Rename - file is renamed by addition of the actual date at the end of the name
  • Delete - file is deleted from the file system


system-specific    optional

chapter section key example
System logical name of the system Encoding System_PartsOrderAutoline_Encoding=ISO-8859-1

This parameter allows you to specify the character encoding of the file. A list of valid values can be found at the Internet Assigned Numbers Authority.

Note: If this optional parameter is not present, the default value from the server will be used.

 
 FileByteArrayListReceiver

system-specific    optional

chapter section key example
System logical name of the system RecordLineLength System_WarrantyClaimsAutoline_RecordLineLength=128

This parameter specifies the length of a record line in the interface file. Usually the record ends are identified by line breaks. But this method does not work if field values may contain line breaks. In this case byte array transmission is to chose and this parameter is to set to the length in terms of bytes. If the parameter is missing, record ends are identified by line breaks.

The parameter is only available for the FileByteArrayListReceiver. It can be used for interfaces with record transformation or byte array data transfer without transformation (Message=RecordTypeMessage or Message=ByteArrayListMessage). In other cases this entry is useless and it will be ignored.

Note that all record types in the interface file must have the same length. The receiver does not interpret the interface description. Setting the RecordLineLength parameter prevents from using the record completion.

 
 FileSender,   FileByteArrayListSender,   FileLineWriterSender

system-specific    required

chapter section key example
System logical name of the system Filename System_PartsOrderAutoline_Filename=/Autoline/DEALERNUMBER/kpod.txt

This parameter specifies the absolute path that represents a file in the file system to be write. Use a forward slash as the path separator.

File names may contain markers for additional address information.


system-specific    required

chapter section key example
System logical name of the system ConflictResolution System_PartsOrderAutoline_ConflictResolution=Append

This parameter defines the action if the file to be written is already existing. The following actions are available:

  • Append - append the new data to the existing file
  • Overwrite - overwrite existing file with the new data
  • Error - do not write but report an error
  • Rename - file is renamed by addition of the actual date at the end of the name
Note that this action will only be processed when all transactions are committed. Otherwise no modifications of the original file are done.


system-specific    optional

chapter section key example
System logical name of the system Encoding System_PartsOrderAutoline_Encoding=ISO-8859-1

This parameter allows you to specify the character encoding of the file. A list of valid values can be found at the Internet Assigned Numbers Authority.

Note: If this optional parameter is not present, the default value from the server will be used.

 
 HTTP Receiver

system-specific    optional

chapter section key example
System logical name of the system ForceSSL System_TechnicalCampaignsWholesale_ForceSSL=true

Set this parameter to true if clients must use an SSL-enabled secure connection. The parameter is optional in the sense that a missing value is interpreted as false.

 
 HTTP Sender

system-specific    required

chapter section key example
System logical name of the system URL System_TechnicalCampaignsWholesale_URL=http://intern.nonsense.com/b2baccess

Use this parameter to specify the URL to which the data shall be send. When the URL begins with https, a SSL-secured connection is used.


system-specific    required

chapter section key example
System logical name of the system Content-Type System_TechnicalCampaignsWholesale_Content-Type=text/xml

Use this parameter to specify content type for the HTTP header.


system-specific    required

chapter section key example
System logical name of the system URL System_TechnicalCampaignsWholesale_URL=http://intern.nonsense.com/b2baccess

Use this parameter to specify the URL to which the data shall be send. When the URL begins with https, a SSL-secured connection is used.


system-specific    required

chapter section key example
System logical name of the system URL System_TechnicalCampaignsWholesale_URL=http://intern.nonsense.com/b2baccess

Use this parameter to specify the URL to which the data shall be send. When the URL begins with https, a SSL-secured connection is used.


system-specific    required

chapter section key example
System logical name of the system URL System_TechnicalCampaignsWholesale_URL=http://intern.nonsense.com/b2baccess

Use this parameter to specify the URL to which the data shall be send. When the URL begins with https, a SSL-secured connection is used.

 MQ Receiver

system-specific    required

chapter section key example
System logical name of the system Queuename System_MQAdministration_Queuename=Administration

This parameter specifies the name of the message queue, from which data will be received.

 
 MQ Sender

system-specific    required

chapter section key example
System logical name of the system Queuename System_MQAdministration_Queuename=Administration

This parameter specifies the name of the message queue, to which data will be sent.

 
 SMTPSender

system-specific    required

chapter section key example
System logical name of the system Host System_ErrorMail_Host=mail.yyy.com

This parameter specifies the hostname of the SMTP server which will be used to transfer the mail.


system-specific    required

chapter section key example
System logical name of the system Subject System_ErrorMail_Subject=Unrecoverable error in xBus

With this parameter you can define the "Subject line" for the mail message.


system-specific    required

chapter section key example
System logical name of the system ToAddress1..n System_ErrorMail_ToAddress1=aaa@yyy.de
System_ErrorMail_ToAddress2=bbb@yyy.com

Use this parameter to define your list of mail addresses where the message will be sent to.

system-specific    required

chapter section key example
System logical name of the system FromAddress System_ErrorMail_FromAddress=xxx@yyy.com

This parameter specifies the mail address of the mail sender.

system-specific    optional

chapter section key example
System logical name of the system FromName System_ErrorMail_FromName=xBus Administration

Use this parameter if you want that also the name of the mail sender will be written on the "from" line.

system-specific    optional

chapter section key example
System logical name of the system User System_ErrorMail_User=user

This parameter specifies the user name that needed for authentication.

Note that this parameter is optional in the sense, that it is only necessary if the SMTP server requires an authentication. In other cases it will be ignored.


system-specific    optional

chapter section key example
System logical name of the system Password System_ErrorMail_Password=secret

This parameter specifies the password for user that needed for authentication. Both the user name and the password are only necessary if the SMTP server requires an authentication.

system-specific    optional

chapter section key example
System logical name of the system Encoding System_ErrorMail_Encoding=EUC-KR

This parameter allows you to specify the character encoding of the mail message. A list of valid values can be found at the Internet Assigned Numbers Authority.

Note: If this optional parameter is not present, the default value from the server will be used.

 
 AS400FileReceiver,   AS400ByteArrayListReceiver

system-specific    required

chapter section key example
System logical name of the system AS400 System_TechnicalCampaignsWholesale_AS400=ZK

To access a resource on an AS/400, the connection to this AS/400 must be configured explicitly. The chapter AS/400 Connection explains how to do this. Every connection to an AS/400 gets a name.

This parameter specifies the name of the used AS/400 connection.


system-specific    required

chapter section key example
System logical name of the system Filename System_TechnicalCampaignsWholesale_Filename=/QSYS.LIB/KCPG.FILE/KCPG.MBR

This parameter specifies the complete filename that represents an object in the QSYS library file system on the AS400 machine to be read. Use a forward slash as the path separator.

File names may contain markers for additional address information.

Note, that each part of the name should not be longer than 10 characters.


system-specific    required

section key example
System logical name of the system FinalResolution System_PartsOrderIMPHDL_FinalResolution=Preserve

This parameter defines the action with the object in the QSYS library file system after it was read and the message was successfully send to the neighbor-system. To specify the action, the following values can be used:

  • Preserve - to remain the integrated file system object without modifications
  • Delete - to delete the file and all of its members
  • DeleteFile - to delete the file and all of its members
  • DeleteMember - to delete just the member of the file
  • CallProgramm - to call a specific AS400 program (the name of this program must be defined with the parameter System_logical name of the system_AS400Program.Terminator)
  • Rename - to rename the member of the file
Note that this action will only be processed when all transactions are committed. Otherwise no modifications of the original file are done.


system-specific    required

chapter section key example
System logical name of the system OnError System_PartsOrderAutoline_OnError=Preserve

As it was explained in Base definitions, in case of an error, the receiver automatically retries to process the message some defined times und in defined time intervals.

The purpose of this parameter is to determine the action with the file in the QSYS library file system, if the error is still appearing after all attempts and the file could not be processed. You can specify the following three actions:

  • Preserve - file is remained in the file system without modifications
  • Rename - the member of the file is renamed by addition of the actual date at the end of the name
  • Delete - the member of the file is deleted


system-specific    optional

chapter section key example
System logical name of the system AS400Program.Terminator System_MiscInterfaceVLS_AS400Program.Terminator=
   /QSYS.LIB/KCC.LIB/VCLMSIC.PGM

This parameter specifies the absolute path to the AS400 program which will can be called after processing the data. It is only essential if the FinalResolution for your file object was defined with the value CallProgramm. In other cases this entry is useless and will be ignored.


system-specific    optional

chapter section key example
System logical name of the system ProgramTimeout System_StockCheckIMPHDL_ProgramTimeout=120

Meaningful only when FinalResolution=CallProgramm. The call of the program will be canceled, if it is not finished after the specified number of seconds. When this parameter is not specified, the timeout is infinite.


system-specific    required

chapter section key example
System logical name of the system OnEmpty System_PartsReceiptIMPHDL_OnEmpty=Error

The purpose of this parameter is to determine the action when an empty file was read. You can specify three actions:

  • Error - throw an exception and report an error
  • Ignore - do not process the file but do not report an error
  • Process - process the empty file normally


system-specific    optional

chapter section key example
System logical name of the system Encoding System_PartsOrderIMPHDL_Encoding=ISO-8859-1

This parameter allows you to specify the character encoding of the file. A list of valid values can be found at the Internet Assigned Numbers Authority.

Note: If this optional parameter is not present, the default value from the AS/400 will be used.

 
 AS400FileSender

system-specific    required

chapter section key example
System logical name of the system Sender System_WarrantyClaimsWholesale_Sender=AS400FileSender

Use this parameter to define name of the sender that will write to your system.

For information on the different senders, please refer to the corresponding chapter Technical Functions.


system-specific    required

chapter section key example
System logical name of the system AS400 System_TechnicalCampaignsWholesale_AS400=ZK

To access a resource on an AS/400, the connection to this AS/400 must be configured explicitly. The chapter AS/400 Connection explains how to do this. Every connection to an AS/400 gets a name.

This parameter specifies the name of the used AS/400 connection.


system-specific    required

chapter section key example
System logical name of the system Filename System_TechnicalCampaignsWholesale_Filename=/QSYS.LIB/KCPG.FILE/KCPG.MBR

This parameter specifies the complete filename that represents an object in the QSYS library file system on the AS400 machine to be read. Use a forward slash as the path separator.

File names may contain markers for additional address information.

Note, that each part of the name should not be longer than 10 characters.


system-specific    required

chapter section key example
System logical name of the system ConflictResolution System_PartsOrderAutoline_ConflictResolution=Append

This parameter defines the action if the file to be written is already existing in the QSYS library file system. The following actions are available:

  • Append - append the new data to the existing file
  • Overwrite - overwrite existing file with the new data
  • Error - do not write but report an error
  • Rename - file is renamed by addition of the actual date at the end of the name
Note that this action will only be processed when all transactions are committed. Otherwise no modifications of the original file are done.


system-specific    optional

chapter section key example
System logical name of the system Encoding System_PartsOrderAutoline_Encoding=ISO-8859-01

This parameter allows you to specify the character encoding of the file. A list of valid values can be found at the Internet Assigned Numbers Authority.

Note: If this optional parameter is not present, the default value from the AS/400 will be used.

 
 AS400ProgramSender

system-specific    required

chapter section key example
System logical name of the system AS400 System_StockCheckIMPHDL_AS400=ZK

To access a resource on an AS/400, the connection to this AS/400 must be configured explicitly. The chapter AS/400 Connection explains how to do this. Every connection to an AS/400 gets a name.

This parameter specifies the name of the used AS/400 connection.


system-specific    optional

chapter section key example
System logical name of the system ProgramTimeout System_StockCheckIMPHDL_ProgramTimeout=120

The call of the program will be canceled, if it is not finished after the specified number of seconds. When this parameter is not specified, the timeout is infinite.

 ByteArrayListMessage,   RecordTypeMessage

system-specific    required

chapter section key example
System logical name of the system DescriptionFile System_PartsOrderAutoline_DescriptionFile=PartsOrderAutoline.xml

This parameter specifies the name of the XML file wich describes your source interface data structure. This structure description is essential for parsing. Information about its structure are listed in the section XML interface file descriptions.

This parameter is intended for interfaces with record transformation and byte array data transfer without transformation. Thus, if you defined Message=RecordTypeMessage or Message=ByteArrayListMessage for your system, this parameter must be specified. In other cases it is useless and will be ignored.

Note that only the file name (without path) is expected. All XML interface descriptions are stored in the directory XBUS_HOME/etc/InterfaceDescriptions (where XBUS_HOME is the xBus home directory).

 
 RecordTypeMessage

system-specific    optional

chapter section key example
System logical name of the system LineCutting System_PartsOrderAutolineLineCutting=true

This parameter instructs the RecordTypeParser to fill up incomplete lines in the input data. This allows transmitting fewer data by omitting ending blanks in record lines.

The parameter is optional. The default value is false. This means that all records have to be complete.

The treatment of incomplete lines is available for string and byte array oriented parsing if the record ends are determined by line breaks. Setting the RecordLineLength parameter prevents from using the record completion.

 
 ByteArrayList

system-specific    optional

chapter section key example
System logical name of the system Platform System_CustomerSalesInfoGIS_Platform=Unix

This parameter specifies the platform to which data is send. When serialising ByteArrayLists to strings the linebreak of the target platform must be used. If the serialising is done on the target system itself, the information about the linebreak is optained from the machine settings. The parameter is only necessary if the serialisation is carried out on another system.

 
 ProgramSender

system-specific    required

chapter section key example
System logical name of the system ProgramName System_FolderPreparator_ProgramName=net

The name - may be including complete path - of the program to call.

system-specific    required

chapter section key example
System logical name of the system Parameter1..n System_FolderPreparator_Parameter1=use
System_FolderPreparator_Parameter2=P:

The parameters for the program call.

system-specific    required

chapter section key example
System logical name of the system ProcessInput1..n System_PartsPricesCdCall_ProcessInput1=$VARIABLE_CdCallSubmitPartCopyDel$ $VARIABLE_CdCallSnodeNZPart$ &fromdsn="$VARIABLE_AutolineDirDos$\\send\\GIS_shared\\Price_$WILDCARD$.txt" &todsn="$VARIABLE_NZcdDirDos$\\rec\\GIS_shared\\Price_$WILDCARD$.txt" ×tamp="$TIMESTAMP$";
System_PartsPricesCdCall_ProcessInput2=quit;

After the program was called input data may be piped into the program's process. The input data is specified line by line.

 Deleted Message Store

system-specific    optional

chapter section key example
System logical name of the system UseDeletedMessageStore Base_DeletedMessageStore_UseDeletedMessageStore=true

This entry has only an effect, when the global entry Base_DeletedMessageStore_Enabled doesn't exist or has been set to false. In this case setting this entry to true lets all deleted messages for this system be written into the Deleted Message Store.