How to: Create and Install a Specification Flow Template (DriveWorks Documentation)

How to: Create and Install a Specification Flow Template

This topic shows how to create a Specification Flow Template, include a description file and install it to be used for other Projects and users.

A Specification Flow Template has the file extension of .drivesft

Create a Specification Flow Template

Follow the steps below to create a Specification Flow Template (.drivesft).

With the Project containing the Specification Flow to be exported open in DriveWorks Administrator:

Navigate to Stage 5: Specification Control>Specification Flow, to display the current Specification Flow.
Ensure the current Specification Flow meets the requirements for the template.
Click Export Template from the Command Bar, the Template Exporter will launch.
In the Template Exporter enter a Title for the template
Once the template has been installed, the Title will be displayed as the Template name in the Template list, of the Load Template dialog.
Optionally enter a description for the template. Click Next.
Enter a File Name for the template and browse to a location to save. Click Save.

You now have a Specification Flow Template that you can distribute and install.

Create a Description File (Optional)

A Description File allows information about the template to be displayed in the Load Template dialog.

Locate the .drivesft file that is to have the Description added.
Using Windows Explorer rename the .drivesft extension to be .zip.
Right click the file and select Extract All, follow the wizard to extract the contents of the zip file.
Extract the files to a new folder so all contents are separate to any other files.
In the location of the extracted zip file create a folder named Description.
In the Description folder create a file named index.html.
Open the index.html file in a program such as Notepad.

Copy the following html into the index.html file:

<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
	<head>
		<meta charset="utf-8" />
		<title>MySpecFlowTitle</title>
		<style type="text/css">
			html {
				font-family: 'Segoe UI', Verdana, Arial;
				font-size: 12px;
			}
			h1 {
				color: #3f5f7f;
				font-size: 12px;
			}
		</style>
	</head>
	<body>
		<h1>Specification Flow Template Title</h1>
		<p>Specification Flow Template Description</p>
	</body>
</html>

Edit the text Specification Flow Template Title (between the <h1> and </h1> tags) to be the Title required.
Edit the text Specification Flow Template Description (between the <p> and </p> tags) to be the Description required.
Place any additional lines of text in between <p> and </p> tags.

Save the index.html file and close the program used to edit the file.
In the template folder you will now have the following items:
- File - [Content_types].xml
- File - TemplateFileName.xml (this will be the name (not the Title) given to the template when it was exported)
  The name of this file is important for the next step.
- Folder - Description
  This contains the index.html file
Select all items, right click and select Send To > Compressed (zipped) folder.
It is important the zip is created this way so the contents are not placed within a sub folder.
Rename the zip file.
- The name of the zip file is required to match the name of the xml file that has the TemplateFileName (see the previous step).
- The extension of the zip file is required to be changed to .drivesft.

Add an Image to the Index File

Images can be included in the index.html file by encoding them to base64.

Use a Web Service such as Base64 Image to convert an image to base64.

Once you have the base64 code of the image:

Open the index.html file created in the previous section.
If this file has been re-packed in a .drivesft file, rename the extension to be .zip and extract the file.

Replace the text INSERT BASE64 HERE below with the base64 code:

    <body>
        <h1>Specification Flow Template Title</h1>
        <p>Specification Flow Template Description</p>

        <img src="INSERT BASE64 HERE" />

    </body>

Ensure the quotes around the base64 code are included.

Save and close the file, follow steps 9 to 10 from the previous section (create the zip file and rename) to complete the template.

Installing a Specification Flow Template

If a template is not displaying in DriveWorks after being installed, check that the installer or version of DriveWorks is the one currently being used, as templates are version specific.

If there is an error in the templates data it will not display.

The steps below will guide you through the process of installing a Specification Flow Template (.drivesft) :

Double click on the new .drivesft file and the DriveWorks Install Template wizard will automatically launch.
Choose whether this template should be made available to either the Current User or for Everyone (who has access). Click Next.
The DriveWorks Install Template wizard will then launch and complete the task to install the template for the
users selected.

Uninstall a Specification Flow Template

To uninstall a Specification Flow Template please follow the steps below:

Open Windows Explorer and navigate to the folder where the Templates are stored in DriveWorks.
See Specification Flow Template File Location
From the SpecificationFlows folder, select the template you want to uninstall.
Right-click and select Delete or press the Delete key on your keyboard.

The selected Specification Flow Template will no longer appear in the list of available templates when following the steps to Load Template (restart of DriveWorks maybe required).

DriveWorks Pro 22 How to: Create and Install a Specification Flow Template