EDI Setup

Aptean EDI  •  Article  •  5/12/2025  •  12 min

A number of other values must be configured before the Aptean EDI solution is ready for use. The following procedures describe how to setup EDI.

  1. Select the Search icon , enter EDI Setup, and then choose the related link.
    The EDI Setup page opens.

  2. On the General FastTab, fill in the fields as follows:

    Field Description
    Disable Aptean EDI When Aptean EDI is deployed, by default its functionality is enabled. If for any reason it is necessary to disable the EDI functionality, this field can be used to do so.
    Enable Logging Turn on this toggle to create entries for Job Queue processes in a separate EDI log table. Log entries are created for Job Queue processes only; any manual activity is not included as part of this process. Please note that the creation of log entries will have an adverse effect on overall performance. As logging is not required for day-to-day activity, it is recommended that it only be activated for troubleshooting problems that occur with Aptean EDI.
    Send Retry Count Enter the number of attempts made to send outbound activity before terminating the process. Depending on setup, the failure to process an activity may result in a notification being sent to one or more designated parties. The recommended retry count is 3.
    Disable Expiration Notification Turn on this toggle to stop receiving the alerts for items with upcoming expiration dates.
    Amount Rounding Precision Enter the size of the interval to be used when rounding amounts in LCY. This covers amounts created with all types of transactions and is useful to avoid inconsistencies when viewing or summing different amounts. Amounts will be rounded to the nearest digit. For example, to have amounts rounded to whole numbers, enter 1.00 in this field. In this case, amounts less than 0.5 will be rounded down, and amounts greater than or equal to 0.5 will be rounded up. On the Currencies page, you specify how amounts in foreign currencies are rounded.
    Quantity Rounding Precision Enter the size of the interval to be used when rounding the quantity and weight. This is useful to avoid inconsistencies when viewing or summing quantities and weights of different items. They will be rounded to the nearest digit. For example, to have quantities rounded to whole numbers, enter 1.00 in this field. In this case, quantities less than 0.5 will be rounded down, and quantities greater than or equal to 0.5 will be rounded up. On the EDI Port Card page, you can specify the rounding value for individual ports.
    Unit-Amount Rounding Precision Enter the size of the interval to be used when rounding unit amounts, items, or resource prices per unit, in LCY. Amounts will be rounded to the nearest digit. For example, to have unit amounts rounded to whole numbers, enter 1.00 in this field. In this case, amounts less than 0.5 will be rounded down, and amounts greater than or equal to 0.5 will be rounded up. On the Currencies page, you specify how unit amounts in foreign currencies are rounded.
    Dynamics 365 Serial Number Enter the unique identifiers assigned to each license purchased for the Dynamics 365 software.
    License Key Aptean EDI license key will grant access to Aptean EDI functionality. You must enter the license key that has been linked the relevant Dynamics 365 serial number. Contact your Dynamics Business Central partner to obtain your Aptean EDI license key. When you create a new company, the system will take the license key of the existing companies, instead of requesting for new trail license keys. If you create or change or validate the license key in any company, it will also reflect in all other companies.
    License Status The current status of the Aptean EDI license is displayed in this field. Status options include: Pending - the software subscription will start on a future date. Trial - the software subscription is under trial, and has a defined expiration date. Active - the software subscription is active. Cancellation Pending - the software subscription will be cancelled on a future date. Paused - the software subscription has been paused by the software vendor. Cancelled - the software subscription has been cancelled by the software vendor. Invalid - the software subscription has been rendered invalid. The software vendor should be contacted for assistance. Inactive - the software subscription is not active, but not paused or cancelled. Unknown - the software subscription's status cannot be confirmed.
    Expiration Notification (Days) Set the number of days before receiving an alert regarding the expiration of the item. This notification lead time helps you stay informed about the upcoming expirations and take the required actions.
    Version The currently running version of Aptean EDI is displayed in this field. This value is copied from the version tags of the currently installed EDI objects.

  3. On the Process FastTab, fill in the fields as follows:

    Field Description
    Auto Receive from Ports Place a check mark in this field to instruct the program to automatically receive inbound data from active EDI ports. It is recommended that this field be checked; if it is left unchecked, users must manually instruct the program to receive this data.
    Auto Process It is possible to instruct the program to automatically process a number of designated EDI activities. Automation can be specified on an activity-by-activity basis, and is available for sales invoices, sales credit memos, sales shipments, sales acknowledgments, inbound EDI messages, outbound EDI messages, outbound transfer acknowledgments, and outbound transfer shipments. Please note that, when dealing with documents such as sales and transfer orders, automatic processing will only be performed on those orders that are identified as EDI activities. It is recommended that these fields be checked; if any field is left unchecked, the processing of the relevant activity will be dependent on manual instruction by a user.
    Pre-processing Object It may be that certain activities must be performed before the automatic processing of designated EDI transactions. For example, it may be that a value-added network consolidates multiple EDI documents into a single .txt file, making it necessary to separate these transactions before they can be entered into the program as unique documents. In such a scenario, this preliminary activity could be defined as part of a report or a codeunit, and the program can then be instructed to run this object prior to any automatic EDI processing. To assign this object, it must first be identified as either a report or a codeunit in the Pre-processing Object Type field. The relevant identification number must then be entered in the Pre-processing Object ID field. The name of the assigned object will be displayed in the Pre-processing Name field.
    Auto Proc. Whse. Shpmt Turn on this toggle to automatically send and process the 940 EDI message. This will happen only when the Pick Ticket Port Code field on the Location Card page also has a value, and the EDI Document toggle on the Warehouse Shipment page is automatically turned on after the shipment is released.
    Auto Proc. Whse. Receipt Turn on this toggle to automatically send and process the 943 EDI message. This will happen only when the Receipt Port Code field on the Location Card page has a value, and the Auto Proc. Whse. Receipt toggle on the EDI Setup page, the Auto Release EDI toggle on the EDI Port page, and the EDI Document toggle on the Warehouse Shipment page are turned on.

  4. On the Notification FastTab, fill in the fields as follows:

    Field Description
    From E-Mail Address Enter the address of the e-mail account from which EDI notification messages will be sent. This can be an unmonitored account.
    Notify on Success Place a check mark in this field to instruct the program to send an e-mail notification of each successful EDI message processing to the addresses in the Notify E-Mail Address(es) field. Please note that, in an environment that sees a high volume of EDI transactions, most of which will be successful, placing a check mark in this field may result in an equally high number of notifications to the designated recipients.
    Notify on Failure Place a check mark in this field to instruct the program to send an e-mail notification of each failed EDI message processing to the addresses in the Notify E-Mail Address(es) field.
    Notify E-Mail Address(es) Enter the address of every e-mail account to which EDI notifications will be delivered. Multiple e-mail addresses are separated with a semicolon.Please note that these notification settings will apply globally to all EDI activity. Transaction-specific notifications can be defined on the relevant EDI port record. Once the setup for notifications on the SMTP Mail Setup window and the Notification FastTab of the EDI Setup window has been completed, the user can ensure that these settings are configured correctly by clicking the Home tab and, in the Process group, selecting Test E-mail Notification. If EDI notifications have been set up correctly, a test e-mail will be delivered to the recipients that have been identified in the Notify E-Mail Address(es) field. If incorrect setup exists, the program will display an error message describing the issue.

  5. On the Default FastTab, fill in the fields as follows:

    Field Description
    Default In. Connection Type Indicate the source from which inbound EDI transactions are obtained. There is a single file option that will instruct Aptean EDI to import a single, specified file; this is used for testing purposes.
    Default In. Address Enter or use the AssistEdit button to browse to the location in which inbound EDI transactions will be stored. The type of address that is entered in this field depends on the selection in the Default In. Connection Type field. You will be provided with two addresses – /testout/, and /out/. The former address is meant to be utilized for testing activities, while the latter one will be employed in a live environment.
    Default In. Port Enter the port number that is used to process inbound activity. It is not necessary to specify a port if the Web service is being utilized.
    Default In. Username/Password If inbound EDI transactions will be processed through an FTP or SFTP site, you must enter the username and password that will permit access to the specified address. This information is not required if the Web service is being utilized.
    Default Out Connection Type Indicate the source to which outbound EDI transactions are sent. If Aptean EDI is being processed through the fulfillment platform, you will most likely want to select the Web Service option. There is also a single file option that will instruct Aptean EDI to export a single, specified file; this is used for testing purposes.
    Default Out Address Enter or use the AssistEdit button to browse to the location to which outbound EDI transactions will be stored. The type of address that is entered in this field depends on the selection in the Default Out Connection Type field. When using the Web service, you will be provided with two addresses – /testin/, and /in/. The former address is meant to be utilized for testing activities, while the latter one will be employed in a live environment.
    Default Out Port Enter the port number that is used to process outbound activity. It is not necessary to specify a port if the Web service is being utilized.
    Default Out Username/Password If outbound EDI transactions will be processed through an FTP or SFTP site, you must enter the username and password that will permit access to the specified address. This information is not required if the Web service is being utilized.
    Inbound Storage Connection This is a Blob Storage Connection card through which the user can import files. It is also used in Azure Blob Storage Connection.
    Inbound Storage Connection Archive This is a Blob Storage Connection card through which the user can archive files which is possible only during import and is used in Azure Blob Storage Connection.
    Outbound Storage Connection This is a Blob Storage Connection card through which the user can export files and is also used in Azure Blob Storage Connection.

  6. On the Packaging FastTab, fill in the fields as follows:

    Field Description
    Default Packaging Type This packaging type determines the GS1 indicator digit associated with the SSCC, indicating a packaging level.
    Default Package Carton Type Code The default package carton type code for EDI transactions. The system uses this code when no carton type is specified.
    GS1 Company Prefix Enter your organization’s GS1 Company Prefix, a unique numerical identifier. This is the part of the generated GS1 compliant barcodes and is used for item identification and tracking. It should be an alphanumeric value with maximum character limit of 10.

  7. On the action bar, select Install Aptean EDI Ports or Install SPS Ports on the EDI Setup page to define the ports and port options to be installed.