7. Dynaway Mobile Functionality Configuration

Set up and configure the Mobile Client

Introduction

This section contains guides on how to set up and configure the Mobile Client in the Dynaway Mobile module in Dynamics 365 for Finance and Operations.

Prerequisites

You have completed the mobile deployment.

Audience
Sysadmin, Partner Consultant

Security Roles

In Dynamics 365 for Finance and Operations, security roles are used to grant access rights to a user, allowing the user to access certain menu items and perform specific tasks.

Security roles relate to Client Access Licenses (CAL) in Dynamics 365 for Finance and Operations. Refer to the article Security roles in the Mobile Setup for Dynamics 365FO section for an overview of security roles related to the Mobile Client.

Module Configuration

The module configuration defines which functions are available for users using the Mobile Client. Select Dynaway mobile > Setup > Module configuration to open the form.

The configuration parameters are shown in a tree structure. The leaves in the tree structure represent a parameter. The leaves are grouped based on functional area.

You can see the following 6 root nodes:

  • Application locations
  • Floor plan
  • General
  • Scheduling board
  • Safe work, and
  • Work execution

Change a Configuration Value

All leaves in the configuration structure have default parameter values that can't be edited or deleted. If required, you must add additional lines to change the value of a parameter – defining a new value for all users, or a user group, or a specific user.

Do this by first selecting a parameter and selecting Add to add an additional value line. When adding a line, you must define both the scope of the value and the selected value. If the scope is either a user group or a user, a specific user group or user is also required.

In screenshot 01 below, an example of a configuration setup for Checklists is shown. This setup relates to viewing and working with checklists, which are related to work orders, on the Mobile Client. You can see that there are default values set for different worker types (Maintenance requestor, Maintenance contractor and Tasks user). There is also a default value is 'true', meaning all users can view and work with checklists, unless there is an over ride by a worker type or a user group or a user. In this example you can see that this setup has been modified so the user/worker Julia Funderburk can't see checklists related to work orders because that parameter value is set to 'false'.

In screenshot 02 below, the Scope column is highlighted to show you the options for setting up different parameter values:

  • Default shows the pre-defined parameter value, which is automatically set up during installation of the Dynaway mobile module.
  • To have a different value for all, a specific user group or a single user, add a new line, select the desired scope and fill in the value.
  • When determining which value a specific user has, the setting for the individual worker precedes settings for user groups the user is in, which precedes the All scope which then precedes the Default setting.

01: Configuration for 'Checklists'.
01: Configuration for 'Checklists'.
02: Options in 'Scope' column.
02: Options in 'Scope' column.

Running Environment

Changes made to the module configuration are effective immediately after the changes have been saved. To update the module configuration on the Mobile Client for the individual user, they may go to the Settings page and click the 'Refetch Configuration' button.

The tables in the two articles below provide an overview of the configuration setup in Dynamics 365 for Finance and Operations > Dynaway mobile > Setup > Module configuration for the Mobile Client, including a description of standard settings.

Asset Management

This area includes configuration of functionality and modules on the Mobile Client.

Configuration
section
Configuration Default
value
Description
Enabled true

Enable/disable the Asset management module.

Assets Asset and functional
location attribute add
false Allow adding attributes to assets and functional location attributes.
Assets Asset and functional
location attribute update
false Allow updating asset attributes and functional location attributes.
Assets Asset BOM true

Enable/disable asset BOM.

Assets Asset counters true

Enable/disable asset counters.

Assets Asset image updates false

Allow updating the image for an asset.

Assets Document attachments true

Enable/disable asset document attachments.

Assets Event history true

Enable/disable asset event history.

Assets Faults true

Enable/disable asset faults.

Assets Maintenance downtime false

Enable/disable maintenance downtime functionality on work orders
and requests.

Assets Offline assets false

Enable/disable downloading assets with only basic information available.
This is done to allow users to create requests and work orders while offline.

Maintenance
requests
Allowed lifecycle states [param]

List of maintenance request lifecycle states that can be set
on the Mobile Client. An empty list means that all
maintenance request lifecycle states can be set.

Maintenance
requests
Document attachments true Enable/disable attachments on maintenance requests.
Maintenance
requests
Enabled false

Enable/disable maintenance requests on assets.

Maintenance
requests
Faults true Enable/disable faults on maintenance requests.
Scheduling board Enabled false

Enable/disable the Scheduling board module.

Scheduling board Planned absence false

Show planned absence for time registration users on the Scheduling board.

Scheduling board Readonly mode false

Enable/disable read-only mode on the Scheduling board.

Scheduling board Schedule-duration
modification
false

Allow scheduling a different duration than forecasted
on the job during planning.

Scheduling board Split maintenance jobs true

Allow splitting a work order job schedule in two
individual schedules.

Scheduling board Week start day [param]

Select the day to be shown as the first day in the
week in the calendar on the Scheduling board.
The default setting is 'Monday'.

Scheduling board Work order card title
configuration
[param]

Configure how work order jobs are displayed
on the Scheduling board.

Service portal Document attachments true

Enable/disable attachments on requests in the
Service portal.

Service portal Enabled false

Enable/disable the Service portal module.

Service portal Faults true

Enable/disable faults on requests in the
Service portal.

Work orders Allowed lifecycle states [param]

List of work order lifecycle states that can be set
on the Mobile Client. An empty list means that all
work order lifecycle states can be set.

Work orders Checklists true

Enable/disable work order checklists.

Work orders Create related work order false

Enable/disable creating related work orders.

Work orders Create work order false

Enable/disable creating work orders.

Work orders Create work order line false

Enable/disable creating work order lines (jobs) on a work order.

Work orders Work order deep link false

Enable/disable usage of deep links for work orders in Scheduling Board.

Work orders

Document attachments true

Enable/disable work order document
attachments.

Work orders Item forecast modification false

Enable/disable modifying work order
item forecasts.

Work orders Offline inventory false

Allow storing a snapshot of a partial inventory
offline. The snapshot is from a site, warehouse,
and/or location specified by the user on the Mobile Client.

Work orders Purchase requisition false

Enable/disable creating purchase requisitions on work orders.

Work orders Remarks and reason codes false

Enable/disable showing fields to enter remarks and select
reason codes on work orders.

Work orders

Responsible worker
modification

false

Enable/disable editing Responsible worker on a work order.

Work orders

Work order schedule
modifications

true Allow making changes to work order schedules.
Work orders

Work order schedule
work status

false

Show work status on scheduled work order jobs and
use this information to automatically make changes on
work order lifecycle state. If this parameter is not enabled,
the user must manually change work order lifecycle state.

Work orders

Work order schedule
work status color

false Enable/disable color setup on work status. Setup the specific colors
in the work order work status display setup.

Work orders >
Registrations

Expense registrations true Enable/disable expense registration on work orders.
Work orders >
Registrations
From and to time on
hour registrations
false

Enable/disable registration of From and To time on
an hour registration. If the parameter value is set to 'false',
it means you enter duration in hours on a work order job,
but a specific time interval cannot be selected.

Work orders >
Registrations
Item registrations true

Enable/disable item consumption registrations on
work orders.

Work orders >
Registrations
Lock item registration
storage dimension
false

Enable/disable forcing the Mobile Client to use inventory
dimensions from the functional location on the work order
job during item consumption, if those dimensions have
been set on the functional location.

Work orders >
Registrations
Registrations for other
workers
false

Allow create and edit registrations on behalf of
other workers.

Work orders >
Registrations
Start/stop on
maintenance jobs
false

Enable start/stop of timer that tracks work hours
spent on a work order job.

General

This area includes configuration of general mobile functionality.

Configuration
section
Configuration Default
value
Description
Document attachments Document attachment
cache size
75

Define the amount of storage in megabytes that will be used for
non-prefetched attachments before the least recently used
attachments will be deleted from the Mobile Client to make
room for recently requested attachments.

Document attachments Max. attachment
upload size
15000

Define the maximum file size in kilobytes for document
attachments (default is 15 MB per file).

Document attachments Max. image attachment
upload size
200

Define the maximum file size in kilobytes when uploading
image attachments (default is 200 KB per file).
Larger files will be resized to this value.

Entity synchronization

true

Enable synchronization of entities for offline operation.

NOTE: This is only relevant if mobile users are only using the Scheduling board.

Telemetry

false

Enable collection of telemetry data on the Mobile Client.

Configuration of all module parameters is set up in Dynaway mobile > Setup > Module configuration. Each parameter has a default value that can be changed for all users, a specific user group, or a specific user. For any user, the most specific setup is always used.

Offline Functionality

The Mobile Client can be used outside company premises, for example, in remote areas with limited or no internet coverage. Registrations on the Mobile Client are transferred to the company's ERP system, Dynamics 365 for Finance and Operations, when an online connection is available. This solution supports offline functionality meaning that registrations can be made by workers even if Dynamics 365 for Finance and Operations is temporarily offline.

The following should be observed regarding data synchronization:

  1. Data synchronization only takes place when the Mobile application is active on the mobile device.
  2. When data are registered on the Mobile Client, the client will attempt to submit those changes to Dynamics 365 for Finance and Operations.
  3. A complete synchronization step, during which data updated in Dynamics 365 for Finance and Operations are synchronized to the Mobile Client and vice versa, takes place every 10 minutes.
    The 10-minute interval is customizable using the module configuration General > Synchronization > Synchronization frequency.
    1. Data are submitted immediately when you create a work order from a request, and thus this operation can only occur when the Mobile Client has online access to D365F&O.
  4. From Dynamics 365 for Finance and Operations, a system administrator can force a rebuild of the client databases. However, the Mobile Clients will not start a rebuild before all local changes have been submitted to Dynamics 365 for Finance and Operations.

