Communication settings¶

Introduction¶

Documents are exchanged with partners via the FTP or AS2 connection protocols. The details are on the Admin page, in the Communication settings tab:

My connections¶

EDI communicates with partners using the FTP and AS2 protocols. Except for the Jitterbit van service, connection profiles for each protocol are set up by you in the Create new FTP or Create new AS2 tabs. To communicate with a trading partner, you must assign one of these connections to them.

The My Connections tab shows these connection profiles, and lets you assign, edit, or delete them:

Jitterbit VAN service¶

To use the Jitterbit VAN service, you must contact Support or your customer success manager (CSM) to have it set up. When configured, you can assign it to a partner.

Assign¶

To assign a connection, follow these steps:

1. Select a partner in the trading partners pane.

2. Click a connection's Actions icon and select Assign.

3. A green border and check mark appears on the connection to show it is now assigned to the currently selected partner.

Edit¶

To edit a connection, follow these steps:

1. Click a connection's Actions icon and select Edit.

2. The Edit FTP or Edit AS2 tab opens (depending on the connection type).

3. Edit the connection's details, then click Save.

4. The My Connections tab opens showing the updated connection.

Delete¶

To delete a connection, follow these steps:

1. Click a connection's Actions icon and select Delete.

   Note

   Assigned connections cannot be deleted. To delete an assigned connection, assign a different one to the selected partner.

2. The connection is deleted.

   Caution

   Connections are deleted without confirmation.

Create new FTP¶

