The following provides steps for tenants to enable their own Logixboard integration without sharing Cargowise One (CW1) login access.
🛠️ Generally a CW1 user login is required not only for the initial integration, but also for ongoing maintenance, support, and troubleshooting. Without CW1 access, the Logixboard Support team will be limited in our ability to assist with any potential issues.
Initial Configuration
EAM service task → active
Maintain > System > Service Tasks > EAM
Under Service Tasks, locate the EAM entry and make sure it is set to active. This task must be active before we can connect to and utilize the Outbound eAdaptor.
Logixboard Custom Event → Z87
Maintain > Workflow Manager > Events
In Events, sort by Event Code and scroll down to the bottom. There are many custom events which start with ‘Z’ and we need to adapt one to work with Logixboard. If it is available, please select custom code Z87. If Z87 is already in use, please select a different Z-code to use and be sure to inform Logixboard which specific Z-code you have chosen.
Important: Deselect option Allow Propagate and Cascade
Optional: Change name to “Logixboard Custom Event”
Purpose Code → LXB
Maintain > EDI Messaging > Purpose Code
In order for Logixboard to use the eAdaptor, we’ll need a Purpose Code to attach to EDI communications. Click “New” to create a new purpose code and enter the info below.
Code: LXB
Name: Logixboard EDI
Check for Job Revenue Journal Control Account
Registry > Accounting > General Ledger Defaults > Control Account > Job Revenue Journal Control Account
In order for financial information such as invoices to be sent through the eAdaptor, CW1 requires for a Job Revenue Journal Control Account to be enabled. It isn’t particularly important which control account is entered here, just that one has been applied.
Message Purge Settings → XUR messages for 1 week
Registry > eServices > Message Purge Settings
Application Code: UDQ
Message Type: XUR
The XUR messages are the file type which contain eDocs, so they are sizable. We recommend checking the retention time for these messages in CW1 and ensuring that they are cleared out from your database in a timely manner, such as 1 Week. Longer retention times for XUR messages could result in your CW1 database growing in size unnecessarily.
Provide one Shipment_ID
Operate > Forwarding > Shipments
This is very straightforward, we just need a single Shipment_ID for our automated tools to use for a health check it performs at kickoff. Any S-file from Forwarding > Shipments is fine, assuming that shipment is active.
eAdaptor Inbound credentials
Registry > eServices > eAdaptor > eAdaptor Inbound Authentications
Once the above steps have been completed, please provide Logixboard with your eAdaptor Inbound credentials:
URL
Login/Username
Password
Logixboard needs these credentials in order to connect with the eAdaptor Inbound and kick off the automation portion of the integration.
(Optional) Logixboard Republisher Service setup
Registry > eServices > eAdaptor > Outbound eAdaptor Service URL Registry > eServices > eAdaptor > Outbound eAdaptor Password
If your CW1’s Outbound eAdaptor is currently in use and Logixboard will be republishing messages to another endpoint for you, we will need to collect those details before we proceed to the automated portion of the integration. By setting up the Logixboard republisher in advance, we can enable the service without any interruption to your current operations.
Automated integration steps
Automated process kickoff (via eAdaptor Inbound)
At this point, Logixbooard can launch the automated steps of the integration process. Using the eAdaptor inbound, our system will attempt to install LXB Workflow Templates and configure Org Proxies for Logixboard EDI comms.
🛠️ Please note: Our tooling will identify any potential Workflow Template conflicts before attempting to install our templates.
Rectify any Workflow Template Conflicts
If any Workflow Template conflicts are found, we will provide a list of these conflicts to you. Resolving such conflicts is often as simple as updating the Fallback Method on the conflicting template(s) to ensure your LXB templates are always applied to jobs.
Outbound eAdaptor configuration
Once potential Workflow Template conflicts are addressed, the automated system will generate an Outbound URL and password for sending CW1 messages to Logixboard.
Outbound Option 1
If Logixboard is taking the primary Outbound eAdaptor position in your CW1, then these details should be entered in your Registry at the paths below: Registry > eServices > eAdaptor > Outbound eAdaptor Service URL Registry > eServices > eAdaptor > Outbound > Password
🛠️ Please Note: Logixboard’s Outbound eAdaptor Password must be applied to all companies in your CW1. Failure to apply the Outbound password to all companies will result in data integrity issues, failed messages, and other severe interface problems.
Outbound Option 2
If a middleware will be republishing messages to Logixboard, then these details won’t need to be entered in CW1. Instead, please provide your Logixboard Outbound URL and password to your middleware. They should be able to set up republishing for you.
Activating the Endpoint
Once these Logixboard Outbound eAdaptor credentials have been configured—whether in your CW1 Registry or by your middleware provider—please notify Logixboard immediately. At that point we will activate the endpoint on our end and the configuration phase will be complete.
Data Backfills
After the eAdaptor Outbound is configured, we can start backfilling data. This involves exporting CSV files from CW1—mostly just a list of reference IDs—and providing those files to Logixboard for import. Once set up, our system will go through files one-by-one, contacting CW for the job data, and loading that into the Logixboard database.
Exporting Data from CW1
For each of the data type below, you will need to do the following in CW1. These are recommended steps to most easily collect the backfill data.
Go to the appropriate module.
Search for a date range of shipments with a Created Time between the date we want to import historical information to and today.
Right-click and select “Customize Columns” to modify the table columns to only show the specified column(s) for the job.
Click Find.
Click the Actions button in the top center
Go to Data Transfer → Export Visible Columns To Excel
This will generate a .xls file that you can export to .csv (Comma delimited) using the tool of your choice.
Modules & Column Headers
Shipments | Operating → Forwarding → Forwarding → Shipments Table Columns: Shipment ID |
Consols | Operating → Forwarding → Forwarding → Consolidations Table Columns: Reference (Consol ID) |
ISFs | Operating → Customs → Customs Global → US Importer Security Filing Table Columns: Job Reference |
Orders | Operating → Forwarding → Order Manager → Orders Table Columns: Order Number, Split Number, Buyer |
Declarations | Operating → Customs → Customs → Customs Declarations Table Columns: Job Number |
Invoices | Manage → Receivables → Receivables Transactions Table Columns: Transaction Number, Transaction Type, Ledger |
💡 Declarations and Invoices must be collected from each Company separately.
Company Specific Jobs (Custom Declarations & Invoices)
🛠️ Most of these job types are universal in CW1, so we only have to pull one file for data backfills. The two exceptions are Custom Declarations (B-Files) and Invoices, which are company-specific. This means for Declarations and Invoices, we need to pull a separate file for each active Company in CW1.
💡 Pro Tip: As a way of keeping track of the CW companies that each file relates to, we highly recommend including the 3-character company code in the file names for Declaration and Invoice backfills.
It may look something like Declarations-SYD.csv & Invoices-SYD.csv, and Declarations-AKL.csv and Invoices-AKL, for example. Knowing which specific company to apply to each individual Declarations and Invoice file to is critical for Logixboard’s data integrity.
Providing backfill files to Logixboard
Once the CSVs have been collected, please send them to Logixboard. We will enter the files into are system and begin backfilling data. Once this process completes your new Logixboard platform will be ready.
Congratulations, the process is complete! 🎉