Submit an order as a technical user

A technical user is a machine configured to submit orders on behalf of a non-technical (human user) EBICS Client user using a back-end file system. The technical user is associated with a non-technical user.

To submit an order using a technical user, you must configure:
  • User as a technical subscriber
  • File system adapter or a similar technical adapter

The scenario illustrates using a file system adapter configured on Sterling B2B Integrator.

A technical user submits the orders by placing a compressed file that contains an XML file, ordermetadata.xml and optionally the payload data in a collection folder specified when configuring a file system adapter.

The following diagram illustrates the process flow when a technical user submits orders. The backend process generates the ordermetadata.xml, packages the payload metadata in a compressed format and places it in a directory so that a technical adapter, such as the file system adapter can pick up the file and send it to EBICS Client for processing the data. The EBICS Client Runtime components include the User Mailbox, OrderPreProcessor, EBICS Client Mailbox, and EBICS Runtime. The OrderPreProcessor extracts the contents of the compressed file and transfers the XML metadata to the EBICS Client Mailbox that in turn sends it to the EBICS Runtime component for processing the metadata. The OrderPreProcessor component sends the payload data to the mailbox of the EBICS Client user. Based on the values specified in the XML, EBICS Client sends the order request to the banking server.

Figure 1. Process flow of order submission by a technical user
The backend process generates the ordermetadata.xml, packages the payload metadata in a compressed format and places it in a directory so that a technical adapter, such as the file system adapter can pick up the file and send it to EBICS Client for processing the data. The EBICS Client Runtime components include the User Mailbox, OrderPreProcessor, EBICS Client Mailbox, and EBICS Runtime. The OrderPreProcessor extracts the contents of the XML file and transfers the metadata to the EBICS Client Mailbox that in turn sends it to the EBICS Runtime component for processing the metadata. The OrderPreProcessor components sends the payload data to the mailbox of the EBICS Client user. Based on the values specified in the XML, EBICS Client sends the order request to the banking server.
If the order type is FUL, the ordermetadata.xml contains the following details:
HostID
details of the bank involved in the transaction
UserID
non-technical user who wants to submit the FUL order
SystemID
technical user who is a delegate of the non-technical user
PartnerID
details of the partner associated with the user
OrderType
details of the order type and file format
Custom attributes
In Sterling B2B Integrator V5.2.6.1_2 and later, users can add custom attributes before submitting an EBICS order. These attributes are saved in the ordermetadata.xml file and then displayed in the UI of the order. To define custom attributes, use the <ebicsUserAttribute> tag in the ordermetadata.xml file.
The following example details the format of an XML if you are submitting an FUL order as a technical user.
<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' 
xsi:nonNamespaceSchemaLocation='new_omd.xsd'>
<HostID>TESTBNKPK12</HOSTID>
<PartnerID>PARTNERPK12</PartnerID>
<UserID>USERPK12</UserID>
<SystemID>TECHUSER</SystemID>
<orderIdPrefix>D</orderIdPrefix>
<SecurityMedium>0200</SecurityMedium>
<OrderType>FUL</OrderType>
<FileFormat>pain.001.001.02.ict</FileFormat>
<autoSubmit>TRUE</autoSubmit>
<ebicsUserAttribute value="123456" name="totalamount"/>
<ebicsUserAttribute value="AAA" name="accountid"/>
</orderMetaData>

If the order type is INI or HIA, the system ID and the user ID have the same value in the ordermetadata.xml file.

The following example illustrates the format of an XML if you are submitting an INI order as a technical user:
<?xml version="1.0" encoding="UTF-8"?>
<orderMetaData xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' 
xsi:nonNamespaceSchemaLocation='new_omd.xsd'>
<HostID>TESTBNKPK12</HOSTID>
<PartnerID>PARTNERPK12</PartnerID>
<UserID>TECHUSER</UserID>
<SystemID>TECHUSER</SystemID>
<orderIdPrefix>W</orderIdPrefix>
<SecurityMedium>0200</SecurityMedium>
<OrderType>INI</OrderType>
</orderMetaData>
The following example details the format of an XML if you are submitting a BTU order as a technical user.

