CarrierAPI Update

In this description, you will find all the necessary information to update Carrier API Version 3. Please read this carefully. If you have any questions, please contact our support directly. (support@heidler-strichcode.de)

Directory Name / Service Name

The Carrier API is typically installed in the Heidler directory as HeidlerCarrierAPI.

The naming of the Windows service corresponds to the naming of the installation directory.

Compatibility

Carrier API from Version 2.0 can be updated to the latest version without any issues.

Update Duration / Downtime

Approximately 5 minutes of downtime should be scheduled for the update.

During this time, you will be unable to process carriers that operate through a web service.

Carriers that operate without webservices are not affected by this.

What needs to be done after the update?

During the update, the Windows service will be stopped automatically.

It will not be started by default after the setup has been executed.

This must be done manually. Alternatively, there is a checkbox in the setup to start the service automatically.

How do I check if the application works properly after the update?

After the Windows service has been restarted, the logs of the Carrier API should be checked. These are located in the main directory in the logs subfolder.

carrierapiservice.log: In this log the start / stop of the Windows service, as well as incoming requests can be traced.

error.log: In this log, you will find all application errors.

After processing requests in a web service module, check both logs to ensure that requests were processed successfully and to identify any error messages.

Additional logs:

Each Carrier API module has detailed logs for processing in the respective module.

These logs include complete requests to the web service and responses from the web service.

What tests should I perform after the update?

After starting the service, you should process a test data record.

For this purpose, you can choose any carrier of your preference as long as they operate through a web service.

Other Special Considerations

There are no other special considerations.