dmswiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Introduction ======

Although almost all data required for DMS can be created using the DMS Console and Setup the amount of data makes import routines the most efficient way of getting the majority of data into a DMS instance. This section provides information what data each import process and its relationship to other data if relevant.

====== Data Import/Load ======

By its nature a deployment project such as the type DMS has been designed to manage requires a lot of data to be input and processed. To make the input process more efficient most of the data required by DMS can be imported. It is important to understand which data can be imported but more importantly the order in which the data must be imported and the relationship between the data and the imports. Through this and other DMS documents the import process is often referred to as a ‘load’.

The imports fall into three categories: component (previously referred to as global), deployment and new computer. Component imports are for data to be made available to the whole project, deployment imports handle data specific to an individual Schedule Group, and new computer is the load used to import the factory new computer information. This last one is used when the optional asset tracking feature is enabled.

{{:dms:dataimportimage2_vsm.png|}}



===== Import Templates =====

DMS is provided with a Microsoft Excel spreadsheet based template for each of the data import processes. In addition there is a combined template for user, legacy computer and deployment imports. These files must be used and must not be edited in any way. Once the template has the data required entered correctly and saved the file must be saved as an XML file. This file format (XML data) is available as a save option in Excel 2003 and above.

====== Component Imports ======

Component imports are used to populate the Project Components in DMS Setup. There are three types of Component: Computers, Applications and Peripherals. Once Components are created in DMS they are then available as options for all deployments within the project structure. Often the number of computer and peripheral models means it is quicker to create these manually however an import template is provided for all three types of components.

===== How To Import =====

  * Load DMS Console Setup
  * Select the Component tab and then select the component you are importing
  * Select import from the toolbar at the top right
  * Browse to the correct XML file
  * If you are adding components to an existing list ensure you select the Merge option in the next dialogue
  * Finally if there are any components that you decide not to import you still have the option to deselect them in the final dialogue

===== Rules =====

The Package ID **__must__** be unique in the DMS instance.

The Peripheral ID **__must__** be unique in the DMS instance.
===== Order =====

The component applications are typically loaded at the start of a project but can be added to at any time. Applications must exist in Components before they can be added to a Schedule Group and deployments.

The component peripherals are typically loaded at the start of a project but can be added to at any time. Peripherals must exist in Components before they can be added to a Schedule Group and deployments.

===== Errors =====

If you try and import an application with a Package ID that already exists in the system you will see an error for each duplicate at the end of the import routine. The error code is 52 and the error is “operation cancelled: duplicate attribute not allowed”.

If you try and import a peripheral with a Peripheral ID that already exists in the system you will see an error for each duplicate at the end of the import routine. The error code is 52 and the error is “operation cancelled: duplicate attribute not allowed”.

===== Examples =====

Below are some examples of the templates:

{{:dms:component_apps1.jpg|}}\\ Component Application import template



{{:dms:component_peripherals1.png|}}\\ Component Peripheral import template


====== Deployment Imports ======


There are five possible deployment imports:
  * Users
  * Legacy Computers
  * Deployments
  * Deployment Applications (optional)
  * Deployment Peripherals (optional)

====== User Import ======

The User Import should be the first import that you carry out for a Schedule Group. If the User Portal is to be used in order for the users to validate project data the user data is presented in Step1 of the User Portal. Figure 4 below shows an example User Import, and the fields shown in red are the ones that a user can change in the User Portal, if permitted.

{{ :figure_4_-_user_import_template.png?nolink |}}

===== How to Import =====

If you are not using the ‘path’ field and only importing user data for a single Schedule Group:
  * Load DMS Console Setup
  * Navigate the project structure down to the Schedule Group for the users to import
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the Schedule Group and choose Import.
  * Select ‘Import data from XML file’
  * Browse to the correct XML file
  * Now re-check the OU that you are importing to. If not correct use the choose OU option to ensure the correct Schedule Group container is selected.
  * If you are updating existing user information ensure you select the ‘Merge with existing items’
If you are collating user data for multiple Schedule Groups in a single file you **__must__** use the ‘path’ field. The path is relative and therefore when storing data from multiple Schedule Groups we recommend you use the full path from the root and then import from this (root) location (as in this example):
  * Load DMS Console Setup
  * Select the root of the structure
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the root and choose Import.
  * Select ‘Import data from XML file’
  * Browse to the correct XML file
  * Ensure you select the option ‘Use Path & Create OU structure’
  * If you are updating existing user information ensure you select the ‘Merge with existing items’
  * 
===== Rules =====

The ‘email address’ **__must__** be unique in the DMS instance.

The ‘account’ **__must__** be unique in the DMS instance.