Generally, all data are available on the Mobile Client in offline mode, with a few exceptions:

  • While the Mobile Client is in offline mode, item consumption registrations can only be viewed and deleted. However, if Offline inventory functionality is enabled, you can also create and update item consumption registrations. When the Mobile Client is in online mode, you can perform all tasks on item consumption registrations.
  • Item forecasts on work orders can only can be viewed and deleted when the Mobile Client is in offline mode. However, if Offline inventory functionality is enabled, you can create, view, update, and delete item forecasts in offline mode.
  • Working with applications other than the Work execution application requires online mode
  • Search for data not already available on the Mobile Client requires online mode.

In some circumstances, errors may occur while synchronizing registrations from the Mobile Client to Dynamics 365 for Finance and Operations. If data cause the errors, detailed error information can be seen in the Notifications area of the Settings page. Generally, the analysis and processing of these messages will not be performed by the worker making the registrations, but by a supervisor, manager, or system administrator.

Example: A worker made hour registrations on a work order on a Mobile Client in offline mode and then logged out and went on a one-week vacation. In the meantime, data were not submitted to Dynamics 365 for Finance and Operations, and when the worker returns and logs in again, the data transfer fails because, during the one-week period, a manager changed the status of the work order, on which hour registrations was made, to Completed. You cannot make registrations on a completed work order, which is why an error message will be displayed in the synchronization log when the Mobile Client goes online.

Data Entities

Data sent to and from the Mobile Client are sent as data entities, which are stored offline by the Mobile Client in a local database. The data entities can be viewed in entity setup.

Entity Setup

Select Dynaway mobile > Setup > Entity setup to see the list of mobile entities.

Note: The entities, which should be synchronized to the Mobile Clients, must be enabled. Usually, that would include all entities.

All the data entities that are eligible to be sent to the Mobile Client are stored in a synchronization table in the database, which must be initialized before you can start using the Mobile Client. No data will be available to mobile users on the Mobile Client until data initialization has been completed.

Entity list

Each line in the Entity setup list represents a data entity that is being sent to the Mobile Client. Entities may contain data from one or more tables in Dynamics 365 for Finance and Operations. Each entity can have a number of properties (described in the table below), which affect the synchronization and the amount of data being sent. These properties can't be changed, but some individual properties can be adjusted or contain related setup.

Enabled

This property indicates whether or not the entities should be monitored and sent to the Mobile Clients.

Personated

This property indicates if the data entity will be personalized to the individual mobile user.

Personalized entities mean that data will only be synchronized to devices for selected mobile users. This occurs if there is a relation between the user and the data entity. Personalizing will be done during an 'initialize synchronization data' job each time data inside Dynamics 365 for Finance and Operations are created or updated.

Example: Work orders is a personalized entity. Work orders will only be personalized and synchronized to the users' mobile devices when the work order, or any of the work order jobs, have been scheduled to the users. The result is that the number of work order data on the users' mobile devices are greatly reduced.

Some entities may also get personated to users based on their behavior on the Mobile Client, even if they have not been directly linked to the data. If the user requests data on the Mobile Client that are not available offline, this can result in personalizing new data entities.

Example: If a user does have any work related to a specific asset, data for that asset will be unavailable offline as this is not automatically personalized. However, if the user uses the online search to find an asset and starts working with the asset, the asset data will be personalized.

Update deferred

Is selectable for ObjectType and JobType mobile entities.

When enabled, updates are postponed until Maintenance cleanup jobs run, rather than being applied immediately. This helps improve performance in F&O, especially when working with large, related datasets (such as fault combinations), which can otherwise slow down the system during updates.

For example if there are many fault combinations associated with an asset type, updating the asset type in F&O will be way slower if Update deferred is disabled.

Document
references

This property indicates if the data entity supports attachments on the Mobile Client. Attachments are handled in Dynamics 365 for Finance and Operations as document references.

If document references are related to a data entity, document references can also be included in the data entity for offline use. Data can either be downloaded on demand or using prefetch. The configuration determining which document types are related to an entity, and how data are downloaded, is described in the article Attachments.

Date range
enabled

Date range enabled indicates if the entity synchronization can be adjusted to take less data, based on the age of the data.

This is done by using a sliding window of a set amount of days - refer to the Days description below. If no sliding window is available, all historical data are sent to the Mobile Client. This setting will only have an effect during 'data initialization'.

Days

Indicates if the entities are available for custom translations to different languages so that users from different countries using the same data can understand what is meant, e.g. checklist instructions.

Translations

See the Date range enabled description above.

Change this value to reduce the amount of data being sent to the Mobile Client. The number of days indicate the number of days in the past that will be included in the synchronization of the
entity. If the number of days has not been specified, or if it is set to zero, no sliding window of data will be applied.

Example: Setting up a sliding window for a period of 90 days on 'TimeRegistrationHeader' and 'TimeRegistration' means that only time registrations for the past 90 days are available to the
user on the Mobile Client.

Initializable

This indicates if the entity type can be initialized directly.

Initialization
count

Number of entities generated if initialization is performed with the current setting (Days).

Entities

This value shows the total number of data entities that are currently stored in the synchronization table. If the entity is not personated, this is also the number of data entities being sent to all mobile users.

A large value may indicate a large amount of data being sent to Mobile Clients for offline use. Setting up a date range and/or 'initialize synchronization data' could reduce the number of entities.

Personations

This value shows the number of personalized entities.

A large value may indicate that a large amount of personalized synchronization entities have been generated. If the data initialization is taking a long time to run, the reason could be a large value set in this field.

Failed entity submits

Lists the number of times operations on this type of entity has failed.

Clicking the menu button for Failed entity submits will lead the user to the list of failed entity submits for the selected entity.

Data Initialization

Data Initialization is a functionality performed in D365, specifically used in conjunction with the Work execution app.

Guidelines for using Data initialization

Below are guidelines to ensure that customers apply Data initialization only when necessary.

  1. When to use Data initialization
    • In a standard installation, Data initialization should only be used after upgrading to a new version of the Dynaway modules in D365.
  2. When Data initialization is NOT required.
    • Adding master data such as a new work order type or changing allowed transitions for work order lifecycle states.
      • New and updated data is automatically synchronized to end-users.
    • Changing module configuration for a user, including:
      • Adding or removing users from user groups.
      • Updating document types setup (Dynaway mobile > Setup > Document types).
      • The updated settings will be available to the end-user upon application restart or by navigating to the settings page and selecting Refetch configuration.
  3. When Data initialization is required
    • After adding new translations in (Dynaway mobile > Inquiries > Translations) you will need to run Data initialization.
    • If deferred initialization is enabled for the JobType and/or ObjectType entity, after updating fault combinations or job variants, you will need to run Data initialization.

Using the Data initialization

The data initialization job will, based on user and entity setup, identify and add the data required by users to the synchronization table. Only data required by users will be added to the synchronization. In most cases, the data entities will be personalized to specific users. This means that data are only sent to users that require the data, which is done in order to limit the overall data size being sent to individual users.

Example: Maintenance work order data are personalized based on work order scheduling. This means that the work order data entity - and associated data entities – will only be sent to the users who have been scheduled to the work order.

  1. Click Dynaway mobile > Periodic > Data initialization.
  2. In Dynaway mobile > Setup > Mobile parameters > Change tracking > Synchronization status FastTab, the Initialization active check box may already be activated on the company account on which you want to run initialization. If that check box is activated, you can't start a new initialization. See example in screenshot 02 below. Therefore, if you want to run initialization once more, for example, if the first initialization failed, you must select Yes in the Force field in Data initialization dialog, which will override the mobile parameters setup. Note that Force should only be used if the previous initialization has failed or you expect that it has failed.
  3. Select Yes in the Verbose field if you want to see detailed information about the initialization. Detailed information is shown in an Infolog message.
  4. Select OK to run data initialization.

The screenshot 01 below shows the Data initialization dialog.

Synchronization status and paging information is shown in Change tracking:

  • The Synchronization paging section shows how many records are currently held in the temporary synchronization paging table, which is used to ensure a steady flow of data to the Mobile Clients. Under normal conditions, this number should be fairly low; only after a new data initialization has completed should a large number be shown in the Records field. Under normal conditions, a large number may indicate a problem with data or synchronization in general.
  • The Synchronization status section shows the synchronization status for each company account for which synchronization has been initialized. The table shows the company account, if initialization is currently running for this company account, start and end times for the latest initialization, database change tracking version, number of initialized entities, and the number of personations currently active in the company account.

If any of the data entities have been disabled by setup, or data related to entities have been changed - either by module updates or custom changes - synchronization data must be reinitialized.

01: 'Data initialization' dialog.
01: 'Data initialization' dialog.
02: Initialization active on a company setup
02: Initialization active on a company setup

Initialize Data in Multiple Companies

If you have multiple company accounts in which you need to initialize data entities, the Multicompany data initialization functionality allows you to quickly start data initialization for several companies at a time.

  1. In the Synchronization status grid view, select the company accounts that should be initialized by selecting the Initialization active check box for the accounts.
  2. Select the Multicompany initialization button to start data initialization.

