Back to Website
Product Documentation Operations Portal Integrations MaxRecall Integration

Operations Integrations - MaxRecall Integration

If you are using MaxRecall on premise software and need to sync documents to display to customers in the Customer Portal, this can be configured within the Kodaris Operations Portal. This does need to connect to your on premise system, so there may need to be some configuration with your security team.

In order to set up the MaxRecall Integration, you can go to System > Settings in the Operations Portal.

There are a few settings that need to be configured. First is the maxRecallApiUrl setting.

To configure the maxRecallApiUrl setting:

  • Search maxRecallApiUrl - this will display the needed setting to update
  • To click into the details of a setting, click the arrow next to it
  • On the Details screen, you can update the value to be your MaxRecall Api Url and then click Save

Next, following the same steps as above, you'll want to configure the following settings as well:

  • maxRecallUsername

This setting should be populated with your MaxRecall API Username.

  • maxRecallPassword

This setting should be populated with your MaxRecall API Password.

  • maxRecallIsEnabled

This setting should be populated with 1 to enable MaxRecall integration.

  • maxRecallOrderDocTypes

A comma-separated list of pairs {maxRecallDocTypeID} - {KodarisFileType}, indicating which order documents should be synced. Example: 1160-ProofOfDelivery,1131-ProofOfDelivery.

  • maxRecallOrderStatuses

A comma-separated list of order statuses to search in MaxRecall.

  • jobSyncMaxRecallDocs

This setting allows documents from MaxRecall to be automatically synced into your Kodaris system. To enable this setting, the value should be 1.

Once these settings have been set up, you're all set!

Documents from MaxRecall will now sync once a day. To confirm that the sync is working correctly, go to your Operations Portal > System Events and look for MAXRECALL_SyncOrderCustomerFiles.

Documents will be stored under Customer Files on the Order Details screen in the Operations Portal.

Also, you can view synced files in the Customer Portal under the Files tab on the Order Details screen.

In this article