4.2.4. Gateway types

Here is the list of all the gateway types used in the application, with some more information about their specific uses and parameters.

Gateway In

  • Email Gateway In: Incoming messages are attached to email messages and sent to a specific Babelway email address and processed as soon as they arrive.

  • FTP Client Gateway In: Incoming messages are polled and retrieved from a remote ftp server using a login and password.

  • SFTP Client Gateway In: Incoming messages are polled and retrieved from a remote sftp server using a login and password.

  • FTP Server Gateway In: Incoming messages are transferred to a specific Babelway Ftp server and processed as soon as they arrive.

  • SFTP Server Gateway In: Incoming messages are transferred to a specific Babelway sftp server and processed as soon as they arrive.

  • AS2 Gateway In: A communication standard largely used in retail environment to secure communications over the Internet.

  • Internal Gateway In: A gateway used to transfer messages between 2 channels within Babelway.

  • Message record Gateway In: Used to export the messages details from the Monitoring in a message processed by the channel.

  • Lookup table Gateway In: Used to create a message using values present in a lookup table.

  • OFTP Server Gateway In: Incoming messages are transferred to a Babelway specific OFTP server and processed as soon as they arrive.

  • OFTP client Gateway In: Incoming messages are polled and retrieved from a remote OFTP server using login and password.

  • Http Client Gateway In: Incoming messages are polled and retrieved from a remote Http server.

  • Web Scraping Gateway In: Incoming messages are polled using a scenario mimicking a browser navigating the web.

  • Http Gateway In: Incoming messages are transferred to a Babelway specific Http server and processed as soon as they arrive and it is using asynchronous request.

  • Rest Gateway In: Allows you to implement a REST api and it is using asynchronous request.

  • X.400 Gateway In: Incoming messages are transferred to a Babelway specific X.400 server and processed as soon as they arrive.

  • Scheduler Gateway In: Create new messages based on time triggers.

  • NFS Gateway In: Incoming messages are polled and retrieved from a remote NFS server using login and password.

  • SAP Gateway In: Incoming messages are pushed to Babelway from an SAP server and processed as soon as they arrive.

  • Dropbox Gateway In: Incoming messages are polled from a Dropbox account.

  • Tradeshift Gateway In: Incoming messages are polled from a Tradeshift account.

  • E-conomic Gateway In: Incoming messages are pushed to Babelway from an E-conomic account and processed as soon as they arrive.

  • VAN Gateway In: Incoming messages are polled from ECGrid VAN.

  • PEPPOL Gateway In: Incoming messages are received from the PEPPOL network.

  • RosettaNet Gateway In: Incoming messages are received from a RosettaNet server.

  • ePrior Gateway In: Incoming messages are received from ePrior requests.

  • Simpl.ePrior Gateway In: Incoming messages are received from Simpl.ePrior requests.

  • Amazon Marketplace Gateway In: Incoming messages are polled from an Amazon marketplace account.

  • NemHandel Gateway In: Incoming messages are received from the NemHandel network.

  • Oracle Fusion Gateway In: Incoming messages are received from the Oracle Fusion CMK.

Gateway Out

  • Email Gateway Out: With an Email Gateway Out, outgoing messages are attached to an email and sent to a specific email address.

  • FTP Client Gateway Out: With a Ftp Client Out Gateway, outgoing messages are transferred to an external Ftp server.

  • SFTP Client Gateway Out: With a SFTP Client Out Gateway, outgoing messages are transferred to an external SFTP server.

  • FTP Server Gateway Out:With a Ftp Server Out Gateway, outgoing messages are available from a Babelway FTP server.

  • SFTP Server Gateway Out:With a Sftp Server Out Gateway, outgoing messages are available from a Babelway SFTP server.

  • AS2 Gateway Out: A communication standard largely used in retail environment to secure communications over the Internet.

  • Internal Gateway Out: The internal gateways in / out are used to transfer messages between 2 channels inside the same Babelway environment.

  • Null Gateway Out: The outgoing messages are not sent anywhere.

  • Splitter Gateway Out: A gateway used to split your messages and pass them to other gateways.

  • Aggregator Gateway Out: The aggregator allows you to merge messages into one larger file. The resulting messages are forwarded to another channel in the same environment.

  • Lookup Table Gateway Out: Used to fill a lookup table automatically from a message.

  • OFTP Server Gateway Out: With an OFTP Server Out Gateway, outgoing messages are available from a Babelway OFTP server.

  • OFTP Client Gateway Out: With an OFTP Client Out Gateway, outgoing messages are transferred to an external OFTP server.

  • Http Gateway Out: With a HTTP out Gateway, outgoing messages are available from a Babelway HTTP server.

  • Http Client Gateway Out: With an Http Client Out Gateway, outgoing messages are sent using an Http connection.

  • SOAP Client Gateway Out: With a Soap Client Out Gateway, outgoing messages are sent using a SOAP call and it is using asynchronous request.

  • ePrior Gateway Out: With ePrior Out Gateway, outgoing messages are made available on Babelway ePrior server.

  • Simpl.ePrior Gateway Out: With Simpl.ePrior Out Gateway, outgoing messages are made available on Babelway ePrior server.

  • X.400 Gateway Out: With an X.400 Gateway, outgoing messages are sent to a specific trading partner address using an X.400 network.

  • NFS Gateway Out: Outgoing messages are pushed from Babelway to an NFS server.

  • SAP Gateway Out: Outgoing messages are pushed from Babelway to an SAP server.

  • Dropbox Gateway Out: Outgoing messages are pushed from Babelway to a Dropbox account.

  • Exact Postbox Gateway Out: Outgoing messages are pushed from Babelway to an Exact POSTBOX account.

  • Tradeshift Gateway Out: Outgoing messages are pushed from Babelway to a Tradeshift account.

  • Billtrust Gateway Out: Outgoing messages are pushed from Babelway to a Billtrust API.

  • VAN Gateway Out: Outgoing messages are pushed from Babelway to ECGrid VAN.

  • PEPPOL Gateway Out: Outgoing messages are sent to the PEPPOL network.

  • RosettaNet Gateway Out: Outgoing messages are sent to a RosettaNet server.

  • Amazon Marketplace Gateway Out: Outgoing messages are sent to Amazon marketplace account.

  • NemHandel Gateway Out: Outgoing messages are sent to the NemHandel network.

Email Gateway In

Email gateway in allows you to receive incoming messages sent to a specific Babelway email address, as attachments. The messages are processed as soon as they arrive.

The specific settings are:

Email address

The email address to which the incoming messages are sent as email attachment. If the address already exists, you will have to enter a new address. Remember that this email address will only be created at channel deployment.

Process all files

By default we will process all files received. Unselect this box if you wish to define a specific rule.

File name pattern

Pattern (regular expression) for the file name in the email of the file that will become your input message. First match is used.

Other files to save

Allows you to save other files of the email for future use. For every file that you want to save, you have to specify the pattern of the file name in the email and the name of the metadata in which you want to save the content. If one pattern matches multiple files, it is possible to save them all if you guarantee to generate a different metadata name for each. This can be achieved by using the capturing groups of the regex in the metadata names. Ex: if your pattern is (.*\.csv) and your metadata name is attachment-$1, processing with files file1.csv and file2.csv will result in two metadata as follows attachment-file1.csv and attachment-file2.csv .

Note: This "Gateway In" filters out images in the attachment with the formats (bmp, gif, jpg, jpeg, png, eml, vcf) .

FTP Client Gateway In

With an Ftp Client In Gateway, incoming messages are transferred from an external Ftp server. Babelway polls files from this server at regular intervals. You may need this gateway to integrate with Wayfair for example.

The specific settings are:

Server

External ftp server address where Babelway should fetch messages, e.g. ftp.example.com

Username

Login or username to access files on this external ftp server.

Password

Password associated to the username.

Passive Mode

Indicates that the ftp connection is in passive. Ticking this means the ftp client will establish 2 connections to the ftp server.

Directory

Directory where files are to be fetched on the server.

File pattern