If you create a batch job for the initialization process, each company account initialization will be created as a separate task, allowing for parallel execution of the data initialization. Depending on the hardware, this setup may reduce the total time for data initialization significantly. If you don't create a batch job, the company accounts are initialized in sequence.

01: Multicompany data initialization.
01: Multicompany data initialization.

Data Synchronization

When the Dynamics 365 for Finance and Operations environment is running, and the Mobile Clients are used, initialization data synchronization is not required. Any changes to data, that are required by users, will be identified based on database change tracking. This means that any changes made in Dynamics 365 for Finance and Operations are added to the synchronization table immediately, if those changes are required by one or more mobile users.

Example: A maintenance work order is scheduled to a user in Dynamics 365 for Finance and Operations, which results in an update to the work order database table. This change in data triggers the data to be added to the synchronization table if the user scheduled on the work order is a mobile user.

Key Terminology

Term Explanation

(Mobile) Entity

A JSON object that holds information about data for setup or data entries in F&O, e.g. asset type and work order.

Note: There is a concept called Data Entity in standard F&O, which is used for exporting and importing data. These two concepts have nothing to do with each other.

Mobile synchronization

A mechanism that moves data between F&O and mobile clients

Personation

When an entity is marked for synchronization for a specific user. Some entities are automatically marked for synchronization for all users (e.g. Asset Types and other setup data). Others can be marked later, such as when an entity is clicked or if it is connected to the user (e.g. a work order scheduled to a worker will be automatically personated for this worker)

Synchronization Page

In order to not overwhelm the mobile client with all data at once, entities are sent in batches called pages.

Initialization of synchronizing data in a running environment should only be done during planned system maintenance, or if synchronization data sent to users has been identified as incorrect or containing data errors.

How does Synchronization Work?

A mobile client can request mobile entities on behalf of a mobile user. F&O will always return changes since the last time a mobile device synchronized. When a mobile client is opened for the first time, all mobile entities personated to the user will be transmitted. On subsequent synchronization calls F&O sends the delta (difference) between the last sync and the current state.

Platform List of entities + toggle what entities are synchronized See actual entities
AM

Dynaway mobile > Setup > Entity setup

Dynaway mobile > Inquiries > Entities > Inspect entities

EAM Mobility > Setup > Entity setup Mobility > Inquiries > Inspect entities

Alternatively, you can see the actual entities in more than the way mentioned above.

To view the mobile entity for a specific table record in F&O:

  1. Select the specific table record in F&O.
  2. From the top menu go to Options > Page options > Record info.
  3. On the Record information panel you can see the Inspect entities button (see screenshot 03) for Dynaway mobile (AM) and Mobility (EAM).
  4. Click to open the entity information directly for that record.

Specify Synchronization Frequency

You have the option to specify an interval of how often data is synchronized to the Mobile Client.

Example: If you are working with poor Wi-Fi conditions, you can set the frequency to update data, for example, once every hour, to improve mobile client performance.

Setup
Go to Setup > Module configuration > General > Synchronization frequency, and set the frequency in seconds to specify the interval between live data being synchronized to the mobile client (see screenshot 01). Any value lower than 10 seconds will automatically be set to 10 seconds, as that is the lowest value available.

Inspect Synchronization Data

It is possible to inspect the number of entities and the data content that are sent to the mobile clients. This can be used for debugging purposes if offline data on mobile clients is unavailable or incorrect.

  1. To open the Inspect form, on the Entity setup page, select an entity in the grid view, and click on Inspect entities from the top menu.
  2. You can inspect the synchronization table for all entities by clicking Dynaway mobile > Inquiries > Entities > Inspect entities. See screenshot 02 for an example below:
    • The grid views show all the entities that have been added to the synchronization.
    • The Mobility entity grid shows a line for each entity.
    • Selecting a line shows a list of workers to which the entity has been personalized (if any), and the data included.
  3. In the Entity personations section, a line indicates a personalized entity. The worker name indicates the user to which data has been personalized.
  4. F&O can also return fullSync: true when asked for changes by the mobile client. This means that the mobile client should drop all entities and prepare to receive all entities again from scratch. This will happen the first time a mobile client synchronizes or when the mobile client is so out of date that F&O can no longer determine what the difference between now and the last time the mobile client synchronized is.

Data Synchronization Triggers

Several events can start a synchronization:

  • Every time the mobile client is opened or refreshed.
  • While opened, the mobile client will trigger a synchronization periodically. The interval can be set in module configuration.
  • When changes are made on the mobile client - the mobile client will send the changes and receive them back alongside other changes that happened since the last synchronization.
  • Clicking Synchronize in the settings page of the mobile client.

Module Configurations

There are several module configurations that can impact how the mobile synchronization works. They can be found in General > Synchronization.

  • General > Synchronization > Synchronization frequency: Will impact how often the mobile client will request changes from F&O.
  • General > Synchronization > Paginated synchronization: Toggles if multi threaded synchronization should be used. This is enabled by default and can make the synchronizations significantly faster.
  • Two other module configurations will only work if Paginated synchronization is true. They depend on each other and impact the speed at which the client synchronizes the changes.
    • General > Synchronization > Page size: Determines how large each synchronization page is in MB.
    • General > Synchronization > Concurrent pages: Determines how many synchronization pages can be requested and processed at the same time by the client, i.e. how many download threads are running.

01: Specify synchronization frequency
01: Specify synchronization frequency
02: Inspect mobile entities
02: Inspect mobile entities
03: The 'Record information' panel with 'Inspect entities' button for AM and EAM.
03: The 'Record information' panel with 'Inspect entities' button for AM and EAM.

Handlers

Handler setup shows the data handler and data provider classes and data handler methods used on the Mobile Client. These handlers are used for data synchronization or online data requests.

Select Dynaway Mobile > Setup > Handler setup to open the grid view.

Each mobile handler is represented by a URL, which is used by the Mobile Client when communicating with Dynamics 365 for Finance and Operations. Each handler has a corresponding Dynamics 365 for Finance and Operations class and method, which represent the code that handles the request.

When this form is opened, available handlers are automatically initialized/refreshed. The Mobile Client will not be able to connect to handlers if the handlers haven't been initialized. If any custom data handlers have been added, or existing handlers have been updated, you may need to open the form in order to initialize new handlers.

Enable Logging

In the Handler setup (see screenshot 01), you can specify whether incoming requests from the Mobile Client and the results of these requests should be logged in the handler log. Enabling logging helps you identify errors that occur on the Mobile Client and review data that is created on the Mobile Client but not yet committed in Dynamics 365 for Finance and Operations.

When logging is enabled, the system stores both:

  • The contents of the data received from the Mobile Client.
  • The corresponding response returned by the system.

To view the log information:

  1. Go to Handler setup, and check the Handler logs column. You can see the number of available log entries.
  2. Select the handler and click Handler log in the top menu to open all logs related to the selected handler.

To enable logging for a handler:

  1. Select the required handler and click Edit.
  2. Enable the Enable logging (see screenshot 02) checkbox for one or more handler lines.
  3. Save the changes.

Note:

  • Enable logging only when you need to troubleshoot issues or analyze data from the Mobile Client.
  • Keeping logging enabled continuously can generate a large number of log entries and may impact performance.
  • Turn off logging after completing your analysis to avoid unnecessary data accumulation.

01: 'Handler setup' page.
01: 'Handler setup' page.
02: Handler setup to enable logging.
02: Handler setup to enable logging.

Skip XDS Policies

Managers can set up that XDS Policies are skipped for online calls from mobile client.

This can be done using 'Skip XDS Policies' parameter in Mobile parameters form by going to Dynaway mobile > Setup > Mobile parameters.

Additionally for each handler in the Handler setup form, users can set up if the individual call should skip XDS in the 'Skip XDS Policies' column.

In Mobile parameters, toggle the button 'Skip XDS Policies' to say Yes.
In Mobile parameters, toggle the button 'Skip XDS Policies' to say Yes.
In the 'Skip XDS Policies' column in the Handler setup form, check the box for each handler ID where individual calls should skip XDS policies.
In the 'Skip XDS Policies' column in the Handler setup form, check the box for each handler ID where individual calls should skip XDS policies.

Mobile User Functional Location

The mobile user functional location feature allows you to limit the data shown in the mobile app based on a selected functional location. When a mobile user functional location is selected, only records related to that functional location are shown in supported mobile queries such as assets, maintenance requests, and work orders. When functional location filtering is applied, worker functional locations take highest priority when enabled, followed by the mobile user functional location. If neither is set, no functional location filter is applied.

Prerequisites

Before using this feature, ensure the following is configured in D365:

  • Enable the configuration to allow user to change functional location for the relevant user or user role in Dynaway mobile > Setup > Module configuration > General > Allow user to change functional location .
  • Review the Limit functional locations based on worker setup parameter (Dynaway mobile > Setup > Module parameters > General > Limit functional locations based on worker setup) if worker functional locations are used. if enabled, mobile queries for assets, maintenance requests, and work orders will take into account only those functional locations to which the worker is assigned.

Set Mobile User Functional Location

You can set the mobile user functional location in the following ways:

  1. In the mobile app from the Settings page
  2. In the mobile app from the Asset details page
  3. In D365 from the Users setup page

Set the mobile user functional location from the Settings page

The Mobile user functional location field in the Settings page is editable only when:

  • Allow user to change functional location is enabled, and
  • Limit functional locations based on worker setup is disabled, or no worker functional locations are assigned.

