Settings Reference

Quick reference of DMS Agent Settings

General Settings

General settings are settings which are applied to the entire DMS Agent instance.

The general settings are configured by following these steps:

  1. Login to DMS Agent console

  2. Navigate to Control panel

  3. Navigate to General Setting

  4. Add your setting on a new line: MySetting = true

  5. Click the Save button at the bottom.

Common

Setting

Values

Description

DeviceMergeFolder

string

Optional path to a folder, where DMS Agent will store the mobile databases as files

useStrictLiveLinkSelect

true | false

default: false

Forces livelink engine to explicitly select only the fields specified for the given business object instead of using *

invalidatePacketTables

Comma separated table names:

Table1, Table2, Table3

Invalidates pending PULL packets in DMS Agent if any of the tables given as comma separated list is presented in the push packet - e.g. invalidate pending packet if Inventory operation is detected

sendPacketTables

Comma separated table:

Table 1, Table2, Table3

if the setting is presented, it will enforce DMS Agent to send packets, which contains at least on of the table names given in sendPacketTables table. This setting is used to limit the number of the packets sent to the ERP.

maxJsonPacketsPerRun

number

default: 50

Controls how much push (inbound) mobile packets are processed per run. Increasing the value will make the system more performant but will eat up more resources ( RAM, CPU)

noJsCompression

true | false

default: false

Value of true will disable the Code static analysis and code compression for legacy mobile apps (developed with DMS Agent Studio)

dontReturnOldPacketForNewDevices

true | false

default: false

Value of true will prevent the devices from downloading a pull packet on deploy e.g. newly deployed devices has to wait for new pull packet export.

skipJsonPacketsByTableName

list of comma separated table names

SLA_CustomerActivity, SLA_Skip, SLA_Visit

List of tables, which will cause the object to be skipped ( e.g. not sent to the ERP ) if found within the packet.Note that the setting will only skip certain records from the packets. Rest of the records will still be processed.

Setting

Values

Description

cloudModeEnabled

true | false

default: false

Value of true will enable the cloud mode for DMS Agent

cloudMode

full | hybrid | disconnected

default: full

full - enabled full cloud mode.

hybrid - enables hybrid cloud mode

disconnected - enables disconnected mode

must be used with cloudModeEnabled=true

cloudAppArea

string

the application are name to connect with

must be used with cloudModeEnabled=true

cloudAPIKey

string

the api key for the application area to connect with

must be used with cloudModeEnabled=true

cloudCompanyFilter

string

must be used with cloudModeEnabled=true

cloudIsSandBox

true | false

default: false

All pull/push packets are considered as sandboxed

must be used with cloudModeEnabled=true

Security

Setting

Values

Description

MobileUserDomain

string

Windows Domain name

MobileUserDomainVerbose

true | false

default: false

Value of true will spit out detailed server side logs during authentication.

MobileUserDomainLogonServer

string

Windows Domain Controller name ( or IP )

MobileUserDomainPrincipalUser

string

user to be used to query the Windows Domain Controller during authentication sessions.

restrictDeployByDeviceId

true | false

default: false

Value of true will enforce DMS Agent to allow device deploy only if the mobile app's agentId matches the mobile user's agent id. This allows the admin to further limit the actual physical devices which can deploy the mobile app

mobileWebAccessDisabled

true | false

default: false

Value of true disables the legacy Web user interface for mobile apps used during development/debugging

assistedDeploy

true | false default: false

Value of true will prevent the mobile users from deploying the mobile app on their devices unless allowed by the system admin user by user

Setting

Values

Description

useAIFFileShare

true | false

default: false

Forces AX inbound and outbound ports to use file IO operations to exchange files between AX and DMS Agent instead of using AIF.

remoteAXPath

string

Absolute file path to the folder, where AX/D365FO stores their SyncPackets ( local to AOS )

Setting

Values

Description

navGatewayServiceName

string

Name of the NAV/BC Gateway service name

remoteNAVPath

string

Absolute path pointing to the sync log folder for NAV

navWebServiceCompanyName

string

Company name to be used when querying NAV Web Services

Setting

Values

Description

D365LiveLinkQueryMethod

  • Microsoft.Dynamics.DataEntities.querySqlADO

  • Microsoft.Dynamics.DataEntities.querySqlD365

default: Microsoft.Dynamics.DataEntities.querySqlADO

Specifies the ODATA method to use for LiveLink

Group Settings

There are number of settings, which can be applied per device group. In this way these settings affects only the group to which they are applied.

The group settings are configured by following these steps:

  1. Login to DMS Agent console

  2. Navigate to Control panel

  3. Navigate to Groups

  4. Tap over the Group that you want to modify

  5. Tap over the Settings tab

  6. Click the Add new record button

  7. Enter the Setting name and setting value

  8. Click the Green checkmark button to Save

Alternatively you can click the EDIT button next to the setting to modify the setting name and value or even delete it by tapping the BASKET icon next to the setting.

The Group settings are affecting the way the mobile devices/apps are behaving.

Setting

Values

Description

cloud.token

string

name of application area. Enables the Disaster Recovery mode, when provided

cloud.tag

string

optional group name. Used in reports as a tag/label. Could be a region for example. Must be used with cloud.token and xapikey settings

xapikey

string

ap key for the given application area defined by cloud.token setting

connectionTimeout

number

default: 20000

timeout in milliseconds for the mobile app to wait for the server allow connection. If the server does not return response within the given timeout, the mobile app will display error message. Please note that if the timeout is set to a lower value ( under 5000) the app may unable to sync again and only new app deploy will help in this case.

readTimeout

number

default: 20000

timeout in milliseconds for the mobile app to wait for the server return response. If the server does not return response within the given timeout, the mobile app will display error message. Please note that if the timeout is set to a lower value ( under 10000) the app may unable to sync again and only new app deploy will help in this case.

fetchTimeout

number

default:0

Time in milliseconds to wait after each successful execution of select sql against the local ( ondevice) database. The default value is 0 , e.g. no waiting is done.

printTimeout

number

default: 50

Time in milliseconds to wait after each printed line during document printing. This timeout can be increased for some printer models to allow the printer to successfully process each line sent by the mobile device.

forceLiveLink

true or false.

default: false

Forces all calls to local business objects to be executed via livelink - e.g. tries to "convert" all local database calls to remote (livelink) database calls.

noGCM

true | false

default: true

Value of false will disable the check if the current Android device has active Google account. This setting is useful for devices where Google apps are not used like Zebra and others.

orientation

landscape | portrait

default: empty

Value of landscape will "fix" the app to work in landscape mode and will not "listen" to the device's orientation sensor. Value of portrait will "fix" the app to work in portrait mode and will not listen to the device's orientation sensor. Empty value will make so that the app will be automatically rotated with the rotation of the mobile device.

disableFullBkgrSync

true | false

Value of true disables the automatic background synchronization of Android devices. This setting will make the device battery to last more, but will disable the automatic sync of packets.

$agnt.trackLocation

true | false

Enables or disabled the location tracking

$agnt.requireLocation

true | false

Value of true will display error on the mobile device, if the device location service is disabled on the mobile device and the app will not run until the location service is enabled again.

$agnt.disallowsettings

true | false

default: false

Value of true, will require the user to enter PIN whenever the user tries to open the application's settings. The PIN is changed automatically and available in the Agent's tab for each device group.

isFilterActive

true | false

default: false

Value of true will filter-out all non-printer devices. Dynamics Mobile app will display all BT devices to the mobile user , when a document is about to be printed and this might include headphones and other devices, besides printers. The isFilterActive option will try to automatically detect non-printer devices and hide them from the list.