Install EAM-FO

Introduction

This document describes how to retrieve and deploy the Dynaway Enterprise Asset Management (EAM) solution for Microsoft Dynamics® 365 for Finance and Operations using Microsoft Lifecycle Services (LCS).

In order to complete installation by following this guide, you must be familiar with Microsoft Lifecycle Services (LCS) and administration of Microsoft Dynamics® 365 for Finance and Operations environments. For topics not covered in this installation guide, refer to Microsoft deployment guidelines on Microsoft Docs website.

Note

This installation guide covers deployment into cloud-hosted environments for demo, development, and user acceptance testing purposes.

This guide does not cover installation into a production environment as these environments are managed and operated by Microsoft®.

Prerequisites

Before you can set up an environment with Dynaway Enterprise Asset Management (EAM), your company must have access to:

        • a Microsoft® Dynamics Lifecycle Services (LCS) project for Microsoft Dynamics® 365 for Finance and Operations
        • a Microsoft® Azure™ subscription
        • a Dynaway EAM license file

Acquire license file

If you want to install Enterprise Asset Management, first you must acquire a license file. In order to acquire an Enterprise Asset Management license file for Dynamics 365 for Finance and Operations, send an email to support@dynaway.com and provide the following version information:

        • License holder name
        • Serial number of Dynamics 365 for Finance and Operations
        • Product version number of Dynamics 365 for Finance and Operations

This information can be found by clicking Settings (the cogwheel icon in the upper-right corner of the Dynamics 365 for Finance and Operations application) > About.

Note

If you update your Enterprise Asset Management solution from an older version to a newer version, the license file may also need to be updated due to certificate updates.

Dynaway EAM solution for your LCS project

The procedure described in this chapter can be omitted if the Dynaway EAM solution is already available in your LCS project.

The Dynaway EAM solution is published and distributed using the Asset Library in the Microsoft LCS project. In order for the EAM solution package to become available, it needs to be imported into the Asset Library by a representative of Dynaway. In order to do this, Dynaway needs temporary access to your LCS project.

Follow the procedure below to grant access to a Dynaway representative in your LCS project.

  1. In your new project > More tools section > click Project users.
  2. Click the plus sign (+) to add a new user. Leave the User lookup field blank.
  3. In the Email field, insert the e-mail address of Dynaway's LCS administrator.
  4. In the Project role field, select "Project team member".
  5. On the Project user management screen, you will see that you have been added with status "Pending". The first time you log on to LCS, the status will be updated to "Accepted".
  6. If you want to invite other users to your project, repeat steps 2-5.
  7. Notify Dynaway Support that you require the Dynaway EAM solution package by sending an email to support@dynaway.com. Please specify your customer name and the name of your LCS project. Dynaway Support will then add the Dynaway EAM solution to your LCS Project Asset Library. The reply email is from EG Service Desk.

Note

Recommended for security purposes: When the Dynaway EAM solution has been imported to your LCS project, the added users can be removed again. Future versions will automatically be available when they are published.

Invite user as project team member
Invite user as project team member
Project user management status
Project user management status

Get EAM solution

When you have completed the procedure described in the Invite Dynaway to Your LCS Project, the Dynaway EAM solution will be available in the Asset Library of your LCS project. To see the Dynaway EAM solution package contents, go to the Asset Library.

        • You will not get notifications from LCS regarding solution package imports and version updates. In the Asset Library,
          • verify that the EAM solution is available.
          • verify that the version is compatible with the version number of Dynamics 365 for Finance and Operations.
        • You must manually select the correct version of the solution package. Every time Dynaway publishes an updated version of Dynaway EAM, it is automatically available in the versions list. Please refer to the Release Notes to identify if a version of EAM is compatible with a specific version of Dynamics 365 for Finance and Operations.

Use the following procedure to get an updated version of Enterprise Asset Management in LCS.

  1. Go to your LCS Project Asset Library and click Solution package.
  2. Click the Dynaway EAM solution.
  3. Click Versions to view the list of available versions.
  4. Select the most current version and click Get version.