The file pattern is a regex used to filter files to import (ex: '.*\.csv' for all files ending with '.csv' or '(?!proc_).*\.csv' for all csv files that don't start with 'proc_'. If left empty, all files will be transferred.

Protocol

Select FTP, FTPS (Explicit mode) or FTPS (Implicit mode) protocol.

Private key

The private key associated with the previous username to access your account. This can be left empty if you choose to only use the password authentication mechanism.

Suffix during transfer

Suffix that will be appended to the file name when a file is being transferred. This mechanism is used to prevent that a file is transferred twice.

After transfer behaviour

What will happen to your file after we have read it. This behaviour is important so that your file is not read again at next poll. The possible values are :

  • Delete. It is the default. After having read it, the file will be deleted from the remote server.
  • Rename. A suffix will be appended to the file name.
  • Move. File will be moved to another folder of the remote server.
  • Move and rename. File will be moved to another folder, and renamed.
  • DoNothing. Don't do anything. Be very careful with this option, as it could mean that your file will be redownloaded at each poll. Should only be used with servers that move or delete the file automatically at download.

Suffix after transfer

Suffix that will be appended to the file name when a file has been completely transferred.

Folder for transferred files

Directory where transferred files will be moved.

Cron expression

Cron expression. Allows you to define complex time expressions like every weekday night at 23:00 (0 23 ? * MON-FRI). If left empty, the system will check at least once every 15 minutes. For easy creation of your cron expression, you can use the online cron maker tool available at http://www.cronmaker.com/. For more information, please refer to the page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

When a message is transferred to the ftp server, it is processed immediately then the original file is removed from the server.

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

FTP Server Gateway In

With a Ftp Server In Gateway, incoming messages are received on a Babelway specific ftp server and processed as soon as they arrive.

The specific settings are:

Server

Babelway ftp server is the hostname for the ftp server where the files will be fetched.

Username

Login or username to access your account on Babelway ftp server. This username must be unique as it is linked to a specific directory on the ftp server.

Password

Password associated with the username.

Directory

The directory on the ftp server on which you wil have to put your files so that they are processed by this gateway.

After channel deployment, your ftp server will be available to send messages. You can access this ftp server using any ftp client software set up with the previous account settings.

The files sent by FTP commands STOR, STOU, APPE are processed as soon as the command is completed. There is no need to use a temporary file name suffix are other precautions. The FTP server does not support FTP commands RMD, MKD, RNTO.

Babelway FTP gateways are supporting FTP and FTPS (Explicit mode) on port 21. It also support FTPS (Implicit mode) on port 990.

Note: The ports used for the FTP connections in Babelway are: (FTP, FTPs explicit : 20020-21020, FTPs implicit : 22021-23020).

SFTP Client Gateway In

With an SFTP Client Input Gateway, incoming messages are transferred to an external SFTP server. Babelway platform polls this server at regular intervals and retrieves incoming files to process them.

The specific settings are:

Server

Sftp server host name

Username

Login or username to access files on this external sftp server.

Password

Password associated with the username.

Private key

Private key associated with the username.

Directory

Directory where files are to be fetched on the server.

File pattern

The file pattern is a regex used to filter files to import (ex: '.*\.csv' for all files ending with '.csv' or '(?!proc_).*\.csv' for all csv files that don't start with 'proc_'. If left empty, all files will be transferred.

Cron expression

Cron expression. Allows to define complex time expression like every weekday night at 23:00 (0 23 ? * MON-FRI). If left empty, the system will check at least once every 15 minutes. For easy creation of your cron expression, you can use the online cron maker tool available at http://www.cronmaker.com/. For more information, please refer to the page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

Suffix during transfer

Suffix that will be appended to the file name when a file is being transferred. This mechanism is used to prevent that a file is transferred twice.

After transfer behaviour

What will happen to your file after we have read it. This behaviour is important so that your file is not read again at next poll. The possible values are :

  • Delete. It is the default. After having read it, the file will be deleted from the remote server.
  • Rename. A suffix will be appended to the file name.
  • Move. File will be moved to another folder of the remote server.
  • Move and rename. File will be moved to another folder, and renamed.
  • DoNothing. Don't do anything. Be very careful with this option, as it could mean that your file will be redownloaded at each poll. Should only be used with servers that move or delete the file automatically at download.

Suffix after transfer

Suffix that will be appended to the file name when a file has been completely transferred.

Folder for transferred files

Directory where transferred files will be moved.

Note:

  • Babelway By default connect to the remote SFTP server on port 22 but if you want to connect to this remote SFTP server using different port then use the below.

    In the Server field add the port number you want to use it, For example if use X.X.X.X:1722 in the Server field which means connect to the remote SFTP server X.X.X.X on port 1722.

  • In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

SFTP Server Gateway In

Using the SFTP Server In Gateway, incoming messages are received on a Babelway specific server and processed as soon as they arrive. The SFTP server gateway supports SFTP version 3 and password and/or public key user authentication mechanisms.

The specific settings are:

Server

Babelway sftp server is the hostname for the sftp server where the files will be fetched.

Username

Login or username to access your account on the Babelway SFTP server. This username must be unique as it is linked to a specific directory on the SFTP server.

Password

The password associated with the username. This can be left empty if you choose to only use the public key authentication mechanism.

Public Key

The public key associated with the username. This can be left empty if you choose to only use the password authentication mechanism. The supported formats are RSA public key (OpenSSH, Putty or DER format). More information about generating such a key can be found at the end of this page.

Directory

The directory on the ftp server on which you wil have to put your files so that they are processed by this gateway.

You can set both password and public key fields. Therefore, you will be able to connect to your account either by using a password or by using your private key associated with the uploaded public key.

After channel deployment, your SFTP server will be available to send messages. You can access this SFTP server using any SFTP (version 3) client software set up with the previous account parameters.

When a message is received by the SFTP server, it is directly processed. After processing, the file is removed from the server.

The public key is expected to be in an RSA format (OpenSSH, Putty or DER). If you don’t already have a public/private key, you can generate one using ssh-keygen from OpenSSH :

ssh-keygen.exe
Generating public/private rsa key pair.
Enter file in which to save the key (/.ssh/id_rsa): /tmp/identity
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /tmp/identity.
Your public key has been saved in /tmp/identity.pub.
The key fingerprint is:
f0:e4:2f:(...) user@computer
		

AS2 Gateway In

With an AS2 Gateway, incoming messages are received using an AS2 connection. Incoming files are processed as soon as they are received. (see how Walmart, Rite Aid, Wayfair. and Amazon use AS2)

AS2 (Applicability Statement 2) is a specification about how to transport data securely and reliably over the Internet. Security is achieved by using digital certificates and encryption.

The specific settings are:

From

AS2 ID of the server that sends incoming messages. Provided by your partner

To

AS2 ID of the Babelway destination server. You must communicate it to your partner

Local URL address

URL address used by your partner to send messages to this gateway. It works for both http and https protocol.

AS2 documentation

File containing instructions and certificates for the installation. You should download it and send it to your AS2 partner.

Message signature enforced

Should message signature be enforced or not.

Certificate for verification

Certificate used for message verification. Provided by your partner.

Message encryption enforced

Should message encryption be enforced or not.

Certificate for decryption

Local certificate to use for decrypting the AS2 messages. These certificates are kept in the environment certificates store.

Maximum retries

Maximum number of retries if message sending failed. Default is 5 times.

Retry interval

Interval of time before trying to send message again (in seconds). Default is 60 (1 minute) and the maximum is 600 (10 minutes).

After channel deployment, your AS2 connection will be available to receive messages.

To report AS2 settings to the other party, dowload the AS2 documentation ZIP file. This file can be sent to the other party to give them all settings they will require to establish a communication with your channel.

Note: The Listening ports for the AS2 Gateway are:

  • When using the HTTPS protocol the Listening port is 443.

  • When using the HTTP protocol the Listening port is 80.

OFTP Server Gateway In

With an Oftp server Gateway in, Incoming messages are received on a Babelway specific OFTP server and processed as soon as they arrive.

The specific settings are:

Partner SSID

The OFTP ID provided by your partner.

Partner SFID

The SFID provided by your partner. If none has been provided, this is probably the same as SSID.

Partner password

The password of your partner. Provided by your partner.

My SSID

Babelway is providing an official Odette SSID : O01770000000000X0B5SHARED. Please call support if you want to use a different one.

My SFID

An SFID is automatically assigned to your Environment: O01770000000000X0B5xxxxxx. Please call support if you want to use a different one.

My password

The value of the password is 'BABELWAY'.

OFTP documentation

File containing instructions and certificates for the installation. You should download it and send it to your OFTP partner.

Use compression

Compresses the messages.

Secure Authentication

Use OFTP2 'Secure Authentication'. This will use the certificates defined for encryption and signature.

Sign messages

Sign outgoing messages using the key selected in "Signature certificate". This allows your partner to verify that you are the one sending the message. This option is only available with OFTP 2.0.

Signature certificate

Select signature certificate or go to certificates store. These certificates are also used for decrypting incomming messages. Multiple certificates for decryption are possible, but only first one in the list is used for signing. This option is only available with OFTP 2.0.

Encrypt messages

Encrypt outgoing messages using the certificate selected in "Encryption certificate". This allows your partner to be the only one able to decrypt the messages sent. This option is only available with OFTP 2.0.

Encryption certificate

Select encryption certificate or go to certificates store.

Encryption algorithm

Select encryption algorithm or go to certificates store.

Receive signed messages

This allows you to verify that your partner is the one sending the message using the certificate selected in "Signature verification certificate". This option is only available with OFTP 2.0.

Signature verification certificate

Select certificate for data or go to certificates store.

Request signed ack (EERP)

Requests that incoming acknowledgments are signed. The signature will be verified using the Certificate selected in "EERP verification certificate". This allows you to be sure that only the partner could have signed the incoming messages. This option is only available with OFTP 2.0.

EERP verification certificate

Select certificate for EERP or go to certificates store.

Transfer mode

Advanced. Once the connection is open the OFTP gateway will act as both sender and receiver by default. You can control this by setting the following values : BOTH / RECEIVER_ONLY / SENDER_ONLY

Version

Advanced. Babelway is supporting both OFTP1 and OFTP2. When a connection is open, Babelway uses the OFTP built-in mechanism to negotiate the protocol version. The protocol will be the highest possible. Valid values are : OFTP_V12 for version 1.2 / OFTP_V13 for version 1.3 / OFTP_V14 for version 1.4 / OFTP_V20 for version 2.0

Credit count

Advanced. Control the OFTP "creditCount" parameter. This is the number of data command ( = CREDIT) that could be exchanged prior to an OFTP confirmation from the partner. Default is 64

Data exchange buffer size

Advanced. Control the OFTP "dataExchangeBufferSize" parameter. This is the size of the OFTP data buffer. It should be smaller than the maxBDataLen for ISDN connection. The minimum is 128 bytes and the maximum is 4096 for ISDN and 65535 for TCP connections. Default is 1024

After channel deployment, your Oftp server will be available to send messages. You can access this oftp server using any Oftp client software set up with the previous account settings.

If you require a custom SSID / SFID / PASSWORD, please send a request to support@babelway.com .

When a message is transferred to the Oftp server, it is processed immediately then the original file is removed from the server.

OFTP client Gateway In

With an OFTP Client In Gateway, incoming messages are transferred from an external OFTP server. The Babelway platform polls this server at regular intervals and retrieves files to process them.

The specific settings are:

Partner SSID

The OFTP ID provided by your partner.

Partner SFID

The SFID provided by your partner. If none has been provided, this is probably the same as the SSID.

Partner password

The password of your partner. Provided by your partner.

My SSID

Babelway is providing an official Odette SSID : O01770000000000X0B5SHARED. Please call support if you want to use a different one.

My SFID

An SFID is automatically assigned to your Environment: O01770000000000X0B5xxxxxx. Please call support if you want to use a different one.

My password

The value of the password is 'BABELWAY'.

OFTP documentation

File containing instructions and certificates for the installation. You should download it and send it to your OFTP partner.

ISDN number

List of phone numbers used for ISDN communication instead of Internet communication. The expected format is a comma separated list of phone numbers ex : 0049511211306466 or 0049511211306466,003221234567

Max nb datablocks

Advanced. Control the OFTP "maxBDataBlocks" parameter (ISDN only). Default is 7

Max size datablock

Advanced. Control the OFTP "maxBDataLen" parameter (ISDN only). Default is 1024

Server

The URL of the server of your partner. It is provided by your partner.

Port

The port to connect onto. It is provided by your partner.

Use TLS

Use TLS (SSL) for communication

Secure Authentication Certificate

Use this certificate to perform client side TLS (SSL) authentication.

Cron expression

Cron expression. Allows to define complex time expressions like every weekday night at 23:00 (0 23 ? * MON-FRI). If left empty, the system will check at least once every 15 minutes. For easy creation of your cron expression, you can use the online cron maker tool available at http://www.cronmaker.com/. For more information, please refer to the page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

Use compression

Compresses the messages.

Secure Authentication

Use OFTP2 'Secure Authentication'. This will use the certificates defined for encryption and signature.

Sign messages

Sign outgoing messages using the key selected in "Signature certificate". This allows your partner to verify that you are the one sending the message. This option is only available with OFTP 2.0.

Signature certificate

Select signature certificate or go to certificates store. These certificates are also used for decrypting incomming messages. Multiple certificates for decryption are possible, but only first one in the list is used for signing. This option is only available with OFTP 2.0.

Encrypt messages

Encrypt outgoing messages using the certificate selected in "Encryption certificate". This allows your partner to be the only one able to decrypt the messages sent. This option is only available with OFTP 2.0.

Encryption certificate

Select encryption certificate or go to certificates store.

Encryption algorithm

Select encryption algorithm or go to certificates store.

Receive signed messages

This allows you to verify that your partner is the one sending the message using the certificate selected in "Signature verification certificate". This option is only available with OFTP 2.0.

Signature verification certificate

Select certificate for data or go to certificates store.

Request signed ack (EERP)

Requests that incoming acknowledgments are signed. The signature will be verified using the Certificate selected in "EERP verification certificate". This allows you to be sure that only the partner could have signed the incoming messages. This option is only available with OFTP 2.0.

EERP verification certificate

Select certificate for EERP or go to certificates store.

Transfer mode

Advanced. Once the connection is open, the OFTP gateway will act as both sender and receiver by default. You can control this by setting the following values : BOTH / RECEIVER_ONLY / SENDER_ONLY

Version

Advanced. Babelway supports both OFTP1 and OFTP2. When a connection is open, Babelway uses the OFTP built-in mechanism to negotiate the protocol version. The protocol will be the highest possible. Valid values are : OFTP_V12 for version 1.2 / OFTP_V13 for version 1.3 / OFTP_V14 for version 1.4 / OFTP_V20 for version 2.0

Credit count

Advanced. Control the OFTP "creditCount" parameter. This is the number of data command ( = CREDIT) that could be exchanged prior to an OFTP confirmation from the partner. Default is 64

Data exchange buffer size

Advanced. Control the OFTP "dataExchangeBufferSize" parameter. This is the size of the OFTP data buffer. It should be smaller than the maxBDataLen for ISDN connection. The minimum is 128 bytes and the maximum is 4096 for ISDN and 65535 for TCP connections. Default is 1024

After channel deployment, your Oftp server will be available to send messages. You can access this oftp server using any Oftp client software set up with the previous account settings.

If you require a custom SSID / SFID / PASSWORD, please send a request to support@babelway.com .

When a message is transferred to the Oftp server, it is processed immediately then the original file is removed from the server.

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

Http Gateway In

With an Http In Gateway, incoming messages are received as HTTP Post on the Babelway HTTP server and processed as soon as they arrive.

The HTTP Post can use the following encoding method: HTML Form, base64 and urlencode.

Babelway is supporting synchronous processing of messaging. This is available when you submit messages using our HTTP gateway using SOAP and the SOAP operation: "process Message". The response will contain the final result of the execution of the messages. If the messages generate more than one message, the response will contain the full graph of processed messages.

It is also available through the REST of the gateways. There is only a limited available documentation on this topic, but we would be more than happy to understand more your requirements and provide a proof of concepts for you.

The specific settings are:

Authentication method

You can select from BASIC or CERT. BASIC is user/password authentication. CERT is 2-way SSL authentication.

Username

Login or username to access the service.

Password

Password associated with previous username.

2-way auth. certificate

The certificate used to validate the client certificate.

HTTP(S) Post URL

Using the HTTP(S) Post protocols. Support HTTP and HTTPS protocols.

The old address http(s)://{URL}/ws/HttpPostIn is still available, where {URL} is the same as the one in the new url http(s)://{URL}/ws/gateways/...

SOAP HTTP(S) Url

Using the SOAP Post protocols. WSDL.

Support HTTP and HTTPS protocols.

HTTPS Post URL

Using the HTTPS 2way authentication Post protocols.

Submitted using a FORM

Check the message posting was performed using a Http POST submit.

FORM parameter

If the option "Submitted using a FORM" is used, this selects the parameter where to find the content of the message.

Note: The HTTP server Gateway uses the port 80 for HTTP and 443 for HTTPS.

This "Gateway In" allow to provide the username and password in the URL when using the HTTP Post URL, The below print screen shows an example for this configuration.

HTTP Gateway IN example

Figure 4.31. HTTP Gateway IN example


The URl is http://eu1.babelway.net/ws/gateways/501484 ?userName=test4321&pwd=kM7kqSpFRkSX5nXZ

Note: Note: You will need to download the WSDL file for this gateway by using the SOAP URL in the browser then login using the user name and password for this gateway in order to download the WSDL file for this environment as for some environments the SOAP URL and the WSDL file are different from other environments.

Http Client Gateway In

The Http Client allows to periodically retrieve the content of the Http response to a specific URL

Authentication method

You can select from BASIC or TOKEN. BASIC depend on the server response.

Login url

If authentication method is FORM.

Url

Url to call to create message.

Support HTTP and HTTPS protocols.

Username

Username used for BASIC/NTLM/DIGEST authentication.

For NTLM authentication, the username can be prepended by the domain (domain/username).

Password

Password used for BASIC/NTLM authentication.

Valid HTTP return code

Comma separated list of expected return Http code. If the return code is not in the list, the polling generates an alert. The default is '200,201,202,204,205'.

Timeout

Timeout for connection in milliseconds. Must be between 10000 and 240000.

Http Method

You can specify the http method to call. The default is GET.

TLS version

You can specify the version of the TLS protocol. TLS is the replacement of SSL. The default is TLSv1.2.

Http headers

You can add specific http header.

Trust level

The trust level defines the level of security used in the SSL handshake. Relax = No certificate verification, Standard = trusting certificates in environment certificates as well as known CA's, Paranoiac = only trusts certificates defined in the environmnent certificates. The default is Standard

Login url

If authentication method is FORM.

Authentication form fields

When using FORM authentication, you can add specific authentication form fields to the authentication call. This accepts metadata.

Metadata from response

You can use data receive by the login request as metadata, which can be used in the data sending after login.

Cron expression

Cron expression. Allows to define complex time expression like every weekday night at 23:00 (0 23 ? * MON-FRI). If left empty, the system will check at least once every 15 minutes. For easy creation of your cron expression, you can use the online cron maker tool available at http://www.cronmaker.com/. For more information, please refer to the page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

Note:

  • The Gateway In of type "HTTP Client" only supports the BASIC authentication mode.

  • In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

Web Scraping Gateway In

The Web scraping allows to periodically retrieve messages using a scenario mimicking a browser navigating the web.

This gateway has to be enabled by Babelway support. For more information or to request the activation, please send a mail to support@babelway.com.

Scenario

Xml definition of the web scraping scenario.

Use variables from lookup table

The scenario will be executed once per iteration lookup table row block. The value of the lookup table will be added to the execution context and available using the VARIABLE::columnName function. The scenario will be executed once without parameters if the lookup table is left empty.

2-way auth. certificate

If CERT authentication is used (2-way SSL authentication), this allows to select the key pair to use from the environment certificate.

Cron expression

Cron expression. Allows to define complex time expression like every weekday night at 23:00 (0 23 ? * MON-FRI). If left empty, the system will check at least once every 15 minutes. For easy creation of your cron expression, you can use the online cron maker tool available at http://www.cronmaker.com/. For more information, please refer to the page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

Rest Gateway In

This gateway in allows you to easily publish a REST api.

It has the following characteristics:

  • It will respond synchronously to the REST api calls with the result of the processing of the message by the channels.
  • It injects an xml message in that contains all the elements of the REST call (uri, parameters, expected output format, ...).
  • It supports 'json', 'xml' and 'csv' as output format.
  • It supports multi-credentials.

The specific settings are:

Url identifier

Part of the url that identifies this gateway. The urls to call the REST api will have the form https://ws.babelway.net/rest/<urlIdentifier>/<yourUrlParams>.(json|xml|csv)

Body of API call as message content

Activate this settings if you want to use the body of the API call (also known as the payload of the HTTP call) as message IN content. This only works with POST, PUT and PATCH HTTP methods. If you deactivate this options, your message content will look like the XML example we provided in the help guide.

Url to call

The URL to call the REST api.

Allowed credentials

A list of user names/password pairs that are allowed to access this api. The user will have the choice to provide user name and password via http basic authentication, http settings 'user' and 'password' or http headers 'user' and 'password'.

Url patterns

Optional. If filled, the requested url will be checked again. This pattern will be refused if it doesn't match at least one pattern. You can also prefix the pattern with 'PRE:', 'POST:', 'PUT:', ... if you want this pattern to only be accessible via one specific http method.

Here is an example of message In, that is generated by this gateway if you use the HTTP method POST.

<?xml version="1.0" encoding="UTF-8"?>
<restRequest>
  <uri>/sws/shipmentStatus/BE.json</uri>
  <identifier>sws</identifier>
  <action>shipmentStatus</action>
  <method>GET</method>
  <format>json</format>
  <userName>bertrand</userName>
  <parameters>
    <param1>BE</param1>
    <myParam>myValue</youpie>
  </parameters>
  <POST>... Payload or body of your HTTP call ... </POST>
</restRequest>
		

<POST>...</POST> xml tags will match the HTTP method you use to perform the call. Those would be <GET>...</GET> if you are using the GET method, etc...

Below is how to use the URL parameters for a REST API Server Gateway IN

For example we have created the REST API Server Gateway IN with the below parameters as a test values for explanation

1-The "Url identifier" as "testurl".

2-Regarding the "Allowed credentials" the "Username" as "usernametest" and the "Password" as "passwordtest".

3-For this test environment the "Url to call" is "http://ws.babelway.net/rest/testurl/message(?URL Params).(json|xml)"

REST API Server Gateway IN

Figure 4.32. REST API Server Gateway IN


To use the URL settings for a REST API Server Gateway IN, for example, this is the Url to call "http://ws.babelway.net/rest/testurl/message(?URL Params).(json|xml)"

You will replace the (?URL Params) with your URL params you want to use them.

Regarding the (json|xml) here you can determine the format of the data.

Note: If you want to get the input message name then you have to select one of the two below mentioned options. This is due to the fact that, when using the REST API Server Gateway IN there is no file.

  • Option one: You will need to include the input file name somewhere in the API call in the body of the HTTP call.
  • Option two: You will need to include the input file name somewhere in the URL parameters.

Now you can use the name that you have provided by selecting one of the two above mentioned options to create the output message file name.

X.400 Gateway In

An X.400 In Gateway allow to receive messages from X.400 networks. Your trading partners can reach you via your private X.400 address.

The specific settings are:

X.400 address

The account private address. This is the address to communicate to your trading partners. The formatting may vary from one partner to the other. The most common format is: C=WW; A=400NET; P=BABELWAY; S=HUB-25333 /C=WW/A=400NET/P=BABELWAY/S=HUB-25333.

After channel deployment, your connection will be available to send messages.

The first time X.400 is used in an account, it has to be enabled by Babelway support. The request is done automatically and you will be notified when the gateway is functional.

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

Scheduler Gateway In

The Scheduler in Gateway allows you to create a message based on a time trigger.

The specific settings are:

Frequency

Number of seconds between two events. The default value is 90 seconds and cannot be lower. This is the simplest way to define a time event. For more complex needs, use the Cron Expression property instead.

Cron expression

Cron expression. Allows you to define complex time expressions like every weekday night at 23:00 (0 23 ? * MON-FRI). This takes precedence on the frequency property. For easy creation of your cron expression, you can use the online cron maker tool available at: http://www.cronmaker.com/. For more information, please refer to the following page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

Message

Message template that will be sent each time this scheduler is activated. If not filled, a default xml is used (that just contains the time and the gateway id).

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

Internal Gateway In

The internal gateway in / out is used to transfer messages between 2 channels within the same account environment.

There is no setting to define in this template. The internal gateway will be automatically created using the gateway name you entered. You will then be able to select it as an Internal Gateway Out in another channel configuration.

As opposed to most other gateways, the internal gateway is immediately available as the gateway out for other channels configuration without requiring a channel deployment.

Message record Gateway In

This gateway exports periodically your message records (Messages details from the Monitoring). The export is in CSV, and is exactly the same format that you would have by exporting your messages manually in the interface.

Period

The period with the messages to export.

Filter

In addition to the time criteria, this setting allows you to define additional criteria to filter the messages to export.

In gateways

The list of gateways for which you want the processed messages.

Channels

The list of channels for which you want the processed messages.

Cron expression

Cron expression. Allows you to define complex time expressions like every weekday night at 23:00 (0 23 ? * MON-FRI). If left empty, the export will be scheduled automatically based on your period criteria. For easy creation of your cron expression, you can use the online cron maker tool available at: http://www.cronmaker.com/. For more information, please refer to the following page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

This Gateway In is used to get the Message records from your environment and then for example the channel which has this Gateway In will send to your system a custom statistics every 7 days, The below example show how this is done.

1-Create a Gateway In of type Message Record then set the Cron expression to scheduled every 7 days.

Gateway IN of type Message Record

Figure 4.33. Gateway IN of type Message Record


2-For example the Message Out is of type XML that will contain custom statistics structure, In the transformation map all of the field from the "Message In" to the "Message out" to achieve the required information.

Message Record Transformation

Figure 4.34. Message Record Transformation


3-Every seven days the channel will send a custom statistics XML file to your system, Below is a sample for the generated XML file.

Message Record Output

Figure 4.35. Message Record Output


Lookup table Gateway In

This gateway allows you to create a message from the content of a lookup table. The message created is a XML document. It uses the same format as the XML CSV representation used internally by Babelway.

Lookup Table Id

The technical id of the lookup table.

Include headers

Check this to add the column names as headers of the messages created.

Filter 1 column

Column used to filter the extract of the lookup tables entries.

Filter 1 value

Value used to filter the extract of the lookup tables entries.

Filter 2 column

Column used to filter the extract of the lookup tables entries.

Filter 2 value

Value used to filter the extract of the lookup tables entries.

Filter 3 column

Column used to filter the extract of the lookup tables entries.

Filter 3 value

Value used to filter the extract of the lookup tables entries.

Post extract operation

Optional operation to perform on selected entries (NONE, DELETE and UPDATE) after extraction. Default is DELETE

Column to update

Column to update after the extract of the lookup tables entries, Only used with 'Update' in 'Post extract operation'.

Column to update

Column to update after the extract of the lookup tables entries, Only used with 'Update' in 'Post extract operation'.

Update value

Value to use when updating the column to update.

Limit

Maximum number of entries to extract in 1 execution of this gateway.

Entries per message

Maximum number of entries per message. If the overall limit is bigger, several messages will be created for each execution of this gateway.

Cron expression

Cron expression. Allows you to define complex time expressions like every weekday night at 23:00 (0 23 ? * MON-FRI). If left empty, the system will check at least once every 15 minutes. For easy creation of your cron expression, you can use the online cron maker tool available at: http://www.cronmaker.com/. For more information, please refer to the following page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

NFS Gateway In

The NFS gateway is used to connect and fetch files from a remote NFS server.

Server

Hostname of the NFS server.

Export

Name of the exported volume.

Login method

NFS login method: use PCNFSD for username / password and UGID to directly use UID, GID and GIDS.

Username

Username used for the NFS authentication. Only used with PCNFSD login method.

Password

Password used for the NFS authentication. Only used with PCNFSD login method.

User ud

Unix user UID to use during authentication. Only used with UGID login method.

User group id

Unix user's group GID to use during authentication. Only used with UGID login method.

User extra group ids

Unix user's additional groups GID to use during authentication, encoded as a comma separated list. Only used with UGID login method.

Directory

Local NFS path to the folder you want to use. This is relative to the export.

Filename pattern

If not empty, only the files whose name matches this pattern will be transferred.

Suffix during transfer

Suffix that will be appended to the file name when a file is being transferred. This mechanism is used to prevent that a file is transferred twice.

After transfer behaviour

What will happen to your file after we have read it. This behaviour is important so that your file is not read again at next poll. The possible values are :

  • Delete. It is the default. After having read it, the file will be deleted from the remote server.
  • Rename. A suffix will be appended to the file name.
  • Move. File will be moved to another folder of the remote server.
  • Move and rename. File will be moved to another folder, and renamed.
  • DoNothing. Don't do anything. Be very careful with this option, as it could mean that your file will be redownloaded at each poll. Should only be used with servers that move or delete the file automatically at download.

Suffix after transfer

Suffix that will be appended to the file name when a file has been completely transferred. The use of this mechanism allows you to keep the file after the transfer, with this suffix appended to its name. If left empty, the file will be deleted after the transfer.

Folder for transferred files

Directory where transferred files will be moved.

Cron expression

By default, the gateway will regularly poll the messages from your NFS server, so that they come into Babelway a short time (less than 10 minutes) after they have been placed in your NFS server. You can write here a cron expression to customise the polling schedule. For easy creation of your cron expression, you can use the online cron maker tool available at : http://www.cronmaker.com/.

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

SAP Gateway In

The SAP Gateways are based on the SAP RFC protocol and JCo technology. RFC is an SAP interface protocol allowing internal or external systems to communicate with the SAP system. JCo is the Java implementation of RFC distributed by SAP. Babelway leverage the built-in JCo redundancy mechanism to distribute the gateway on our different locations (data centers).

Solution overview

Figure 4.36. Solution overview


System boundaries, acknowledgment and error management

For Inbound IDoc, Babelway sends the IDoc to SAP. If the message cannot be delivered to SAP, the error will be managed using the traditional Babelway process. Error notifications will be delivered to registered users. When the message is delivered to SAP, Babelway fetches the detailed status and error messages of the IDoc. The messages are always set to 'acknowledged' when the transmission is successfully. However the status could be SUCCESS or ERROR depending the SAP IDOC status code.

For Outbound IDoc, SAP sends IDOC to Babelway. If the message cannot be delivered to Babelway, the IDoc is in error in SAP with a status = 20. Once the message is delivered to Babelway, SAP automatically change the status to 03. In addition of this, we provide a function to explicitly change the status by calling the RFC defined during the setup phase. This allow SAP that the remaining of the IDoc processing will entirely take place in Babelway.

Connectivity Setup

Babelway provides the gateways to communicate in both direction. SAP Gateway In allows to receive outbound IDoc and SAP Gateway Out allows to send inbound IDoc to SAP. The JCo RFC Provider service uses a TCP/IP connection type. In order to secure this connection, Babelway advices one of the following solutions:

  • Option 1: A strict firewall rule to allow Babelway public IP addresses to connect to the SAP server
  • Option 2: Using SAP router in the DMZ, as well as the firewall configuration like in Option1
  • Option 3: You can contact Babelway support to setup a IPSec VPN between the Babelway public IP addresses and the SAP server. Please send a request to support@babelway.com

The Port number used to contact the SAP system range from 3300 to 3399. The exact port number depends on the SAP system you want to reach. The exact port number must be given in the parameters (defined below). Firewall need to allow Babelway server to reach these ports.

SAP configuration

Here is the list of the SAP specific setup to perform in order to make the connector working. This is guide lines

  • Create a "RFC destination" (transaction sm59) with the name "BABELWAY". The "Connection Type" is "TCP/IP Connection". Go to "Technical settings" and fill "BABELWAY" in the "Program ID" field. Go next to the "Unicode" tab and in the "Communication Type", select the "Unicode".
    RFC destination

    Figure 4.37. RFC destination


  • Create a "Ports in IDoc processing" (transaction we21) in the "Transactional RFC" with the name "BABELWAY".
    Ports in IDoc processing

    Figure 4.38. Ports in IDoc processing


  • For inbound IDoc, there is no special configuration. All programs are allowed to delivered IDocs for all partners. For outbound IDoc, Go to "Partner profiles" (transaction we20) then for each partner and each "Message Type" you want to change, go to "Outbound Options" and change the "Receiver port" to "BABELWAY" in the tab "tRFC".
    Sap Partner Profiles

    Figure 4.39. Sap Partner Profiles


    Sap Partner Profiles Outbound Parameters

    Figure 4.40. Sap Partner Profiles Outbound Parameters


  • If you want to leverage the "Update Status" feature, you need to add the specific RFC call. By default the system will call the following function: ZZBABELWAY_IDOC_STATUS_UPD taking 2 input parameters: PI_DOCNUM (IDoc number) and PI_STATUS (the new status = 16). The code for such function is given here.
  • Here is a list of transactions that could help you during the setup of your connection:
    • sm59 : maintenance of "RFC destination"
    • we21 : maintenance of "Ports in IDoc processing"
    • we20 : maintenance of "Partner profiles"
    • we02 : "IDoc List"
    • we19 : "Test tool for IDoc processing"
    • sm58 : "Transactional RFC". Use this to look for TID = Gateway In message key
    • smgw : "Gateway Monitor"
    • sm21 : "System Log"
    • we63 : "Documentation" usefull to get IDoc parser or XSD to use in Babelway wizard
    • su01 : "User Maintenance"
Babelway configuration

Simply create a channel with the SAP gateway and XML IDoc message definition.

Sap Channel Details

Figure 4.41. Sap Channel Details


The specific parameters are :

SAP client

SAP client to use. This is the three digit number you use in the first field of the login screen of SAP Gui. It has the name 'Client' and is just above the user and password fields. For instance: 001, 210, 400 ...

User

The Valid SAP user ID you want to use. Ideally this should be a user specially created for this purpose. For instance: user

Password

Password associated with the user ID. For instance: password

Server address

IP or DNS name for SAP application server. For instance: sap.yourcompany.com if using a sap router, use the sap router syntax details here: /H/SAP_ROUTER/S/3300/H/SAP_SERVER/S/3300 http://help.sap.com/saphelp_nw04/helpdata/en/4f/993172446d11d189700000e8322d00/frameset.htm if you are using a NAT: put the public address in sm59

RFC destination

This is the name of the RFC Destination to use. This RFC destination must use TCP/IP connection. See help for more details. For instance: BABELWAY

SAP system number

SAP system number is the last 2 digits of the SAP client. For instance: 01, 10, 00. Default is the last 2 digits of SAP client parameter

Gateway address

IP or DNS name for SAP gateway. It could be the same as jco.client.ashost if no external gateway is used. the For instance: gateway.yourcompany.com. Default is the same as SAP server address parameter.

Gateway port

This is the port number to reach the TCP RFC server. For instance use 3301 to reach system 01 or 3310 to reach system 10. Default is 3300 + the last 2 digits of SAP client parameter.

Custom update status

Should the system call the RFC function to explicitly update the status in SAP. Default is true and it required a RFC to be configured in SAP. Default is false.

Update status function

The name of the RFC updating the status. For instance: ZZBABELWAY_IDOC_STATUS_UPD

Use unicode

Specify if unicode should be used. Use 0 for false and 1 for true. For instance: 0

Dropbox Gateway In

The Dropbox gateway in allows to retrieve your messages from a Dropbox account.

The specific settings are:

Dropbox account

The name of the Dropbox account from which the messages are polled. This information is "read only", and set by the wizard when you allow Babelway to access the Dropbox account.

Folder

The folder in your Dropbox account from which the messages are transferred to Babelway. This folder is located under the path /Apps/Babelway/ .

Filename pattern

If not empty, only the files whose name matches this pattern will be transferred to Babelway. Otherwise, all files are automatically transferred to Babelway

Suffix during transfer

Suffix that will be appended to the file name when a file is being transferred. This mechanism is used to prevent that a file is transferred twice.

After transfer behaviour

What will happen to your file after we have read it. This behaviour is important so that your file is not read again at next poll. The possible values are :

  • Delete. It is the default. After having read it, the file will be deleted from the remote server.
  • Rename. A suffix will be appended to the file name.
  • Move. File will be moved to another folder of the remote server.
  • Move and rename. File will be moved to another folder, and renamed.
  • DoNothing. Don't do anything. Be very careful with this option, as it could mean that your file will be redownloaded at each poll. Should only be used with servers that move or delete the file automatically at download.

Suffix after transfer

Suffix that will be appended to the file name when a file has been completely transferred. The use of this mechanism allows you to keep the file after the transfer, with this suffix appended to its name. If left empty, the file will be deleted after the transfer.

Folder for transferred files

Directory where transferred files will be moved.

Scheduling

By default, the gateway will regularly poll the messages from your Dropbox account, so that they come into Babelway a short time (less than 10 minutes) after they have been placed in your Dropbox account. You can write here a cron expression to customise the polling schedule. For easy creation of your cron expression, you can use the online cron maker tool available at : http://www.cronmaker.com/.

Tradeshift Gateway In

This gateway allows to retrieve files directly from an account on Tradeshift. The document retrieved will be marked as 'processed-by-babelway' in Tradeshift. The message will contain 2 metadata, 'document.metadata' containing the document metadatas and 'connection.properties' containing the connection properties, both as a single line JSON string.

API URL

URL Prefix to call Tradeshift API. Default is https://api.tradeshift.com/tradeshift/rest/

Polling type

Choose 'Document' for regular fetching of document. Choose 'Workflow' to poll workflow document.

Tenant Id

The Tradeshift tenantId to use. Use Babelway application in Tradeshift to retrieve this value.

Token

The Tradeshift token to use. Use Babelway application in Tradeshift to retrieve this value.

Secret

The Tradeshift token secret to use. Use Babelway application in Tradeshift to retrieve this value.

Consumer key

The Tradeshift consumer key to use to authenticate the Babelway application. This should be left empty in most of the case.

Consumer secret

The Tradeshift consumer secret to use to authenticate the Babelway application. This should be left empty in most of the case.

Stag

Specify where the document should be retrieved from. Values are 'inbox', 'outbox', 'sales', 'purchases', 'inbox,outbox', 'inbox,outboxsales,purchases', 'draft', 'sent'. Default is 'inbox'.

Type

type of document to retrieve. Values are 'invoice', 'creditnote', 'order', 'despatchadvice', 'invoice,creditnote', 'invoice,creditnote,order,despatchadvice'. Default is 'invoice'.

Additional query parameters

Parameter list added to the initial 'list documents' api call.

Reverse documents order

Process the documents in reverse order of retrieval. This option is useful if you query documents with the property 'ascending' set to false, which results in document being polled in the reverse order timewise, to process them in the correct order

Query parameters

Parameters used to build the document query. It is highly recommended to at least set the properties 'withouttag', 'limit', 'type' and 'stag'.

Get document metadata

Should document metadata be fetched?

Get network connections properties

Should network connection properties be fetched?

Poll processed documents

Poll processed documents by appending '/processed' to the GET document call

Additional tags

Set these tags to the document. It is important to at least set the 'withouttag' to avoid multiple processing of same message

Additional tags

Set these tags to the document. It is important to at least set the 'withouttag' to avoid multiple processing of same message

Properties

Set these properties to the document

Tags to remove

List of tags you want to remove from the document

Properties to remove

List of properties you want to remove from the document

Pull collaborations

Fetch collaboration messages for every document. Collaboration datas will be saved in message metadatas

Collaboration type

Which type of collaborations to fetch

Fetch Attachments

Include attachment into fetched data?

Frequency

Number of seconds between 2 checks. The default value is 3600 seconds (1 hour) and it can be lowered; the minimum accepted value is 90 seconds. This is the simplest way to define a time event. For more complex need, use the Cron Expression property instead.

Cron expression

By default, the gateway will regularly poll the messages from your Tradeshift account, so that they come into Babelway less than one hour after they have been placed in your Tradeshift account. You can write here a cron expression to customise the polling schedule. For easy creation of your cron expression, you can use the online cron maker tool available at : http://www.cronmaker.com/.

This Gateway In allow you connect to Tradeshift server to receive specific document base on the configuration of this Gateway In.

By using the Tradeshift API in the configuration in the Gateway In we can control to receive:

-A specific document type (The corresponding parameter is "type").

-Receive document in ascending or descending order (The corresponding parameters is "ascending").

-Receive document issued between a specific period of time (The corresponding parameters are "minissuedate" and "maxissuedate").

-Control the limit of the received document in one call (The corresponding parameter is "limit").

The below link from Tradeshift describes all of the Tradeshift API calls to be used in this Gateway In.

https://api.tradeshift.com/tradeshift/rest/external/doc

When the Tradeshift "Gateway In" is used in the channel and the message is in status of "in delivery" in the Babelway system then it will be marked as "processed-by-babelway" in Tradeshift, If the status is "Success" in the Babelway system then it will be marked as "sent-by-babelway" in Tradeshift, and if the status is "Error" in the Babelway system then it will be marked as "babelway-errorDescription" in Tradeshift.

For each message retrieved from Tradeshift two metadata are created and stored in the Context in file related to each document separately, This is stored in the "contextIn.xml" file in the "UserMetadatas" tag.

The "document.metadata" metadata contains all of the information related to this document for example (DocumentId, DocumentType, documentProfileId, … etc) stored in a JSON string.

Document Metadata

Figure 4.42. Document Metadata


The "connection.properties" metadata contains all of the information related to this connection properties for example (OpenDated, SupplierCategory, CompanyUrl, … etc) stored in a JSON string.

Connection Properties

Figure 4.43. Connection Properties


Example 1

We want to only poll documents with specific connection property which is "argtag"="TestInbound".

To accomplish this we will use the two query parameters "propertykey" and "propertyvalue".

In this case the "propertykey" will be "argtag" and the "propertyvalue" will be "TestInbound".

1-Create the Tradeshift Gateway In and configure the connection parameters.

2-From the Gateway In click on "Properties".

3-In the "Tradeshift" section for the "Additional query parameters" we will create the two query parameters with the corresponding values.

Example 1

Figure 4.44. Example 1


Example 2

The default limit for polling is 25 documents, so in this case for example we want to change it to be 70 documents.

To accomplish this we will use the query parameters "limit" which will be set to 70.

In the "Tradeshift" section for the "Additional query parameters" we will create the query parameter "limit" and set its value to "70".

Example 2

Figure 4.45. Example 2


Example 3

The query parameter "tag" is set by default to be interpreted as "OR" in this case we want to change it to be interpreted as "AND" this is done by setting the query parameter "useAndOperatorForTags" to "true".

In the "Tradeshift" section for the "Additional query parameters" we will create the query parameter "useAndOperatorForTags" and set its value to "true".

Example 3

Figure 4.46. Example 3


Example 4

We can use query parameter at the same time, In this we want to only poll documents with specific connection property which is "argtag"="TestInbound" and with limit of 70 documents.

We will use the three query parameters "propertykey" and "propertyvalue" and "limit".

In this case the "propertykey" will be "argtag" and the "propertyvalue" will be "TestInbound" and the "limit" will be "70".

Example 4

Figure 4.47. Example 4


Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

Amazon Marketplace Gateway In

This gateway allows to retrieve orders from an account on Amazon Marketplace. The gateway will only process orders created after the deployment of the gateway.

Process

Request support@babelway.com for changing this parameter. Type of process. 'PollOrders' is the only one supported at this stage.

Endpoint

Endpoint is the entry point for an Amazon marketplace web service. Default is https://mws.amazonservices.com

Access key

Amazon marketplace web services access key ID.

Secret key

Amazon marketplace web services secret key ID.

Seller Id

Amazon marketplace seller ID.

Marketplace Id

Amazon marketplace ID.

Cron expression

By default, the gateway will regularly poll the messages from your Amazon Marketplace account, so that they come into Babelway less than one hour after they have been placed in your Amazon Marketplace account. You can write here a cron expression to customise the polling schedule. For easy creation of your cron expression, you can use the online cron maker tool available at : http://www.cronmaker.com/.

Note: This Gateway In only receive order messages from Amazon Marketplace.

The below link has the complete list for all of the available FeedType in the Amazon MWS Feeds API section.

https://docs.developer.amazonservices.com/en_US/feeds/Feeds_FeedType.html

Below is a link for a list of Amazon Marketplace that will help you to access Amazon Marketplace Web Service (Amazon MWS) through a URL endpoint for your Amazon marketplace.

http://s3.amazonaws.com/devo.docs.developer.amazonservices.com/en_DE/dev_guide/DG_Endpoints.html

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

E-conomic Gateway In

The E-conomic wizard is used to create a gateway that lets you query your e-conomic online account (http://www.e-conomic.com) and retrieve invoice documents based on a specified CVR reference.

The specific settings are:

E-conomic Token Id

The generated Token Id by E-conomic that grants Babelway access to your E-conomic account.

It can be generated via https://secure.e-conomic.com/secure/api1/requestaccess.aspx?appId=N3m3TyMMqNgwTTso7dnr7f3rGOnXlZwKEeneiL2Uwo0=&role=SuperUser.

CVR Reference

Reference to Central Business Register (CVR). Only invoice documents with this reference will be retrieved by Babelway.

Cron expression

Cron expression. Allows to define complex time expression like every weekday night at 23:00 (0 23 ? * MON-FRI). If left empty, the system will check at least once every 15 minutes. For easy creation of your cron expression, you can use the online cron maker tool available at : http://www.cronmaker.com/. For more information, please refer to the following page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

VAN Gateway In

This gateway allows to retrieve files from specific trading partners on ECGrid VAN. A Trading Partner is the company from whom you are going to receive documents. You may wish to use this gateway for example to integrate with Rite Aid or Wayfair.

The VAN gateway receives the message based on the Identifier / Qualifier pair as determined in the X12 or Edifact data. They look like this:

X12: ISA*00* *00* *ZZ*SENDERID *ZZ*RECEIVERID *010101*0101*U*00401*000000001*0*T*!

EDIFACT: UNB+UNOA:1+ SENDERID:ZZ+RECEIVERID:ZZ +

For the VAN IN Gateway, your ID Is the Receiver ID. Your Trading Partner ID is the Sender ID.

If you are using an already existing ID (on another VAN), your ID must be migrated to Babelway before you can begin receiving documents. To do so you must:

1-Download and complete this letter of authorization, found here

2-Printout on your company letterhead, scan with completed information

3-Send authorization to along with your desired migration date

Please note that this migration will cause all traffic under this ID to be routed to the Babelway VAN Gateway In. You must be prepared to process all documents that you currently receive through your old VAN before the migration can be completed successfully.

If you would rather use a new ID and have your partners change what they are using, Babelway let’s you create a new ID on the gateway.

Your identifiers

Your Names / Identifiers / Qualifiers on VANs. All EDI messages specifying these Id/Qual in recipient will be routed to this gateway. Identifier = The X12 or EDIFACT ID for the ISA and UNB segments. Qualifier = The X12 or EDIFACT Qualifier for the ISA and UNB segments (Maximum is 2 characters). The name should be your company/ entity name and will be used by other EDI partners to find you before sending messages.

Note:

  • In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

  • VAN ID can't be used in two different environments. You can only share it in the same environment with more than one channel, then you will have to set routing conditions.

PEPPOL Gateway In

This gateway allows to receive files from the PEPPOL network.

PEPPOL ?

The PEPPOL project was started in 2008 with the objective to enable businesses to communicate electronically with any European government institution in the procurement process. Seven years later, PEPPOL standard is gaining traction by the European governments but also within the industry (the peppol.eu site lists 99 certified PEPPOL Access Points providers).

The three main components of the PEPPOL architecture are :

  • The Access Point (AP) : responsible to send and receive documents for a PEPPOL participant

  • The Service Metadata Publisher (SMP) : registry containing the Participant AP information. It tells you which access point must be contacted to send document of certain type to a PEPPOL participant

  • The Service Metadata Locator (SML) : the PEPPOL DNS Server. It tells you in which SMP a PEPPOL participant is registered

PEPPOL In Gateway

Figure 4.48. PEPPOL In Gateway


Participant

An "PEPPOL In Gateway" must be configured for one PEPPOL Participant (the receiver). There can be only one PEPPOL Gateway IN per participant identifier in Babelway.

The identifier value is the value identifying the PEPPOL participant in a given identification scheme. Most of the time this is a national VAT or a GLN number. For easier use, you can, for each identifier, define a user-friendly name that we call a "label".

When you deploy an "PEPPOL In Gateway", the gateway is registered as an Access Point for the receiver and document types in a Babelway SMP and the Babelway SMP is referenced in the SML for this participant.

The participant SML status tells you if the participant is registered in the PEPPOL SML.

PEPPOL In Gateway - Participant SML status

Figure 4.49. PEPPOL In Gateway - Participant SML status


Some actions are available depending on the participant status :

  • Prepare migration : Let you start the participant migration to another SMP than Babelway. It will generate a migration key that need to be exchange with the new SMP.

  • Migrate : If the participant is registered to another SMP in the SML, this action lets you migrate him to a Babelway SMP. The migration key received from the old SMP need to be entered.

  • Register : If the participant is not registered at all in the SML, you can register it by clicking on this action.

Registered Documents

Registered documents are UBL document type that are customized and categorized by PEPPOL business flows (i.e. : An UBL v2.1 Invoice that follows business specifications of the PEPPOL BIS 4a v2.0 ). One or more document types can be choose to configure the gateway.

PEPPOL In Gateway - Document types

Figure 4.50. PEPPOL In Gateway - Document types


Message Level Response

A Message Level Response (MLR) can be sent back to the sender of the PEPPOL message. A MLR is a business acknowledgment that tells the sender if the received message follows business rules related to the document type and business flow. You can choose the "MLR strategy" in the Gateway IN configuration.

PEPPOL Directory

Participants registered in the Babelway SMP can optionnally also be published to PEPPOL Directory.

Once your gateway is deployed, you will be able to see the defined identifiers in the PEPPOL directory ( http://directory.peppol.eu for Production, and http://test-directory.peppol.eu for Test environment).

Undeploying your gateway will delete the participants from the PEPPOL Directory.

Note that the process to add/delete participants to the PEPPOL Directory is asynchronous and might take some time until it actually shows up.

Here is the summary of gateway properties:

PEPPOL environment

Choose between the regular PEPPOL production infrastructure, connected to the SML, or the test infrastructure, connected to the SMK. The default is Production

Identifiers Values

The values identifying the PEPPOL participants. All values are mandatory.

The option 'Publish to PEPPOL directory' will only be taken into account if the PEPPOL participants is registered in the SMP of Babelway.

The 'label' of the PEPPOL participants will be used as the PEPPOL participant name in the PEPPOL directory (if the option is checked).

Registered Documents

List of documents accepted by this gateway and registered in the SMP.

Message Level Response

Using this option you can decide to send MLR directly after message reception. The options are :

  • Never send MLR MLR will never be sent automatically. The MLR is completely under the responsibility of the environment maintainer. This is the right choice if you want to generate a MLR based on the response of a back-end system or if the partner is not supporting MLR.

  • On invalid document, send MLR and stop message processing with an error MLR is sent automatically if the incoming message is not conforming to the documents customization business rules (schematron rules). In this case the MLR is return and the message is marked as 'ERROR' in Babelway. With this strategy, the 'SUCCESS' business acknowledgement flow can be based on the response of a back-end system.

  • On invalid document, send MLR and continue message processing MLR is sent automatically if the incoming message is not conforming to the documents customization business rules (schematron rules). In this case the MLR is return but the message is not marked as 'ERROR' in Babelway. With this strategy, the 'SUCCESS' business acknowledgement flow can be based on the response of a back-end system.

  • Always send MLR and stop message processing with an error MLR will always be sent back. An negative MLR is sent if the message is not conforming to the documents customization business rules (schematron rules), a positive MLR is sent otherwise. The message is put in error in case of a negative MLR.

  • Always send MLR and continue message processing MLR will always be sent back. An negative MLR is sent if the message is not conforming to the documents customization business rules (schematron rules), a positive MLR is sent otherwise. The message is not put in error in case of a negative MLR.

Participant SML status

The status of the participant in the PEPPOL SML

Access Point Key

The peppol key you received as an access point. If none is provided, the Babelway's key will be used.

SMP Key Alias

They key with which you wish to be registered as an SMP. If none is provided, your participants and documents will be registered on Babelway's SMP.

RosettaNet Gateway In

This gateway allows to receive RosettaNet complient PIP message from an other RosettaNet Server. The resulting message is the body of the Service Content section of the MIME message. Signature and Encryption are supported.

Url

URL of the RosettaNet server of the receiver.

Return receipt acknowledgment

Return the ReceiptAcknowledgment (RNIF v2.00) synchronously to the caller. If the option is not selected, the content of a valid ReceiptAcknowledgment is placed in the metadata of the message with the name 'RosettaNetReceiptIn' to be used later by the processing.

Decryption certificate

Select encryption certificate or go to certificates store.

Signature verification certificate

Select signature certificate or go to certificates store.

Note: In the "General" page for this Gateway In you can see the "Poll now" button. When clicking on this button this will poll all of the messages immediately (and will not wait for the next defined moment).

ePrior Gateway In

This Gateway allows to receive messages through ePrior requests.

The specific settings are:

Signature Verification Certificate

The X509 certificate used to verify the signature of the incomming ePrior requests.

Document Type

The document type which is accepted by the ePrior gateway.

Simpl.ePrior Gateway In

This Gateway allows to receive messages through Simpl.ePrior requests.

The specific settings are:

Signature Verification Certificate

The X509 certificate used to verify the signature of the incomming Simpl.ePrior requests.

NemHandel Gateway In

This gateway allows you to receive messages from the Danish NemHandel network.

Registration certificate

Select the certificate use to register your information into the NemHandel registry.

NemHandel environment

Choose between the regular NemHandel production infrastructure, or the test infrastructure. The default is Production

Identifiers Values

The values identifying the NemHandel participants.

Registered Documents

List of documents accepted by this gateway.

Signature certificate

Select signature certificate or go to certificates store.

Chorus Pro Gateway In

This gateway allows you to get information from the Chorus Pro platform, the french administration network.

Environment

This is the Chorus Pro environment you want to use: Production or Qualification.

Action type

This is the action you want to perform on the Chorus Pro platform. This includes :

  • invoice_status: This will fetch last 100 invoices you've submitted to the Chorus Pro platform and will create an XML document that looks like the following :

Technical API username

This is the technical username provided by chorus pro support to access the API through Babelway. More information on how to have that username can be found below.

Technical API password

This is the technical password provided by chorus pro support to access the API through Babelway. More information on how to have that password can be found below.

Cron Expression

Allows you to specify the frequency of the calls to the Chorus Pro platform with a cron expression. For easy creation of your cron expression, you can use the online cron maker tool available at: http://www.cronmaker.com/. For more information, please refer to the following page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

XML generated for the invoice_status action type :

<?xml version="1.0" encoding="UTF-8"?>
<ChorusInvoiceStatuses>
	<ChorusInvoiceStatus>
		<ChorusInvoiceId>530273</ChorusInvoiceId>
		<InvoiceType>FACTURE</InvoiceType>
		<InvoiceNumber>BABELWAY-7657654</InvoiceNumber>
		<DepositDate>2016-12-23</DepositDate>
		<InvoiceDate>2016-08-22</InvoiceDate>
		<InvoiceStatus>MISE_A_DISPOSITION</InvoiceStatus>
		<AmountToPay>49.2</AmountToPay>
		<Devise>USD</Devise>
		<ReceiverId>25773702</ReceiverId>
		<ReceiverCode>00000000008266</ReceiverCode>
		<ReceiverIdentifierType>SIRET</ReceiverIdentifierType>
		<ReceiverName>AAA118DESTINATAIRE</ReceiverName>
	</ChorusInvoiceStatus>
...
</ChorusInvoicesStatuses>
		

Oracle Fusion Gateway In

This Gateway allows to receive messages through Oracle Fusion Collaboration Message Framework (CMK).

The specific settings are:

Authentication Method

How the inbound message is authenticated. The two methods are HTTP's Basic authentication (username/password) or WS-Security signature

Username

Login or username to access the service.

Password

Password associated with previous username.

Signature Verification Certificate

The X509 certificate used to verify the signature of the incomming Oracle Fusion requests.

ConfirmBOD success code behavior

The value to use for the ProcessingResultCode in the ConfirmBOD message on successful message reception

SOAP Url

The endpoint for the SOAP Post protocol.

Email Gateway Out

With an Email Gateway Out, outgoing messages are attached to an email and sent to a specific email address.

The specific settings are:

To Recipients

Email address to which messages will be sent (destination). You can add a comma separated list of recipients or a metadata.

Cc Recipients

Email destination CC address.You can add a comma separated list of recipients or a metadata.

Bcc Recipients

Email destination Bcc address.You can add a comma separated list of recipients or a metadata.

Sending Email Address

Email address from which messages will appear to be sent. Replies will be sent to that address.

Secure Email

If checked, the email message is signed using the transfer certificate. The sending email address should be hub-XXXXX@babelway.net where XXXXX is your account environment id.

Track email using web beacon

If checked, a web beacon (an image containing a unique link) will be in the footer of the email. When the image is loaded for the first time, it will report it as an acknowledgement of the reception of the message. The message is successful when it has been delivered to all recipients, and opened by at least one.

Subject

Email message subject.

Body type

[text/plain , text/html] default is text/plain

Email body

Email message Body.

HTML codes < and > must be escaped.

See http://www.htmlescape.net/htmlescape_tool.html for an online tool.

Send message as attachment

Should the message be sent as attachment or not.

Attachment name

Attachment file name [with extension if applicable]. If empty, we will apply the default settings.

Send message as a link

Add a download link in the message body. When the link is first clicked, it will "acknowledge" the message and mark it as successful. The link expiration period is 30 days from the moment the link is sent.

Text of message link

This is the text displayed for the download link. Default: "download message".

Attachments

Allows you to attach other files to the email. Name = filename of the attachment. Value = Pattern to match metadata containing the file to attach. If one pattern matches multiple files, it is possible to attach them all if you guarantee to generate a different filename name for each. This can be achieved by using the capturing groups of the regex in the filename. Ex: if your metadata pattern is attachment-(.*) and your filename is \1, processing with two metadata attachment-file1.csv and attachment-file2.csv will result in files file1.csv and file2.csv.

Enable DKIM authentication

Allows you to sign the outgoing message with a DKIM signature.

DKIM Domain Selector

Domain selector of the domain signing the message. This selector will be used by recipient to query DNS of giving domain.

DKIM Private Key

Private key to sign the message with.

FTP Client Gateway Out

With a Ftp Client Out Gateway, outgoing messages are transferred to an external Ftp server. You may wish to use this gateway for example to integrate with Wayfair.

The following fields should be defined in order to configure access to your external ftp server:

Server

External ftp server address where Babelway should send messages eg ftp.example.com.

Username

Login or username to access files on this external ftp server.

Password

Password associated with the username.

Passive Mode

Indicates that the ftp connection is in passive. Ticking it means the ftp client will establish 2 connections to the ftp server.

Retry strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

Directory

Directory where outgoing files will be stored on the server.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Filename during transfer

Prefix and suffix that will be prepended and appended to the file name when a file is being transferred. This mechanism is used to prevent that a file is read before it is complete. However some systems do not allow to remotely rename files or directly process and delete the file triggering an ERROR in Babelway.

Protocol

Select FTP, FTPS (Explicit mode) or FTPS (Implicit mode) protocol.

Private Key

The private key associated with the username to access your account. This can be left empty if you choose to only use the password authentication mechanism.

FTP Server Gateway Out

With a Ftp Server Out Gateway, outgoing messages are available from a Babelway FTP server, where they can be fetched.

The specific settings are:

Server

Babelway ftp server is the hostname for the ftp server where the files will be made available to download.

Username

Login or username to access your account on Babelway ftp server. This username must be unique as it is linked to a specific directory on the ftp server.

Password

Password associated with the username to access your account.

Directory

The directory on the ftp server into which the outgoing files will be written.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Time out

During how much time the file will be kept available on the FTP server.

After this timeout, the file will be automatically removed from the FTP server (it you did not do it before). If the file was never downloaded, the file will also be marked in ERROR, because it has not reached its destination.

To be warned the soonest possible of errors, we recommend that you set here the lowest possible value. Example : if an automatic process polls the files from here every hour, a value of "3 hours" will allow you to be notified of the problem after just 2 or 3 failed/missing pollings, while a value of "30 days" would lead to files leaving there, without any automatic notification, until some user worries about lack of files.

After channel deployment, your ftp server will be available to receive messages. You can access this ftp server using any ftp client software set up with the previous account settings.

Note: The ports used for the FTP connections in Babelway are: (FTP, FTPs explicit : 20020-21020, FTPs implicit : 22021-23020).

SFTP Server Gateway Out

With a Sftp Server Out Gateway, outgoing messages are available from a Babelway FTP server, where they can be fetched.

The specific settings are:

Server

Babelway sftp server is the hostname for the sftp server where the files will be made available to download.

Username

Login or username to access your account on Babelway ftp server. This username must be unique as it is linked to a specific directory on the ftp server.

Password

Password associated with the username to access your account.

Public Key

The public key associated with the username. This can be left empty if you choose to only use the password authentication mechanism. The supported formats are RSA public key (OpenSSH, Putty or DER format). More information about generating such a key can be found at the end of this page.

Directory

The directory on the ftp server into which the ougoint files will be written.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Time out

During how much time the file will be kept available on the FTP server.

After this timeout, the file will be automatically removed from the FTP server (it you did not do it before). If the file was never downloaded, the file will also be marked in ERROR, because it has not reached its destination.

To be warned the soonest possible of errors, we recommend that you set here the lowest possible value. Example : if an automatic process polls the files from here every hour, a value of "3 hours" will allow you to be notified of the problem after just 2 or 3 failed/missing pollings, while a value of "30 days" would lead to files leaving there, without any automatic notification, until some user worries about lack of files.

After channel deployment, your sftp server will be available to receive messages. You can access this sftp server using any sftp client software set up with the previous account parameters.

SFTP Client Gateway Out

With a SFTP Client Out Gateway, outgoing messages are transferred to an external SFTP server.

The specific settings are:

Server

External sftp server address where Babelway will send messages.

Username

Login or username to access files on this external sftp server.

Password

Password associated with the username to access account.

Private Key

The private key associated with the previous username to access your account. This can be left empty if you choose to only use the password authentication mechanism. The supported formats are RSA private key (OpenSSH format).

Retry strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

Directory

Directory where outgoing files will be stored on the server.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Filename during transfer

Prefix and suffix that will be prepended and appended to the file name when a file is being transferred. This mechanism is used to prevent that a file is read before it is complete. However some systems do not allow to remotely rename files or directly process and delete the file triggering an ERROR in Babelway.

Babelway provides a unique private key per environment named Transfer that can be used in "private Key" and then share the "public key" one with the partner, For the SFTP Client Gateway Out when using the public and private key authentication mechanism.

Below in the steps that you will follow to be able to use this certificate.

1-You do need to set the private key on Babelway and share the public one with your partner, From the GATEWAY OUT (SFTP_CLIENT) select "Transfer" from the dropdown of the Private Key.

SFTP Gateway Out

Figure 4.51. SFTP Gateway Out


2-The public key to provide to your partner can be downloaded from Channels -> Certificates -> Your certificates

Your Certificates

Figure 4.52. Your Certificates


3-By downloading the SSH version and sending it to your partner to add it into his SFTP server implemenation.

Key Certificate Detail

Figure 4.53. Key Certificate Detail


Note: Babelway By default connect to the remote SFTP server on port 22 but if you want to connect to this remote SFTP server using different port then use the below.

In the Server field add the port number you want to use it, For example if use X.X.X.X:1722 in the Server field which means connect to the remote SFTP server X.X.X.X on port 1722.

OFTP Client Gateway Out

With an OFTP Client out Gateway, outgoing messages are transferred to an external OFTP server.

The specific settings are:

Partner SSID

The OFTP ID provided by your partner.

Partner SFID

The SFID provided by your partner. If none has been provided, this is probably the same as the SSID.

Partner password

The password of your partner. Provided by your partner.

My SSID

Babelway is providing an official Odette SSID : O01770000000000X0B5SHARED. Please call support if you want to use a different one.

My SFID

An SFID is automatically assigned to your Environment : O01770000000000X0B5xxxxx where xxxxx is the ID of your Babelway environment. Please call support if you want to use a different one.

My password

The value of the password is 'BABELWAY'.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

OFTP documentation

File containing instructions and certificates for the installation. You should download it and send it to your OFTP partner.

ISDN number

List of phone numbers used for ISDN communication instead of Internet communication. The expected format is a comma separated list of phone numbers ex : 0049511211306466 or 0049511211306466,003221234567

Max nb datablocks

Advanced. Control the OFTP "maxBDataBlocks" parameter (ISDN only). Default is 7

Max size datablock

Advanced. Control the OFTP "maxBDataLen" parameter (ISDN only). Default is 1024

Server

The URL of the server of your partner. It is provided by your partner.

Port

The port to connect to. It is provided by your partner.

Use TLS

Use TLS (SSL) for communication

Secure Authentication Certificate

Use this certificate to perform client side TLS (SSL) authentication.

Skip EERP

Select this if your partner is not sending the mandatory EERP. The message will be set in SUCCESS directly after upload.

Use compression

Compresses the messages.

Secure Authentication

Use OFTP2 'Secure Authentication'. This will use the certificates defined for encryption and signature.

Sign messages

Sign outgoing messages using the key selected in "Signature certificate". This allows your partner to verify that you are the one sending the message. This option is only available with OFTP 2.0.

Signature certificate

Select signature certificate or go to certificates store. This option is only available with OFTP 2.0.

Encrypt messages

Encrypt outgoing messages using the certificate selected in "Encryption certificate". This allows your partner to be the only one able to decrypt the messages sent. This option is only available with OFTP 2.0.

Encryption certificate

Select encryption certificate or go to certificates store.

Encryption algorithm

Select encryption algorithm or go to certificates store.

Receive signed messages

This allows you to verify that your partner is the one sending the message using the certificate selected in "Signature verification certificate". This option is only available with OFTP 2.0.

Signature verification certificate

Select certificate for data or go to certificates store.

Request signed ack (EERP)

Requests that incoming acknowledgments are signed. The signature will be verified using the Certificate selected in "EERP verification certificate". This allows you to be sure that only the partner could have signed the incoming messages. This option is only available with OFTP 2.0.

EERP verification certificate

Select certificate for EERP or go to certificates store.

Transfer mode

Advanced. Once the connection is open, the OFTP gateway will act as both sender and receiver by default. You can control this by setting the following values : BOTH / RECEIVER_ONLY / SENDER_ONLY

Version

Advanced. Babelway is supporting both OFTP1 and OFTP2. When a connection is open, Babelway is using the OFTP built-in mechanism to negotiate the protocol version. The protocol will be the highest possible. Valid values are : OFTP_V12 for version 1.2 / OFTP_V13 for version 1.3 / OFTP_V14 for version 1.4 / OFTP_V20 for version 2.0

File format

Advanced. Babelway is supporting all types of records. Valid values are : FIXED / TEXTFILE / UNSTRUCTURED / VARIABLE. Default is UNSTRUCTURED

Record max size

Advanced. You can specify the record size (only used for FIXED and VARIABLE)

Credit Count

Advanced. Control the OFTP "creditCount" parameter. This is the number of data command ( = CREDIT) that could be exchanged prior to an OFTP confirmation from the partner. Default is 64

Data exchange buffer size

Advanced. Control the OFTP "dataExchangeBufferSize" parameter. This is the size of the OFTP data buffer. It should be smaller than the maxBDataLen for ISDN connection. The minimum is 128 bytes and the maximum is 4096 for ISDN and 65535 for TCP connections. Default is 1024

Retry strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

After channel deployment, your Oftp server will be available to send messages. You can access this oftp server using any Oftp client software set up with the previous account settings.

After channel deployment, your Oftp server will be available to send messages. You can access this oftp server using any Oftp client software set up with the previous account settings.

If you require a custom SSID / SFID / PASSWORD, please send a request to support@babelway.com .

When a message is transferred to the Oftp server, it is processed immediately then the original file is removed from the server.

Note: When sending the message through this "Gateway Out" and the message fell in error "Unable to establish TLS connection to remote OFTP server for SSID XXXXXXXXXXX due to : General SSLEngine problem", This error means that there is a problem occurred while building SSL connection with the remote server, In order to fix this issue we will need to trust the self-signed SSL certificate used in the remote server by following the below steps.

1-From the "certificates" page in the "Trusted certificates" tab click on the "Trust new certificate" button.

Provide the sever IP and Port or URL and Port in the "Trusted Url" field then click on the "Trust root certificate", as shown below.

Lookup table detail - duplicate table

Figure 4.54. Lookup table detail - duplicate table


After that done forget to deploy the environment in order to push this changes to production, Then the messages should be processed successfully.

OFTP Server Gateway Out

With an OFtp server Gateway out, outgoing messages are available from a Babelway OFTP server.

The specific settings are:

Partner SSID

The OFTP ID provided by your partner.

Partner SFID

The SFID provided by your partner. If none has been provided, this is probably the same as the SSID.

Partner password

The password of your partner. Provided by your partner.

My SSID

Babelway is providing an official Odette SSID : O01770000000000X0B5SHARED. Please call support if you want to use a different one.

My SFID

An SFID is automatically assigned to your Environment : O01770000000000X0B5xxxxxx where xxxxx is the ID of your Babelway environment.. Please call support if you want to use a different one.

My password

The value of the password is 'BABELWAY'.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

OFTP documentation

File containing instructions and certificates for the installation. You should download it and send it to your OFTP partner.

Skip EERP

Select this if your partner is not sending the mandatory EERP. The message will be set in SUCCESS directly after upload.

Use compression

Compresses the messages.

Secure Authentication

Use OFTP2 'Secure Authentication'. This will use the certificates defined for encryption and signature.

Sign messages

Sign outgoing messages using the key selected in "Signature certificate". This allows your partner to verify that you are the one sending the message. This option is only available with OFTP 2.0.

Signature certificate

Select signature certificate or go to certificates store. This option is only available with OFTP 2.0.

Encrypt messages

Encrypt outgoing messages using the certificate selected in "Encryption certificate". This allows your partner to be the only one able to decrypt the messages sent. This option is only available with OFTP 2.0.

Encryption certificate

Select encryption certificate or go to certificates store.

Encryption algorithm

Select encryption algorithm or go to certificates store.

Receive signed messages

This allows you to verify that your partner is the one sending the message using the certificate selected in "Signature verification certificate". This option is only available with OFTP 2.0.

Signature verification certificate

Select certificate for data or go to certificates store.

Request signed ack (EERP)

Requests that incoming acknowledgments are signed. The signature will be verified using the Certificate selected in "EERP verification certificate". This allows you to be sure that only the partner could have signed the incoming messages. This option is only available with OFTP 2.0.

EERP verification certificate

Select certificate for EERP or go to certificates store.

Transfer mode

Advanced. Once the connection is open, the OFTP gateway will act as both sender and receiver by default. You can control this by setting the following values : BOTH / RECEIVER_ONLY / SENDER_ONLY

Version

Advanced. Babelway is supporting both OFTP1 and OFTP2. When a connection is open, Babelway is using the OFTP built-in mechanism to negotiate the protocol version. The protocol will be the highest possible. Valid values are : OFTP_V12 for version 1.2 / OFTP_V13 for version 1.3 / OFTP_V14 for version 1.4 / OFTP_V20 for version 2.0

File format

Advanced. Babelway is supporting all types of records. Valid values are : FIXED / TEXTFILE / UNSTRUCTURED / VARIABLE. Default is UNSTRUCTURED

Record max size

Advanced. You can specify the record size (only used for FIXED and VARIABLE)

Credit Count

Advanced. Control the OFTP "creditCount" parameter. This is the number of data command ( = CREDIT) that could be exchanged prior to an OFTP confirmation from the partner. Default is 64

Data exchange buffer size

Advanced. Control the OFTP "dataExchangeBufferSize" parameter. This is the size of the OFTP data buffer. It should be smaller than the maxBDataLen for ISDN connection. The minimum is 128 bytes and the maximum is 4096 for ISDN and 65535 for TCP connections. Default is 1024

Time out

During how much time the file will be kept available on the OFTP server.

After this timeout, the file will be automatically removed from the OFTP server (it you did not do it before). If the file was never downloaded, the file will also be marked in ERROR, because it has not reached its destination.

To be warned the soonest possible of errors, we recommend that you set here the lowest possible value. Example : if an automatic process polls the files from here every hour, a value of "3 hours" will allow you to be notified of the problem after just 2 or 3 failed/missing pollings, while a value of "30 days" would lead to files leaving there, without any automatic notification, until some user worries about lack of files.

After channel deployment, your Oftp server will be available to send messages. You can access this oftp server using any Oftp client software set up with the previous account settings.

If you require a custom SSID / SFID / PASSWORD, please send a request to support@babelway.com .

When a message is transferred to the Oftp server, it is processed immediately then the original file is removed from the server.

AS2 Gateway Out

With an AS2 Gateway, outgoing messages are transmitted using an AS2 connection. Common trading partners using AS2 include Walmart, Amazon and Wayfair.

AS2 (Applicability Statement 2) is a specification about how to transport data securely and reliably over the Internet. Security is achieved by using digital certificates and encryption.

The following fields should be defined in order to configure your AS2 access:

From

Babelway source server.

To

AS2 ID of the server that receives outgoing messages. Provided by your partner.

type

MIME/TYPE used to transfer the AS2 message to your partner. Possible values are :

"edi", for the content type "application/EDIFACT".

"x12", for the content type "application/EDI-X12".

"eco", for the content type "application/edi-consent".

"xml", for the content type "application/XML".

"bin", for the content type "application/ octet-stream".

DEFAULT is "bin".

Attachment name

Name of the file sent by AS2. This is an extension to the base AS2 specification and might not be supported by all partners. By default no file name is sent.

Recipient address

The endpoint URL of the receiving gateway ,requires protocol prefix in URL (http:// or https://).

AS2 documentation

File containing instructions and certificates for the installation. You should download it and send it to your AS2 partner.

Compress message

Should the message be compressed or not?

Encrypt message

Should the message be encrypted or not?

Certificate for encryption

Certificate used for message encryption. Provided by your partner.

Encryption algorithm

Select algorithm used for encrypting message, if any.

Sign message

Should the message be signed or not?

Certificate for signature

Local certificate to use for signing AS2 messages. The certificates are kept in the environment certificates store.

Signing algorithm

Select algorithm used for signing the AS2 message. DEFAULT is SHA-1.

Request receipt

Should a receipt be sent when a request is received or not.

Asynchronous receipt

Should the receipt be sent asynchronously or not.

Signed receipt

Should the receipt be signed or not.

MIC algorithm

Select Message Integrity Code algorithm used to compute the MDN of the message. DEFAULT is SHA-1.

Message signature enforced

Should message signature be enforced or not. This parameter only applies if no AS2 IN gateway is configured for this partner (same AS2 FROM and AS2 TO).

Certificate for verification

Certificate used for message verification. Provided by your partner. This parameter only applies if no AS2 IN gateway is configured for this partner (same AS2 FROM and AS2 TO).

Maximum retries

Maximum number of retries if message sending failed. Default is 8 times.

Retry interval

Interval of time before trying to send message again (in seconds). Default is 1800 (30 minutes).

To report AS2 parameters to the other party, dowload the AS2 documentation ZIP file. This file can be sent to the other party to give them all parameters they will require to establish a communication with your channel.

Walmart requires their suppliers to use AS2 to connect with them: learn more.

Note: The Listening ports for the AS2 Gateway are:

  • When using the HTTPS protocol the Listening port is 443.

  • When using the HTTP protocol the Listening port is 80.

Http Client Gateway Out

With an HttpClientOut Gateway, outgoing messages are sent using a Http connection.

All the user defined metadatas defined in the messages are passed in the context of the new message.

The specific settings are:

Url

External service address.

Support HTTP and HTTPS protocols.

Username

Login or username to access the service.

Password

Password associated with the username.

Connected gateway

Select zero, one or several gateways to receive the response from the http server.

Valid HTTP return code

Comma separated list of expected return Http code which evaluates the response HTTP code in the header. If the return code is not in the list, the message is set in error. The default is '200,201,202,204,205'.

Success expression

The success expression is a regex that evaluates the HTTP response body. If the response doesn't match the success expression, the message is flagged with 'error' status.

Response filename

You can specify a filename that will be associated with the server response. Default is 'attachment'.

User Metadata Transfer Strategy

The strategy that will be used to transfer the user metadata to the response message created in the connected gateways.

Retry strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Timeout

Timeout for connection in milliseconds. Must be between 10000 and 240000.

Http Method

You can specify the http method to call. 'Form Posting' is emulating a browser Form Post using mime multipart. The default is POST.

TLS version

You can specify the version of the TLS protocol. TLS is the replacement of SSL. The default is TLSv1.2.

Message parameter name

Name given to the parameter containing the actual message. This is also equivalent to the FORM parameter when a POST if done from a web browser.

Extra parameters

Extra parameters to inlude in the message. Name is the parameter name (FORM parameter) and the value is the name of a metadata containg the parameter content. In case of a binary content, the name of the metadata will also be used as the 'filename' of the parameter.

Http headers

You can add specific http header. This accepts metadata.

Trust level

The trust level defines the level of security used in the SSL handshake. Relax = No certificate verification, Standard = trusting certificates in environment certificates as well as known CA's, Paranoiac = only trusts certificates defined in the environmnent certificates. Mutual = requires 2-way authentication.

Authentication method

You can select from FORM, BASIC, DIGEST, NTLM, CERT, OAUTH1, OAUTH2, ANY or TOKEN. CERT is 2-way SSL authentication. ANY is BASIC, DIGEST or NTLM depending on the server response.

Preemptive authentication

Allows to send authentication information with the first http request (to avoid making a second request). Only for BASIC or DIGEST authentication.

Login url

If authentication method is FORM.

Authentication form fields

When using FORM authentication, you can add specific authentication form fields to the authentication call. This accepts metadata.

Metadata from response

You can use data receive by the login request as metadata, which can be used in the data sending after login.

2-way auth. certificate

If CERT authentication is used (2-way SSL authentication), this allows to select the key pair to use from the environment certificate.

Oauth bearer

If OAUTH2 authentication is used, this allows select the OAUTH bearer token to use.

Oauth signature method

If OAUTH1 authentication is used, this allows select the signature algorithm to use. Note that if SHA1withRSA is used, a Key alias must be selected.

Oauth consumer key

If OAUTH1 authentication is used, this allows defined the consumer key. This is mandatory.

Oauth consumer secret

If OAUTH1 authentication is used, this allows defined the consumer secret. This is optional.

Oauth token

If OAUTH1 authentication is used, this allows defined the token. At this version of Babelway this is mandatory, please contact support if you need to retreive the token from an OAUth handsake.

Oauth token secret

If OAUTH1 authentication is used, this allows defined the token secret. This is optional.

Oauth RSA key

If OAUTH1 authentication is used with SHA1withRSA, this allows to select the key signing the OAUTH authentication.

After channel deployment, your connection will be available to send messages.

Note: The sent HTTP request has a default content type of "text/html" and if you need to change it based in the output message, you can add the desired Content-Type in the headers section under the properties of the HTTP Client Gateway OUT as seen below:

1- Click on the properties of the HTTP Client Gateway OUT as seen below:

Go to the Properties of the HTTP Client Gateway OUT

Figure 4.55. Go to the Properties of the HTTP Client Gateway OUT


2- Add the desired Content-Type in the headers section (fo example "application/json") as seen below:

Add the desired Content-Type

Figure 4.56. Add the desired Content-Type


SOAP Client Gateway Out

With an SoapClientOut Gateway, outgoing messages are sent using a SOAP call.

All the user defined metadatas defined in the messages are passed in the context of the new message.

The specific settings are:

Url

External service address.

Username

Login or username to access the service.

Password

Password associated with the username.

Connected gateway

Select zero, one or several gateways to receive the response from the http server.

SoapFault strategy

If an error occurs during processing, the response to a SOAP message is a SOAP fault element in the body of the message, and the fault is returned to the sender of the SOAP message.

Standard Soap protocol suggests that they should be sent with a 500 HTTP error code, but some systems still send it with a HTTP 200 ok return code.

Choose here how you want to handle your Soap Fault messages:

1) You can treat them as normal messages and therefore, no special rules applies. If they arrive with a HTTP 500 error code, you should add 500 in the list of valid return code. Otherwise, they will end up in error, as normal messages.

2) You can always treat them as Error. Even if we receive them via a valid HTTP response code, the message will be put in error.

3) You can always treat them as Successful messages. Even if we receive them via a invalid HTTP return code, the message will be put in success and possibly transferred to a connected gateway.

Valid HTTP return code

Comma separated list of expected return Http code. If the return code is not in the list, the message is set in error. The default is '200,201,202,204,205'.

Success expression

The success expression is a regex. If the response doesn't match the success expression, the message is flagged with 'error' status.

Response filename

You can specify a filename that will be associated with the server response. Default is 'attachment'.

User Metadata Transfer Strategy

The strategy that will be used to transfer the user metadata to the response message created in the connected gateways.

Retry strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Http Method

You can specify the http method to call. The default is POST.

Timeout

Timeout for connection in milliseconds. Must be between 10000 and 240000.

Http headers

You can add specific http header. This accepts metadata.

SOAPAction http header

Value of the SOAPAction http header.

SOAP Attachments

Allows to specify one or more soap attachments, based on SOAP with Attachments (SwA) using MIME. Name will be sent as 'ContentId' of the mime part of the attachment and Value must contain the name of the metadata containing the String or byte array body of the attachment.

Trust level

The trust level defines the level of security used in the SSL handshake. Relax = No certificate verification, Standard = trusting certificates in environment certificates as well as known CA's, Paranoiac = only trusts certificates defined in the environmnent certificates. Mutual = requires 2-way authentication.

Authentication method

You can select from FORM, BASIC, DIGEST, CERT or ANY. CERT is 2-way SSL authentication. ANY is BASIC, DIGEST or NTLM depending on the server response.

Preemptive authentication

Allows to send authentication information with the first http request (to avoid making a second request). Only for BASIC or DIGEST authentication.

Login url

If authentication method is FORM.

Authentication form fields

When using FORM authentication, you can add specific authentication form fields to the authentication call. This accepts metadata.

2-way auth. certificate

If CERT authentication is used (2-way SSL authentication), this allows to select the key pair to use from the environment certificate.

Soap headers

You can add specific soap header. This accepts metadata.

Soap version

Defined the standard version of the remote SOAP service.

Ws-Security profile

Ws-Security profile defines the type of security required to call the SOAP service.

Ws-Security Username

Ws-Security username is used in the username/token digest profile.

Ws-Security token

Ws-Security token is used in the username/token digest profile.

Ws-Security signing key

Ws-Security username is used in the X.509 signing profiles.

Ws-Security encryption certificate

Ws-Security username is used in the X.509 encryption profiles.

After channel deployment, your connection will be available to send messages.

Oracle Fusion Gateway Out

With an Oracle Fusion Out Gateway, outgoing messages are sent to a Oracle Fusion CMK endpoint using a SOAP call.

All the user defined metadatas defined in the messages are passed in the context of the new message.

The specific settings are:

Url

External service address.

Username

Login or username to access the service.

Password

Password associated with the username.

Connected gateway

Select zero, one or several gateways to receive the response from the http server.

SoapFault strategy

If an error occurs during processing, the response to a SOAP message is a SOAP fault element in the body of the message, and the fault is returned to the sender of the SOAP message.

Standard Soap protocol suggests that they should be sent with a 500 HTTP error code, but some systems still send it with a HTTP 200 ok return code.

Choose here how you want to handle your Soap Fault messages:

1) You can treat them as normal messages and therefore, no special rules applies. If they arrive with a HTTP 500 error code, you should add 500 in the list of valid return code. Otherwise, they will end up in error, as normal messages.

2) You can always treat them as Error. Even if we receive them via a valid HTTP response code, the message will be put in error.

