The Set Specification Host Control is a task that sets the control Specification Host with the Specification to run.
Set Specification Host Control can be used in a few ways and shows the resulting Specification in the Specification Host Control.
It can:
| Property Name | Description |
|---|---|
| Child Specification List | The name of the Child Specification List that contains the Specification to host. This is only required if you wish to host a Child Specification. |
| Project Name | The name of the Project to create a Specification from. |
| Specification Host Control Name | The name of the Specification Host Control to host the Specification in. |
| Specification Id | The Id of the Specification you wish to host. This can be a root Specification or a Child Specification. If this is set then Specification Name does not have to be set. |
| Specification Name | The name of the Specification you wish to host. This can be a root Specification or a Child Specification. If this is set then Specification Id does not have to be set. |
| Transition Name | The name of the Transition that you wish to use to Transition the target Specification to a Running State. |
| Title | Changes the Title (not the name) of the task. |
Below are a few examples of how Set Specification Host Control can be used.
When this task is added the properties are static by default. See How To: Change A Static Property To A Dynamic Property to enable rules to be built on these properties.
When run, this task will create a new Specification in the Control called SpecificationHostControl based on the Door Project.
| Property | Example Rule | Example Result | Meaning |
|---|---|---|---|
| Project Name | "Door Project" | Door Project | Door Project is the name of the DriveWorks Project as it appears in the Projects List. |
| Specification Host Control Name | "SpecificationHostControl" | SpecificationHostControl | The name of the Specification Host Control to set with the DriveWorks Project to run. |
When run, this task will edit the existing Specification "Door Project 0001" in the Control called SpecificationHostControl.
| Property | Example Rule | Example Result | Meaning |
|---|---|---|---|
| Specification Host Control Name | "SpecificationHostControl" | SpecificationHostControl | The name of the Specification Host Control to set with the DriveWorks Specification to run. |
| Specification Name | "Door Project 0001" | Door Project 0001 | Door Project 0001 is the name of the DriveWorks Specification as it appears in Specification Explorer. |
| Transition Name | "Edit" | Edit | Edit is the name of the Transition to run on the existing Specification |
Or, you can use the Specification Id to Edit an existing Specification.
| Property | Example Rule | Example Result | Meaning |
|---|---|---|---|
| Specification Host Control Name | "SpecificationHostControl" | SpecificationHostControl | The name of the Specification Host Control to set with the DriveWorks Specification to run. |
| Specification Id | 33 | 33 | 33 is the Id of a DriveWorks Specification. |
| Transition Name | "Edit" | Edit | Edit is the name of the Transition to run on the existing Specification |
When run, this task will create a new Child Specification in the Control called SpecificationHostControl based on a Project in the specified Child Specification List.
| Property | Example Rule | Example Result | Meaning |
|---|---|---|---|
| Child Specification List | "ChildSpecList" | ChildSpecList | ChildSpecList is the name of the DriveWorks Project as it appears in the Projects List. |
| Project Name | "Door Project" | Door Project | Door Project is the name of the DriveWorks Project as it appears in the Projects List. |
| Specification Host Control Name | "SpecificationHostControl" | SpecificationHostControl | The name of the Specification Host Control to set with the DriveWorks Project to run. |
When run, this task will create a new Child Specification in the Control called SpecificationHostControl based on a Project in the specified Child Specification List.
| Property | Example Rule | Example Result | Meaning |
|---|---|---|---|
| Child Specification List | "ChildSpecList" | ChildSpecList | ChildSpecList is the name of the DriveWorks Project as it appears in the Projects List. |
| Specification Host Control Name | "SpecificationHostControl" | SpecificationHostControl | The name of the Specification Host Control to set with the DriveWorks Project to run. |
| Specification Id | 105 | 105 | 105 is the Specification Id, not Index, of the Child Specification to Edit and Host. |
| Transition Name | "Edit" | Edit | Edit is the Transition to run in the chosen Child Specification. |
Or, you can use the Specification Name to Edit an existing Child Specification.
| Property | Example Rule | Example Result | Meaning |
|---|---|---|---|
| Child Specification List | "ChildSpecList" | ChildSpecList | ChildSpecList is the name of the DriveWorks Project as it appears in the Projects List. |
| Specification Host Control Name | "SpecificationHostControl" | SpecificationHostControl | The name of the Specification Host Control to set with the DriveWorks Project to run. |
| Specification Name | "Door Project 0001" | Door Project 0001 | This is the name of the Child Specification to Edit and Host in the Specification Host Control. |
| Transition Name | "Edit" | Edit | Edit is the Transition to run in the chosen Child Specification. |
This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.
Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.
This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.
The status output navigation is as follows:
Success
Success with Warnings
Failed (one of the following occurred)