Note

The latest version may contain builds for multiple Application Updates from Microsoft.

Overview of available versions
Overview of available versions

Overview of EAM major build versions

In the table below, compatibility between major EAM versions and Dynamics 365 for Finance and Operations Application Updates is described. Refer to the EAM Release Notes for further details on version contents and compatibility with Microsoft updates to Dynamics 365 for Finance and Operations.

Platform Updates vs. Application Updates

Microsoft releases Platform Updates and Application Updates for Dynamics 365 for Finance and Operations.

Generally, Platform Updates do not contain changes that affect the functionality of Dynaway EAM. Therefore, Platform Updates should not require a new version of EAM to be applied.

Application Updates may affect Dynaway EAM, meaning you should always update to a version of EAM that is compatible as specified in the Release Notes.

Microsoft Application Release

EAM Release

Description

7.0

103.*

Dynamics AX

7.1 (1611)

1611.*

Dynamics 365 for Operations

7.2 (July 2017)

1707.*

Dynamics 365 for Finance and Operations, Enterprise edition

7.3

1712.*

Dynamics 365 for Finance and Operations, Enterprise edition

8.0

1804.0

Dynamics 365 for Finance and Operations

8.1

1810.0

Dynamics 365 for Finance and Operations

8.1

1810.1

Dynamics 365 for Finance and Operations

10.0

1904.0

Dynamics 365 for Finance and Operations

Solution package contents

The Dynaway EAM solution package consists of multiple artifacts. The contents may differ, based on the active version.

Name

Description

BPM Artifact

Business Process Methodology

An LCS business process methodology for EAM is included, which includes processes for the core areas of EAM.

Database Backup

The database backup contains a full backup of Dynamics 365 for Finance and Operations, including Contoso demo data from Microsoft and demo data from Dynaway.

Use this backup if you want to rapidly deploy a new environment for demo or training purposes.

Model

The model contains the X++/.NET source code for Dynaway EAM.

Import this model on development environments in case you need to view, debug, or extend the Dynaway EAM source code. When the model is installed in an environment, the source code becomes available in Visual Studio®.

Process Data Package (PDP)

The solution package contains a process data package including a Business Process Methodology and a demo data package.

https://docs.microsoft.com/en-us/dynamics365/unified-operations/dev-itpro/lcs-solutions/process-data-packages-lcs-solutions/

Software Deployable Package

The software deployable packages contain the binary files required for deploying Dynaway EAM into Dynamics 365 for Finance and Operations. Dynaway EAM consists of two deployable packages,"Dynaway EAM Common" and "Dynaway EAM".

The "Dynaway EAM Common" package contains core functionality and is a prerequisite for deploying the "Dynaway EAM" package, which contains the EAM functionality itself.

Deploy EAM in a new cloud-hosted environment

This section describes how to deploy Dynaway EAM together with a new Dynamics 365 for Finance and Operations environment. Refer to the Deploy EAM to Existing Cloud-Hosted Environment chapter if you are deploying to an existing environment.

Prerequisite: You have already set up an Azure Connector for your LCS project.

  1. Select your LCS project for Dynamics 365 for Finance and Operations.
  2. In the Environments section, click the plus sign (+) to create a new environment.
  3. Select Application version and Platform version.
  4. Select Azure.
  5. Select primary environment topology, "DEMO" or "DEVTEST".

Note

Select "DEMO" if the environment is for demo (sales) or training purposes. DEMO environments can be deployed with both demo data and Dynaway EAM preinstalled, using the advanced deployment options.

Select "DEVTEST" for development, sandboxes, and acceptance testing. This topology requires you to deploy Dynaway EAM through the LCS maintain function as described in the Deploy EAM to Existing Cloud-Hosted Environment chapter.

If you select "DEVTEST" for build and test, you will not be able to deploy Dynaway EAM using the LCS maintain function but are required to manually deploy packages. That scenario is not covered by this installation guide.

  1. Select secondary environment topology.
    1. Select the environment topology matching the version you want to deploy.

Note