<?xml version='1.0' encoding='UTF-8'?><orderMetaData xmlns:ns2="partnerInfo"><PartnerID>SANPARTNER</PartnerID><HostID>SANBANK</HostID><HostUrlAlias>SANBANKURL</HostUrlAlias><OrderType>BTU</OrderType><orderTypeJsonFile>BTUTemplate</orderTypeJsonFile><orderIdPrefix></orderIdPrefix><readMailbox>no</readMailbox><Product>IBM EBICS Client</Product><productLang>EN</productLang><ParameterList/><SecurityMedium>0200</SecurityMedium><UserID>SANUSER10</UserID><PAYLOADMSGID>328</PAYLOADMSGID>
	<autoSubmit>true</autoSubmit>
	<serviceName>SDD</serviceName>
	<serviceOptions>B2B</serviceOptions>
	<serviceScope>GLB</serviceScope>
	<MsgNameElement>
		<msgName>pain.008</msgName>
		<MessageType>
			<msgVersion></msgVersion>
			<msgVariant></msgVariant>
			<msgFormat>XML</msgFormat>
		</MessageType>
	</MsgNameElement>
	<ContainerElement>
		<serviceContainer>false</serviceContainer>
		<ContainerFlagType>
			<containerType></containerType>
		</ContainerFlagType>
	</ContainerElement>
	<SignatureFlagElement>
		<signatureFlag>false</signatureFlag>
		<SignatureFlagType>
			<requestEDS>false</requestEDS>
		</SignatureFlagType>
	</SignatureFlagElement>
	<addtnOrderInfo></addtnOrderInfo>
	<btfFileName>C:\fakepath\Test_pain.001.001.02Payment.xml</btfFileName>
</orderMetaData>
The following example details the format of an XML if you are submitting a BTD order as a technical user.
<?xml version='1.0' encoding='UTF-8'?><orderMetaData xmlns:ns2="partnerInfo">
<PartnerID>SANPARTNER</PartnerID>
<HostID>SANBANK</HostID>
<HostUrlAlias>SANBANKURL</HostUrlAlias>
<OrderType>BTD</OrderType>
<orderTypeJsonFile>BTDTemplate</orderTypeJsonFile>
<Product>IBM EBICS Client</Product>
<productLang>EN</productLang>
<ParameterList/>

<SecurityMedium>0200</SecurityMedium>
<UserID>SANUSER10</UserID>
<serviceName>PSR</serviceName>
<serviceOptions></serviceOptions>
<serviceScope>FR</serviceScope>
<MsgNameElement>
	<msgName>cfonb560</msgName>
	<MessageType>
		<msgVersion></msgVersion>
		<msgVariant></msgVariant>
		<msgFormat></msgFormat>
	</MessageType>
</MsgNameElement>
<ContainerElement>
	<serviceContainer>false</serviceContainer>
	<ContainerFlagType>
		<containerType></containerType>
	</ContainerFlagType>
</ContainerElement>
<DownloadDateRangeStart>2021-06-01</DownloadDateRangeStart>
<DownloadDateRangeEnd>2021-06-25</DownloadDateRangeEnd>
</orderMetaData>
If the file name of the payload has non-ASCII characters, then use the jar utility that comes with the Java Development Kit (JDK) installed with Sterling B2B Integrator to create a compressed file. You have to execute the jar utility from the command prompt in Windows or the terminal in UNIX with the following parameters: jar cFM <zip_fileName> ordermetadata.xml <payload_fileName with non-ASCII characters>.
Note: Java Home must be set to the JDK.

If the file name of the payload has only ASCII characters, then either the jar utility or any application such as WinZip or WinRAR can be used to create a compressed file.