To set the mobile user functional location from the Settings page

  1. Open the mobile app, and navigate to Settings.
  2. On the Settings page (see screenshot 01), go to the setting Mobile user functional location, and select the relevant functional location.
  3. After selecting a functional location:
    • The selected location is applied as the active filter in the mobile app.
    • A gray header bar displays the selected functional location in the app header. Note that this appears only when the configuration is enabled, a functional location is selected, and the worker functional location override is not active.
    • You can tap the header bar to change the location or tap Clear to remove the filter.
    • If worker functional locations override the user selection, the setting appears as Ignored in Settings.

Set the mobile user functional location from the Asset details page

To set the mobile user functional location from the Asset details page:

  1. Open an asset record in the mobile app.
  2. On the Asset details page, click on the Use as location filter button in the functional location field or alternatively, tap the context menu (three dots on the top right corner of the page) and select Use as location filter (see screenshot 02).
  3. Select the relevant functional location.
  4. After selecting a functional location.
    • The selected location becomes the active mobile user functional location filter.
    • A gray header bar displays the selected functional location in the app header.
    • You can tap the header bar to change the location or tap Clear to remove the filter.

Set the mobile user functional location in D365

To set the mobile user functional location in D365:

  1. In D365, go to Dynaway mobile > Setup > Users.
  2. On the Users page, select the relevant user, and view or update the mobile user functional location and click on the Functional locations hyperlink (see screenshot 03).
    • For all mobile users:
      • The value can be set either in D365 or in the mobile app.
    • For AM workers:
      • Functional locations are set in the worker record in D365.
      • The value cannot be edited in the mobile app.
  3. After updating the mobile user functional location:
    • The selected value applies to the mobile user unless worker functional locations override it.
    • If worker functional locations are assigned and Limit functional locations based on worker setup is enabled, worker functional locations take priority, and the mobile user functional location is ignored.

Note:

  1. When you set the mobile user functional location in D365, the filter is applied even if the user cannot edit the setting in the app.
  2. If worker functional locations are active, the value set in D365 remains stored but is not used for filtering.

01: Setting up the mobile user functional location from the 'Settings' page of mobile app.
01: Setting up the mobile user functional location from the 'Settings' page of mobile app.
02: Setting up the mobile user functional location from the 'Asset details' page of mobile app.
02: Setting up the mobile user functional location from the 'Asset details' page of mobile app.
03: Setting up the mobile user functional location in D365 from the 'Users' page.
03: Setting up the mobile user functional location in D365 from the 'Users' page.
04: The 'Functional locations' page for setting up accessible functional locations.
04: The 'Functional locations' page for setting up accessible functional locations.

Functional Location Selector Behavior

  • When selecting a functional location in the mobile app, the selection window always shows the worker’s assigned functional locations as the starting options.
  • This applies regardless of whether Limit functional locations based on worker setup is enabled.
  • Note that this parameter affects data filtering only. It does not change the initial functional location options shown in the selector.
  • The same functional location selector behavior applies in other mobile pages where functional locations are selected, such as incident and task creation dialogs.

Work Status

Work status is used on the Mobile Client to define work progress on a work order job. Work status has five values, which can be mapped to different work order lifecycle states.

Depending on the setup, which we will explain in this article and related sub-articles, changing the work status on a work order job schedule may update the work order lifecycle state on the work order automatically.

Changing the work order lifecycle state on a work order does not change the work status of a work order job schedule automatically.

A work order may contain one or more work order jobs.

A work order job may contain one or more work order job schedules.

The five work status values available are:

  • Not started
  • In progress
  • Waiting
  • Canceled
  • Work completed

There are different rules for when a work order lifecycle state should be updated, depending on the work status of one or all work order job schedules. A work order job with no schedules is considered to be 'Not started' when determining which work order lifecycle state to update the work order to, when work order schedules change their work status.

Not started
Update the work order lifecycle state (for example Scheduled) when all work order job schedules on the work order are in this work status.

In progress
Scenario 1: Update the work order lifecycle state (for example In progress) when at least one work order job schedule is in this work status, and all other schedules are either Not started, Canceled, or Work completed.
Scenario 2: Update the work order lifecycle state when some work order job schedules are in Canceled or Work completed while the others are in Not started.

Waiting
Update the work order lifecycle state when at least one work order job schedule is in this work status.

Canceled
Update the work order lifecycle state when all work order job schedules are in this work status.

Work completed
Update the work order lifecycle state when all work order job schedules are in this work status.

Scenario 1: A work order contains five work order jobs. When you complete each job, you update work status to Work completed. When all jobs have status Work completed, the work order lifecycle state is automatically updated.

Scenario 2: A work order contains 10 work order jobs:

  • Two jobs have work status Canceled.
  • Three jobs have work status Work completed.
  • Five jobs have work status In progress.

As you complete the five In progress jobs, you update the work status of those jobs to Work completed. When you update the last of the five work order jobs to Work completed, the work order lifecycle state is automatically updated even though two work order jobs have been canceled.

Setting Default Actual Start/End

Lifecycle states that update the actual start or actual end of the work order show a default timestamp based on what is configured on the lifecycle state. The default timestamp can be customized for each lifecycle state.

To do this:

  1. Go to Asset management > Setup > Work orders > Lifecycle states.
  2. Select the lifecycle state for which you would like to customize and set the values for Default actual start and Default actual end.
    • Notes:
      • By default, this is set to Now, which is the present time.
      • In Work execution, the system uses the current time as the default start or end time when the user is prompted to set it, and setting this value to Now will not change any existing setup.
      • If Scheduled start/end or Expected start/end is selected, the default timestamp is copied from the Scheduled start or Scheduled end of the work order, if those values exist. If the scheduled values do not exist, the Expected start or Expected end is used.
      • The Expected end is not a mandatory field. If it does not exist, the system falls back to the current time as the default timestamp.

01: The screen to customize the 'Default Actual Start' and 'Default Actual End' of work orders.
01: The screen to customize the 'Default Actual Start' and 'Default Actual End' of work orders.

Setup in Asset Management

If you want to use work status to automatically update a work order lifecycle state, you must set up a mapping between a work status and a work order lifecycle state.

You set up the mapping of work status and work order lifecycle state in Asset management.

1. Select Asset management > Setup > Work orders > Lifecycle models.
2. Select the Mobile work status to state mapping FastTab.
3. Select Add line.
4. Select a Work status, and select the work order lifecycle state that you want to update a work order to when you select the work status.
5. Repeat steps 3-4 if you want to add more lines.
6. Save the setup. The screenshot below shows our minimum recommended setup.

Refer to Microsoft documentation regarding the general setup of work order lifecycle models in Asset management: Work order lifecycle states.

If you've set up several lifecycle models, work status mapping should be set up on each lifecycle model.

Minimum recommended setup for mapping work status and work order lifecycle state
Minimum recommended setup for mapping work status and work order lifecycle state

Setup in Dynaway Mobile

Next, you set up the mobile workers who should be able to select work status on a work order job on the Mobile Client. This is done in D365FO in Dynaway mobile > Setup > Module configuration > Work execution > Work orders > Work status > Work order schedule work status ( screenshot 1.)
To enable Work order schedule work status, select the configuration key in the license module (screenshot 2.)

Refer to the article Module Configuration and related sub-articles to learn more about the configuration of the Mobile Client.

You can set up specific workers (as shown in the screenshot below), user groups, or all mobile workers to be allowed to select work status on work order jobs on the Mobile Client.

Workers not set up to use work status can only change the work order lifecycle state on a work order.

Workers who can change the work status on a work order job can also shift the work order lifecycle state on the related work order on the Mobile Client. In that case, we recommend instructing your workers only to use work status.

1. Module configuration setup in Dynaway mobile module.
1. Module configuration setup in Dynaway mobile module.
2. Work order schedule work Status
2. Work order schedule work Status

Usage on the Mobile Client

On the Mobile Client, work order lifecycle state is shown in the upper-right corner of the work order details screen.

Work status is shown in the upper-right corner of the work order job details screen if a schedule has been created (see example in the screenshot below).

When you update work status (by selecting the current status, which opens a dialog), a message confirming the update is shown on the Mobile Client.

Work order job details screen. Current Work Status (in this case 'In Progress') is shown in the upper-right corner of the screen.
Work order job details screen. Current Work Status (in this case 'In Progress') is shown in the upper-right corner of the screen.

Colors on Work Order Work Status

Colors on work statuses are available in the Mobile client on work order jobs/lines and schedules. Colors on work statuses allow you to easily get an overview of current work status on work order job/lines and on schedules.

In order to use the functionality, you need to enable the module configuration which can be accessed in Module configuration > Work execution > Work orders > Work status > Work order schedule work status color.

Use default colors

A set of default colors for work statuses are available and are designed to be distinguishable for people with color blindness. Click the button Default values if you have made changes and want to go back to the default colors.

Create your own colors

If you want to use other colors than the default set of colors, follow the steps below.

  1. Click New and choose the work status.
  2. On a record, select the arrow-down button in the Color field. In the drop-down, you can change color in two ways.
    a. In the color palette, select a color. The color number is automatically inserted in the Hex # field, or
    b. If you know the Hex number, enter the Hex color number in the Hex # field.
  3. Select OK.
  4. Leave the field and log out/in on the mobile client or go to the mobile client settings and select Fetch Configuration to see the color update.

Default colors.
Default colors.
Example of work order jobs/lines where the grey color represents the work status.
Example of work order jobs/lines where the grey color represents the work status.