If you selected "DEVTEST" in the previous step, selection of a secondary topology build and test will not allow you to deploy packages using LCS. This topology is required if you want to deploy packages manually using runbooks or similar tools.

  1. Select Azure connector.
    1. If you have more than one Azure connector associated with your project, you will be prompted to select a connector, for which the environment will be billed.
  2. In the Environment name field, insert a descriptive name.
  3. If you are deploying a "DEMO" topology, click the Advanced settings button and follow steps 10-12 to select deploying Dynaway EAM together with the environment. If you are deploying a "DEVTEST" topology, continue to step 13.
  4. Select Customize solution assets.
  5. Select the two EAM packages corresponding to the version you wish to deploy: "Dynaway EAM [version number]" and "Dynaway EAM Common [version number]".
  6. Click Done.
  7. Adjust the virtual machine size, if required. Accept the pricing and license terms by selecting the check box at the bottom of the screen.
  8. Click Next.
  9. Wait for the environment to deploy. A new Azure-hosted environment will be created for you, and you will be able to run and test the Dynaway EAM solution.
  10. Continue to the Import License File Using a Deployable Package chapter.

Create a new environment
Create a new environment
Select Azure as environment
Select Azure as environment
Select environment topology
Select environment topology
Select the Dynaway version
Select the Dynaway version

Deploy EAM to existing cloud-hosted environment

This chapter describes how to deploy Dynaway EAM into an existing cloud-hosted environment using LCS. You can also deploy Dynaway EAM during the deployment of a new environment. This is described in the Deploy EAM in a New Cloud-Hosted Environment chapter.

The EAM module is deployed into existing environments using the environment management section of LCS. When the Dynaway EAM solution has been imported into the LCS project as described in the Get EAM Solution chapter, deployable packages will appear in the list of applicable updates.

Note

Before deployment, ensure that the active version of Dynaway EAM in LCS is compatible with the Application Update version of Dynamics 365 for Finance and Operations.

  1. Go to the existing environment in LCS.
  2. Click Maintain.
  3. Click Apply updates.
  4. Select Dynaway EAM Common [version number] in the list.
  5. Click Apply and wait until the process completes. This may take several hours.
  6. Click the Sign off button.
  7. Select Dynaway EAM [version number] in the list.
  8. Click Apply and wait until the process completes. This may take several hours.
  9. Click the Sign off button.
  10. Continue to the Import License File Using a Deployable Package chapter.

Maintain environment
Maintain environment
Apply updates
Apply updates
Select the software deployable package
Select the software deployable package
Sign off
Sign off
Application of the software deployable package
Application of the software deployable package

Import license file using a deployable package

This section describes how to import the Dynaway EAM license file into Dynamics 365 for Finance and Operations using a deployable package. Prerequisite: You already have a license file (.txt) from Dynaway as described in the Acquire License File chapter.

Dynaway EAM uses ISV licensing as described on Microsoft Docs: https://docs.microsoft.com/en-us/dynamics365/unified-operations/dev-itpro/dev-tools/isv-licensing#create-a-package-and-generate-a-customer-specific-license

Microsoft provides a tailored template package for importing ISV licenses. In order for it to work, it must be populated with your own specific Dynaway EAM license file. To create a deployable package follow the procedures below.

Create a deployable package

  1. Make a remote desktop connection to an environment running the same version as your target environment.
  2. Navigate to the CustomDeployablePackage directory under the AOSService folder <PackagesFolder>\bin\CustomDeployablePackage\ImportISVLicense.zip.
    Example location: j:\AOSService\PackagesLocalDirectory\CustomDeployablePackage\
  3. Make a copy of the template package "ImportISVLicense.zip" and rename the copy. For example, rename the file to "DynawayEAM_ImportISVLicense.zip".
  4. Open the zip package file.
  5. In the zip package file, navigate to the sub folder "\AosService\Scripts\License". Copy the license file you received from Dynaway to this folder.
  6. Delete the placeholder file "place your license file here.txt".
  7. Close the file.

