EDI Configuration
The setup and management of EDI (Electronic Data Interchange) trading partners takes place in the EDI section of the Configuration Manager (File → Configuration Management → EDI).
To create a new EDI Partner
- File → Configuration Management → EDI → Trading Partners.
- Click New.
Continue populate the applicable fields based on the information below.
System Defaults
Each EDI trading partner is setup in the Trading Partners section. To make the configuration of multiple trading partners easier, <system>
defaults can be set. System Defaults can only be defined for one type of trading partner, either Customer or Warehouse. Unless you enter different configuration information for a trading partner, the trading partner will use the System Defaults settings.
System Options
Partner Option
The Partner Options tab allows you to define defaults that can be used by other EDI partners.
Field | Field Type/ Length | Definition |
---|---|---|
Trading Partner Type | List | You can set system defaults for either customer or warehouse trading partners. These defaults can be used by other trading partners of the same partner type. |
Partner ID | Text / 15 Characters | The Partner ID for <system> cannot be changed. |
Partner Name | Text / 50 Characters | The Partner Name for <system> cannot be changed. |
Partner Vendor ID | Text / 15 Characters | The Partner Vendor ID will match the database name and cannot be edited. |
Advanced System Options
Clicking the Show Advanced button will reveal advanced configuration options, such as Partner Options, Incoming Files, Outgoing Files, and FTP Options
Partner Options
Field | Field Type/ Length | Definition |
---|---|---|
Partner Qualifier | Text / 2 Characters | |
Logging Level | List | This option can only be set for the <system> partner, but applies to all partners. Logging entries can be found in the Acctivate Logs.
|
Our Qualifier | Text / 2 Characters | Our Qualifier cannot be changed; it will always be "ZZ". |
Our ID | Text / 15 Characters | The Partner Vendor ID will match the database name and cannot be edited. |
Usage | List |
|
Consolidate Shipments | Checkbox | When checked, orders being shipped to the same location will be consolidated into single shipments during the Create Shipments step. |
Incoming Files
Configuration options for the EDI transaction files imported by Acctivate.
Field | Field Type/ Length | Definition |
---|---|---|
Mailbox Path | Text / 256 Characters | The file path where files from your VAN (Value Added Network) will be deposited for Acctivate to import. |
Mailbox File Mask | List | Double click in this field to view and select from a list of options. These behave as a variable that Acctivate will use to match the correct file:
%PARTNERID&* , any filename that starts with "ABC" will be imported in. For example "ABC20200101.txt" |
File Extension | Text / 50 Characters | You can define a specific file extension to be matched during the import, such as txt , or you can enter an asterisk (* ) to act as a wildcard and match on all file extensions. |
Outgoing Files
Configuration options for the EDI transaction files exported by Acctivate.
Field | Field Type/ Length | Definition |
---|---|---|
Mailbox Path | Text / 256 Characters | The file path where files exported from Acctivate will be deposited. |
Mailbox File Mask | List | Double click in this field to view and select from a list of options. The Mailbox File Masks behave as a variable that Acctivate will use to create a file name:
|
File Extension | Text / 50 Characters | You can define a specific file extension to be used for the exported file. The default extension is txt . |
FTP Options
Acctivate supports downloading files from and exporting to folders using FTP (File Transfer Protocol) or SFTP (Secure File Transfer Protocol) protocols. Your VAN (Value Added Network) or trading partner will need to setup and host the folders as well as provide you with connection credentials. The connection credentials can be entered on the FTP Options tab. You can use the Test Download and Test Upload to confirm a successful connection. In both instances a test file with arbitrary text will uploaded/downloaded.
The transmission of EDI Files to and from an FTP folder still requires setting up incoming and outgoing mailbox paths on your local network. When opening the Process EDI window in Acctivate, files are first downloaded a copy of the file from the FTP Server In directory to the local incoming mailbox path configured. During the export process, Acctivate will export the EDI transaction file to the local outgoing mailbox path configured, then it will upload a copy of the file to the FTP Server Out directory. A copy of all incoming and outgoing files will remain on your local network.
Field | Field Type/ Length | Definition |
---|---|---|
FTP Service Provider | Text / 32 Characters | A description of the FTP Service Provider, typically the VAN or host of the FTP folder. Used for descriptive purposes only, however typing True Commerce or SPS Commerce (the two most commonly integrated VANs) will cause some other fields to default to typical values. |
Use FTP SFTP | Radio Button | Used to select the protocol transferring files. |
FTP UserID | Text / 60 Characters | The user ID used to connect to the FTP folders. |
FTP Password | Text / 60 Characters | The password used to connect to the FTP folders. |
FTP Port | Numeric | The port to use when connecting to the SFTP folder. Only available for SFTP, FTP protocol will use port 21 by default. To use a different port than the default for FTP, include the port number you wish to use after the server name. For example, to use port 2121, change the FTP server path to servername.com:2121/out . |
FTP Enabled | Checkbox | If checked, Acctivate will download files from the FTP Server In folder into the Incoming Mailbox, then import the files into Acctivate. Likewise, Acctivate will export files to the Outgoing Mailbox location, then upload the files to the FTP Server Out folder. If unchecked, files are only imported/exported to the incoming/outgoing mailbox on your network. |
FTP Server In | Text / 256 Characters | The FTP server name and directory that the EDI Transaction files will be downloaded from. Format example: <servername><.com|.net>/<directoryname> , e.g., "myftpserver.com/in" |
FTP Server Out | Text / 256 Characters | The FTP server name and directory that the EDI Transaction files will be uploaded to. Format example: <servername><.com|.net>/<directoryname> , e.g., "myftpserver.com/out" |
Note
The Add/Remove Item and Add/Remove Transaction aren't available to be set for the <system>
trading partner. Click Show Advance to see additional options.
New Partner Setup
You can create a new Trading Partner, however once created it cannot be deleted and will count against the number of trading partners you're licensed for. To create a new trading partner, follow these initial steps:
- Go to File→ Configuration Management→ EDI→ Trading Partners.
- Click New.
- Select Customer or Warehouse for the Trading Partner Type.
- Enter the Partner ID and Partner Name.
- Click Save
Partner Options
The Partner Options tab allows you to define basic information for this trading partner.
Field | Field Type/ Length | Definition |
---|---|---|
Trading Partner Type | List | The following options are available:
|
Partner ID | Text / 15 Characters | The Partner ID for the trading partner. If using a Value Added Network (VAN), they will typically supply this ID. |
Partner Name | Text / 50 Characters | The user friendly name for the Trading Partner. |
Partner Vendor ID | Text / 15 Characters | The Partner Vendor ID will match the database name and cannot be edited. |
Advanced Partner Options
Clicking the Show Advanced button will reveal advanced configuration options.
Field | Field Type/ Length | Definition |
---|---|---|
Partner Qualifier | Text / 2 Characters | |
Our Qualifier | Text / 2 Characters | Our Qualifier cannot be changed; it will always be "ZZ". |
Our ID | Text / 15 Characters | The Partner Vendor ID will match the database name and cannot be edited. |
Usage | List |
|
Consolidate Shipments | Checkbox | When checked, orders being shipped to the same location will be consolidated into single shipments during the Create Shipments step. Applies to Customer trading partners only. |
Incoming Files
Any fields that are populated will apply to this trading partner. If a field is left blank, Acctivate will use the <system>
trading partner, if the field is filled in there.
Field | Field Type/ Length | Definition |
---|---|---|
Mailbox Path | Text / 256 Characters | The file path where files from your VAN (Value Added Network) will be deposited for Acctivate to import. |
Mailbox File Mask | List | Double click in this field to view and select from a list of options. These behave as a variable that Acctivate will use to match the correct file:
%PARTNERID&* , any filename that starts with "ABC" will be imported in. For example "ABC20200101.txt" |
File Extension | Text / 50 Characters | You can define a specific file extension to be matched during the import, such as txt , or you can enter an asterisk (* ) to act as a wildcard and match on all file extensions. |
Outgoing Files
Any fields that are populated will apply to this trading partner. If a field is left blank, Acctivate will use the <system>
trading partner, if the field is filled in there.
Field | Field Type/ Length | Definition |
---|---|---|
Mailbox Path | Text / 256 Characters | The file path where files exported from Acctivate will be deposited. |
Mailbox File Mask | List | Double click in this field to view and select from a list of options. The Mailbox File Masks behave as a variable that Acctivate will use to create a file name:
|
File Extension | Text / 50 Characters | You can define a specific file extension to be used for the exported file. The default extension is txt . |
FTP Options
Acctivate supports downloading files from and exporting to FTP (File Transfer Protocol) Folders. Your VAN (Value Added Network) or Trading Partner will need to setup and host the folders as well as provide you with connection credentials. The connection credentials can be entered on the FTP Options tab. You can use the Test Download and Test Upload to confirm a successful connection. In both instances a test file with arbitrary text will uploaded/downloaded.
The transmission of EDI Files to and from an FTP folder still requires setting up incoming and outgoing mailbox paths on your local network. When opening the Process EDI window in Acctivate, files are first downloaded a copy of the file from the FTP Server In directory to the local incoming mailbox path configured. During the export process, Acctivate will export the EDI transaction file to the local outgoing mailbox path configured, then it will upload a copy of the file to the FTP Server Out directory. A copy of all incoming and outgoing files will remain on your local network.
Tip
If you want this trading partner to use the FTP settings configured for the <system>
trading partner, you only need to check the FTP Enabled checkbox.
Field | Field Type/ Length | Definition |
---|---|---|
FTP Service Provider | Text / 32 Characters | A description of the FTP Service Provider, typically the VAN or host of the FTP folder. Used for descriptive purposes only, however typing True Commerce or SPS Commerce (the two most commonly integrated VANs) will cause some other fields to default to typical values. |
Use FTP SFTP | Radio Button | Used to select the protocol transferring files. |
FTP UserID | Text / 60 Characters | The user ID used to connect to the FTP folders. |
FTP Password | Text / 60 Characters | The password used to connect to the FTP folders. |
FTP Port | Numeric | The port to use when connecting to the SFTP folder. Only available for SFTP, FTP protocol will use port 21 by default. To use a different port than the default for FTP, include the port number you wish to use after the server name. For example, to use port 2121, change the FTP server path to servername.com:2121/out . |
FTP Enabled | Checkbox | If checked, Acctivate will download files from the FTP Server In folder into the Incoming Mailbox, then import the files into Acctivate. Likewise, Acctivate will export files to the Outgoing Mailbox location, then upload the files to the FTP Server Out folder. If unchecked, files are only imported/exported to the incoming/outgoing mailbox on your network. |
FTP Server In | Text / 256 Characters | The FTP server name and directory that the EDI Transaction files will be downloaded from. Format example: <servername><.com|.net>/<directoryname> , e.g., "myftpserver.com/in" |
FTP Server Out | Text / 256 Characters | The FTP server name and directory that the EDI Transaction files will be uploaded to. Format example: <servername><.com|.net>/<directoryname> , e.g., "myftpserver.com/out" |
Additional EDI Partner Options can be found in the grid when viewing Advanced options. Applies to Customer trading partners only.
Option Name | Setting |
---|---|
PackagingOption | There are three packaging options that apply to the Create Shipment process:
|
StoreAsAlternateCustID | Acctivate CYMA Edition Option. If this option is enabled, the location ID in the 850 will be compared against the Alternate Customer ID for customers associated with the trading partner. The customer that has the matching Alternate Customer ID that matches the Location ID will be selected. |
Assigned To
You can assign this trading partner to one or more customers in Acctivate (you must hide click Hide Advanced to hide the advanced options and see this option):
- Go to File→ Configuration Management→ EDI→ Trading Partners.
- Click Edit.
- Click +Add Item and select the Customer or Warehouse (depending on the Trading Partner Type).
- When prompted if you want to continue, select OK.
- If necessary, repeat again.
- Click Save.
Note
If the same Trading Partner ID is assigned to multiple customers in Acctivate, the Acctivate customer with the Location ID that matches the 850 Ship To Location ID will be used.
Customer Transactions
For trading partners that are customers, we support importing in Customer Purchase Orders (850 EDI Transaction) and exporting Customer Advance Ship Notices (856) and Customer Invoices (810). You can add a transaction for the Customer trading partner by clicking +Add Transaction (you must hide click Hide Advanced to hide the advanced options and see this option):
- Customer Purchase Orders (850):
The Customer Purchase Order (850 EDI Transaction) is a purchase order submitted to you from your customer. Customer Purchase Orders are imported in as your sales order. - Customer Advance Ship Notice (856):
The Customer Advance Ship Notice (856 EDI Transaction) is a transaction exported from Acctivate containing shipment data. - Customer Invoice (810):
The Customer Invoice (810 EDI Transaction) is a transaction exported from Acctivate containing sales invoice data.
Customer Purchase Order
Once the Customer Purchase Order transaction has been added a new Customer Purchase Order tab will appear. Configuration options specific to the Customer Purchase Order (850 EDI Transaction) are defined here:
Field | Field Type/ Length | Definition |
---|---|---|
Enabled | Checkbox | If checked, Acctivate will attempt to import in available 850 transaction files for this trading partner. |
Mailbox Path | Text / 256 Characters | The file path where files will be imported in from If left blank, the Mailbox Path in the Partner Options section will be used. If that is blank, the Mailbox Path for the <system> trading partner will be used. |
Mailbox File Mask | List | Double click in this field to view and select from a list of options. The Mailbox File Masks behave as a variable that Acctivate will use to identify files to import in:
<system> trading partner will be used. |
File Extension | Text / 50 Characters | You can define a specific file extension to be matched during the import, such as txt , or you can enter an asterisk (* ) to act as a wildcard and match on all file extensions. If left blank, the File Extension in the Partner Options section will be used. If that is blank, the File Extension for the <system> trading partner will be used. |
Additional EDI Customer Purchase Order Options can be found in the grid on this tab.
Option Name | Setting |
---|---|
IgnoreUOM |
|
ProductSearchOrder | An 850 transaction file can contain up to three different product identifiers: Customer Product ID, Buyer Product ID and Vendor Product ID. Acctivate can compare these against various Acctivate product identifiers to make a match. The 850 data can be compared to the Customer Product ID, Product ID, UPC and Alternate Product ID. The sequence in which these are searched can be changed by reordering the values, though the default is recommended
|
ShipToDistributionCenter | When enabled, a customer's Ship To EDI configuration will be evaluated when an 850 transaction does not have a Ship To location, but includes a Mark for Store location. If disabled, the Mark for Store location will be used as the Ship To location when no Ship To location is included in the 850 transaction file. |
SetPriceUnit |
|
Customer ASN
Once the Customer Advance Ship Notice (ASN) transaction has been added a new Customer Advance Ship Notice tab will appear. Configuration Options specific to the ASN (856) are defined here:
Field | Field Type/ Length | Definition |
---|---|---|
Enabled | Checkbox | If checked, Acctivate will attempt to export available 856 transaction data for this trading partner. |
Mailbox Path | Text / 256 Characters | The file path where files exported from Acctivate will be deposited. If left blank, the Mailbox Path in the Partner Options section will be used. If that is blank, the Mailbox Path for the <system> trading partner will be used. |
Mailbox File Mask | List | Double click in this field to view and select from a list of options. The Mailbox File Masks behave as a variable that Acctivate will use to create a file name:
<system> trading partner will be used. |
File Extension | Text / 50 Characters | You can define a specific file extension to be used for the exported file. The default extension is txt . If left blank, the File Extension in the Partner Options section will be used. If that is blank, the File Extension for the <system> trading partner will be used. |
Additional EDI Customer Advance Ship Notice Options can be found in the grid on this tab.
Option Name | Setting |
---|---|
IncludeSSCCAI |
|
ShipmentStructure | Different trading partners may require the ASN Transaction be formatted differently. Acctivate can generate the 856 Transaction File in three different formats:
|
Customer Invoice
Once the Customer Invoice transaction has been added a new Customer Invoice tab will appear. Configuration Options specific to the Invoice (810) are defined here:
Field | Field Type/ Length | Definition |
---|---|---|
Enabled | Checkbox | If checked, Acctivate will attempt to export available 810 transaction data for this trading partner. |
Mailbox Path | Text / 256 Characters | The file path where files exported from Acctivate will be deposited. If left blank, the Mailbox Path in the Partner Options section will be used. If that is blank, the Mailbox Path for the <system> trading partner will be used. |
Mailbox File Mask | List | Double click in this field to view and select from a list of options. The Mailbox File Masks behave as a variable that Acctivate will use to create a file name:
<system> trading partner will be used. |
File Extension | Text / 50 Characters | You can define a specific file extension to be used for the exported file. The default extension is txt . If left blank, the File Extension in the Partner Options section will be used. If that is blank, the File Extension for the <system> trading partner will be used. |
Additional EDI Customer Invoice Options can be found in the grid on this tab.
Option Name | Setting |
---|---|
ExportInSalesUnit |
|
InvoiceSelection |
|
Warehouse Transactions
For Trading Partners that are Warehouses (3PL), we support exporting the Warehouse Shipping Order (940 EDI Transaction) and importing in the Warehouse Shipping Advice (945 EDI Transaction). You can add a transaction for the Warehouse trading partner by clicking +Add Transaction (you must hide click Hide Advanced to hide the advanced options and see this option):
- Warehouse Order (940):
The Warehouse Shipping Order (940 EDI Transaction) is a transaction that is sent to your third party logistics (3PL) firm containing order information that needs to be shipped to your customers. - Warehouse Shipment (945):
The Warehouse Shipping Advice (945 EDI Transaction) is a transaction that is returned from your third party logistics (3PL) firm containing shipping information corresponding to your sales orders.
Warehouse Order
Once the Warehouse Order transaction has been added a new Warehouse Order tab will appear. Configuration Options specific to the Warehouse Shipping Order (940 EDI Transaction) are defined here:
Field | Field Type/ Length | Definition |
---|---|---|
Enabled | Checkbox | If checked, Acctivate will attempt to export available 940 data for this trading partner. |
Mailbox Path | Text / 256 Characters | The file path where files will be imported in from If left blank, the Mailbox Path in the Partner Options section will be used. If that is blank, the Mailbox Path for the <system> trading partner will be used (if the <system> trading partner uses the Warehouse Trading Partner Type). |
Mailbox File Mask | List | Double click in this field to view and select from a list of options. The Mailbox File Masks behave as a variable that Acctivate will use to create a file name:
<system> trading partner will be used (if the <system> trading partner uses the Warehouse Trading Partner Type). |
File Extension | Text / 50 Characters | You can define a specific file extension to be used for the exported file. The default extension is txt . If left blank, the File Extension in the Partner Options section will be used. If that is blank, the File Extension for the <system> trading partner will be used (if the <system> trading partner uses the Warehouse Trading Partner Type). |
Additional EDI Customer Purchase Order Options can be found in the grid on this tab.
Option Name | Setting |
---|---|
FilterOrdersByWorkFlow | Only sales orders with the workflow status you select here will be included in the exported 940 Transaction File. Typically, this would be Ready to Pick. |
OrderWorkflowStatus | Sales Orders that have been exported in a 940 Transaction File will be updated to the status selected here. Typically, this would be Pick in Progress. |
SendKitComponents | If this option is checked, Acctivate will send the kit components in the 940 transaction file instead of the kit product. The price and extended amount of the kit will be associated with the first component in the 940 transaction file. Other components will have a $0 price. Note: The components and quantities sent will be based on the Kit item's scheduled quantity. Regardless of the "SendKitComponents" EDI option being enabled, if the 945 contains kit components, rather than the kit itself, the scheduled quantity of the kit will be set to the number of complete kits shipped, based on the shipped quantity of the components. |
Warehouse Shipment
Once the Warehouse Shipment transaction has been added a new Warehouse Shipment tab will appear. Configuration Options specific to the Warehouse Shipping Advice (945 EDI Transaction) are defined here:
Field | Field Type/ Length | Definition |
---|---|---|
Enabled | Checkbox | If checked, Acctivate will attempt to import available 945 data for this trading partner. |
Mailbox Path | Text / 256 Characters | The file path where files will be imported in from If left blank, the Mailbox Path in the Partner Options section will be used. If that is blank, the Mailbox Path for the <system> trading partner will be used (if the <system> trading partner uses the Warehouse Trading Partner Type). |
Mailbox File Mask | List | Double click in this field to view and select from a list of options. The Mailbox File Masks behave as a variable that Acctivate will use to identify files to import in:
<system> trading partner will be used (if the <system> trading partner uses the Warehouse Trading Partner Type). |
File Extension | Text / 50 Characters | If a specific file extension is entered here, only 945 files with that extension will be imported in for this trading partner. The default extension is txt , or you can enter an asterisk (* ) to act as a wildcard and match on all file extensions. If left blank, the File Extension in the Partner Options section will be used. If that is blank, the File Extension for the <system> trading partner will be used (if the <system> trading partner uses the Warehouse Trading Partner Type). |
When a 945 Transaction File is imported in, the shipment data is added to the Packages tab of the Edit Sales Order window and the sales order's Workflow Status is updated to Shipped.