Define and test FTP connections in the Create new FTP tab. (The tab's label changes to Edit FTP when editing an existing connection.) It contains the following tabs:

• Connection information: The FTP connection's primary details.

• FTP details: FTP settings.

• Remote details: The FTP connection's remote details.

• Automation: Set a date and frequency for automatically running the connection.

Click Test Connection to test an FTP connection. This button is active when all required fields are filled. It does not apply to SFTP connections.

Click Cancel to abandon any changes and return to the My connections tab. A dialog opens asking you to confirm the action:

Click Save to save the connection. The new connection automatically becomes the currently assigned one.

Connection information¶

• Active: Enable to activate the connection.

• Name: The connection's name.

• Login1: The primary account's username for the FTP server.

• Password1: The primary account's password for the FTP server. Leave blank if no password has been set.

• Login2: The username for a secondary or additional account on the FTP server.

• Password2: The secondary account's password for the FTP server. Leave blank if no password has been set.

FTP details¶

The FTP Details tab contains the following:

• Address: The IP address or host name of the FTP server.
• Port: The port number. (Your firewall must allow traffic on the port.)
• Protocol: Select FTP or SFTP.
• Security: The security type. Select Explicit, Implicit, or None.
• Mode: The FTP mode. Select Active or Passive.
• Send private key: Enable to authenticate a client when it connects to an SFTP server.
• Download active: Enable to use active FTP mode. Turn off to use passive FTP mode.
• Delete file after download: Enable to delete the file from the FTP server after it has been downloaded.
• SSL settings: The SSL settings.
• Retrieval mask: A filename mask.

Remote details¶

The Remote Details pane contains the following:

• Remote download folder: The folder on the remote server where files are downloaded from.
• Remote upload folder: The folder on the remote server where files are uploaded to.
• Remote upload file name: The filename for uploaded files.
• Remote upload file extension: The filename extension for uploaded files.
• Remote download file name start index: The remote download filename start index.
• Remote download file name end index: The remote download filename end index.

Automation¶

The Automation tab lets you set how often and when to run an FTP connection. It contains the following:

• Frequency: How often to run the FTP service. Select 15 minutes, 1 Hour, 12 Hours, Daily, or Weekly.
• Next Run: When to next run the service. Select any of the date-time fields and enter a numeric value, or click the calendar icon to pick a date.

Create new AS2¶

Use the Create New AS2 tab to define AS2 connections. (The tab's label changes to Edit AS2 when editing an existing connection.) It contains the following tabs:

• Connection information: The AS2 connection's primary details.
• Proxy: Proxy server settings for outgoing transmissions.
• HTTP authentication: HTTP authentication settings.
• Encryption: Encryption settings.
• Certificate: Public key certificate details.

Connection information¶

• Active: Enable to make the connection active.
• Sending URL: The URL provided by the trading partner for sending documents through the AS2 connection. The Sending URL is used in conjunction with the Receiving URL that you provide your trading partner so they can send data to Jitterbit's AS2 connection. The receiving URL is different for each Harmony region:
  • North America: na.as2.jitterbitedi.com
  • EMEA: emea.as2.jitterbitedi.com
  • APAC: apac.as2.jitterbitedi.com
• Connection Timeout: The initial connection timeout.
• AS2 Company ID: The AS2 company identifier.
• AS2 Partner ID: The AS2 partner identifier.
• Email on Failure: Enable to send an email when there is a connection failure.
• Test Mode: Enable to test the connection.

Proxy¶

• Proxy: Enable to use a proxy server.
• Proxy Address: The proxy server's address.
• Proxy Domain: The proxy server's domain.
• Proxy Username: The proxy server's username.
• Proxy Password: The password for the proxy server's username.

HTTP authentication¶

• HTTP Authentication: Enable to use HTTP authentication.

• HTTP Authentication Type: Select the HTTP authentication type from the following choices:

  • Basic: Use non-encrypted base64-encoded credentials (RFC 2617).
  • Digest: Use encrypted base64-encoded credentials (RFC 2617).

• HTTP Authentication User: The username for HTTP authentication.

• HTTP Authentication Password: The password for HTTP authentication.
• HTTP Subject: The subject describing the purpose of the endpoint.

Encryption¶

• Signature Algorithm: Select the signature algorithm.
• Encryption Algorithm: Select the encryption algorithm.
• Sign: Enable to reject unsigned incoming messages.
• Encrypt: Enable to reject unencrypted incoming messages.
• Request MDN Signed: Enable to request a message disposition notification (MDN).
• Compress: Enable to use ZLIB compression.

Certificate¶

Use the Certificate tab to manage certificates for your organization and your trading partners:

The Certificate tab contains two panes:

• My certificate: Certificates for your organization.
• Partner certificate: Certificates for the trading partner.

My certificate¶

Click Manage to open the Manage Certificate pane:

The pane contains the following:

• Manage Certificate: A list of available certificates. Select an entry to edit or delete one. (The selected entry is not highlighted.)

• Upload: Upload a certificate file. Accepted file types are .cer, .crt, and .pfx.

  

  • Certificate File: Click to open your system's file browser. Navigate to a certificate file, select it, then select Open.
  • Description: A description for the uploaded certificate. (Required.)
  • Password: The password for the certificate. (Required.)
  • Close: Close the Upload Certificate pane and return to the Manage Certificate pane.
  • Upload: Upload the certificate.

• Generate: Generate a certificate.

  

  • Description: A description for the generated certificate. (Required.)
  • Validity Years: How many years the certificate should be valid for. (Required.)
  • Close: Close the Generate Certificate pane and return to the Manage Certificate pane.
  • Generate: Generate the certificate.

• Delete: Delete the certificate selected in the Manage Certificate list.

  Caution

  Certificates are deleted without confirmation.

• Download: Download a certificate. The file type is .cer.

Partner certificate¶

Click Manage to open the Manage Certificate pane for the partner certificate:

The pane contains the following:

• Manage Certificate: A list of available partner certificates. Select an entry to edit or delete one. (The selected entry is not highlighted.)

• Upload: Upload a partner certificate.

  

  • Certificate File: Click to open your system's file browser. Navigate to a certificate file, select it, then select Open.
  • Description: A description for the uploaded partner certificate. (Required.)
  • Password: The password for the partner certificate. (Required.)
  • Close: Close the Upload Certificate pane and return to the Manage Certificate pane.
  • Upload: Upload the certificate.

• Delete: Delete the selected partner certificate.

  Caution

  Certificates are deleted without confirmation.