Defining an Environment

Open the Run MQL window:
1. From the compass, select Collaboration and Approvals.
2. In the navigation pane, click Utilities > Run MQL.
To run an MQL command, enter the command in the MQL Command box and click Run or press Enter.
To verify and update the Environment Characteristic Type attribute values, do one or more of the following, depending on your business needs:
1. To view the current values of the Environment Characteristic Type attribute, run the following command:
```
print attribute "Environment Characteristic Type";
```
2. To add a new environment category to the Environment Characteristic Type attribute, run the following command:
```
modify attribute "Environment Characteristic Type" add range = "<range value>"
```
  where <range value> is the new range value that you want to add.
  For example:
```
modify attribute "Environment Characteristic Type" add range = "Host Location"
```
3. To remove an environment category from the Environment Characteristic Type attribute, run the following command:
```
modify attribute "Environment Characteristic Type" remove range = "<range value>";
```
  where <range value> is an existing range that you want to remove.
  For example:
```
modify attribute "Environment Characteristic Type" remove range = "Server OS";
```
4. To define a new default value for the Environment Characteristic Type attribute, run the following command:
```
modify attribute "Environment Characteristic Type" default = "<range value>";
```
  where <range value> is an existing range value that you want to make the default value.
  For example:
```
modify attribute "Environment Characteristic Type" default "Browser";
```
  Note: You must change the attribute's default value setting if you have deleted or modified the range value defined as the default.
5. To review any changes that you make to the values of the Environment Characteristic Type attribute, run the following command:
```
print attribute "Environment Characteristic Type";
```
Note: Any changes that you make to the Environment Characteristic Type attribute values must be reflected in the environment-related attributes on the Environment type.
If you made changes to the Environment Characteristic Type attribute values, to reflect those changes in the environment-related attributes on the Environment type, do one or more of the following, depending on your business needs:
1. To view the current attributes of the Environment type, run the following command:
```
print type "Environment";
```
2. To create the new attribute for the Environment type that corresponds to the new range value that you added to the Environment Characteristic Type attribute, run the following command:
```
add attribute "<attribute>" type string range = "<range>" range = "<range>" default "<default>" desc "<description of new range value>";
```
  where:
  - <attribute> is the new Environment type attribute that corresponds to the new range value that you added to the Environment Characteristic Type attribute.
  - <range> is a possible range value for the attribute. You can define multiple possible values.
  - <default> is the default range value for the attribute.
  - <description of new range value> is a description of the attribute that you are adding to the Environment type.
  For example:
```
add attribute "Host Location" type string range = "True" range = "False" default "False" desc "Defines whether the Host Location 
characteristic of an Environment can contain multiple values";
```
3. To add the new attribute for the Environment type that corresponds to the new range value that you added to the Environment Characteristic Type attribute, run the following command:
```
modify type "Environment" add attribute "<attribute>";
```
  where <attribute> is the new Environment type attribute that corresponds to the new range value that you added to the Environment Characteristic Type attribute.
  For example:
```
modify type "Environment" add attribute "Host Location";
```
4. To remove an attribute from the Environment type that corresponds to a range value that you removed the Environment Characteristic Type attribute, run the following command:
```
modify type "Environment" remove attribute "<attribute>";
```
  where <attribute> is the Environment type attribute that corresponds to the range value that you removed from the Environment Characteristic Type attribute.
  For example:
```
modify type "Environment" remove attribute "Server OS";
```
5. To verify your changes to the Environment type, run the following command:
```
print type "Environment";
```
To create an Environment Characteristic Value business object, do all of the following:
1. To set the context to a user that has the appropriate permissions to create business objects, run the following command:
```
set context user "<user name>" password <password> role "<context role>";
```
  where:
  - <user name> is the user name of a user that is assigned a role with permissions to create business objects.
  - <password> is the password associated with the user name.
  - <context role> is the assigned user role that has permissions to create business objects.
  For example:
```
set context user "DEFECT-MANAGER" password MyPassword role "ctx::Librarian.Company Name.GLOBAL";
```
2. To create an Environment Characteristic Value business object, run the following command:
```
add bus "Environment Characteristic Value" "<business object name>" - policy "Environment Characteristic Value" vault "<vault name>";
```
  where:
  - <business object name> is the name of the business object that you want to create.
  - <vault name> is the name of the vault where you want to create the business object.
  For example:
```
add bus "Environment Characteristic Value" "Waltham" - policy "Environment Characteristic Value" vault "Production";
```
3. To activate the newly-created Environment Characteristic Value business object, run the following command:
```
modify bus "Environment Characteristic Value" "<business object name>" - current Active;
```
  where <business object name> is the name of the business object that you want to make active.
  For example:
```
modify bus "Environment Characteristic Value" "Waltham" - current Active;
```
To create an Environment business object, do all of the following:
1. If it is not already set, to set the context to a user that has the appropriate permissions to create business objects, run the following command:
```
set context user "<user name>" password <password> role "<context role>";
```
  where:
  - <user name> is the user name of a user that is assigned a role with permissions to create business objects.
  - <password> is the password associated with the user name.
  - <context role> is the assigned user role that has permissions to create business objects.
  For example:
```
set context user "DEFECT-MANAGER" password MyPassword role "ctx::Librarian.Company Name.GLOBAL";
```
2. To create an Environment business object, run the following command:
```
add bus Environment "<business object name>" - policy Environment description "<business object description>" 
Browser True vault "<vault>";
```
  where:
  - <business object name> is the name of the business object that you want to create.
  - <business object description> is the description of the business object.
  - <vault name> is the name of the vault where you want to create the business object.
  For example:
```
add bus Environment "Test Environment" - policy Environment description "This is the main Test Environment" Browser True 
vault "Production";
```
3. To activate the newly-created Environment business object, run the following command:
```
modify bus Environment "<business object name>" - current Active;
```
  where <business object name> is the name of the business object that you want to make active.
  For example:
```
modify bus Environment "Test Environment" - current Active;
```
To link the Environment business object to the appropriate Environment Characteristic Value business object to create a specific environment, do all of the following:
Note: You must specify the appropriate Environment Characteristic Type on the relationship itself between the Environment business object and the Environment Characteristic Value business object. For example, connecting the Environment named "Test Environment" to the to the Environment Characteristic Value named "Austin" requires you to specify the Environment Characteristic Type as "Host Location" to define the relationship between the business objects.
1. If it is not already set, to set the context to a user that has the appropriate permissions to create business objects, run the following command:
```
set context user "<user name>" password <password> role "<context role>";
```
  where:
  - <user name> is the user name of a user that is assigned a role with permissions to create business objects.
  - <password> is the password associated with the user name.
  - <context role> is the assigned user role that has permissions to create business objects.
  For example:
```
set context user "DEFECT-MANAGER" password MyPassword role "ctx::Librarian.Company Name.GLOBAL";
```
2. To link the Environment business object to the appropriate Environment Characteristic Type business object, run the following command:
```
connect bus Environment "<environment business object>" - relationship "Environment Characteristic" to 
"Environment Characteristic Value" "<environment characteristic value>" - "Environment Characteristic Type" 
"<environment characteristic type>";
```
  where:
  - <environment business object> is the name of the Environment business object that you created.
  - <environment characteristic value> is the name of the Environment Characteristic Value business object that you created.
  - <environment characteristic type> is the name of the Environment Characteristic Type that defines the relationship between the business objects.
  For example:
```
connect bus Environment "Test Environment" - relationship "Environment Characteristic" to 
"Environment Characteristic Value" "Austin" - "Environment Characteristic Type" "Host Location";
```
  and
```
connect bus Environment "Test Environment" - relationship "Environment Characteristic" to 
"Environment Characteristic Value" "Chrome" - "Environment Characteristic Type" "Browser";
```
3. To update the Environment business object to indicate active characteristics, run the following command:
```
modify bus Environment "<environment business object>" - "<environment characteristic type>" True;
```
  where:
  - <environment business object> is the name of the Environment business object that you created.
  - <environment characteristic type> is the name of the Environment Characteristic Type that defines the relationship between the business objects.
  For example:
```
modify bus Environment "Test Environment" - "Host Location" True;
```
  and
```
modify bus Environment "Test Environment" - "Browser" True;
```
To make the Environment business object available for connection to the Person business objects in your company (that is, enable the assignment of an environment to users in your company), do one or more of the following, depending on your business needs:
1. If it is not already set, to set the context to a user that has the appropriate permissions to create business objects, run the following command:
```
set context user "<user name>" password <password> role "<context role>";
```
  where:
  - <user name> is the user name of a user that is assigned a role with permissions to create business objects.
  - <password> is the password associated with the user name.
  - <context role> is the assigned user role that has permissions to create business objects.
  For example:
```
set context user "DEFECT-MANAGER" password MyPassword role "ctx::Librarian.Company Name.GLOBAL";
```
2. To link the Environment business object to the appropriate Company business objects, run the following command:
```
connect bus Company "<company name>" - relationship "Organization Environment" to Environment "<environment business object>" -;
```
  where:
  - <company name> is the name of the business object that represents your company.
  - <environment business object> is the name of the business object that represents the environment that you want to assign to users in your company.
  For example:
```
connect bus Company "My Company" - relationship "Organization Environment" to Environment "Test Environment" -;
```
3. If you created more than one Environment business object and want to specify one as the default environment for your company, run the following command:
```
connect bus Company "<company name>" - relationship "Primary Environment" to Environment "<environment business object>" -;
```
  where:
  - <company name> is the name of the business object that represents your company.
  - <environment business object> is the name of the business object that represents the environment that you want to make the default for your company.
  For example:
```
connect bus Company "My Company" - relationship "Primary Environment" to Environment "Test Environment" -;
```
4. If you want to specify a default environment for certain users in your company, run the following command:
```
connect bus Person "<user name>" - relation "Primary Environment" to Environment "<environment business object>" -;
```
  where:
  - <user name> is the name of the user to whom you want to assign a default environment.
  - <environment business object> is the name of the business object that represents the default environment t be assigned to that user.
  For example:
```
connect bus Person "QA-ENGINEER" - relation "Primary Environment" to Environment "Test Environment" -;
```
Stop, then restart the 3DSpace app to see your changes to environments reflected in Defect Management and Collaboration user interface.