3) You can always treat them as Successful messages. Even if we receive them via a invalid HTTP return code, the message will be put in success and possibly transferred to a connected gateway.

Valid HTTP return code

Comma separated list of expected return Http code. If the return code is not in the list, the message is set in error. The default is '200,201,202,204,205'.

Success expression

The success expression is a regex. If the response doesn't match the success expression, the message is flagged with 'error' status.

Response filename

You can specify a filename that will be associated with the server response. Default is 'attachment'.

User Metadata Transfer Strategy

The strategy that will be used to transfer the user metadata to the response message created in the connected gateways.

Retry strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Http Method

You can specify the http method to call. The default is POST.

Timeout

Timeout for connection in milliseconds. Must be between 10000 and 240000.

Http headers

You can add specific http header. This accepts metadata.

SOAPAction http header

Value of the SOAPAction http header.

SOAP Attachments

Allows to specify one or more soap attachments, based on SOAP with Attachments (SwA) using MIME. Name will be sent as 'ContentId' of the mime part of the attachment and Value must contain the name of the metadata containing the String or byte array body of the attachment.

Trust level

The trust level defines the level of security used in the SSL handshake. Relax = No certificate verification, Standard = trusting certificates in environment certificates as well as known CA's, Paranoiac = only trusts certificates defined in the environmnent certificates. Mutual = requires 2-way authentication.