Attachments

The Mobile Client supports handling file and image attachments using standard Dynamics 365 for Finance and Operations document handling. Enabling this functionality requires defining document type setup on data entities, and setup in the module configuration.

Attachment setup is enabled for each specific entity.

Document types that have been set up on entities will be included in the synchronization and will be available on the Mobile Client for offline use.

Set up Document Types

The basic requirement for using attachments is that document references are supported on the entity, and that document types have been set up for the entity.

Entities that support document references can be seen by the check mark in the grid view. To configure document types for entities with document support, select an entity and go to the Entity setup document types grid view.

  1. Select Dynaway mobile > Setup > Entity setup.
  2. Select the entity. The selected entity must support document references.
  3. You can see the document setup across all entities by going to Dynaway mobile > Setup > Document types.
    • Note:
      • It is not possible to dynamically add support for document references on entities.
      • Using the setup alone, it is not possible to enable document references on entities that do not already support it.
  4. Add one or more document types that needs be available on the mobile client. You will need to reference a Dynamics 365 for Finance and Operations standard document type and a permission level. For documents that are supposed to be attached from the Mobile Client, you must also select a Document type identifier.
  5. To create a new document type, on the Entity setup document types screen, select New. Screenshot 01 below shows the Entity setup document types grid.
  6. The Type value refers to standard Dynamics 365 for Finance and Operations document types, which are managed in Organization administration > Document management > Document types. Consider whether existing document types can be used, or new document types should be added.
    1. In the screenshot below, you can see an example of a document type used for attaching files such as PDFs.
    2. If you select a document type with no data (e.g., Note or URL) in the Type field, make sure its Permission is set to Read only. If this is not set to Read, the attachments of these types will not be shown in the mobile application (see screenshot 03).

The upload identifier value is specific to the Dynaway mobile module and is used by the synchronization framework to identify incoming and outgoing file types when new attachments are created from the Mobile Client. Refer to the table below to select the required value.

Document type
identifier
Description
Audio

Used for audio files, for example, mp3 and wav formats.

File/All

Includes file types if specific types haven't already been defined.

Image

Should be used for all image types. Images will be automatically reduced in size
to reduce use of network bandwidth and storage space on the Mobile Client.

Select Attach file in the document type Class field, and Image in the Group field.

SignOffReport

Only available for WorkOrder entity type and must be used together with a custom type named 'SignOffReport' for the sign-off report feature on a work order to work.

See more in Create a Sign-off Report section.

Text

Used for handling text files, html pages (other than the sign off report), log files, etc.

Video

Used for handling video files, for example, mp4 and mov formats.

If the File/All identifier is configured for a specific entity type, it works as an 'all-files-included' configuration, meaning any file type can be handled without having to configure it.

Permission level indicates if users on the Mobile Client should be able to read, create, update, or delete documents. The minimum value is read. Refer to the table below for permission level values.

Permission
level
Description
Read

Allows users to view documents on the Mobile Client.

Minimum value and the recommended value for most document types.

Create

Allows users to attach new documents/images using the Mobile Client.

Update

Allows users to update/replace existing attached images/documents.

Delete

Allows users to delete attachments.

This value is generally not recommended. Deleted files will be removed from the Mobile Client and Dynamics 365 for Finance and Operations without any option to undo.

The Caching field indicates whether data should be fetched automatically to the Mobile Clients. If the Caching check box has not been selected, data is not retrieved until the user selects the attachment to view it. This also means that if the Mobile Client is in offline mode, the data related to attachments is not available. Here you must note that it is recommended only to use caching if all users must have all related documents available at all times because in certain scenarios it can cause performance issues.

Once the user has downloaded attachments, they are available on the Mobile Client in online and offline mode.

01: Entity setup document types in Dynaway mobile.
01: Entity setup document types in Dynaway mobile.
02: Document types setup.
02: Document types setup.
03: 'Entity setup document types' screen with 'Permission' value set with 'Read' access only.
03: 'Entity setup document types' screen with 'Permission' value set with 'Read' access only.

Module Configuration

When the entity setup has been made, the attachment functionality needs to be enabled in one or more sections of the module configuration. Enabling attachments will make attachment menu items available on the Mobile Client.

See an example of enabling attachments on work orders in the screenshot below. It is a prerequisite, that documents have been set up on the work order data entity.

Attachments added to a maintenance job type setup in Asset management are automatically transferred to work order jobs on the Mobile Client, if they use a job type setup that includes attachments, and if the entity document type setup is set to be prefetched.

If an add blocker extension is set up in your browser, it may block access to attachments and asset documents on the Mobile Client. Attachments can be related to assets, requests, work orders, work order jobs, and checklist lines. Asset documents are set up on assets. To allow mobile users to see attachments and asset documents, you can either remove the add blocker extension, or you can allow the mobile site in the add blocker extension.

Module configuration setup for document attachments
Module configuration setup for document attachments

Create a Sign-off Report

When you've completed all the jobs/line on a work order, a maintenance worker and a manager or supervisor can sign off a report to verify completion of the jobs/lines related to the work order. The Sign-off report can contain various information about the work order depending on your needs.

Setup

  1. In order to have the sign-off report be available, the module configuration Work execution > Sign-off report > Enabled must be set to 'true' for the user.
  2. The contents of the sign-off report can be configured, depending the type of information you want to include in the report. This can be configured in Setup > Module configuration > Work execution > Sign-off report. See screenshot 01 below to see the possible configurations.
  3. The Customer signature and Worker signature are mandatory input fields - if you enable them, the user must fill them in before the sign-off report can be saved.
  4. It's possible to write some terms and conditions that will be added to the sign-off report. This can be done in Setup > Mobile parameters > General > Sign-off report.
    1. Whether they are shown depends on the lifecycle state/stage the work order is in when the sign-off report is created. This can be set on the lifecycle state/stage in D365 as seen in screenshot 02 below.
  5. In order to have the sign-off report be saved correctly, a specific document type must be added to Setup > Document types: Entity setup = WorkOrder, Type = SignOffReport, Document type identifier = SignOffReport, Permission = (Either: Create, Update, or Delete).

Create a sign-off report

  1. On the Work order details screen, select 'context menu' in the top right and then Sign-off report.
    1. Note that if the work order is not active, the user will be informed that the sign-off report can't be created for an inactive work order.
    2. Note that if the work order has non-processed mandatory checklist lines, i.e. not checked or set as N/A, the user is informed that some checks are not filled in, and they are also presented with a link to open the checklist.
  2. On the Sign-off report screen, you can see the report. The report is automatically filled out. View an example of a sign-off report in screenshot 04.
  3. If the worker and/or customer signature are enabled for the sign-off report, these must be filled in. Each of the fields Service technician signature and Customer signature is an input field where the name can be typed and a canvas where a signature can be drawn with the finger or mouse. See the input fields at the bottom of the report in screenshot 03.
  4. Select the Signature required button in the 'Service technician signature' field where the maintenance worker or service technician enters a name in the Printed name field and provides a signature in the large signature field.
  5. Select Apply to save the changes.
  6. Select the Signature required button in the 'Customer signature' field. The manager or supervisor enters a name in the Printed name field and provides a signature in the large signature field.
  7. Select Apply to save the changes.
  8. When the sign-off report has been approved and signed, it can be saved. It's saved as a PDF and added as an attachment to the work order. View an example of a sign-off report in screenshot 04.

01: Configuration of content shown on the sign-off report.
01: Configuration of content shown on the sign-off report.
02: Specify if terms and conditions should be shown on the sign-off report on a lifecycle state/stage.
02: Specify if terms and conditions should be shown on the sign-off report on a lifecycle state/stage.
03: Signature required input field.
03: Signature required input field.
04: Example of a sign-off report.
04: Example of a sign-off report.

Customize Fields on Cards/Pages

It's possible to control which users or groups should have access to viewing certain extra information in the mobile client. You also have the possibility of adding your own custom fields that are not directly related to the standard AM/EAM module in D365.

In the following sections below, you can learn how to personalize fields and learn how you can add your own custom fields.

Personalize Fields on Work Execution Cards

It's possible to personalize the fields displayed in the Work execution app. This is valid for Work orders,Work order jobs, Assets and My Calendar.

In order to set up which users and groups can view certain fields on the work order card and the work order job card, go to Dynaway mobile > Setup > Module configuration > Work execution > Card design. From there, you'll see the menu shown in screenshot 01 below.

Asset card design

To view the details on setting up the asset card design, refer to the section on Customize Asset Card Design.

My calendar job design

To view the details on setting up the calendar job card design, refer to the section on Customize My Calander Job Card Design.

Work order design

  • Work order card date fields: you can specify which users or groups should have access to viewing the:
    • Start date
    • End date
  • Work order card other fields: you can specify which users or groups should have access to viewing the:
    • Number of lines
    • Priority/service level
    • Responsible worker group Id
    • Responsible worker group name
    • Responsible worker name
    • Responsible worker personnel number

