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 ======

When a DMS instance is first commissioned, you will be supplied with a URL and an initial administrator account. To get started you will need to open an internet browser ((DMS supports the latest versions of Internet Explorer and Google Chrome, however other browsers will also work but Modus do not guarantee 100% feature support)) and enter the URL provided. This will to load the DMS Web Portal and when prompted use the administrator credentials to login.

All DMS setup and configuration except that done within the [[dms:the_language_portal|Language Portal]] is carried out using the DMS Console, a Windows 32-bit application which requires no installation. The DMS Console is run from and/or downloaded from the DMS Web Portal based on permissions. The initial administrator credentials you are provided with have this permission. Click on the administrator name in the top right of the DMS Web Portal to show the menu, and from here click on Console and then chose to Save/Download the EXE to your local computer.

====== Configuring the DMS Console ======

To configure the DMS Console you will first need to launch it either directly from the DMS Web Portal or from where you saved it to having downloaded it.

Once the DMS Console is loaded you will be presented with a blank logon screen. To configure and save the settings for your instance click on the {{:dms:3_dots.png?nolink|}} button next to the //Connections:// option which will take you to the server connections page.

  - Click on the New icon in the top right menu or right click anywhere on the dialogue and select New
  - Click in the Name column and enter a name for this instance
  - Click in the Server column and enter the server Fully Qualified Domain Name. Do **NOT** precede with 'https:'
  - Click on SSL to select
  - Click on Email Address and enter the administrator credentials you were provided with
  - **Do not** click on Save Password
  - **Do not** enter a password in the Password field
  - Now click Save at the bottom right of the screen

You will now be back at the login screen however the Name you entered in the section above will now be in the drop down list selector in //Connections:// and the server details you added will also automatically be entered. All you need to do to login is provide the password and click on connect.
 


====== DMS Setup ======

The configuration of the DMS instance is done through the Setup feature of the DMS Console. You can access this feature from the //Tools// menu in the top right of the DMS Console. DMS Setup is used to:

  *   create and edit the project structure, including various inheritable properties
  *   setup Asset Transfer routes
  *   create Organisations
  *   create and edit Components: computers, applications and peripherals
  *   create and edit DMS Administrators
  *   setup Template Tasks
  *   configure which languages are available
  *   create Fail Codes
  *   enable and disable available Reports
  *   upload images for use within DMS
  *   set general Server settings

====== General Settings ======

The Settings tab allows you to enter the following information:

^       Setting       ^  Description  ^
|Company Name     |This is displayed on various dialogues in the various interfaces and is also a replaceable value within emails.|
|Project Name      |As above.|
|Sever Web Address      |As above.|
|Reply email Address |This is the address that will be added as the Reply Address to all emails sent for this instance of DMS.|
|T- Date units      |This allows the Task timeline to be configured as days or weeks.|
|Home Page Logo      |This list box shows all images from the images tab.  Selecting one of these images will replace the default which is displayed in the top left of the User Portal Page.The default logo size is 39x28 pixels and we recommend you aim to replace it with a similar size logo so as not to adversely affect the layout of the DMS Web Portal.|


====== Organisation ======

Organisations can be assigned to Organisational Units (OUs) within the project structure to allow ownership to be set. This is especially useful for Asset Location OUs as the Organisation field is listed in some of the Asset Reports.

====== Administrators ======

DMS refers to the users that use the various interfaces of DMS to manage migrations/deployments as Administrators or Admins. This is to distinguish them from the 'Users' (end users) as defined in migrations/deployments. These Admin users must be created in the Administrators tab of Setup:

  - Select the Administrator tab
  - Use the context menu (right click) on the right side and click on New
  - This will create a new row where you will need to type in the email address of the new user, as well as their first and surnames. The email address is the login name used to access DMS.
  - Once entered Click Save.
 
You can now double click on the user icon to open the properties window. The properties window allows you to:

