~~NOTOC~~
====== Creating and Editing Project Communications ======

The **Language Portal** provides the capability to create and or edit the following, including the input of multilingual content :
  * [[the_language_portal#email|Email]]
  * [[the_language_portal#User Portal pages|User Portal Pages]]
  * [[the_language_portal#Lists|Lists]]
  * [[the_language_portal#survey|Surveys]] 

Access to the Language Portal is enabled from the Menus tab of a User’s properties within Administrators in DMS Console Setup, with no further security.  The Language Portal is supported on the latest versions of Microsoft Internet Explorer and and Google Chrome.
====== Email ======

Emails are sent to individual users, multiple users, or whole Schedule Groups using the User and Deployment Wizards in the DMS Console. During the wizard process a drop down list will prompt for which email to use, and this list is populated from all the emails configured in the Language Portal

To create a new email, load the Language Portal from the DMS Web Portal.

  - Click on the '>' to expand the email section
  - Click on ‘+' above the list to Add a new email
  - The Type will automatically be selected as Email and all that needs to be entered is a Name
  - Click on Save Changes and the email will be created
  - You will now see 3 further entries in the 2nd column for //description, subject// and //body//
  - Select description and enter a description for the email ensuring it will enable the DMS Console user to distinguish the email when using the User or Deployment wizards to send emails.
  - The priority of the email (none/high/low) can also be set if required.
  - Click Save in the bottom left of the browser. Do this after each edit to ensure all changes are saved. If the button is greyed out change between //description, subject// or //body// and back and then click Save.
  - If you wish to add a translated version of text you have entered select the appropriate language from the ‘Translations’ drop down list and then enter the appropriate text in the lower text box on the right.
  - You can now repeat the process for //subject//.

Within an email a number of replaceable/merge fields can be used to populate the email with data from the database automatically. A replaceable/merge value field is entered with the % sign at the start and end of the word, for example %first_name%. The table below lists some of the more common fields that can be used in emails, however for a more detailed list please email <support@modus-interactive.co.uk>.

**N.B.** A field that starts //'user_'// or //'settings_'// can be used in an email being sent from either the User or Deployment Wizard. A field that starts //'deployment_'// can **only** be used in an email being sent from the Deployment Wizard.

^  Field  ^  Value  ^
|email_address |User's email address.|
|user_first_name |User's first name.|
|user_surname |User's surname.|
|user_new_password |The password set when using the Change Password option part of the User Wizard.  Requires 'Store password so it can be sent in new password email' set.|
|deployment_end_date |The date of the deployment.|
|settings_web_address |The %%URL%% of the DMS server (from DMS Setup Settings).|
|settings_company_name |The company name (from DMS Setup Settings).|


===== Email Formatting =====

The email //body// can now be formatted within the Language Portal using the WYSIWYG editor. For more advanced formatting the HTML code is still accessible too. The Email can include embedded images that have been uploaded to the DMS server. When using this option the path to the image should be //<img src="/custom/images/filename.png">//. For more information on storing images on the DMS server see the [[user guide#images|Images]] section in General Settings.

====== User Portal Pages ======

Each of the pages that can be presented to the user within the User Portal can be edited as well as translated. Typically the editing of a page is limited to customising the help text shown on certain pages. The process of editing a page is very similar to that of an email.
  - Use the table below to select the page you need to edit.
  - Each area or field on the page that can be edited is named and can be selected on the left side.
  - Once selected edit the text in the top text box on the left.
  - Click Save once you have edited the text.
  - If you wish to add a translation of the text select the area/field on the left for editing.
  - Now select the language to be added or edited from the Translation drop down list.
  - Now enter the translated text in the bottom text box on the right side.
  - Click Save once you have edited the text.

^  Page Name  ^  Description  ^
|pageLogon.php |This is the logon page the user sees when they access the %%URL%%|
|pageChangePassword.php |This is the change password screen|
|pageAsset.php|Allows for the localisation of the Asset portal|
|pageBuild.php|Allows for the localisation of the Assignment portal|
|pageDashboard.php|Allows for the localisation of the portal Dashboard|
|pageDTL.php|This allows the date format on the Assignments Portal and Deployments portal to be set based on language|
|pageDisplayComputer.php|These are the fields used when displaying computer details in the User Portal|
|pageDisplayminLen8.php|This text to display if the user enters a new password that does match the complexity rules (if used)|
|pageHome.php|This the text used when adding Notices to the Web Portal home page|
|pageHomeNoticeEdit.php| This is the OK and Cancel text used when editing a Notice|
|pageSchedule |This is the first page of the User Portal. It includes the welcome text as well as being the page which guides the user through each of the ‘steps’. Replaceable value fields can be used on this page for Primary Contact data|
|pageScheduleAcceptance.php |This is the page that the user is shown after their new computer has been deployed to allow them to confirm the deployed computer. This is ‘Step 3’. If a user survey is used it is also controlled and displayed by this page including the multiple choice answers|
|pageScheduleDeploySummary.php |This is the page that is shown if a user logs in to the User Portal after their data is ‘locked down’. It allows them to view summary information regarding their current computer and their deployment date and location|
|pageScheduleDeployment.php |This is the page for showing the user their deployment date whilst allowing them to edit it as well as edit the deployment location. This is in Step 2 of the User Portal and is displayed if the default Setting for Deployment is //Select Date and Location//|
|pageScheduleDeploymentEditDateReadLocation.php |This is the page for showing the user their deployment date whilst allowing them to edit it, however the deployment location is read only. This is in Step 2 of the User Portal and is displayed if the default Setting for Deployment is //Select Date, View Location//|
|pageScheduleDeploymentReadDateEditLocation.php |This is the page for showing the user their deployment date whilst allowing them to edit the location. This is in Step 2 and is displayed if the default Setting for Deployment is //View Date, Select Location//|
|pageScheduleDeploymentView.php |This is the page for showing the user their deployment date and deployment location. This is in Step 2 and is displayed if the default Setting for Deployment is //Read Only//|
|pageScheduleEnd.php |This is the page that is shown at the end of each of the Steps.|
|pageScheduleLegacyComputerView.php |This is the page for surveying the user about their existing computer details. This is in Step 2 and is displayed if the default Setting for Legacy //Read Only//|
|pageScheduleNewAppsSelect.php |This is the page for showing the user the new applications they will be receiving with the option to select/de-select applications depending on their configuration.  This is in Step 2 and is displayed if the default Setting for Software is //Select Software//|
|pageScheduleNewAppsView.php |This is the page for showing the user the new applications they will be receiving. This is in Step 2 and is displayed if the default Setting for Software is //Read Only//|
|pageScheduleNewHWSelectAny.php |This is the page for allowing the user to choose any new hardware for their deployment. This is in Step 2 and is displayed if the default Setting for New Model is //Select Any Computer//|
|pageScheduleNewHWSelectDesktop.php |This is the page for allowing the user to choose any desktop model of hardware for their deployment.This is in Step 2 and is displayed if the default Setting for New Model is //Select Any Desktop//|
|pageScheduleNewHWSelectLaptop.php |This is the page for allowing the user to choose any laptop model of hardware for their deployment. This is in Step 2 and is displayed if the default Setting for New Model is //Select Any Laptop//|
|pageScheduleNewHWView.php |This is the page for showing the user the new hardware they will be receiving. This is in Step 2 and is displayed if the default Setting for New Model is //Read Only//|
|pageScheduleUser.php |This is the page for surveying the user about their details. This is Step 1|
|pageSettings.php|These are the fields used in the User Settings on the Web Portal.|
|pageSignIn.php|These are the fields on the login page along with the error messages that can be produced|
|pageSurvey.php||
|pageValidate.php|This is the the Validation Portal main page|
|plugins-modussubmit.js||


===== Adding Primary Contact data to the User Portal =====

By editing pageSchedule.php you can chose what Primary Contact data to show the end user. By default all the replaceable value fields are shown in the field called PrimaryContact. The fields available are name, telephone and email. If no data exists for the field it is not shown.

====== Lists ======

The List function is currently used to provide 2 types of list, Attribute Lists which allow you to create lists for data entry fields in the User Portal, and Slots Comms which allows you to give names to deployment slots so that they appear in the User Portal and emails and can be translated.

To create a list, load the Language Portal from the DMS Web Portal.

  - Click on the '>' to expand the //list// section
  - Click on ‘+' above the list to Add a new //list//
  - Change the Type to //list// and enter a Name
  - Click on Save Changes and the list will be created
  - The //list// will be empty be default however you can start to add entries by using the add '+' button a the top to the right of the list name
  - As with creating emails, every time you add an entry click on Save at the bottom left of the screen to ensure you always have the latest data saved
  - For each entry you can add the value for UK English in the top field and if any languages are configured you can add the translation in the bottom field. **Note** If you translate one entry in a list you must translate all, even if the other entries are the same as the UK English otherwise you will see blank entries.
  - Ensure you click Save after entering the text.

===== Attribute Lists =====

User data in the User Portal can be presented as lists rather than manual entry fields, for example rather than asking the user to type in the name of their department you could provide a list to chose from. A choice of entries is created as a list using the Language Portal and then the list is assigned using the Schedule Group properties window. This means the list can be assigned at any part of the Project structure allowing ultimate flexibility.

Once you have created your lists you will need to notify Modus support <support@modus-interactive.co.uk> as they will need to make them available to you for the final configuration in the Console. Once you have confirmation from Modus support that this has been done you can complete the configuration as below.

To assign the list you will need to access the Structure of the project in DMS Console Setup:

  - Locate the part of the structure where you want the list to be applied, whether from the highest part of for an individual Schedule Group.
  - Right click and select [[dms:configuring_dms#structure|properties]].
  - Select the Schedule Group Properties tab
  - In the Attribute section select the field you are going to use the list for and use the drop down list to select the list you created in the Comms Portal.

===== Slots Comms =====

Before you can create your list in the Language Portal you must first have defined the Deployment Slots within the [[dms:configuring_dms#structure|Schedule Group Properties]], for example //AM,PM//. Once you have the list as it will appear in the DMS Console you can then define a list in the Language Portal to configure how the names will appear in the User Portal and emails.

In our example of //AM,PM// the customer may decide that for the User Portal and emails the user should see //Morning// or //Afternoon// instead. In this case you would create a list with two entries, and with the list created in the Language Portal you can also create translated entries if required.

Once you have a list for your Slots Comms you can then assign this in the Schedule Group Properties, Schedule Group Defaults tab.







====== Survey ======

There are 2 types of survey in DMS, User and Site. The Site survey was introduced in release 42 of DMS and allows a DMS Admin to create a web based Site survey that can be emailed to a DMS user in order that he/she can complete it. The DMS Admin can check the status of the survey using the Console
 
Once a deployment has been completed the user can be provided with a User survey using the User Portal. This survey appears as soon as the user has ticked to accept their new computer in Step 3 of the User Portal process. Once the survey has appeared to the user the user cannot progress to the end of the User Portal process without answering the questions, and only once the user has answered the questions will the deployment state change from 6 Deploy Success to 7 User Accepted.

The process of creating a Site or User survey is the same although once created the fields that can be used are specific to one type or the other. In the Language Portal 

  - Click on the '>' to expand the //survey// section
  - Click on ‘+' above the list to Add a new //survey//
  - Change the Type to //Survey// and enter a Name
  - Click on Save Changes and the survey will be created
  - The //survey// will be empty be default however you can start to add entries by using the add '+' button a the top to the right of the //survey// name

At this point what fields you can add to the survey depends on whether you are creating a User or Site survey.

===== User Survey =====

The User survey feature allows the customer to collect feedback from the user on their migration experience. The survey page is displayed when the user visits the User Portal post migration and goes through Step 3 Verification. There is also a “free text” comment box after the questions however entering text in this box is not mandatory. User survey questions and answers follow a single format of multiple choice with set answers which by default are:
  * Not Applicable
  * Very Dissatisfied
  * Dissatisfied
  * Satisfied
  * Very Satisfied

These set answer values can of course be changed by editing the correct //portal// page however there is only one set of answers for all questions. You carefully plan what feedback information you are trying to get from the users and design the answer range to best suit your set of questions. 

To add a new question to the survey:
  - click on the '+' Add button at the top of the 2nd column (the name of the question is not shown to the User so you can use whatever naming convention you like, e.g. Question1, Question2, etc)
  - In the right pane set the //Survey Type// to //1-5 Satisfied//
  - In the question field enter the question text that will appear on the survey page.
  - Ensure you always click on Save in the bottom left whenever a question is added or edited to ensure your data is always saved

As with all Language Portal fields you can add translated versions of your question if you have additional languages configured.

Use the up and down arrows in the 2nd column to re-order the questions.
 
===== Site Survey =====

A Site Survey is allocated within the project structure and can be sent to the contact assigned as the Primary Contact for that part of the structure.	

Unlike the User survey ?the Site survey allows for various different types of data field to be presented on the survey as well as Section Headers, Section text and section breaks:	
  * Text - single line and multiple line	
  * Date	
  * Multiple Choice
  * Yes/No

To add a new question to the survey:
  - click on the '+' Add button at the top of the 2nd column (the name of the question is not shown to the User so you can use whatever naming convention you like, e.g. Question1, Question2, etc)
  - In the right pane set the //Survey Type// to which ever type required
  - In the question field enter the question text that will appear on the survey page
  - Ensure you always click on Save in the bottom left whenever a question is added or edited to ensure your data is always saved

There are various types of question listed under //Survey Type:// and these can all be used bar the //1-5 Satisfied// which is reserved for use in the User survey.

|Section Header|If are doing different sections use this to title or label each section|
|Section Text|This can be used to include some descriptive text at any point during the survey|
|Section Break|This inserts a horizontal line to break up sections of the survey|
|Date|This prompts for a date to be selected and when the empty field is selected a calendar control is displayed so that a date can be selected|
|Text|Use this for a single line text answer|
|Text - Multiline|Use this for a multi-line text answer|
|Multiple Choice|Use this if you want to provide a choice of answers from which to pick\\ The format for this question is "question text" followed by the answer choices labelled alphabetically and seperated by "\".\\ For example: Do you have a \A\Car\B\Bike\C\Scooter|
|Yes No|Use if you want a simple Yes No selector|