Home Search

DriveWorks Pro 21
Set Specification Host Control

Send Feedback

Set Specification Host Control

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:

  • Create a new Specification from any DriveWorks Project in the Group that the user has access to.
  • Transition and view any existing Specification in the DriveWorks Group that the user has access to.
  • Create a new Child Specification based on a Child Specification List Control.
  • Transition and view an existing Child Specification based on a Child Specification List Control.

Properties

Property NameDescription
Child Specification ListThe 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 NameThe name of the Project to create a Specification from.
Specification Host Control NameThe name of the Specification Host Control to host the Specification in.
Specification IdThe 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 NameThe 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 NameThe name of the Transition that you wish to use to Transition the target Specification to a Running State.
TitleChanges the Title (not the name) of the task.

Examples

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.

Host new DriveWorks Specification

When run, this task will create a new Specification in the Control called SpecificationHostControl based on the Door Project.

PropertyExample RuleExample ResultMeaning
Project Name"Door Project"Door ProjectDoor Project is the name of the DriveWorks Project as it appears in the Projects List.
Specification Host Control Name"SpecificationHostControl"SpecificationHostControlThe name of the Specification Host Control to set with the DriveWorks Project to run.

Host an existing DriveWorks Specification

When run, this task will edit the existing Specification "Door Project 0001" in the Control called SpecificationHostControl.

PropertyExample RuleExample ResultMeaning
Specification Host Control Name"SpecificationHostControl"SpecificationHostControlThe name of the Specification Host Control to set with the DriveWorks Specification to run.
Specification Name"Door Project 0001"Door Project 0001Door Project 0001 is the name of the DriveWorks Specification as it appears in Specification Explorer.
Transition Name"Edit"EditEdit is the name of the Transition to run on the existing Specification

Or, you can use the Specification Id to Edit an existing Specification.

PropertyExample RuleExample ResultMeaning
Specification Host Control Name"SpecificationHostControl"SpecificationHostControlThe name of the Specification Host Control to set with the DriveWorks Specification to run.
Specification Id333333 is the Id of a DriveWorks Specification.
Transition Name"Edit"EditEdit is the name of the Transition to run on the existing Specification

Host a new Child 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.

PropertyExample RuleExample ResultMeaning
Child Specification List"ChildSpecList"ChildSpecListChildSpecList is the name of the DriveWorks Project as it appears in the Projects List.
Project Name"Door Project"Door ProjectDoor Project is the name of the DriveWorks Project as it appears in the Projects List.
Specification Host Control Name"SpecificationHostControl"SpecificationHostControlThe name of the Specification Host Control to set with the DriveWorks Project to run.

Host an existing Child 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.

PropertyExample RuleExample ResultMeaning
Child Specification List"ChildSpecList"ChildSpecListChildSpecList is the name of the DriveWorks Project as it appears in the Projects List.
Specification Host Control Name"SpecificationHostControl"SpecificationHostControlThe name of the Specification Host Control to set with the DriveWorks Project to run.
Specification Id105105105 is the Specification Id, not Index, of the Child Specification to Edit and Host.
Transition Name"Edit"EditEdit is the Transition to run in the chosen Child Specification.

Or, you can use the Specification Name to Edit an existing Child Specification.

PropertyExample RuleExample ResultMeaning
Child Specification List"ChildSpecList"ChildSpecListChildSpecList is the name of the DriveWorks Project as it appears in the Projects List.
Specification Host Control Name"SpecificationHostControl"SpecificationHostControlThe name of the Specification Host Control to set with the DriveWorks Project to run.
Specification Name"Door Project 0001"Door Project 0001This is the name of the Child Specification to Edit and Host in the Specification Host Control.
Transition Name"Edit"EditEdit is the Transition to run in the chosen Child Specification.

Using the Task in a Specification Macro

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.

Status Outputs

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

  • Task was successfully executed.

Success with Warnings

  • No Child Specification Control.
  • Project could not be found.
  • Specification could not be found.

Failed (one of the following occurred)

  • Unable to nest Specifications more than 50 levels deep.
  • Host Control could not be found.
  • Project Could not be found.
  • User does not have Specify permissions.
  • User does not have edit permissions for Project.
  • Transition name wasn't set.
  • General failure - Check the Specification report for more details.