Work order job design

  • Work order job card date fields: you can specify which users or groups should have access to viewing the:​​
    • Start date
    • End date
  • Work order job card other fields: you can specify which users or groups should have access to viewing the:
    • Functional location Id
    • Functional location name
    • Job trade Id
    • Job trade name
    • Job variant name
    • Object Id
    • Object name
  • Work order job card personnel fields: you can specify which users or groups should have access to viewing the:
    • Scheduled worker name
    • Responsible worker name
    • Scheduled worker personnel number
    • Responsible worker personnel number
  • Work order job card title field: This configuration allows you to control what is displayed as the title for the work order job card.
    • You can choose between:
      • Work order description
      • Note description
    • Note:
      • If the title exceeds two lines, it is collapsed by default, and you can select Show more to expand the full text
      • The title is read-only on the Job Details page, you cannot edit it directly, and it must be updated in the Notes section.
      • The Notes section always displays the job notes, and this this is not affected by the title field configuration.
      • Hiding note description using module configuration does not impact the title field. The title still follows the selected configuration.

01: Card design menu under Work execution.
01: Card design menu under Work execution.
02: Specify who has access to viewing certain information on the scheduling board.
02: Specify who has access to viewing certain information on the scheduling board.

Personalize Fields on Scheduling Board

This configuration allows you to control what is displayed as the title and the fields for the work order card on the scheduling board.

To configure the fields on the scheduling board work order card:

  1. Go to Dynaway mobile > Setup > Module configuration > Scheduling board > Work order card title configuration (see screenshot 01).
  2. Select the user or user role for whom you would like to customize the work order card.
  3. Select the fields you want to display on the work order card by clicking on the drop-down arrow in the corresponding Parameter value column.
  4. On the Select values screen (see screenshot 04), select the fields from the Remaining section that should be included in the work order card and add them to the Selected section using the forward and backward arrows provided. The fields available are:
    • CriticalityCriticality name
    • Forecast hours
    • Job type id
    • Job type name
    • Job variant id
    • Job variant name
    • Job trade id
    • Job trade name
    • Line number
    • Priority/service level
    • Priority/service level name
    • Work order ID
    • Asset/object id
    • Asset/object name
    • Work order description
    • Functional location Id
    • Functional location name
    • Customer id
    • Customer name
    • Scheduled worker name
    • Asset/object type id
    • Asset/object type name
    • Manufacturer/product id
    • Manufacturer/product name
    • Model id
    • Model name
  5. Save the details.

01: Navigation to module configuration for scheduling board work order card design.
01: Navigation to module configuration for scheduling board work order card design.
02: The 'Select values' screen to select parameters.
02: The 'Select values' screen to select parameters.

Personalizing Job Details Page Title Field

You can control what is displayed as the title on the maintenance job details page. The title can show either the work order description or the job description.

To customize the title of the job details page in the Work order module:

  1. Go to Dynaway mobile > Setup > Module configuration.
  2. On the Module configuration page, from the left menu, go to Work execution > Work orders > Maintenance job title field.
  3. On Maintenance job title field (see screenshot 01), select the user or user role for whom you want to customize the job details page title.
  4. Select the field you want to display as the title by clicking the drop-down in the Parameter value column, and select the title field to be displayed.
    • To show the work order description (default), select workOrderDescription (Work order description).
    • To show the job description, select notesDescription (Job description).
  5. Save the configuration. Changes made in the module configuration are reflected immediately on the maintenance job details page.
    • Note:
      • If the title exceeds two lines, it is collapsed by default. Select Show more to expand the full title.
      • The title is read-only and cannot be edited directly. To update the description, edit it in the notes section.

01: Navigation to the module configuration 'Maintenance job/line title field'.
01: Navigation to the module configuration 'Maintenance job/line title field'.

Add Custom Fields

It's possible to add your own custom fields if you want to see data which is not directly related to the standard AM/EAM module in D365. This can for example be from extensions or other standard tables.

Note that the mobile client expects data to be in a specific format, an array of JSON objects consisting of: a label, an id and a value. The value can be a text or another array of JSON objects of this type. This data has to be in 'customFields' property on the entity being extended.

Entities that accept custom fields

Note that for now, the entities that accept custom fields are limited to these in the table below, which also has information regarding classes to extend in order to provide the fields.

Entity

AM class

WorkOrderLine

DynAMMJWorkOrderLine

WorkOrder

DynAMMJWorkOrder

MaintenanceObject

DynAMMJObject

Each of these classes implements a serialize() method responsible for the creation of entity data which is later sent to the mobile client.

Additionally, Dynaway mobile modules include JSON parsing classes which can be used for easy creation of formatted data.

Those classes are DynMPJsonObject and DynMPJsonArray.


Example of the fields Criticality and Service level/Priority added

The example below shows a scenario in which criticality and service level/priority of a work order are added to the work order line entity.

[ExtensionOf(classStr(DynAMMJWorkOrderLine))]

public final class DynAMMJWorkOrderLineCustomFields_Extension

{

public void serialize(Common _record, DynMPJsonObject _serialized)

{

EntAssetWorkOrderLine workOrderLine = _record as EntAssetWorkOrderLine; // _record parameter must be cast to correct table buffer.

EntAssetWorkOrderTable workOrderTable = workOrderLine.workOrderTable();

next serialize(_record, _serialized);

// Specific JSON object containing information.

DynMPJsonObject valueObject = new DynMPJsonObject();

valueObject.addValue('id', 1);

valueObject.addValue('label', 'Work order service level');

valueObject.addValue('value', workOrderTable.ServiceLevel);

// Specific JSON object containing information.

DynMPJsonObject valueObject2 = new DynMPJsonObject();

valueObject2.addValue('id', 2);

valueObject2.addValue('label', 'Work order criticality');

valueObject2.addValue('value', workOrderTable.criticality().Criticality);

// Value array for previous objects.

DynMPJsonArray arrayObject = new DynMPJsonArray();

arrayObject.add(valueObject);

arrayObject.add(valueObject2);

// Previous array is added as value to the main value object.

DynMPJsonObject mainObject = new DynMPJsonObject();

mainObject.addValue('id', 100);

mainObject.addValue('label', 'Work order data');

mainObject.add('value', arrayObject);

// Finally, main value object is added to top-most JSON array.

DynMPJsonArray mainArray = new DynMPJsonArray();

mainArray.add(mainObject);

// The array is added to the serialized entity which will be sent to the mobile client.

_serialized.add('customFields', mainArray);

}

}


Example of structure

Below is an example structure of the data which should be put in the 'customFields' property.

[
{
label: 'Work order data',
id: 100,
value: [
{
label: 'Work order service level',
id: 1,
value: 4
},
{
label: 'Work order criticality',
id: 2,
value: 2
}
]
}
]


Result of the example

In the screenshot below, you can see the result of the extension in the mobile client after adding the fields.

Result of the extension seen in the mobile client.
Result of the extension seen in the mobile client.

Lists

Lists can be created based on filtering of entities and properties related to those entities. An example could be a filtering of assets/objects by asset/object type or filtering a request by service level/priority.

On the Mobile Client, list creation is available for most of our applications and modules the user can create and manage lists.

You can create them in the mobile application and in D365 it's possible to manage them, e.g. by publishing them to multiple users or setting them up to automatically download results to the mobile application (this only works on the work execution mobile application).

Manage and Distribute Lists in D365

In D365, Dynaway mobile/Mobility > Inquiries > Saved search lists shows all available lists (called saved search lists in D365) created by all users for all modules.

From here, it's possible to change the type of a list from User defined (the default type after creating a new saved search) to Predefined which allows whoever is managing them to publish to mulitple users or groups. It's also possible to add, edit, and delete lists from here.

  • Changing the type is done in the 'Query' panel as seen in screenshot 01 below.
    • 'Predefined' allows the person who manages the saved search to distribute it to multiple user groups or users.
  • Distributing a saved search is done in the 'User relations' panel as seen in screenshot 02 below.
    • This allows the person who manages the saved searches to specify which user groups or users should see the lists when they open their application.

01: Option to define the query type.
01: Option to define the query type.
02: 'User relations' panel.
02: 'User relations' panel.

Cached Saved Search Lists

When a user has a saved search list assigned to them, they can view the entities (Work orders, Requests, Assets) in the list while online. Any entity they open will remain on their device, so it can still be accessed when the device is offline. Cached lists load faster and are fully available offline.

To make all assets in a saved search list offline, you can mark the list as cached. In such cases, the mobile client will automatically download all assets in the list to the user’s device.

You can set saved search results to be downloaded by enabling the Caching setting in the User relations panel (see screenshot 01). This option is only available for lists of assets in the Work execution app.

  • Example: A user needs to inspect a number of assets/objects to determine their need for maintenance, and the user can have a saved search filtered by a certain functional location or set of assets/objects, set the saved search to be cached, and then even if the user is outside network coverage, they can still create requests or work orders on the downloaded assets/objects.

Note:

  • When deciding which lists to cache, keep in mind that caching too many entities will increase the time it takes for the application to be ready after initialization and will, in general, decrease overall performance if these entities are updated regularly.

Steps to set up cached saved search lists

  • Step 1: Set up a batch job: For any cached lists to be personated, a batch job needs to execute your lists in F&O. This job will check for new assets that match the criteria of your lists.
    1. Go to Dynaway Mobile > Cache saved search lists.
    2. Set how often the system should check for new assets to cache (e.g., daily, hourly).
    3. This ensures new assets that match the criteria of your cached lists are downloaded to users’ devices.
  • Step 2: Assign lists to users with the 'Caching' option enabled:
    1. Go to Dynaway mobile > Saved search lists.
    2. Find the list you want to cache, and change the Type setting to Predefined.
    3. Click the Save button at the top left corner.
    4. In User Relations FastTab, you can assign this list either to:
      1. All users
      2. A group, or
      3. Specific workers
    5. Tick the Caching checkbox.