Authentication method

You can select from FORM, BASIC, DIGEST, CERT or ANY. CERT is 2-way SSL authentication. ANY is BASIC, DIGEST or NTLM depending on the server response.

Preemptive authentication

Allows to send authentication information with the first http request (to avoid making a second request). Only for BASIC or DIGEST authentication.

Login url

If authentication method is FORM.

Authentication form fields

When using FORM authentication, you can add specific authentication form fields to the authentication call. This accepts metadata.

2-way auth. certificate

If CERT authentication is used (2-way SSL authentication), this allows to select the key pair to use from the environment certificate.

Soap headers

You can add specific soap header. This accepts metadata.

Soap version

Defined the standard version of the remote SOAP service.

Ws-Security profile

Ws-Security profile defines the type of security required to call the SOAP service.

Ws-Security Username

Ws-Security username is used in the username/token digest profile.

Ws-Security token

Ws-Security token is used in the username/token digest profile.

Ws-Security signing key

Ws-Security username is used in the X.509 signing profiles.

Ws-Security encryption certificate

Ws-Security username is used in the X.509 encryption profiles.

After channel deployment, your connection will be available to send messages.

ePrior Gateway Out

With ePrior Out Gateway, outgoing messages are made available on Babelway ePrior server.

The specific settings are:

