Introduction
The custom email tool within MigrationStudio is capable of integrating recipient-specific migration information into the emails that are sent to end-users. To do this, keywords that relate to fields within MigrationStudio are used by the email engine to extract the relevent information at the point that the email is sent.
For example, the example below would add the recipient's first and last name to the global email greeting:
Keywords are identified in text through the use of [% and %] symbols and are case sensitive.
This Solution Article details all the keywords that are relevent to the custom email tool. For further information about using the email tool, please read Getting Started with End User Communications.
Email Keywords
Keywords are grouped into six key areas of information:
- User Migration
- Deployment Unit
- Questionnaire Data
- Contact Info
- Branding
- Date Formats
- Project Resource Keywords
User Migration | |
| Keyword | Example Value |
| [%MigrationDeploymentUnit%] | DU0001 |
| [%MigrationDeploymentUnitDate%] | 17/05/2014 |
| [%MigrationDate%] | 17/05/2014 (Generally used if not using DUs) |
| [%MigrationSignOffLink%] | The 'Audit Survey Sign-Off' url for this User Migration (e.g. http://MigrationStudio/Portal/UserAudit/UserSignOff.aspx?id=10&key=iyurim) |
| [%MigrationSelfServiceLink%] | The 'Self Service Sign-Off' url for this User Migration (e.g. http://MigrationStudio/Portal/UserAudit/SelfService.aspx?id=10&key=iyurim) |
| [%MigrationSatisfactionLink%] | The 'Satisfaction Sign-Off' url for this User Migration (e.g. http://MigrationStudio/Portal/UserAudit/Survey.aspx?id=10&key=iyurim) |
| [%MigrationSelfScheduleLink%] | The 'Self-Schedule' url link |
| [%MigrationSelfScheduleLinkExpiry%] | The 'Self-Schedule' url link expiry date |
| [%MigrationSignOffResult%] | Passed / Failed |
| [%MigrationSignOffComments%] | Some notes from the user... |
| [%MigrationSignOffSignature%] | Richard Hynes |
| [%MigrationSignOffDate%] | 10/03/2014 |
| [%MigrationFirstName%] | Richard |
| [%MigrationLastName%] | Hynes |
| [%MigrationSamAccount%] | HynesR |
| [%MigrationDomain%] | Global |
| [%MigrationEmail%] | Richard.Hynes@MigrationStudio.co.uk |
| [%MigrationEmail2%] | AltEmail@MigrationStudio.co.uk |
| [%MigrationSite%] | London |
| [%MigrationWorkPhone%] | 020-12345678 |
| [%MigrationEmployeeId%] | EMP-100-1111 |
| [%MigrationCostCenter%] | CST-10000 |
| [%MigrationCostCode%] | CC-0001 |
| [%MigrationAddress%] | London-Old Street |
| [%MigrationCountry%] | UK |
| [%MigrationEngineer%] | Engineer ABC |
| [%MigrationPriority%] | High |
| [%MigrationStatus%] | Complete |
| [%MigrationArchivedStatus%] | Archived / UnArchived |
| [%MigrationCustomField1%] | Custom Field Value 1 |
| [%MigrationCustomField2%] | Custom Field Value 2 |
| [%MigrationCustomField3%] | Custom Field Value 3 |
| [%MigrationCustomField4%] | Custom Field Value 4 |
| [%MigrationCustomField5%] | Custom Field Value 5 |
| [%MigrationCustomList1%] | Custom List Value 1 |
| [%MigrationCustomList2%] | Custom List Value 2 |
| [%MigrationCustomList3%] | Custom List Value 3 |
| [%MigrationCustomDate1%] | Custom Date Value 1 |
| [%MigrationCustomDate2%] | Custom Date Value 2 |
| [%MigrationCustomDate3%] | Custom Date Value 3 |
| [%MigrationCustomDate4%] | Custom Date Value 4 |
| [%MigrationNotes%] | Creates a html table of Notes linked to a User Migration |
| [%MigrationBlueprintList%] | List of just the Blueprint names that this User is in |
| [%MigrationBlueprintFullPathList%] | List of the Blueprints with the full path that this User is in |
| [%MigrationUserApplicationsList%] | Creates a html table of Applications linked to a User Migration |
| [%MigrationUserApplicationsListAKA%] | Creates a html table of Applications linked to a User Migration, including the AKA field |
| [%MigrationUserApplicationsDependencyList%] | Creates a html table of the dependencies of the Applications for a User Migration |
| <APPLOOP> .... </APPLOOP> | Special Tag. Loops through all Applications that were USED BY User(s) of this Machine. Includes App dependencies |
| <APPLOOP-NO-DEP> .... </APPLOOP-NO-DEP> | Special Tag. Loops through all Applications that were USED BY User(s) of this Machine. Excludes App dependencies |
| <APPLOOP-INSTALLED-ONLY> .... </APPLOOP-INSTALLED-ONLY> | Special Tag. Loops through all Applications that were USED ON this Machine by a User(s). Includes App dependencies |
| <APPLOOP-NO-DEP-INSTALLED-ONLY> .... </APPLOOP-NO-DEP-INSTALLED-ONLY> | Special Tag. Loops through all Applications that were USED ON this Machine by a User(s). Excludes App dependencies |
Example:<h3>Applications</h3> <table> <tr> <th>Revision Id</th> <th>Application</th> <th>Process</th> </tr> <APPLOOP> <tr> <td> [%RevisionId%] </td> <td> [%ApplicationName%] </td> <td> [%Process%] </td> </tr> </APPLOOP> </table> | |
Deployment Unit | |
| Keyword | Example Value |
| [%DeploymentUnitId%] | 100 |
| [%DeploymentUnit%] | DU00001 |
| [%DeploymentUnitLocation%] | London |
| [%DeploymentUnitDescription%] | Long Description of DU |
| [%DeploymentUnitDate%] | 11/10/2018 |
| [%DeploymentUnitEndDate%] | 12/10/2018 |
| [%DeploymentUnitIsCompleted%] | True/False |
| [%DeploymentUnitCompletionDate%] | 11/10/2018 |
| [%DeploymentUnitIsBaseLineLocked%] | True/False |
| [%DeploymentUnitBaseLineLockedDate%] | 11/10/2018 |
| [%DeploymentUnitBaseLineLockedBy%] | Richard Hynes |
| [%DeploymentUnitIsSignedOff%] | True/False |
| [%DeploymentUnitSignedOffBy%] | 11/10/2018 |
| [%DeploymentUnitSignedOffDate%] | Richard Hynes |
| [%DeploymentUnitCustomField1%] | Custom Field Value |
| [%DeploymentUnitCustomField2%] | Custom Field Value |
| [%DeploymentUnitCustomField3%] | Custom Field Value |
| [%DeploymentUnitCustomField4%] | Custom Field Value |
| [%DeploymentUnitCustomField5%] | Custom Field Value |
| [%DeploymentUnitCustomList1%] | Custom List Value |
| [%DeploymentUnitCustomList2%] | Custom List Value |
| [%DeploymentUnitCustomList3%] | Custom List Value |
| [%DeploymentUnitCustomDate1%] | Custom Date Value |
| [%DeploymentUnitCustomDate2%] | Custom Date Value |
| [%DeploymentUnitCustomDate3%] | Custom Date Value |
| [%DeploymentUnitCustomNumber1%] | Custom Number Value |
| [%DeploymentUnitCustomNumber2%] | Custom Number Value |
| [%DeploymentUnitCustomNumber3%] | Custom Number Value |
| [%DeploymentUnitCustomFlag1%] | Custom Flag Value |
| [%DeploymentUnitCustomFlag2%] | Custom Flag Value |
| [%DeploymentUnitCustomFlag3%] | Custom Flag Value |
Questionnaire Data | |
| Replace the XX with the Id of the Question/Section required. e.g. [%QuestionValue:123%] | |
| Keyword | Example Value |
| [%QuestionSection:XX%] | Shows the Text of the Section: e.g. 'Users Workspace' |
| [%QuestionName:XX%] | Shows the Text of the Question: e.g. 'Dual Screens required' |
| [%QuestionValue:XX%] | Shows the Value of the Question: e.g. 'Yes' |
| [%QuestionUserBlueprintValue:XX%] | Shows the value from a Users Blueprint Question |
| [%QuestionAppBlueprintValue:XX%] | Shows the value from a Apps Blueprint Question. |
Contact Info | |
| Keyword | Example Value |
| [%ContactName%] | Richard Hynes |
| [%FirstName%] | Richard |
| [%LastName%] | Hynes |
| [%WorkPhone%] | 0207-123456 |
| [%MobilePhone%] | 0791-123456 |
| [%Email%] | Richard.Hynes@MigrationStudio.co.uk |
| [%Email2%] | email2@site.com |
| [%JobTitle%] | Developer |
| [%NTDomain%] | Global |
| [%NTAccount%] | HynesR |
| [%CostCenterName%] | IT - Department |
| [%PostCode%] | SE1 AB12 |
| [%Website%] | www.MigrationStudio.com |
Branding | |
| Keyword | Example Value |
| [%BrandingNamePart1%] | App |
| [%BrandingNamePart2%] | Tracker |
| [%BrandingLogoImg%] | http::/MigrationStudio/Assets/Branding/Logo.png |
| [%BrandingCenterImg%] | http://MigrationStudio/Assets/Branding/CentrImg.png |
| [%BrandingClientImg%] | http://MigrationStudio/Assets/Branding/ClientLogo.png |
Date Formats | |
Date Keywords supports custom formats by adding -DF{} to the keyword. Between the {}standard date formats can be used. e.g.[%MigrationDate%] = 17/05/2015
[%MigrationDate-DF{dddd, MMMM d, yyyy}%] = Sunday, March 9, 2015
[%MigrationDate-DF{d/M/yyyy HH:mm:ss}%] = 9/3/2008 16:05:07Build your own dateYear -DF{y yy yyy yyyy} 8 08 008 2008
Month -DF{M MM MMM MMMM} 3 03 Mar March
Day -DF{d dd ddd dddd} 9 09 Sun Sunday
Hour -DF{h hh H HH} 4 04 16 16
Minute -DF{m mm} 5 05
Second -DF{s ss} 7 07
AM/PM -DF{t tt} P PMFor example, using the individual date parts from the above table if we wanted to create a custom date: Some Standard Format Shortcuts-DF{t} 4:05 PM
-DF{d} 3/9/2008
-DF{T} 4:05:07 PM
-DF{D} Sunday, March 09, 2008
-DF{f} Sunday, March 09, 2008 4:05 PM
-DF{F} Sunday, March 09, 2008 4:05:07 PM
-DF{g} 3/9/2008 4:05 PM
-DF{G} 3/9/2008 4:05:07 PM
-DF{m} March 09
-DF{y} March, 2008
-DF{r} Sun, 09 Mar 2008 16:05:07 GMT
-DF{s} 2008-03-09T16:05:07
-DF{u} 2008-03-09 16:05:07Z | |
Project Resource Keywords | |
| Project resource keywords create a URL to download a project resource. This can be used to allow users to download files such as test plans, project help docs, etc. They can also be used in Html IMG tags to allow project image resources to be referenced in emails and surveys. Inserting the current date into an email is also possible by using one of these keywords. More information can be found here. | |
Further Support
If you require further support, please visit MigrationStudio's Service Desk at https://support.migrationstudio.com/ to search the knowledge base or create a new support ticket.