Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

External Device Service

Logistics Execution > Setup > External Device > External Device Service

The External Device Service form displays external device services configured for the active operation.

...

Expand
titleFields

Fields

Click New to create an external device service. 

Fill in the fields to connect with the external service to pull and parse information.

FIELDDESCRIPTION
External Device Service Class Name

The name of the class that pulls data for the corresponding external device service.

Select an option from the drop-down list.

External Device Service ID

Enter text that will be used to identify the service.

Enabled

Select this checkbox to enable the external device service.

Note
titleImportant

Only enabled services will be processed when the Pull External Device and Execute External Device jobs are run.


Last Pulled Token

This code is set by D365 and is mainly used for troubleshooting.

It reveals what data was pulled during the last job so that the system can pull data it has not received yet (new or changed) for the next job. 

External Device User Name

Enter the user name used to log in to the external device service.

External Device Company

Enter the company for the external device service (e.g., the area of business you are pulling data from). 

Info
titleNote

For Geotab, this is the Database field.


Is Password Set?

Select this checkbox if the password is set.

Click Change Password to enter the password for your external device service user name. 


...

Expand
titleButtons

Buttons

There are several buttons you can access to further configure your external device service. 

FIELDDESCRIPTION
Parameters

Click this button to open the External Device Service Parameters flyout window. The available options depend on the service you are setting up.


Expand
titleGeotab

  • External Device URL: The URL used to connect with Geotab.

  • Session Age Date Time: The date the session was last updated. If this is older than one day, the system will reauthenticate using the credentials provided by Geotab.

  • Session ID: The current session ID used for authentication when pulling data.
Info
titleNote

Session Age Date Time and Session ID do not need to be set by the user and are shown for troubleshooting purposes.

  • Start Date: This is not a required field. Only use if you are populating historical data.

    If you set a start date, the program pulls data from that date forward (up to the volume limit of 50k) from Geotab. 

    If you do not set a start date, the program pulls all data changed since the last time the data was pulled from Geotab.  


Expand
titleOmnitracs

  • Sequence Reference Number: Related to your subscription information on the external device service side of setup.


Collection Data Map

Click this button to open the Collection Data Type Map form.

This form allows you to map data that you capture while processing activities.

Info
titleExample

You are starting an activity and want to capture the current fuel level at each location. Use this form to map that data as it comes in.

Action Mapping

Click this button to open the External Device Action Mapping form.

This form allows you to map actions to macros. You can configure which action should run when a specific macro is found in the data pulled from the external device service. 

When the system finds a macro value that you set, it will look to the set action to know what to do.

Info
titleNote

A macro cannot be assigned to two different actions, but different macros can share an action (e.g., two macros can both be tied to an arrive action).

Info
titleExample

In the screenshot above, when Transport + Deliver finds a 16 in the XML received from the external service, it will execute the COMPLETE action. 


Change Password

Click this button to set or reset the external device password.

This is the password that ties into the user name for the external service and allows you to pull information. 

Passwords are encrypted.

Click OK to save the password for use when the service is called.

Move Up

Click this button to move the value up. 

Note
titleImportant

The Pull External Device and Execute External Device jobs will run in the configured sequence. Use these buttons to rearrange in the desired sequence.


Move Down

Click this button to move the value down.

Note
titleImportant

The Pull External Device and Execute External Device jobs will run in the configured sequence. Use these buttons to rearrange in the desired sequence.


External Worker Mapping

Click this button to open the External Worker Mapping form.

This form allows you to map external systems to Transport + Deliver. While an external system might have a number that correlates to a worker, Transport + Deliver has only the worker name and no knowledge of the number.

Add the external worker ID and the worker name here to map the two together for use when running the designated service.


...

Expand
titlePull External Device

Pull External Device

Logistics Execution > Periodic > Pull External Device

Navigate to Pull External Device to set up a job to periodically pull the data from the external device service.

The system—progressing in the order set up on the External Device Service form—checks if the service is enabled.

If so, it uses the external service credentials to connect and pull any records accumulated since the last pulled record. The data is pushed into the Inbound Process Queue (action items) or the Inbound GPS Queue (GPS point trying to keep track of where asset is during an activity.)

Note
titleImportant

It will only attempt to pull data for external device services that are enabled.


Note
titleImportant

This job will be run in the sequence set on the External Device Service form. Keep the sequence in mind if there is a dependency (e.g., the hours of service job needs to be done second).


Image Modified

FIELDDESCRIPTION
Batch processing

Turn on the Batch processing toggle.

Monitoring categorySelect Integration from this drop-down list.
Recurrence

Click this button to enter you start date and time, your end criteria, and your recurrence pattern. Click OK.

Info
titleNote

Make sure to think through how often this needs to run. There is potential to get a lot of records back if you are not running this job often enough.

Image Modified



Expand
titleExecute External Device

Execute External Device

Logistics Execution > Periodic > Execute External Device

Navigate to Execute External Device to set up a job to periodically execute the data from the external device service using the Action Mapping form. 

The system processes the pulled records that were pushed into the Inbound Process Queue or the Inbound GPS Queue using the specific rules you set for the external service. It uses the worker to find the activity, associate that action to that activity, and process the activity.

It will only attempt to execute data for external device services that are enabled.

This job will be run in the sequence set on the External Device Service form.

Image Modified

FIELDDESCRIPTION
Batch processingTurn on the Batch processing toggle.
Monitoring categorySelect Integration from this drop-down list.
Recurrence

Click this button to enter you start date and time, your end criteria, and your recurrence pattern. Click OK.

Info
titleNote

Make sure to think through how often this needs to run. There is potential to get a lot of records back if you are not running this job often enough.

Image Modified


Inbound Process Queue

...

Actions in red indicate that the execution attempt failed (e.g., not in right status, no matching activity found).

Info
titleNote

There is overlap here with the Deliver app so some failures come from the app (e.g., cannot hit Start because someone didn’t finish out the activity in the app).