This section is specific to DriveWorks 23 onwards.
For earlier DriveWorks versions please see How To: Create and Edit Specifications Using URL Parameters (prior to DriveWorks 23).
The Live UI supports arguments passed via the URL to integrate with external sites, for example Content Management Systems, Enterprise Resource Planning and Customer Relationship Management systems.
The /command page reads parameters passed to it as part of the command string which can be passed via a link.
The /command is typically used to accomplish one of more of the following:
This is accomplished using the /command string in the URL. This must include particular parameters depending on the intended action to perform.
For security reasons authentication (Login) credentials cannot be passed into the command function.
To allow different logins for different situations a sharedGroupAlias for each situation, is created in the DriveWorksConfigUser.xml file.
This is a server side configuration file which is never served to the client (browser) so all settings are secure.
See Integration Theme Settings, Shared Group - Multiple Connections for more information.
Once applied, the required sharedGroupAlias is selected by using the alias parameter in the command function.
Certain parameters of the command function have been blocked by default for security reasons.
Constants and Macros must be explicity set in the DriveWorksConfigUser.xml file.
This is a server side configuration file which is never served to the client (browser) so all settings are secure.
See Integration Theme Settings - Permissions for more information.
| Parameter | Description |
|---|---|
| groupAlias={aliasName} | This will log the user in using the specified Group Alias. If no groupAlias is declared the Default Group Alias will be used. |
| user={username} | This will log a particular user in. The module setting "Requires Exact User" ensures the username set in this module is logged on, logging off any previously logged in user. |
| run={Project Name} | This will run a project. |
| driveAppAlias={DriveApp Alias} | This will run a DriveApp. |
specificationName={Specification Name} specificationId={Specification Id} | This will display the details of the existing specification. |
specificationName={Specification Name}&operation={Operation Name} specificationId={Specification Id}&operation={Operation Name} | This will perform an operation on a particular specification. The operation must be a valid operation, with all conditions met for the specification, for this to run. If the operation results in a running state you will be taken to the |
specificationName={Specification Name}&transition={Transition Name} specificationId={Specification Id}&transition={Transition Name} | This will perform a transition on a particular specification. The transition must be a valid transition, with all conditions met for the specification, for this to run. If the transition results in a running state you will be taken to the |
You can pass values into constants and trigger macros using /command.
In the command string the names need to be prefixed with the respective value:
| Name | Parameter | Description |
|---|---|---|
| Length | DWConstantLength=1234 | This will pass the value 1234 into the Constant named Length in the project being run. |
| Height | DWConstantHeight=963 | This will pass the value 963 into the Constant named height in the project being run. |
| Intro | DWMacroIntro | This will execute the macro called Intro in the project being run. |
The table below gives example URLs that can be passed into the Live UI.
| URL | Description |
|---|---|
| http://www.mydomain.com/command?run=MyProject | This URL will go to www.mydomain.com (the DriveWorks Live URL), and create a new specification based on the project called MyProject. |
| http://www.mydomain.com/command?specificationName=IS81951 | This URL will go to www.mydomain.com (the DriveWorks Live URL), and open the specification history page for the Specification IS81951. |
| http://www.mydomain.com/command?specificationName=IS81951&operation=Edit | This URL will go to www.mydomain.com (the DriveWorks Live URL), and open the specification IS81951 by using the Edit operation. |
| http://www.mydomain.com/command?run=MyProject&DWConstantLength=1234&DWConstantHeight=963 | This URL will go to www.mydomain.com (the DriveWorks Live URL), run a new specification based on the project called MyProject and pass the values 1234 and 963 to their respective Length and Height constants. |
| http://www.mydomain.com/command?specificationName=IS81951&transition=Submit | This URL will go to www.mydomain.com (the DriveWorks Live URL), and perform the Submit transition on the Specification IS81951. |
| http://www.mydomain.com/command?specificationName=IS81951&DWConstantLength=1234&DWConstantHeight=963 | This URL will go to www.mydomain.com (the DriveWorks Live URL), and pass the values 1234 and 963 to their respective Length and Height constants in the existing Specification IS81951. |
When characters used in the structure of the URL are required as parameters or values to be passed into a specification, the character must be encoded.
Common characters and their URL-encoding equivalent are listed in the table below:
| ASCII Character | URL-encoding |
|---|---|
| space | %20 |
| & | %26 |
| ? | %3F |
Example of an Escape Tag in use.
When the value My Company is required to be passed into a Constant named ParameterCompanyName, the URL will look like this:
http://www.mydomain.com/command?run=MyProject&DWConstantCompanyName=My%20Company
| Knowledge Base Article Ref: | KB25042201 |
|---|