Zip package file
Zip package file
Copy license file
Copy license file

Upload the license import package to LCS

  1. Open the Asset library of the target project in LCS.
  2. Navigate to Software deployable package.
  3. Click the "plus" button.
  4. Add the deployable license import package file.
  5. Insert a name for the deployable package.
  6. Click Confirm.

Upload license import package
Upload license import package

Import the license package in an environment

In LCS, navigate to the target environment.

  1. Navigate to the target environment
  2. Click Maintain and Apply updates.
  3. In the list, select the newly added license package.
  4. Click Apply and wait for the process to be completed.
  5. Click Sign-off to complete the process.
  6. Open Dynamics 365 for Finance and Operations to verify the Enterprise asset management module is available in the main menu of Dynamics 365 for Finance and Operations.

Apply updates
Apply updates
Apply software deployable package
Apply software deployable package
Verify EAM
Verify EAM

Set up license configuration

This section describes the recommended initial setup of the license configuration values for new Dynaway EAM deployments in which no data has been set up. Depending on your version of Dynaway EAM, the recommended setup may already be the default setup.

For existing installations, the license configuration key values should be determined based on the functionality in use and the need for keeping legacy data for data upgrade.

Note

Refer to our EAM / ASM Training Material > License Configuration chapter for a detailed description of license configuration values.

In order to change the license configuration, the Dynamics 365 for Finance and Operations environment must be in maintenance mode. Refer to Microsoft documentation for details on how to enable maintenance mode: https://docs.microsoft.com/en-us/dynamics365/unified-operations/dev-itpro/sysadmin/maintenance-mode

To set the recommended license configuration in Dynamics 365 for Finance and Operations, click System Administration > Setup > License configuration.

For new installations, we recommend disabling the following configuration keys:

        • Conditional assessment
        • EAM 100.0.0.0 Keep update objects
        • EAM 1712.1.0.0 Keep update objects
        • EAM 1804.0.0.0 Keep update objects
        • Fault hierarchy
        • Inbound/outbound

License Configuration
License Configuration

Rename CMA config keys

This section describes how to handle configuration keys for Contract Management, if you are updating your Enterprise Asset Management solution.

The contents of the Note below are only relevant:

        • if you are updating your Enterprise Asset Management solution from an existing Dynamics 365 for Finance and Operations version,

AND

        • you have purchased an Asset Service Management license,

AND

        • the Contract management module was previously disabled.

Note

If all three statements above describe the current situation for your Enterprise Asset Management solution, you must disable the Contract management module again.

Upgrade to a new version

This section describes the steps that may be required when updating an environment to a newer version of Dynaway EAM for Dynamics 365 for Finance and Operations.

Prepare the update process

Before starting an upgrade, remove any existing data management projects that contains relations to EAM data entities. This is a recommended step as changes in the entity data model may prevent successful deployment of the updated version. If data entities related to Enterprise Asset Management contains staged data, the deployment of a new EAM version may fail.

  1. In the environment you are going to update, go to System administration > Workspaces > Data management.
  2. Select all data import/export projects relating to EAM and click Delete. This will remove any legacy data leftovers.

Note

We always recommend removing all EAM data management projects as soon as data import or export has been completed. This is done to avoid mismatch with the future data model of EAM.

If you do not wish to delete the current data import/export project, use the "Staging cleanup" function to remove staged data without deleting the import/export project itself.

  1. In the environment you are going to update, click System administration > Workspaces > Data management.
  2. Click Staging cleanup.
  3. Select the data project that contains EAM entities and press OK.
  4. Repeat steps 2-3 if multiple data projects are related to EAM entities.

Select data import/export projects
Select data import/export projects
Staging cleanup
Staging cleanup

Update process

The process of updating EAM is similar to the processes used for installing EAM into an existing environment, as described in other areas of this document.

  1. Get the latest version of the EAM solution.
  2. Apply or schedule the deployment of the Dynaway EAM Common and Dynaway EAM packages suited for your Dynamics 365 for Finance and Operations application version. Refer to the Deploy EAM to Existing Cloud-Hosted Environment chapter.
  3. Verify the license is up to date. Refer to the Import License File chapter.
  4. Verify license configuration keys.