01: Option to enable 'Caching'.
01: Option to enable 'Caching'.

Limit Results from Lists to Functional Location

It's possible to limit results shown on lists to functional locations that are assigned to maintenance workers. This is valid for work orders, assets/objects, and requests.

Go to Setup > Mobile Parameters and toggle the button 'Query functional location limitation' to limit results shown on lists to functional location.

To assign workers to functional locations, go to:

  1. Asset Management > Setup > Workers > Workers.
  2. Pick a worker from the list on the left.
  3. On the Functional locations tab, add a line to assign a functional location.

If the assigned functional location has children, these are also assigned.

Limit Online Search in Saved Search Lists

Setup to control access to D365 online results for keyword or scanning searches

This configuration controls whether users can perform online keyword or scanning searches within saved search lists in mobile. When disabled, users can search only within downloaded or cached list data within the Work execution app. Note that this configuration applies only to the Work execution app.

To enable/disable the configuration to perform online keyword or scanning searches within saved search lists in mobile:

  1. Go to Dynaway mobile > Module configuration > Work execution > Search.
  2. By default, the parameter value is enabled (set to true).
    • When enabled (true)
      • Keyword search and scanning can retrieve results from D365.
      • Users can search online within saved search lists.
    • When disabled (false)
      • Online keyword and scanning searches are disabled.
      • Searches are limited to cached entities, such as assets, requests, or work orders.
  3. When online search is disabled, on initial load of the application, the saved search list retrieves all results from D365.
  4. Once the list has loaded, keyword searches work only on downloaded or cached entities.
  5. No additional results are retrieved from D365.

Setup to control user permission to create and edit saved search lists.

This configuration controls whether the user is allowed to create and edit saved search lists. Note that this configuration affects all areas except Scheduling board.

To enable or disable the ability to create and edit saved search lists in mobile:

  1. Go to Dynaway mobile > Module configuration > General > Manage saved search lists.
  2. By default, the parameter is enabled (set to true).
    • When enabled (true):
      • Users can create new saved search lists.
      • Users can edit saved search lists marked as User defined.
    • When disabled (false):
      • Users cannot create new saved search lists.
      • Users cannot edit any previously created saved search lists.
      • Existing saved search lists remain visible but cannot be modified.

Colors on Work Order Lifecycle States

You can set up colors for work order lifecycle states, which are visible on the Scheduling board in the right column and on work orders and work order jobs/lines in the mobile client. This allows you to easily get an overview of current lifecycle states on work orders.

This functionality requires that you have already created the work order lifecycle states you want to use in Asset management. Refer to Microsoft documentation to learn about the general setup of work order lifecycle states in Asset management.

Color code setup for work order lifecycle states is done in the Dynaway mobile module.

  1. Select Dynaway mobile > Setup > Asset management > Work order lifecycle state display setup.
  2. On a record, select the arrow-down button in the Color field. In the drop-down, you can change color in two ways.
    1. In the color palette, select a color. The color number is automatically inserted in the Hex field and the Red, Green and Blue fields, or
    2. If you know the hexnumber enter the color number in the Hex field, or if you know the RGB numbers, enter them in the Red, Green and Blue fields .
  3. Select OK.
  4. Leave the field to see the color update.

Color setup on a work order lifecycle state.
Color setup on a work order lifecycle state.

Colors on Lifecycle State of Permits/Forms and LOTOs

It is possible to set up colors for lifecycle states of permits/forms and LOTOs to allow easy recognition of their current states within the Safe Work module.

To specify required colors for lifecycle states of permits/forms:

  1. Go to Dynaway mobile > Setup > Asset management > Form lifecycle state display setup.
  2. On the Form lifecycle state display setup page from the list of lifecycle states, select the state and click on the corresponding color column.
  3. From the color palette, select a color. The color number is automatically inserted in the Hex # field, or alternatively, if you know the Hex number, enter the Hex color number in the Hex # field (see screenshot 01).
  4. Select OK. Similarly set the colors for all relevant lifecycle states and click on Save.

To specify required colors for lifecycle states of LOTO:

  1. Go to Dynaway mobile > Setup > Asset management > LOTO lifecycle state display setup.
  2. On the LOTO lifecycle state display setup page from the list of lifecycle states, select the state and click on the corresponding color column.
  3. From the color palette, select a color. The color number is automatically inserted in the Hex # field, or alternatively, if you know the Hex number, enter the Hex color number in the Hex # field (see screenshot 02).
  4. Select OK. Similarly set the colors for all relevant lifecycle states and click on Save.

01: Form/permits lifecycle state display setup page.
01: Form/permits lifecycle state display setup page.
02: LOTO lifecycle state display setup page.
02: LOTO lifecycle state display setup page.

Enabling the Start Work / Complete Work buttons

The Start work button on the Work order details/ Job details page allows you to start the timer and record the start time on a work order or job. This aims to make it easier for you as a technician, to track time spent on a job more easily.

Setup

For the application to display the Start work button, ensure that the module configuration for enabling the button is enabled.

To do this, go to:

  1. Dynaway mobile > Setup > Module configuration > Work execution > Work orders > Work order start/stop, and ensure that the module configuration to show the button for the user or user group is enabled (set to true).

Conditions under which the Start work button is enabled

The Start work button is enabled only if the below conditions are met:

On Work order details page:

  1. The module configuration in Dynaway mobile > Module configuration > Work execution > Work orders > Work order start/stop is enabled, and
    • Work status not enabled
      • Actual start is not set on work order, or
      • Not all jobs have been scheduled
    • Work status enabled
      • Actual start is not set on work order, or
      • Not all jobs have been scheduled, or
      • One or more schedules have work status Not started or Waiting
  2. The work order is active.
  3. The actual end time is not yet set on the work order.

On Work order job details page

  1. The module configuration in Dynaway mobile > Module configuration > Work execution > Work orders > Work order start/stop is enabled, and
    • Work status not enabled
      • Actual start is not set on work order, or
      • Job has no schedule
    • Work status enabled
      • Actual start is not set on work order, or
      • Job has no schedule, or
      • Work status Not started or Waiting

Additional Conditions

In addition to the above conditions once the Start work button is displayed on the page, for the Start work button to work, the following conditions must be met:

  1. The employee is active, allowing them to register hours.
  2. Permit is approved:
    1. The permit or all related permits are approved, or
    2. The module configuration Dynaway mobile > Setup > Module configuration > Work execution > Work orders > Safe work > Permits > Enabled for the user or user group is disabled (set to false), or
    3. The module configuration Dynaway mobile > Setup > Module configuration > Work execution > Work orders > Safe work > Permits > Validate permits for the user or user group is disabled (set to false).
  3. Schedules exist or can be created:
    1. A schedule exists, or -
    2. A schedule can be created if the current stage allows scheduling and the module configuration Dynaway mobile > Setup > Module configuration > Work execution > Work orders > Work order schedule modifications is enabled for the user or user group (set to true).
  4. Lifecycle state change is allowed:
    1. The work order can transition to the next lifecycle state that sets the actual start, or
    2. The actual start is already set on the work order.

Limitations

  • Dependency on schedules: The Start work button feature requires the concept of schedules to function properly. For this feature to work, the lifecycle state model and the lifecycle states must permit a transition to a state that either allows scheduling or already has a schedule created. If no schedule exists, the start work action will attempt to create one for the logged-in user. In systems where scheduling is not typically used for work orders, there is no straightforward way to disable this behaviour from Finance & Operations (F&O). However, most customers depend on schedules to manage work orders daily.
  • If the work order already has an actual end set, the Start work button will not be available.
  • If the user is restricted from starting work or performing any related automated tasks, the system will display a message explaining the reason for the restriction.

Enabling the Complete Work/ Complete Work Order Button

The Complete work order button and Complete work button on the Work order details/ Work order job details page allow you to complete the work directly on a work order or a work order job.

Setup

For the application to display the Complete work order / Complete work button on the Work order details/ Work order job details page, ensure that the module configuration to show the button for the user is enabled (set to true).

To do this, go to:

  1. Dynaway mobile > Setup > Module configuration > Work execution > Work orders > Work order start/stop and ensure that the user or user group permission is set to true (see screenshot 01).
  2. The Complete work order button (see screenshot 02) on the Work order details is enabled only if the below conditions are met:
    • Work order is active, and
    • The module configuration in Dynaway mobile > Module configuration > Work execution > Work orders > Work order start/stop is enabled, and
    • Start work button is not available, and
    • Work status feature ( Dynaway mobile > Module configuration > Work execution > Work orders > Work status > Work order schedule work status):
      • Is enabled and the combined work status of all schedules is In progress or,
      • is not enabled
  3. The Complete work button (see screenshot 03) in the Work order job details page is enabled only if the below conditions are met:
    • Work order is active, and
    • The module configuration in Dynaway mobile > Module configuration > Work execution > Work orders > Work order start/stop is set to true, and
    • Start work button is not available, and
    • Work status is In progress, or,
      • Actual start has been set on the work order, and
      • Work order job has been scheduled (not necessarily to current user), and
      • Current work order lifecycle state does not set actual end (e.g. Completed or as defined by the business).

01: Configuration to enable/disable the 'Start work' button.
01: Configuration to enable/disable the 'Start work' button.
02: The 'Complete work order' button on the 'Work order' details page.
02: The 'Complete work order' button on the 'Work order' details page.
03: The 'Complete work' button on the work order 'Job' details page.
03: The 'Complete work' button on the work order 'Job' details page.