The ‘path’ is relative to the point of import and **__must__** exist. The path field is optional.

===== Order =====

The User Import is the first import for a Schedule Group.

===== Errors =====

If you try and import a user with an email address or account that already exists in the system you will see an error for each duplicate at the end of the import routine. The error code is 52 and the error is “operation cancelled: duplicate attribute not allowed”.

====== Legacy Computer Import ======

Each deployment will usually have a legacy computer it is replacing and whilst legacy computers and new computers share the same load template the imports themselves are carried out as two different processes. If the User Portal is to be used in order for the users to validate project data the legacy computer data is presented in Step2 of the User Portal. Figure 5 below shows an example Legacy Computer import, however ‘MAC address’ and ‘Consignment number’ are not used when importing legacy computers.

{{ :dms:figure_5_-_legacy_computer_template.png?nolink |}}

===== How to Import =====

If you are not using the ‘path’ field and only importing legacy computer data for a single Schedule Group:
  * Load DMS Console Setup.
  * Navigate the project structure down to the OU in which the legacy computers for the relevant Schedule Group will be stored. This OU should have been marked as an Asset Location.
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the OU and choose Import.
  * Select ‘Import data from XML file’.
  * Browse to the correct XML file.
  * Now re-check the OU that you are importing to. If not correct use the choose OU option to ensure the correct OU is selected.
  * If you are updating existing legacy computer information ensure you select the ‘Merge with existing items’.
If you are collating legacy computer data for multiple Schedule Groups in a single file you must use the ‘path’ field. The path is relative and therefore when storing data from multiple Schedule Groups we recommend you use the full path from the root and then import from this (root) location (as in this example):
  * Load DMS Console Setup.
  * Select the root of the structure.
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the root and choose Import.
  * Select ‘Import data from XML file’.
  * Browse to the correct XML file.
  * Ensure you select the option ‘Use Path & Create OU structure’
  * If you are updating existing user information ensure you select the ‘Merge with existing items’.

===== Rules =====

The Asset Type **__must__** be set to ‘Legacy’.

Valid entries for the ‘Type’ field are Desktop or Laptop.

Computer Name **__must__** be unique in DMS instance.

The ‘path’ is relative to the point of import and **__must__** exist. The path field is optional.

===== Order =====

The Legacy Computer Import is usually done after the User Import.

===== Errors =====

If you try and import a legacy computer with the same name as one that already exists in the system you will see an error for each duplicate at the end of the import routine. The error code is 52 and the error is “operation cancelled: duplicate attribute not allowed”.

====== Deployment Import ======

Running a deployment import creates the ‘deployment records’ needed for the deployments to be carried out. This brings together the user and legacy computer along with optional addition of new computer model, and deployment date. Figure 6 - Deployment Import below shows an example Deployment Import with the minimum information required to create a valid deployment record. You can add ‘new make’ and ‘new model’ however these must exist in the global Computers list in DMS Console Setup. You can also add a ‘Date’ however you must have already set up the deployment window for the Schedule Group and the date must fall within that window.
A deployment ID allows for a single user to have additional deployments. Each new deployment is entered on a separate line on the import, using the same user email address but having a unique deployment ID. Note Deployment ID needs to be unique across the DMS instance.

{{ :dms:figure_6_-_deployment_import.png?nolink |}}

===== How to Import =====

If you are not using the ‘path’ field and only importing deployment data for a single Schedule Group:
  * Load DMS Console Setup
  * Navigate the project structure down to the Schedule Group where the users are located.
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the OU and choose Import.
  * Select ‘Import data from XML file’.
  * Browse to the correct XML file.
  * Now re-check the OU that you are importing to. If not correct use the choose OU option to ensure the correct OU is selected.
  * If you are updating existing deployments ensure you select the ‘Merge with existing items’.
  * If you are updating deployment data for a rescheduled deployment ensure you update the Deployment ID field with the new system generated Deployment ID. This will be the same as the deployment name which can be seen either in the list of deployments in user properties window, or in the path at the top of the deployment properties window.
If you are collating deployment data for multiple Schedule Groups in a single file you must use the ‘path’ field. The path is relative and therefore when storing data from multiple Schedule Groups we recommend you use the full path from the root and then import from this (root) location (as in this example):
  * Load DMS Console Setup.
  * Select the root of the structure.
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the root and choose Import.
  * Select ‘Import data from XML file’.
  * Browse to the correct XML file.
  * Ensure you select the option ‘Use Path & Create OU structure’
  * If you are updating existing user information ensure you select the ‘Merge with existing items’.

===== Rules =====

The Deployment ID **__must__** be unique in the instance.