Signature Verification Certificate

The X509 certificate used to verify the signature of the incomming ePrior requests.

Consumer Identifier

The identification of the consumer from which the ePrior request comes from.

Receiver Identifier

The identification of the party to which the ePrior document is sent.

Sender Identifier

The identification of the party from which the ePrior document is sent.

Document Type

The type of the ePrior document.

Document Identifier

The identification of the ePrior document.

Time out

During how much time the file will be kept available on the ePrior server.

After this timeout, the file will be automatically removed from the ePrior server (it you did not do it before). If the file was never downloaded, the file will also be marked in ERROR, because it has not reached its destination.

To be warned the soonest possible of errors, we recommend that you set here the lowest possible value. Example : if an automatic process polls the files from here every hour, a value of "3 hours" will allow you to be notified of the problem after just 2 or 3 failed/missing pollings, while a value of "30 days" would lead to files leaving there, without any automatic notification, until some user worries about lack of files.

Simpl.ePrior Gateway Out

With Simpl.ePrior Out Gateway, outgoing messages are made available on Babelway Simpl.ePrior server.

The specific settings are:

Signature Verification Certificate

The X509 certificate used to verify the signature of the incomming Simpl.ePrior requests.

Consumer Identifier

The identification of the consumer from which the Simpl.ePrior request comes from.

