Example EBICS scenarios

An example inbound EBICS scenario is:

1. An EBICS order is uploaded from an EBICS client to an EBICS server in a file upload (FUL) function.
2. The EBICS Order Data Processor (ODP) unpackages the payload to its raw inner .DAT format.
3. The EBICS ODP deposits the file into a mailbox of the structure User/Partner/Inbox (according to the EBICS specification).
4. Sterling File Gateway routes the file from the mailbox for downstream processing and ultimate delivery to the consumer according to the routing channel (RC), which specifies the template to use for the route. The template uses provisioning facts that established the mailbox path and user ID that were determined for the routing channel. The details of an example template suitable for an inbound EBICS scenario are:

   Field	Value
   Template Name	EBICSFUL
   In the Type tab
   Type	Static
   In the Special Characters tab
   Special Characters	None
   In the Groups tab
   Groups	All Partners for producers and consumers
   In the Provisioning Facts tab
   Fact Name	myUserId
   Display Label	User ID
   Description	The user ID of the producer
   In the Producer tab
   Producer Mailbox Path	/${myUserId}/${ProducerName}/Inbox
   Producer File Structure	Click Add
   Producer File Type	Unknown
   File name pattern as regular expression	{([^_]+)_([^_]+)_(.+)([.]DAT)}
   File name pattern group fact names, comma delimited	myHostId,myFileFormat,mySuffix,myExtension
   In the Consumer tab
   Delivery Channel Description	Click Add
   Pattern for Consumer Mailbox Path	/${ConsumerName}/Inbox
   If checked, mailboxes matching this pattern may be created on demand	Do not check the box
   Consumer File Structures	Click Add
   Consumer File Type	Unknown
   Consumer file name format	${myHostId}ara_${mySuffix}${myExtension}

An example outbound EBICS scenario is:

1. Sterling File Gateway routes an incoming file.
2. The file is packaged according to the EBICS configuration.
3. The file is deposited as a message in an EBICS partner's mailbox in the structure /User/Partner/Outbox based on a routing channel, which specifies the template to use for the route. The template uses provisioning facts that establish the mailbox path and user ID for the routing channel. The details of an example template suitable for an outbound EBICS scenario are:

   Field	Value
   Template Name	EBICSFDL
   In the Type tab
   Type	Static
   In the Special Characters tab
   Special Characters	None
   In the Groups tab
   Producer Group	All Partners
   Consumer Group	All Partners
   In the Provisioning Facts tab
   Fact Name	myUserId
   Display Label	User ID
   Description	The user ID of the consumer partner
   In the Producer tab
   Producer Mailbox Path	/${ProducerName}
   Producer File Structure	Click Add
   Producer File Type	Text
   File name pattern as regular expression	.+
   File name pattern group fact names, comma delimited
   In the Consumer tab
   Delivery Channel Description	Click Add
   Pattern for Consumer Mailbox Path	/${myUserId}/${ConsumerName}/Outbox
   If checked, mailboxes matching this pattern may be created on demand	Check the box
   Consumer File Structures	Click Add
   Consumer File Type	Text
   Consumer file name format	${ProducerFilename}

4. The EBICS partner, using an EBICS client, initiates a file download (FDL) request to the EBICS server.
5. The file in the consumer mailbox is picked up by the EBICS server.
6. The packaged file is transferred from the EBICS server to the EBICS client.