Planning Note Categories

If you want to use categories for planning notes on the Scheduling board, you must set up those categories in Dynaway mobile. You can add colors to planning note categories. This allows you to easily distinguish the notes you add on the Scheduling board.

To create a new category

  1. Select Dynaway mobile > Setup > Asset management > Planning note categories.
  2. Select New.
  3. In the Planning note category field, enter a name for the category.
  4. Enter a Description.
  5. The Hours field will populate the the default duration when creating a planning note of that category. This can be edited.
  6. To add a color code in the Color field, follow steps 2-4 in the article Colors on work order lifecycle states.
  7. Select Save.

Below is an example of a note category setup, including the drop-down for color selection.

Planning note categories setup.
Planning note categories setup.

You can create direct links to modules in the mobile client for the Work Execution app and the Safe Work app. This is useful in situations where you want to open for example a link to a work order from another application, or send a co-worker a link to a work order in a message, e-mail or the like.

Work Execution App

For the Work Execution app, you can create direct links to Work orders, Assets/Objects, and Requests.

Note: Users must have access to the module where the link directs to, for instance, if a user has access to the Work order module, they can open a work order using a direct link.

Work orders

When a URL formatted as <website-URL>?woid=<Work order ID>&_id=<Job/Line RecId>&_sid=<Schedule RecId> is opened, the application will navigate to the details of the supplied work order or work order job/line or schedule, and download it if it has not already been downloaded.

Example URLs could be:

  • https://mycompany.azurewebsites.net/work?woid=WO-000042
  • https://mycompany.azurewebsites.net/work?woid=WO-000042&_id=87623415
  • https://mycompany.azurewebsites.net/work?woid=WO-000042&_id=87623415&_sid=87622445

Assets/Objects

When a URL formatted as <website-URL>?objid=<Asset/Object ID> is opened, the application will navigate to the details of the supplied asset/object, and download it if it has not already been downloaded.

An example URL could be:

  • https://mycompany.azurewebsites.net/work?objid=FL-01-02

Requests

When a URL formatted as <website-URL>?reqid=<Request ID> is opened, the application will navigate to the details of the supplied request, and download it if it has not already been downloaded.

An example URL could be:

  • https://mycompany.azurewebsites.net/work?reqid=REQ-000042

Safe Work

For the Safe Work modules, you can create direct links to permits.

When a URL formatted as <Work execution application>/permits/details/<PermitID> is opened, the application will navigate to the details of the supplied permit.

An example URL could be:

  • https://mycompany.azurewebsites.net/work/permits/details/USMF-00000317

It's possible to navigate from Permits in the Work execution app directly to the Permit details in the safe work module.

Setup

A few module configurations must be set up in D365 to use the functionality:

  1. Make sure permits are shown on work orders by going to Work execution > Work orders > Safe Work > Permits and set up relevant users.
  2. Then go to Safe work > Permits > Enabled to enable Permits.
  3. Lastly, go to Application locations > Work execution mobile application and provide a URL in the 'Parameter value' tab and specify relevant users.

Now, when clicking on a Permit on a work order in the Work execution app, you will be taken to the Permit details page in the Safe work module.

Setting up Translation of Master Data

The master setup data can be translated for mobile usage. This functionality will allow you to see names, descriptions, and such other elements in your own selected language on mobile platforms. The following section describes how to set up and manage translations. You must note that only setup data for entities supporting translations is shown.

Pre-requisite

  • This functionality requires a valid Dynaway Mobile Platform Translations license.

Defining Translations

To define translations for the master setup data:

  1. Go to Dynaway mobile > Setup > Languages.
  2. On the Languages page, add the language for which you would like to enable translation by selecting the language code from the Language drop-down menu and clicking the Save button (see screenshot 01).
    • The page will reload with the updated language name.
  3. Click the Translations button in the top menu.
  4. On the Translations screen, you can view all data set up for translations. Only setup data for entities supporting translations is shown.
  5. To update the Text field for all translations where the JSON field is empty, click Copy from original in the top menu options (see screenshot 02).
  6. To export all translations to an Excel spreadsheet, click Download Excel (see screenshot 02).
    • The downloaded Excel file will contain the translated text for available translations. If no translation is available, a new blank row will be created for each text.
    • Update the Excel file with the translations and save it.
  7. To import new text values for translations, click Upload Excel in the top menu options (see screenshot 02).
  8. On successful upload, click Validate Text in the top menu options (see screenshot 02).
  9. Click Copy from text to update the JSON value (see screenshot 02).
  10. The translations are now defined for the master data.
  11. For the changes to take effect, run data initialization from Dynaway mobile > Periodic > Data initialization.

Note:

  • In the case of translations for checklists, only checklist lines added through job type defaults or checklist templates will be translated.
  • Translations will apply only to newly created checklist lines, as existing checklist lines do not retain a reference to the original checklist line.
  • The priority logic for WorkOrderLine descriptions is:
    • WorkOrderLine translations coming from:
      • Job type defaults first,
      • then Job type

Viewing Supported Entities

To view the list of entities supported for translations:

  1. Go to Dynaway mobile > Setup > Entity setup.
  2. On the Entity setup screen, you can view a list of all entities. To check if an entity supports translation, look for a checkmark in the Translations column corresponding to the entity name (see screenshot 03). Not all setup entities support translations. Only entities marked with the Translations checkmark can be translated.

List of Supported Entitites

Here is a list of the entities currently supporting translations:

No. Setup Table Translated Entity Notes
Asset types name ObjectType
Attribute types description SpecificationType
Attribute values stringValue SpecificationTypeValue
Counters name ObjectCounterType
Criticality types criticalityName WorkOrder
Description notesDescription WorkOrderLine Description on job type defaults
Fault area description FaultArea
Fault cause description FaultCause
Fault remedy description FaultRemedy
Fault symptom description FaultSymptom
Fault type description FaultType
LOTO lifecycle states name SafeWorkLOTOStage
Maintenance checklist template line name, instructions WorkOrderLineChecklist
Maintenance Checklist variable value value ChecklistVariableValue
Maintenance downtime reason codes name ProductionStopType
Maintenance job type variants name JobVariant
Maintenance job types name, notesDescription JobType, WorkOrderLine
Maintenance request lifecycle states name StageRequest
Maintenance request types name RequestType
Maintenance worker groups name WorkerGroup
Models description ProductModel
Service levels name WorkOrderPriority
Trades name JobTrade
Work order lifecycle model name StageWorkOrder Lifecycle stages for work orders
Work order pools name WorkOrderPool
Work order types name WorkOrderType

Updating Setup Tables

As an administrator, the Update setup tables option allows you to translate setup tables into another language using the values from the JSON column. This functionality helps ensure that setup tables reflect the translated content.

Important Note:

  • Before using the Update setup tables option, it is recommended to save the original content of the setup tables in a specific language, as this action will overwrite the existing entries.
  • Once updated, the original values in the setup tables cannot be restored automatically.

To update the setup tables,

  1. Go to Dynaway mobile > Inquiries > Translations.
  2. On the Translations page, click on Update setup tables (see screenshot 04).
  3. On the Update setup tables dialog, from the Target language drop-down select the desired language and click OK (see screenshot 05).
  4. You will see a pop-up requesting confirmation to update records in the setup table (see screenshot 06). Select Yes to confirm.
  5. The setup tables will be updated.

01: Language setup screen with navigation to 'Translations' screen.
01: Language setup screen with navigation to 'Translations' screen.
02: 'Translations setup' screen.
02: 'Translations setup' screen.
03: Entity setup screen with 'Translations' column.
03: Entity setup screen with 'Translations' column.
04: 'Translations' page with 'Update setup tables' option.
04: 'Translations' page with 'Update setup tables' option.
05: 'Update setup tables' dialog with option to select language for updating setup tables.
05: 'Update setup tables' dialog with option to select language for updating setup tables.
06: Confirmation pop-up to update records in the setup tables.
06: Confirmation pop-up to update records in the setup tables.

Publish Mobile Site on Mobile Devices

The Mobile Client may be published on the users' mobile devices for offline use. This is an easy step, as the Dynaway Mobile solutions are based on HTML5. The user must insert the link to the website containing the mobile application.

The following procedure describes how to publish a mobile site using the Azure setup on a mobile device.

  1. Start the web browser on the mobile device.
  2. Go to the deployed website (example https://example.azurewebsites.com/work).
  3. The browser automatically detects that the site contains an HTML5-based application and starts downloading the application to the browser's cache. This means that the application can run offline if required.
  4. Log in with your user credentials. Depending on the configuration setup described earlier, login is done using Microsoft Entra ID credentials or the credentials defined for the mobile user in Dynamics 365 for Finance and Operations.
  5. When the website is launched in the browser, the downloaded HTML5 application will start to set up the local database and initiate the first data synchronization. When synchronization is complete, the Mobile Client application is ready for use.

We recommend adding the Mobile Client to the home screen of the mobile device by either clicking the install button that should show on the bottom of the application on the first load or by later using the browser feature to install or add the site to the home screen.

Browser recommendation for Android™

On mobile devices using Android, we recommend using the Google Chrome™ browser.

Browser recommendation for iOS

On mobile devices from Apple®, we recommend using the Apple® Safari® browser.

Browser recommendation for Windows®

On mobile devices using Windows, we recommend using the Google Chrome™ browser or the Microsoft® Edge browser.

Copyright Dynaway A/S

Privacy Policy