Receiver Identifier

The identification of the party to which the Simpl.ePrior document is sent.

Sender Identifier

The identification of the party from which the Simpl.ePrior document is sent.

Document Type

The type of the Simpl.ePrior document.

Document Identifier

The identification of the Simpl.ePrior document.

Time out

During how much time the file will be kept available on the Simpl.ePrior server.

After this timeout, the file will be automatically removed from the Simpl.ePrior server (it you did not do it before). If the file was never downloaded, the file will also be marked in ERROR, because it has not reached its destination.

To be warned the soonest possible of errors, we recommend that you set here the lowest possible value. Example : if an automatic process polls the files from here every hour, a value of "3 hours" will allow you to be notified of the problem after just 2 or 3 failed/missing pollings, while a value of "30 days" would lead to files leaving there, without any automatic notification, until some user worries about lack of files.

Http Gateway Out

With a HTTP out Gateway, outgoing messages are available from a Babelway HTTP server.

The specific settings are:

Username

Login or username to access the service .

Password

Password associated with the username.

SOAP HTTP(S) Url

using the SOAP Post protocol. WSDL

Support HTTP and HTTPS protocols.

Content encoding

How to encode the content

Time out

During how much time the file will be kept available on the HTTP server.

After this timeout, the file will be automatically removed from the HTTP server (it you did not do it before). If the file was never downloaded, the file will also be marked in ERROR, because it has not reached its destination.