From release 1.2.0.34 onward the Schedule User referenced by the email address field does not have to located within the Schedule Group that the deployment is being created/updated. The import routine will search all Schedule Groups for the user.

If Make and Model are entered they **__must__** match an entry in the Computers list in DMS Console Setup. The Model must also be available in the Schedule Group that the deployment is imported into.

If the deployment is a rebuild of the user’s existing computer this can be set in the import by entering a ‘Rebuild’ in the ‘Deployment Type’ field and leaving the ‘new make’ and ‘new model’ fields empty.

If Dates are entered they must fall within the specified Deployment Window for the Schedule Group.
Serial number should not be used in the initial import of data (See 7.3 Order below).

The ‘path’ is relative to the point of import and **__must__** exist. The path field is optional.

The import (or path if used) **__must__** be done into the Schedule Group container only.

===== Order =====

The User and Legacy Computer Imports **__must__** have been completed before the Deployment Import is carried out.

If Asset Tracking is used the Schedule Group Routes must be configured in the Schedule Group properties before this import can be done.

The Deployment import can be used to link assets to deployments prior to deployment similar to the DMS Console functionality for individual deployments. To do this use the Deployment import as a merge and add the relevant computer serial number to the deployment record. This import merge does **__not__** ‘succeed’ the deployment, change its ‘State’ or move its location.

===== Errors =====

If you try and import a deployment with the same deployment ID as one that already exists in the system you will see an error for each duplicate at the end of the import routine. The error code is 52 and the error is “operation cancelled: duplicate attribute not allowed”.

====== Combined Import ======

In order to reduce the number of spreadsheet files used to manage DMS import data you also have the option of using the Combined import template. This holds user, legacy computer and deployment data in a single file. Although theoretically a single file could hold all the data of this type for a project it is still recommended to break these files down to a Schedule Group level or perhaps a site level if applicable. This ensures manageability in terms of size and import timings, as well as security and resilience.

This import template is effectively three tables laid out side by side to provide the ability to manage a single line of information of user, legacy computer and deployment data. As you would expect this means the template has a much larger number of columns (34) and to help identify which type of data is in which columns they are colour coded:

{{ :dms:combined_import_colour_code.png?nolink |}}

The rules for the data as detailed in sections 5, 6 and 7 above still apply and the columns which are mandatory have bold italic black header text. There are also some further tips on some of the column headers as well as some reminders on the Notes worksheet of the file.

Because the data in this import resides in different locations in the structure the path field is mandatory in this import. The path field must start with a ‘\’ and must be relative to the point of import.

===== How to Import =====

  * Load DMS Console Setup
  * Navigate the project structure down to the container to which you path fields are relative. It may be more simple to put the whole path in from the root and always do this import from the root container.
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the OU and choose Import.
  * Select ‘Import data from XML file’.
  * Browse to the correct XML file.
  * Now re-check the OU that you are importing to is relative to the path. If not correct use the choose OU option to ensure the correct OU is selected.
  * Ensure you select the option ‘Use Path & Create OU structure’
  * If you are updating existing data ensure you select the ‘Merge with existing items’.

===== Order =====

As long as you use each row to input related data the order will be automatic as you will be processing User and Legacy Computer data before the Deployment data.

If Asset Tracking is used the Schedule Group Routes **__must__** be configured in the Schedule Group properties before this import can be done.

===== Errors =====

Please refer to the Error sections in sections 5, 6 and 7 above. If the path does not exist you will get an Error 2.

====== Deployment Components ======

Once you have created deployments you can then use a load to associate components (Applications and Peripherals) to the deployments. Application and Peripheral deployment components for any given deployment must be loaded within the same file.


===== How to Import =====

  * Load DMS Console Setup
  * Navigate the project structure down to the Schedule Group where the deployments are located or to the correct point in the structure if you are using the //Path// option to import Deployment Components across multiple Schedule Groups.
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the OU and choose Import.
  * Select ‘Import data from XML file’.
  * Browse to the correct XML file.
  * Now re-check the Schedule Group that you are importing to. If not correct use the choose OU option to ensure the correct Schedule Group is selected.
  * If you are using the //Path// field in the import ensure you tick //Use Path & Create OU Structure//
  * IF you are updating Deployments that already have Deployment Components associated ensure you select //Merge with existing items//

 __**N.B.**__ the merge option does not update the Deployment Components for a deployment, it removes all existing Components (excluding the mandatory ones) and adds the Components in the load file.

===== Rules =====

The Components being associated in the import **__must__** be available to the Schedule Group.

If you are using the import to amend the Components associated to Deployments the merge option will remove any Components not specified in the import. Therefore when amending a Deployment's Components you must ensure you include all existing Components and not just the new ones you are adding.