After the update process

If you are upgrading from a previous EAM version, there may be runnable jobs for upgrading data, which should be executed before the environment is released for general use.

The version number of those jobs, shown in the Version field, shows the EAM build version in which the jobs were introduced.

Note

When you are upgrading from a previous EAM version, you must always run the jobs that contain a higher version number in the Version field, compared to your current EAM version.

If no version number is shown in the Version field, you can always run the job.

  1. Log in to Dynamics 365 for Finance and Operations.
  2. Click Enterprise asset management > Setup > Runnable jobs to open the form.
  3. Execute upgrade jobs related to the version that has been installed. For reference, see the list of runnable jobs.
  4. Repeat step 3 until all relevant runnable jobs have been executed.

Runnable jobs
Runnable jobs

List of runnable jobs

Name

Description

Set up number sequences (optional)

After an installation or update of EAM, the number sequences may in some cases be unavailable.

This job will perform a refresh of cached number sequences related to EAM. After running the job, the number sequences related to EAM should become available, and the number sequence wizard will be initiated.

Initialize active field on maintenance plans

In version 1707.0.2.0, a new Active field is introduced on maintenance sequences. The default value for this field is disabled, meaning all maintenance sequences will be inactive after the update.

Running this job will update all maintenance sequences to become active.

Migrate checklist data to new tables

In version 1712.1.0.0, the data model for work order checklists has been changed and moved to a new table structure. Until this upgrade job has been successfully completed, the existing checklist data will be unavailable because they are stored in obsolete tables.

Running this job will move and convert all existing checklists to the new data model tables from the old tables. The job can be run multiple times, if required.

Migrate EAM and CMA customers to standard customers

EAM no longer uses a specific customer setup. This job will migrate all EAM customer references to use those defined in the global customer table in Dynamics 365 for Finance and Operations. The job will also link contracts directly to work order lines.

Note: This is a mandatory upgrade job if migrating from previous versions of EAM.

Runnable jobs details
Runnable jobs details

Additional setup

This chapter describes additional setup that may be required in relation to the EAM solution.

Set up business process methodology in LCS

The EAM solution deployment package contains a Business Process Methodology (BPM), which is intended as a templates for working with the core processes inside the solution. The methodology is designed as a cross industry template and can be edited and adapted to specific industries.

This guide provides a quick introduction to enabling the BPM in the LCS Business Process Modeler. For further information on the topic, refer to Microsoft documentation: https://docs.microsoft.com/en-us/dynamics365/unified-operations/dev-itpro/lifecycle-services/bpm-overview

In order to activate the Business Process Methodology in the Lifecycle Services project, you must copy the Dynaway EAM Business Process Library, edit and publish it.

  1. Open the Lifecycle Services project and navigate to the Business Process Modeler.
  2. Select the Dynaway EAM library in the overview and create a user copy.
  3. Select the copy to edit or publish the Business Process Methodology.

Dynaway EAM Business Process Library
Dynaway EAM Business Process Library
Business proces modeler logo
Business proces modeler logo
Select Dynaway EAM Business Process Library
Select Dynaway EAM Business Process Library
Select the copy to edit or publish
Select the copy to edit or publish

Set up Help and task recordings

Dynaway EAM includes Help in the form of task recordings. The task recordings cover a number of basic maintenance processes included in the Business Process Methodology. Users can access the recordings using the Help menu in Dynamics 365 for Finance and Operations.

To enable task recordings for Dynaway EAM, ensure the Help server for Dynamics 365 for Finance and Operations is configured and the Help packages for Dynaway EAM are enabled.

  1. In Dynamics 365 for Finance and Operations, select System Administration > Setup > System Parameters > Help tab.
  2. Ensure that the Dynaway EAM Help library is activated.

Ensure activation of the Dynaway EAM Help library
Ensure activation of the Dynaway EAM Help library
Copyright Dynaway A/S