Time Commitment
Setting up Clockwork requires minimal effort but a little bit of waiting time for connections to be made. Whomever is installing the add-in should expect to spend 30-60 minutes of active work to deploy and a few days to do testing as connections are established.
Overview
The Companion (also known as Clockwork) is an Outlook add-in that helps operations teams process inbound logistics email faster and with fewer errors. When a user opens an email, Clockwork extracts key details and uses them to identify the most likely shipment or customs declaration, so operators can quickly confirm the match and keep communications and documents tied to the right file.
Clockwork is designed to reduce time spent searching, copying data between systems, and re-uploading attachments. It supports a consistent workflow for handling common inbound messages (e.g., shipping documents, updates, arrival notices) and improves visibility by keeping the email thread and related documents connected to the underlying work.
This deployment guide covers how to provision access, deploy the add-in to the right user groups, validate the installation, and roll out Clockwork in a controlled pilot-to-full-launch approach.
Install Requirements
Microsoft 365 / Outlook Admin Rights (or whoever manages add-ins) to deploy the Add-in Manifest (XML).
You'll receive two technical documents and links (e.g. xml manifest, and outlook consent) from your Logixboard Partner, usually an Account or Onboarding manager.
A list of users who will get access to the Add-In if not the entire organization.
A list of shared mailbox that users may leverage so we can pre-process the data.
An example shipment you can use for validation. The S-File ID is enough.
Optional Configuration
Staff Assignments in CargoWise for action attribution (e.g. replacing ~AD with the correct user).
High-level Process
You receive your technical documents
You complete the implementation by enabling the Add-in, and completing Outlook API Consent.
You notify your Logixboard partner that you've setup the add-in and granted Outlook API Access. Include any shared mailboxes you want us to process.
We'll complete the configuration.
You can test the plugin using an existing Shipment File.
Configure optional values such as Staff Assignments.
Install Guide
Step 1: Receive your technical setup package
Logixboard will send you the technical documents required to deploy Clockwork. Keep these handy—you’ll reference them for:
Add-in Enablement / Deployment
Outlook API Consent & Authorization
Step 2: Deploy Add-In
The Clockwork add-in is not in the Microsoft Store today allowing us to make updates quickly as we are in very active development. Most customers deploy via Centralized Deployment (Microsoft 365 admin-managed add-ins), so users don’t need to install anything manually.
Navigate to your Microsoft 365 Admin page.
Find
Integrated Appspage using search (direct link).Click
Upload Custom Apps. Provide a name if necessary.Ensure App Type is
Office Add-In.Click
Choose Fileand select the XML Manifest file you were sent.If you are rolling this out to limited users to start, choose the users or user groups.
Review and finish the deployment.
The add-in may take up to 72 hours to appear in users’ Outlook clients, according to Microsoft. It usually doesn’t appear very quickly.
It is very likely that users will have to log out and log back in to see the add-in after installation.
Sometimes the IT admin may need to loosen restrictions for users consenting to apps which you can do within Enterprise Applications → Consent and Permissions.
Step 3: Grant Outlook API Authorization
Clockwork requires your tenant’s authorization so it can access the Outlook data it needs to process messages correctly.
Click the
Clockwork Consent Linkprovided by your Logixboard partner.Review the consent request.
Approve the consent as an tenant admin.
Capture a screenshot of the success screen (we'll send this to your Logixboard partner next).
Step 4: Notify Logixboard Partner
Once the add-in is deployed and consent is granted, send a short confirmation to the Logixboard Partner who sent you your technical documents, likely your Account Manager, or Onboarding Partner.
Confirmation that:
✅ The add-in has been deployed and to whom
✅ Outlook API consent has been granted (with screenshot)
Your requested shared mailboxes for processing (if any)
Step 5: Logixboard Finalizes Configuration
After you notify us, we'll complete the configuration needed for your tenant and environment. You don’t need to do anything here unless we have follow-up questions. This will take about a business day but will likely be faster.
Step 6: Testing
Once we complete the configuration we'll notify you which means you can begin testing. Pick a known shipment (or a known email thread related to a shipment) so you can confirm the experience end-to-end.
Recommended test flow
Choose a shipment you know exists in your system and has related email/document history. Get this from an operator. You'll just need the S-File ID.
Send yourself an email with the S-File ID in the subject line.
Open the email and launch Clockwork (side panel/add-in area).
Confirm that you can:
See Clockwork load without errors
See the email processing or matching experience in Clockwork
See an automatic shipment match. If no matches are found, you'll be prompted to search for your S-File by the ID. Validate you found one.
If you use shared mailboxes:
Repeat the test from a mailbox you asked Logixboard to process.
“Good” results to look for
Clockwork opens reliably on an email
The experience finds a shipment or prompts you to search
No permission/consent errors
Step 7: Optional Configuration
At this point you're ready to use the add-in but we'd recommend setting up Staff Assignments inside of CargoWise to ensure correct attribution of uploads, creates, and edits to the right user.
By default, CargoWise is configured to always use ~AD as the operator when requests come through the e-adaptor. In order for Clockwork to set the operator reference on file creation or document upload, CargoWise must be configured to support overriding the ~AD reference.
There needs to be one entry for each staff user that will be using Clockwork. The staff code and data provider code should be the same.
Navigate to your registry.
Go to your Sender Proxy Users setup. Location depends on setup.
eServices→Universal XML→Interchange Sender Proxy Users(common)eServices→Interchange Sender Proxy UserseAdapter→EDI Message Sender Proxy User
Add in each user with a reference code that is unique to them.
When a user sets up their Outlook Add-In, they will use that code to associate their CargoWise user to the Companion. Additionally, this will help users choose branch and department codes automatically.