Recommendations for editing the Template
Before editing an Environment Create Workflow Template we recommend you:
- Take a copy of the template you’re about to edit
- Use Notepad++ to edit the template
- Set the View level of the template to 3 and then 4 – this make the template easier to navigate
- You can do this by going to ‘View’ -> ‘Collapse level’ -> ‘3’
- Open up an online GUID generator for any data you may add.
XML Notes
The above image gives a general view of the structure of our Wizard template. The ‘Environment’ section provides all the usual allocations that will be made to the environment in the Create Environment Wizard process. This includes
- Env Wide Settings
- User Allocations
- Application Allocations
- Database Allocations
- Server Allocations
- Service Allocations
- Group Allocations
The ‘FirstTimeSetup’ section acts similarly to reference data manager where you provide the data of objects like users that will be needed for the allocations. FirstTimeSetup allows for
- Applications
- Users
- Services
- Roles
To be specified for the allocation purpose. Currently Applications specified in here will also need to be created in Emdash Applications Reference data manager as the template does not allow for a code version to be specified. Code version is needed for Create Environment Wizard to run properly; This is data that will need to be populated in emdash beforehand – This action is performed by SetupEndurFindur and SetupRightAngle
GUIDs
You will notice GUIDs are used throughout the template. This allows us to match up sections of the template in other areas. For example, the GUID attached to the application allows us to allocate the application accordingly with Application Allocation, User Allocation, Server Allocation and Service Allocation.
Replaceable Values
These values are automatically replaced by emdash during the Create Environment Wizard. This gives you flexibility with naming standards.
- EnvironmentNameValue – The name of the environment
- EnvSpreadPortValue – A generated value specific to Endur
To use these values in your template surround them with curly braces e.g. {EnvironmentNameValue}. Emdash will automatically replace them with the desired value.
The figure above shows an example of how to use these values, where ‘Database_’ is a prefix of the Environment Name. This would create a database of ‘Database_Test01’ for an Environment called ‘Test01’
First Time Setup
User
To add a new User Allocation to the xml you’ll need to add a user in the FirstTimeSetup -> Users Section and a new user allocation in the Environment -> Users section.
The below image shows the structure for adding a new User to the FirstTimeSetup -> Users Section
- GUID
- Need to use a GUID generator value
- LandId
- DisplayName
- UserTeam
- Only System User, Project User or Business User may be used here
- UserType
- Only user
These are values that you typically use in the Add User page in the front end of emdash. The purpose of this section is to allow you to enter users that will always be needed for allocations such as service allocations.
When adding a user to this section the User details you add, LanId and Display Name specifically, must match the data in active directory otherwise the values will be used to create a new user in AD.
Template
Paste into the FirstTimeSetup -> Users Section
<User>
<GUID>
\\ Enter GUID \\
</GUID>
<LanId>
\\ Enter LanId \\
</LanId>
<DisplayName>
\\ Enter Display Name \\
</DisplayName>
<UserTeam>
\\ One of System User, Business User, Project User \\
</UserTeam>
<UserType>
\\ User Type - normally User, System Account or Service Account \\
</UserType>
</User>
Application
To add an application allocation to the template you will need to firstly add the application to the FirstTimeSetup -> Applications section
Due to the way Create Environment Wizard works the application must already exist in the emdash applications table along with a code version for the application. This is because we have no way of importing a code version through Environment Wizard. Running the SetupEndurFindur and SetupRightAngle scripts will set this data for you.
The Application name you set here must match up with the Application name set in emdash. The other details have no effect on the Create Environment Wizard, however are required.
Template
Paste this into the FirstTimeSetup -> Applications section
<Application>
<GUID>
\\ Enter GUID \\
</GUID>
<Name>
\\ Enter Application Name – This part matters most \\
</Name>
<Description>
\\ Enter Application Description \\
</Description>
<Type>
\\ Enter Application Type \\
</Type>
<SourceCodeDir>
\\ Enter Application Source code directory \\
</SourceCodeDir>
<TargetCodeDir>
\\ Enter Application Target code directory \\
</TargetCodeDir>
<CodeBitVersion>
\\ Enter code bit version – one of ‘NA’(Default), ‘x64’, ‘x86’, ‘x64;x86’\\
</CodeBitVersion>
</Application>
Service
Adding a service to FirstTimeSetup
- GUID
- Need to use a GUID generator value
- Name
- LogicalName
- Is part of mapping the runsite to Endur. Will most likely be AppserverXX
- DisplayName
- ServiceType
- Only Endur or RightAngle may be used here currently
Template
Paste this into the FirstTimeSetup -> Services section
<Service>
<GUID>
\\ Enter GUID \\
</GUID>
<Name>
\\ Enter Service Name \\
</Name>
<LogicalName>
\\ Enter Logical Name \\
</LogicalName>
<DisplayName>
\\ Enter Service Display Name \\
</DisplayName>
<ServiceType>
\\ Enter Service Type \\
</ServiceType>
</Service>
Role
It is unlikely you will want to change this section. The role provided does enough for a FirstTimeSetup of an environment.
Template
Paste this into the FirstTimeSetup -> Roles section
<Role>
<GUID>
\\ Enter GUID \\
</GUID>
<Name>
\\ Enter Role Name – Normal, Administrator, Read Only \\
</Name>
<Description>
\\ Enter Description of Role \\
</Description>
</Role>
Environment
Adding a Env Wide Setting
Env wide settings allow you to setup some predefined values for the settings of your environment that we accommodate in the Env Wide Settings Options table in Reference data manager
This is not a section we recommend you change; The defaults we set here will be enough.
Template
Paste this into Environment -> EnvironmentWideSettings section
<Setting>
<Name>
\\ Enter Env Wide Setting option name \\
</Name>
<Value>
\\ Enter Value \\
</Value>
</Setting>
Adding User Allocations
The above displays how to add your User Allocation to the Environment -> Users section of your Wizard Template. This works like a User Allocation in the front end would, where the User, Application and Role are needed to proceed with the Allocation. To link a user to an allocation you will need to copy its GUID into the User -> GUID part of the Allocation. This will be picked up by Emdash when the Wizard runs.
Template
Paste this into Environment -> Users section
<UserAllocation>
<User>
<GUID>
\\ Add the GUID of the User \\
</GUID>
</User>
<Application>
<GUID>
\\ Add the GUID of the Application \\
</GUID>
</Application>
<Role>
<GUID>
\\ Add the GUID of the Role \\
</GUID>
</Role>
</UserAllocation>
See ‘Adding an Application Allocation’ and ‘Role’ Sections for adding Applications and Roles.
Adding an Application Allocations
To allocate the application to the environment you will need to create a ApplicationAllocation record in the Environment -> Applications area. Using the GUID of the application you have created.
Template
Paste this into the Environment -> Applications section
<ApplicationAllocation>
<Application>
<GUID>
\\ Enter Application GUID \\
</GUID>
</Application>
<CodeVersion>
\\ NO VALUE NEEDED \\
</CodeVersion>
</ApplicationAllocation>
Adding Database Allocations
We recommend you do not change this section in the template. This sets up the details for the database (or databases) that will support the environment. Three of the values come from the Create Environment Wizard front end ServerNameValue, RdbmsTechnologyValue, RdbmsVersionValue. You must not change these.
The Name section in the Database record may be changed to have a prefix and/or suffix. EnvironmentNameValue should be left inside the Name to keep it unique to the environment.
Adding Server Allocations
Adding a server allocations to Environment
- GUID
- Need to use a GUID generator value
- Name
- LogicalName
- Is part of mapping the runsite to Endur. Will most likely be AppserverXX
- OS
- Type
- Only ‘Endur x64’, ‘Endur x86’ or ‘RightAngle App Server’ may be used here currently
Template
Paste this into the Environment -> Servers section
<ServerAllocation>
<Server>
<GUID>
\\ Enter GUID \\
</GUID>
<Name>
\\ Enter Server Name \\
</Name>
<LogicalName>
\\ Enter Logical Name \\
</LogicalName>
<OS>
\\ Enter Server OS \\
</OS>
<Type>
\\ Enter Server Type – These values only ‘Endur x64’ ‘Endurx86’ ‘RightAngle’ \\
</Type>
</Server>
<Application>
<GUID>
\\ Enter Application GUID to allocate to the Server \\
</GUID>
</Application>
<User>
<GUID>
\\ Enter User GUID to allocate to the Server \\
</GUID>
</User>
</ServerAllocation>
Adding Service Allocations
Template
Paste this into the Environment -> Services section
<ServiceAllocation>
<Server>
<GUID>
\\ Enter Server GUID \\
</GUID>
</Server>
<Service>
<GUID>
\\ Enter Service GUID \\
</GUID>
</Service>
<User>
<GUID>
\\ Enter User GUID \\
</GUID>
</User>
</ServiceAllocation>
Adding Group Allocations
You will want to include the EnvironmentNameValue in your group name.
Template
Paste this into the Environment -> Groups section
<GroupAllocation>
<Group>
<Name>
\\ Enter GUID \\
</Name>
<Domain>
\\ Enter Domain \\
</Domain>
<Application>
<GUID>
\\ Enter Application GUID to allocate to the Group \\
</GUID>
</Application>
</Group>
<Role>
<GUID>
\\ Enter Role GUID to allocate to the group \\
</GUID>
</Role>
</GroupAllocation>
0 Comments