To be warned the soonest possible of errors, we recommend that you set here the lowest possible value. Example : if an automatic process polls the files from here every hour, a value of "3 hours" will allow you to be notified of the problem after just 2 or 3 failed/missing pollings, while a value of "30 days" would lead to files leaving there, without any automatic notification, until some user worries about lack of files.

After channel deployment, your connection will be available to send messages.

Note:

1- The HTTP server Gateway uses the port 80 for HTTP and 443 for HTTPS.

2- You will need to download the WSDL file for this gateway by using the SOAP URL in the browser then login using the user name and password for this gateway in order to download the WSDL file for this environment as for some environments the SOAP URL and the WSDL file are different from other environments.

X.400 Gateway Out

The X.400 out Gateway allows to send the message on the X.400 network to the address of your trading partner.

X.400 Address

The account private address. This is the address to communicate to your trading partner. The formatting may vary from one partner to the other. The most common formats are: C=WW; A=400NET; P=BABELWAY; S=HUB-25333 /C=WW/A=400NET/P=BABELWAY/S=HUB-25333.

Partner Manual Address

You can choose to enter the full address in the "manual address field" or each address component in the corresponding field.

Partner Country

Country = C value

Partner ADMD

Partner Administration Management Domain Name = A value

Partner PRMD

Partner Private Management Domain Name = P value

Partner Organization

Partner Organization = O value

Partner OU1

Partner Organizational Unit 1

Partner Given Name

Partner Given Name

Partner Initial

Partner Initial

Partner Surname

Partner Surname = S value

Partner Generation

Partner Generation Qualifier

Request receipt

Request a X.400 message delivery notification

Send as binary

Send the X.400 message as binary (using bilaterally-defined body part)

Internal Gateway Out

The internal gateway in / out are used to transfer messages between 2 channels within the same Babelway environment.

All the user defined metadatas defined in the messages are passed in the context of the new message.

The specific settings are:

Connected Gateways

Select the internal gateways In that will receive the message. You can select multiple gateway in. A copy of the message will be sent to each of them.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Response Filename

Filename of the Response message.

User Metadata Transfer Strategy

The strategy that will be used to transfer the user metadata to the new message created in the connected gateways.

As opposed to most other gateways, the internal gateway is immediately available as gateway out for other channels configuration without requiring a channel deployment.

Null Gateway Out

The null gateway can be used for test and development purposes. The outgoing message will not be sent anywhere and remain in Babelway.

Outgoing messages will not be forwarded but they are nevertheless created and readable through the Messages interface. You may use this gateway for testing your messages before going to production or for preventing a channel to send messages before deployment.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Splitter Gateway Out

The splitter gateway OUT enables to split a message into multiple messages. The splitter can split according to RegEx, XPath, Edifact or X12 expressions. The resulting messages are forwarded to one or more channels in the same environment.

The specific settings are:

Connected gateways

Select the internal gateways In that will receive the split messages. You can select multiple gateway in. A copy of the message will be sent to each of them.

Split type

The split type determines how the file will be analyzed (text, xml, edifact) to split it in parts.

Message Delay

Introduces a delay (in seconds, up to maximum 300 seconds) before it sends out each message. For example, if the delay is set to 30 and the split generates 4 messages, each message will be sent 30 seconds appart with the last message dispatched 1.5 minutes after the split.

User Metadata Transfer Strategy

The strategy that will be used to transfer the user metadata to the new message created in the connected gateways.

Filename

Filename of the parent message [with extension if applicable]. If empty, we will apply the default settings.

Response filename

Filename of the split message.

Header expression

Regex expression to create a header added to each split message

Regular expression

RegEx expression to select the content of the split message.

[\n](?=EE)

which means split when seeing line return and then EE

Lines

Split the message every so many lines

Xpath expression

XPath to select the content of the split message.

Footer expression

Regex expression to create a footer added to each split message

Keep xml parents

Keep the parent node of the split xml. Only valid with XPath splitting.

Omit xml declaration

Skip the xml declaration in the split xml. Only valid with XPath splitting.

Input charset

Charset to use to decode file waiting to be split.

Output charset

Charset to use to encode the file resulting of the splitting.

Aggregator Gateway Out

The aggregator gateway OUT enables to aggregate messages into one single file. The aggregator can append the messages, use an xslt to merge xml documents or merge Edifact or X12 documents. The resulting message is forwarded to one or more channels in the same environment.

All the user defined metadata in the first of the aggregated messages are passed in the context of the aggregated message.

The specific settings are:

Send aggregate to gateway(s)

The internal gateway where to send the aggregated message. You can select multiple gateways in. A copy of the message will be sent to each of them.

Aggregation type

Select 'append' for simple append. Use header, separator and footer to control the aggregation. Select 'xml' to create an aggregation of xml document. Optionally an xslt can be applied to the result. Select 'edifact' or 'x12' to merge edi documents; the envelope of the first document will be used. Select 'zip' to wrap messages in a single zip file. Select 'tar' to wrap messages in a single tar file.