^ General tab ^
Edit basic user information and check last logon date and time (N.B. do not change the Landing Page

|Logon|Turn on and off the ability for the Admin to logon to either the DMS Web Portal or the DMS Console|
|Reset password|Reset the Admin's password|
|Language option|Set the Admin's default language|
|DMS Console|Allow the Admin to login to the DMS Console|
|DMS Setup|Configure whether the Admin has the Setup menu item on the Tools menu in the DMS Console|
|Home Admin|When selected the Admin has the capability of adding and editing DMS Web Portal notices|

^ Menus ^
Select which menu items appear on the Admin's menu on the DMS Web Portal
  * Assets
  * Assignments
  * Dashboard
  * Deployments
  * Language
  * Reports
  * User Portal
  * Validation

^ Security ^
Set permissions throughout the [[dms:configuring_dms#structure|project structure]]. As well as being assigned access to the various portal interfaces through the Menu tab and Assignments and Deployments tab, the Admin also needs to be assigned security permissions to the project structure. The security does inherit down through the structure so it is not necessary to stipulate each and every OU required.

^ Assignments and Deployments ^
Select which Schedule Groups the Admin has access to in the Assignments and Deployments Portals, if available

^ Assets ^
Select which Asset Locations the Admin user can see in the Assets Portal if available, and which Asset Locations the Admin user can Send to and Receive from

^ Reports ^
Select which Reports the Admin will see on the Reports menu if available. To understand what each report provides see the [[dms:reports|Reporting section]].


====== Structure ======

The project structure is illustrated using the familiar format of a directory or organisational unit (OU) structure. There are three types of OU, a structure OU, an Asset Location (if the Asset Tracking Option is enabled) and a Schedule Group. Schedule Groups (SGs) are the containers where deployments are managed and Asset Locations (ALs) are the containers where assets are managed. The overall OU structure can be any size/depth and complexity/simplicity required to manage the project, with the structure being especially important in terms of reporting.

The structure is normally defined by the project team to meet the requirements of the management of the project. Typically this structure mimics either a geographic or business unit structure. If applicable this structure can be imported from Active Directory, and then optionally manipulated to the needs of the project.

Creating and/or managing a structure is done using the context menu (right click) and then using the menu items: New, Cut, Copy, Paste, Delete, Rename, Import and Properties. You will need to click on {{dms:button_refresh.png?25,nolink}} (refresh) in the top menu to see any changes. The properties of an OU are inherited by OUs or Schedule Groups below it in the structure.

Throughout the OU Property dialogues {{:dms:inherit.png?nolink|}} is the button to turn on and off inheritance of the value for the relevant field.

^ General ^^
|Organisation|Assign an Organisation to the OU|
|Project Manager|Used to assign a PM (typically customer) to the current OU or section of the structure. This user must exist within the structure as an end user|
|Primary Contact|Used to assign a Primary customer contact (typically customer) to the current OU or section of the structure. This user must exist within the structure as an end user. The Primary contact details can be displayed in the User Portal and is the contact the [[dms:the_language_portal#site survey|Site Survey]] can be sent to if required.|
|Secondary Contact|Used to assign a Secondary customer contact (typically customer) to the current OU or section of the structure. This user must exist within the structure as an end user|
|//Site//||
|Name|Set a name for the OU. The Site Name can be referenced in emails and is used to provide a user recognisable name for a part of the structure|
|Survey Template|Chose from the created surveys which one will be used as the Site Survey for this OU|
|Survey| Once you have selected a Survey Template you then need to click on //Create// to create a new Site Survey for this OU using the template. Once created you will see a unique ID in the Survey field. You can click on this to see the progress of the Survey or edit it on behalf of the user. As long as a Primary Contact is assigned to the OU you can then click on //Send// to run the user wizard so that you can send an email which will automatically have the unique URL to the Site Survey included.|

^ Schedule Group Defaults ^^
|Language|Set the default language for this OU and structure below|
|Daily Run Rate|Set the default migration/deployment run rate used when a deployment window is created for a Schedule Group |
|Deployment Slots|Define the names of the slots to be used if deployments are not by day, seperated by commas e.g. Morning,Afternoon. This is the naming used within the DMS Console. In order to see the slot names within emails or the User Portal you will need to set //Slot Comms// (below)|
|Location|For a Schedule Group set the Deployment Location<link required>|
|Tasks Template|Create template sets of tasks that can be applied to Schedule Groups as Task timelines; T-dates|
|Asset Tracking|On by default. Turn off Asset Tracking if for some reason the deployments in this OU do not require asset tracking|
|//User Portal//||
|Legacy|Set default state for this page of the user portal|
|Hardware|Set default state for this page of the user portal|
|Software|Set default state for this page of the user portal|
|Deployment|Set default state for this page of the user portal|
|Survey|Choose which User Survey should be used for this part of the Structure|
|Slots Comms|In order to see the names given to the deployment slots within the User Portal (and emails) you will need to define Slots Comms. Slot Comms are created as a list in the [[dms:the_language_portal#lists|Language  Portal]] and then selected here for this Schedule Group|
|Attribute Lists|Select a field from the User Portal and assign a List to it|
|Validate Portal Deployments|Select which state(s) a migration/deployment needs to be set to in order to appear in the Validation Portal|
|Assignments Portal Deployments |Select which state(s) a migration/deployment needs to be set to in order to appear in the Assignments Portal|
|Project Calendar|Edit the working days for this part of the OU Structure|

^ Component Defaults ^
|This tab is where you configure which Components (Applications, Computers, Peripherals) are available within the Schedule Group or section of the OU. The menu bar in the top right of the dialogue allows you to switch between the 3 Component types, enable or disable inheritance and multi-select values from the lists.|

For each Component type there are three options:
|Available|Select to the make the component available within the Schedule Group or OU structure|
|Default|Select if you want the component to be automatically selected for a deployment|
|Mandatory|Select if you want the component to be mandatory. This is particularly useful for applications and effectively makes the entry read only in any User Portal screen|



====== Template Tasks ======

One of the properties of a Schedule Group itself rather than in the structure properties is that of a list of Tasks. Sometime referred to as T-Schedule Tasks or Tollgates these Tasks allow you track the status of key activities for a Schedule Group using DMS.

In order to make things more efficient you can set up a template or templates of these Tasks lists so that you can simply apply a template rather than create the list each time you configure a Schedule Group.To create a new template:

  - Select the Template Tasks tab
  - Either click on the New icon in the menu bar at the top right or right click and choose New to create a new record.
  - Enter a name.
  - Click Save.
 
You can also copy and paste an existing template if it already has similar settings. Once you have pasted the copy please edit the name to make it unique and click Save. You can now double click on the template or right click and select properties in order to edit the template.

On the Tasks tab:
  - Add a new Tasks by using the the New icon in the right hand toolbar or by right clicking and selecting New from the context menu.
  - Enter a name for the task.
  - Enter a T date - this is the number of days or weeks to T0 (any number of tasks can have the same T date). **__N.B.__** Do not enter anything in the ‘end_date’ field at this time.
  - Enter an Amber Days value if 7 is not appropriate. Setting the Amber Days to 0 will disable any RAG status on the task.
  - Click Apply.
  - Repeat until task list complete

It is also possible to use a load file to import a list of tasks. If you do not have the template file for this please contact Modus support <support@modus-interactive.co.uk>
====== Components ======

There are three types of Component in DMS: Computers, Applications and Peripherals. Components are the defined objects that can be part of a deployment or migration record in DMS.

===== Computers =====

Computer Components are the available hardware models to be used as part of the migration/deployment records. These are the models that the project team or end user will select for deployment. To add new Computer models:

  - Chose //Computer// from the View drop down list in the menu bar of the Components tab
  - Either click on the New icon on the right, click insert, or right click and choose New to create a new record.
  - Enter a //vendor model// and //computer_type// for each Computer. ** N.B. ** the combination of //vendor// and //model// should be unique within the DMS instance
  - When complete click Save

You can further refine the list of actual Computer Components available throughout parts of the project structure within the OU [[dms:configuring_dms#Structure|properties]] in the structure.
===== Applications =====

Application Components are the Applications that are available to be assigned to migration/deployment records with DMS. For an Application to be available and assigned to a deployment it must first exist as an Application Component. You can further refine the list of actual Application Components available throughout parts of the project structure within the OU [[dms:configuring_dms#Structure|properties]] in the structure. To add a new application:

  - Chose //Application// from the View drop down list in the menu bar of the Components tab
  - Either click on the New icon on the right or right click and choose New to create a new record
  - Enter a //vendor name// and //package_id// for each Application. ** N.B. ** The //package_id// must be unique within the DMS instance.
  - When complete click Save.

It is also possible to use a load file to [[dms:importing_data#component imports|import a list of Applications]]. If you do not have the template file for this please contact Modus support <support@modus-interactive.co.uk>

There are a number of additional properties that can be set for an Application Component:

|manual_install|This provides an indicator on the build sheet that the Application requires manual installation|
|group_name|Any Application with a group_name will be displayed on the User Portal by this name. This is useful when a group of Applications is installed in order to run a single Application for which the user is aware of as a single common name - typical in large line of business applications|
|show_on_user_portal|Change the status of whether the Application will be visible on the User Portal or not|
|show_on_build_sheet|Change the status of whether the Application will be visible on the build sheet or not|


===== Peripherals =====

Peripheral Components are the available peripheral models to be used as part of the migration/deployment records.These are the models that the project team will assign to deployments and you can further refine the list of actual Computer Components available throughout parts of the project structure within the OU [[dms:configuring_dms#Structure|properties]] in the structure. Unlike the Computer and Application Components the Peripheral Components are not available to the User Portal. They are however displayed on the build sheets. To add a new Peripheral:

  - Chose //Peripheral// from the View drop down list in the menu bar of the Components tab
  - Either click on the New icon on the right or right click and choose New to create a new record.
  - Enter a //vendor model// and //peripheral_id// for each Peripheral. **N.B.** The //peripheral_id// must be unique within the DMS instance.
  - When complete click Save.

It is also possible to use a load file to [[dms:importing_data#component imports|import a list of Peripherals]]. If you do not have the template file for this please contact Modus support <support@modus-interactive.co.uk>

There are a number of additional properties that can be set for a Peripheral Component:

|group_name|Any Peripheral with a group_name will be displayed on the User Portal by this name instead. This is useful when a group of Peripherals may be referred to as a 'bundle' of some sort.|
|show_on_user_portal|**NOT IN USE**|
|show_on_build_sheet|Change the status of whether the Peripheral will be visible on the build sheet or not|
====== Languages ======

By using the Languages tab you can select which language options are available within the DMS instance. There is no language text other than English supplied and selecting other languages in this list does not add the multi-lingual text or provide any automatic translation of text in the system. You cannot deselect ‘English-Great Britain’ as this is the system language.

Language options apply to:

^  Option  ^  Description  ^
|User Portal login prompt |The user can select from the configured languages to change the language used in the User Portal.|
|OU/Schedule Group Poperties |In DMS Console Setup you can select which language is th default for the OU/Schedule Group from the configured list.|
|Language Portal |When inputting multi-lingual text for emails and/or User Portal you can select which language to input and edit from the configured list.|



====== Fail Codes ======

When an engineer/technician uses the Deployments Portal to record the status of migrations/deployments he can choose from a defined list of reasons should a deployment be unsuccessful. The list that the engineer/technician selects from is the list defined in the Fail Code tab.

As with other tabs in Setup please click Save after editing fail codes.

====== Reports ======

The Reports tab allows you to select or deselect from the list of available reports which will be available within the Reports tab of the Administrator properties.
====== Images ======

Images can be imported into DMS for use in HTML formatted emails and in order to replace the standard User Portal top left logo. Once the images are imported the path is shown for use in HTML emails and the images are available in the list box in the Settings tab for use as the User Portal top left logo. The images uploaded must be less than 2MB.

To import an image:
  - Click on the Import button in the top right menu
  - Select an image of the appropriate file type
  - Click Open to upload

Once listed in the Images your image can be used in [[the_language_portal|email communications]] as or as the User Portal page top left corner logo.
dmswiki

User Tools

Site Tools

Page Tools