===== Order =====

The Deployment import for the Schedule Group must have been completed before the Deployment Component import is carried out.


====== New Factory Computers ======

When the optional Asset Tracking feature is enabled new computers can be imported into DMS. This is done using data supplied from the factory. Figure 9 below shows an example New Computer import; as stated in section 6 the import templates for legacy and new computers are the same.

The model field in this import is not checked against the global computer list in DMS Console Setup. That list is just to present choice within a Schedule Group to a user in the User Portal.

{{ :dms:figure_9_-_new_computer_import.png?nolink |}}

===== How to Import =====

As with legacy computers and users this import has the option of providing relative path data, however as this import is usually used to import to a limited number of locations (e.g. factory goods out) the path is not usually used.
  * Load DMS Console Setup
  * Navigate the project structure down to the relevant factory associated Asset Location OU.
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the OU and choose Import.
  * Select ‘Import data from XML file’.
  * Browse to the correct XML file.
  * Now re-check the OU that you are importing to. If not correct use the choose OU option to ensure the correct OU is selected.

===== Rules =====

The serial number must be unique.

The import should be into an OU which has been defined as an Asset Location.

===== Order =====

The new computer load can be run when required.

===== Errors =====

If you try and import a new computer with the same serial number or MAC address as one that already exists in the system you will see an error for each duplicate at the end of the import routine. The error code is 52 and the error is “operation cancelled: duplicate attribute not allowed.

====== OU Structure Import ======

In order to make creating project structure quicker and more efficient in larger projects you can use the OU Structure import load. This load will automate the creation of the project structure however a separate import is required to add Asset Locations to the structure.

The import is relative to the point in the structure it is carried. In the example below the import is executed from the root of the structure.

{{ :dms:import_oustructure.png?nolink |}}

===== How to Import =====

  * Load DMS Console Setup
  * Navigate to the relative point in the project structure.
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the OU and choose Import.
  * Select ‘Import data from XML file’.
  * Browse to the correct XML file.
  * Now re-check the OU that you are importing to. If not correct use the choose OU option to ensure the correct OU is selected.
  * Ensure you select the option ‘Use Path & Create OU structure’

===== Rules =====

During the import wizard the option ‘Use Path & Create OU structure’ must be ticked.

The Name field is the OU you are creating and therefore the Path must already exist or be created previously in the same file. In the example above UK and Germany OUs are created at the point of import and the subsequent lines are creating the path layer by layer.

===== Order =====

The OU Structure load would typically be run at the start during the initial project setup component of work.

===== Errors =====

If you try to create an OU where the path is incorrect or does not exist you will see an error code 2 at the end of the wizard.

====== Schedule Group Import ======

An import file can be created to load and create the Schedule Groups that are required in the project structure. The import is relative to the point in the structure it is carried. The structure in the //Path// field must already exist in the structure and the Deployment Location for the Schedule Group can also be set in this import.
In the example below the import is executed from the root of the structure.

{{ :dms:import_sgstructure.png?nolink |}}

===== How to Import =====

===== Rules =====

===== Order =====

The project structure in the //Path// field must exist so it is typical to run this import after the [[dms:importing_data#ou_structure_import|OU Structure import]].
===== Errors =====


====== Asset Location Structure Import ======

When creating the structure you can use the Asset Location Structure import to automate the creating of the Asset Location OUs in the structure. The Path must already exist in the structure and as with the OU Structure import the Path used must be relative to the point of the import process. In the example below the import wizard import process is being executed at the root of the structure.

In this import you can also set the Asset Location type <<insert link>>. The default value is 0 or blank and sets the type to //Normal//, a value of 1 sets the type to //Global// and a value of 2 sets the type to //Deployment//.


{{ :dms:import_assetlocationstructure.png?nolink |}}


===== How to Import =====

  * Load DMS Console Setup
  * Navigate to the relative point in the project structure.
  * To start the import wizard either click on the import icon in the toolbar at the top right, or use the context menu on the OU and choose Import.
  * Select ‘Import data from XML file’.
  * Browse to the correct XML file.
  * Now re-check the OU that you are importing to. If not correct use the choose OU option to ensure the correct OU is selected.
  * Ensure you select the option ‘Use Path & Create OU structure’

===== Rules =====

During the import wizard the option ‘Use Path & Create OU structure’ **__must__** be ticked.

The Path entry must exist in the OU Structure.

===== Order =====

The Asset Location Structure load would be run as necessary after the relevant OU structure is created.

===== Errors =====

If you try to create an Asset Location OU where the path is incorrect or does not exist you will see an error code 2 at the end of the wizard.
dmswiki

User Tools

Site Tools

Page Tools