Group by metadata

Optional. Enables to generate different aggregated files grouping incoming messages based on the value of a metadata. Example: 3 messages arrive with value A, B and A in the selected metadata. The aggregator will generate 1 file with the 2 messages with value A and 1 file with 1 message with the value B.

Maximum file size (MB)

Optional. By default, Babelway will put the message in error if it exceeds the maximum size allowed by the system (check documentation on allowed file sizes). If you specify a value, when the number of MB of the generated file reaches that value, Babelway will generate a message with the current values and start again with another file until all messages are processed.

Max file size naming strategy

Specifies how you want Babelway to differentiate files when split by the "Max file size" parameter. Either alphabetical append (alpha: filename, filename-a, filename-b, ...) or numeric append (numeric: filename, filename-1, filename-2, ...).

Frequency

Frequency in seconds. Default is 300 (5 minutes).

Cron expression

Cron expression. Allows you to define complex time expressions like every weekday night at 23:00 (0 23 ? * MON-FRI). This takes precedence on the frequency property. For easy creation of your cron expression, you can use the online cron maker tool available at: http://www.cronmaker.com/. For more information, please refer to the following page: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/tutorial-lesson-06.html

Input filename

Filename of the message OUT of the channel that serves as input to the aggregator. If empty, we will apply the default settings.

Output filename

Filename of the aggregated file, by default the file name is set to 'aggregate'. Tip: You can use: {com_babelway_messaging_context_aggregator_groupBy} to include the name of the group by in the file name, or any user defined metadata defined in the first of the aggregated messages.

Minimum idle time

If you specify a time (in seconds), the aggregation will wait that time after the reception of a new incoming message, even if it conflicts with its scheduled run. This allows, for example, ensuring all messages from a batch are included in a single aggregation.

Header

For 'append' type: prefix to add at the beginning of the file. For 'xslt' type: name for the root of the resulting message. Default='messages'

Separator

For 'append' type: message separator. For 'xslt' type: name for the element surrounding each message. Default='message'

Footer

Suffix to add at the beginning of the file.

Xslt

Xslt to execute on the resulting Xml.

Edifact skip UNA

Check this to skip the UNA section in EDIFACT and Odette messages.

Edifact control

Define a custom XPATH expression used to compute the edifact control field. If left empty, the control of the first message will be used.

Input charset

Charset to use to decode the file waiting to be aggregated. Default is UTF8.

Output charset

Charset to use to encode the file resulting of the aggregation. Default is UTF8.

User Metadata Transfer Strategy

The strategy that will be used to transfer the user metadata to the new message created in the connected gateways.

NFS Gateway Out

The NFS gateway is used to connect and push files to a remote NFS server.

Server

Hostname of the NFS server.

Export

Name of the exported volume.

Login method

NFS login method: use PCNFSD for username / password and UGID to directly use UID, GID and GIDS

Username

Username used for the NFS authentication. Only used with PCNFSD login method.

Password

Password used for the NFS authentication. Only used with PCNFSD login method.

User uid

Unix user UID to use during authentication. Only used with UGID login method.

User group gid

Unix user's group GID to use during authentication. Only used with UGID login method.

User extra group ids

Unix user's additional groups GID to use during authentication, encoded as a comma separated list. Only used with UGID login method.

Directory

Local NFS path to the folder you want to use. This is relative to the export.

Lookup Table Gateway Out

The lookup table gateway is used to fill a lookup table automatically from a message. See also Automatic Population of Lookup table using Channel for information about importing data from a channel.

Lookup Table Id

The technical id of the lookup table.

Append

Check this if you need to append the records contained in the messages going through this channel. Otherwise, the entire table will be replaced by the new values.

Criteria

If filled, only the values that match this criterion will be deleted or inserted in the target lookup table. The name must be the name of the column that must match. The value is the value that this column must have to be replaced.

SAP Gateway Out

With a SAP Out Gateway, outgoing messages are pushed from Babelway to a SAP server.

The specific settings are:

SAP client

SAP client to use. This is the three digit number you use in the first field of the login screen of SAP Gui. It has the name 'Client' and is just above the user and password fields. For instance: 001, 210, 400 ...

User

The Valid SAP user ID you want to use. Ideally this should be a user specially created for this purpose. For instance: user

Password

Password associated with the user ID. For instance: password

Server address

IP or DNS name for SAP application server. For instance: sap.yourcompany.com

SAP system number

SAP system number is the last 2 digits of the SAP client. For instance: 01, 10, 00. Default is the last 2 digits of SAP client parameter

Dropbox Gateway Out

The Dropbox gateway out allows you to upload your messages into a Dropbox account.

The specific settings are:

Dropbox account

The name of the Dropbox account to which the messages will be sent. This information is "read only", and set by the wizard when you allow Babelway to access the Dropbox account.

Folder

The folder in your Dropbox account in which the messages will be placed. This folder will appear under the path /Apps/Babelway/ .

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Exact Postbox Gateway Out

The Exact gateway allows to send messages to Exact Postbox users. This gateway must be used with the Exact wizard and the message delivery is based solely on the content of the message sent.

Tradeshift Gateway Out

This gateway allows you to send files directly to an account on Tradeshift.

API Prefix

URL Prefix to call Tradeshift API. Default is https://api.tradeshift.com/tradeshift/rest/

Connection type

Choose 'Tenant' to connect to your own Tradeshift account and send the document from there. Choose 'Van' if you don't have a Tradeshift account and you need to dispatch the document to the account of someone else.

Tenant Id

The Tradeshift tenantId to use. Use Babelway application in Tradeshift to retrieve this value.

Token

The Tradeshift token to use. Use Babelway application in Tradeshift to retrieve this value.

Secret

The Tradeshift token secret to use. Use Babelway application in Tradeshift to retrieve this value.

Consumer key

The Tradeshift consumer key to use to authenticate the Babelway application. This should be left empty in most of the case.

Consumer secret

The Tradeshift consumer secret to use to authenticate the Babelway application. This should be left empty in most of the case.

Retry on http return code

Comma separated list of error Http return code that should be retried. If the return code is not in the list, the message is set in error. The default is '502,503,504'.

Retry on patterns

Optional. If the HTTP response is success (HTTP code 2xx) and if the HTTP response matches one of the pattern(s) (regular expressions), the message will be retried.

API suffix

The Tradeshift API to call. Do not include the URL prefix.

Http Method

You can specify the http method to call. The default is PUT.

Request content type

The content type of the generic api request. The default is text/xml.

Response content type

The content type of the generic api response. The default is text/xml.

Connected gateway

Select zero, one or several gateways to receive the response from the Tradeshift API.

Document Profile

The Tradeshift document profile.

Van

The van id used by Tradeshift to find the business partner.

Country

The country used by Tradeshift to find the business partner.

Company Name

The company name used by Tradeshift to find the business partner.

Email

The email address used by Tradeshift to find the business partner.

Identifier Scheme

The identifier scheme used by Tradeshift to find the business partner.

Identifier Value

The identifier value of the scheme used by Tradeshift to find the business partner.

Additional query parameters

Key value pairs which will be added to the request.

Additional properties

Additional properties that can be set on the Tradeshift document.

Retry strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

Connected Gateways

Select zero, one or several gateways to receive the response from the server.

User Metadata Transfer Strategy

The strategy that will be used to transfer the user metadata to the new message created in the connected gateways.

Lookup Table Id

The technical id of the lookup table.

Amazon Marketplace Gateway Out

This gateway allows to send 'Feeds' to an account on Amazon Marketplace.

Process

Request support@babelway.com for changing this parameter. Type of process. 'Feed' is the only one supported at this stage.

Endpoint

Request support@babelway.com for changing this parameter. Endpoint is the entry point for an Amazon marketplace web service. Default is https://mws.amazonservices.com

Access key

Amazon marketplace web services access key ID.

Secret key

Amazon marketplace web services secret key ID.

Seller Id

Amazon marketplace seller ID.

Marketplace Id

Amazon marketplace ID.

Feed type

Feed type see MWS doc.

Retry strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

Note: This Gateway Out only sends Price and Inventory and Product messages to Amazon Marketplace.

The below link has the complete list for all of the available FeedType in the Amazon MWS Feeds API section.

https://docs.developer.amazonservices.com/en_US/feeds/Feeds_FeedType.html

Billtrust Gateway Out

With an BilltrustOut Gateway, outgoing messages are sent to Billtrust API.

All the user defined metadata defined in the messages are passed in the context of the new message.

The specific settings are:

Url

External service address.

Login url

URL used to get OAUTH2 token.

Username

Login or username to access the service.

Password

Password associated with the username.

Connected gateway

Select zero, one or several gateways to receive the response from the http server.

Valid HTTP return code

Comma separated list of expected return Http code. If the return code is not in the list, the message is set in error. The default is '200,201,202,204,205'.

Success expression

The success expression is a regex. If the response doesn't match the success expression, the message is flagged with 'error' status.

Response filename

You can specify a filename that will be associated with the server response. Default is 'attachment'.

User Metadata Transfer Strategy

The strategy that will be used to transfer the user metadata to the response message created in the connected gateways.

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

Timeout

Timeout for connection in milliseconds. Must be between 10000 and 240000.

Http Method

You can specify the http method to call. The default is POST.

Http headers

You can add specific http header. This accepts metadata.

Trust level

The trust level defines the level of security used in the SSL handshake. Relax = No certificate verification, Standard = trusting certificates in environment certificates as well as known CA's, Paranoiac = only trusts certificates defined in the environmnent certificates. Mutual = requires 2-way authentication.

After channel deployment, your connection will be available to send messages.

VAN Gateway Out

This gateway allows to send files directly a Trading Partner’s VAN via the ECGrid VAN. A Trading Partner is the company whom you are going to send documents. It can be useful to integrate with Rite Aid or Wayfair for example.

The VAN gateway routes the message to its destination based on the Identifier / Qualifier pair as determined in the X12 or Edifact data. They look like this:

X12: ISA*00* *00* *ZZ*SENDERID *ZZ*RECEIVERID *010101*0101*U*00401*000000001*0*T*!

EDIFACT: UNB+UNOA:1+SENDERID:ZZ+RECEIVERID:ZZ+

For the VAN Out Gateway, your ID Is the Sender ID. Your Trading Partner ID is the Receiver ID.

When sending a message through the gateway, two things may occur:

1. The Receiver ID is known in the VAN database. If this is the case, your message will transmit properly to your receiver. The message will be successful.

2. The Receiver ID is unknown in the VAN database. The message will be a failure. If this is the case, a new Trading Partner request must be sent. To do so, send the following to support@babelway.com

  • Subject: New Trading Partner Request

  • Trading Partner Name

  • Trading Partner Qualifier / ID Pair

  • Trading Partner VAN name

Setup usually takes 5 business days depending on the receiver’s VAN. Babelway will confirm with you when the setup is complete.

Once this is complete, you may begin using the channel to send to your trading partner.

The specific settings are:

Filename

Filename of the outgoing message [with extension if applicable]. If empty, we will apply the default settings.

PEPPOL Gateway Out

This gateway allows you to send files to the PEPPOL network.

More information about PEPPOL in Gateway IN section

PEPPOL environment

Choose between the regular PEPPOL production infrastructure, connected to the SML, or the test infrastructure, connected to the SMK. The default is Production

Access Point Key

The peppol key you received as an access point. If none is provided, Babelway's key will be used.

Attachment Name

Name of the file sent by AS2. This is an extension to the base AS2 specification and might not be supported by all partners. By default no file name is sent.

Retry Strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

Note: In order to change the PEPPOL environment to Production or Test regarding the "Gateway Out" then from "Gateway Out" properties select Production or Test from "PEPPOL environment" field, as shown below.

Select PEPPOL environment Production or Test

Figure 4.57. Select PEPPOL environment Production or Test


RosettaNet Gateway Out

This gateway allows you to send RosettaNet complient PIP message to another RosettaNet Server. This Gateway must be used along with a RosettaNet message out.

Url

URL of the RosettaNet server of the receiver.

Signature certificate

Select signature certificate or go to certificates store.

Encryption certificate

Select encryption certificate or go to certificates store.

Attachment patterns

Attachments to add to the S/MIME message. Metadata = Pattern to match metadata containing the file to attach. Filename = name of the file in the zip. If one pattern matches multiple files, it is possible to put them all if you guarantee to generate a different filename name for each. This can be achieved by using the capturing groups of the regex in the filename. Ex: if your metadata pattern is attachment-(.*) and your filename is \1, processing with two metadata attachment-file1.csv and attachment-file2.csv will result in files file1.csv and file2.csv.

Test flag

Select this to set the GlobalUsageCode in the ServiceHeader to 'Test'. Otherwise 'Production' is used.

NemHandel Gateway Out

This gateway allows you to send messages to the Danish NemHandel network.

Registration certificate

Select the certificate use to register your information into the NemHandel registry.

NemHandel environment

Choose between the regular NemHandel production infrastructure, or the test infrastructure. The default is Production

Signature certificate

Select signature certificate or go to certificates store.

Retry strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

Chorus Pro Gateway Out

This gateway allows you to send invoices and credit note to the french administration network.

Environment

This is the Chorus Pro environment you want to use: Production or Qualification.

Technical API username

This is the technical username provided by chorus pro support to access the API through Babelway. More information on how to have that username can be found below.

Technical API password

This is the technical password provided by chorus pro support to access the API through Babelway. More information on how to have that password can be found below.

Retry strategy

Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error.

Send Chorus detailed report In

Allows you to send the Chorus Json report into one or multiple gateway IN internal. See below for example of json response. For more information, please refer to the page: https://communaute.chorus-pro.gouv.fr/show-detailed-report/

{
"codeRetour": 0,
"libelle": "TRA_MSG_00.000",
"codeInterfaceDepotFlux": "FSO1110A",
"dateDepotFlux": "2018-02-16T15:10:25.536+01:00",
"dateHeureEtatCourantFlux": "2018-02-16T15:10:28.137+01:00",
"etatCourantDepotFlux": "IN_INTEGRE_PARTIEL",
"listeErreurTechnique": {
	"natureErreur": "00000000005734",
	"codeErreur": 252,
	"libelleErreur": "L'identifiant fournisseur de la demande de paiement (balise : AccountingSupplierParty.Party.PartyIdentification.ID.value) n'est pas reference dans notre systeme. "
},
"listeErreurDP": {
	"identifiantDestinataire": "00000000005734",
	"identifiantFournisseur": "00000000005719",
	"libelleErreurDP": "L'identifiant fournisseur de la demande de paiement (balise : AccountingSupplierParty.Party.PartyIdentification.ID.value) n'est pas reference dans notre systeme. ",
	"numeroDP": "F1110_NBO050740100"
},
"nomFichier": "FSO1110A_CPP001_CPP0011110000000000001557"
}