DriveWorks Pro 24

Specification Information

Specification Information

The Specification Information task is used if the specification files have been moved and require re-mapping or if specification information is to be removed form a group.

• Update the Location of Specification Information
• Delete Specification Information
• Delete Specification Reports
• Import Specifications
• Upgrade Specifications

The files associated to a specification that can be managed using this task are:

• DriveWorks Specification file - (SpecificationName.drivespec)
• Documents created from the specification - Copied File, Referenced File, Word, Excel, XML Document, and file formats created from them.

The Specification Information list can be be filtered by using the filter at the top of the list.

Please see the topic How To Use Filters for more advanced filtering information.

To Update the Location of Specification Information:

If all the specification information is in the same file location, then only the file location will need browsing to:

1. Right click the required folder from the folder tree on the left hand side of the window.
2. Select change location. Browse to the new location of the folder.
3. Click OK when the required folder has been selected.
4. This will then update the specification information found in that location.

If the specification information has a different file location then they will all need browsing to:

1. Right click the required name from the specification list.
2. Select change location. Browse to the new location of the project.
3. Click "Open" when the required information has been selected.
4. This will then update that information.

To Delete Specification Information:

Information stored about a specification is deleted by:

1. Select the specification or specifications to be deleted from the specification list.
   Multiple specifications can be selected by:

   • Hold Ctrl key and select individual specifications.
   • Hold Shift key and select a group of specifications.
2. Click the Delete button from the Command Bar.This will open a dialog with some further options:
   • Remove References from DriveWorks. This will remove the reference for the specification from the group database.
   • Delete File from Windows Explorer. This will delete the specification file.
3. Check the appropriate boxes to perform the required action and click OK.

Alternatively there is a right click option to achieve the above:

1. Right click on the required specification from the specification list.
2. Select Delete from the Right click menu. This will open a dialog with some further options:
   • Remove References from DriveWorks. This will remove the reference for the specification from the group database.
   • Delete File from Windows Explorer. This will delete the specification file.
3. Check the appropriate boxes to perform the required action and click OK.

If you wish to remove all of the specification information from a folder:

1. Right click the folder from the folder tree.
2. Click the Delete option and select the required operation from the dialog.

Delete Specification Reports

For each specification DriveWorks produces a number of reports depending on the operations performed on it.

The reports contain information regarding the success of the operation, and are useful in diagnosing any issues.

The reports are stored in the DriveWorks group, they can be deleted as follows:

1. Select the specification or specifications to have its reports deleted from the specification list.
   Multiple specifications can be selected by:

   • Hold Ctrl key and select individual specifications.
   • Hold Shift key and select a group of specifications.
2. Click the Delete Reports button from the Command Bar. This will open a dialog with some further options:
3. Check the reports to be deleted and click the OK button.

Show Missing Files Only

By default the specification information task will display all specification information in the group. Specification information that can be found will be displayed in a dark font. Specification information that cannot be found will be displayed in a red font.

If specification information has been copied to a new location, and still exists in the original location it will be shown as being found. This can be changed by using the methods above.

Missing files only can be displayed by clicking the missing files button from Command Bar.

Toggle Archived Status

Toggle the selected Specification between its Archive and Restored states.

Archive Specification

Archive the selected Specification.

Restore Specification

Restore the selected Specification from its Archived state.

Refresh

The displayed list of files in the group can be refreshed at any time by using the Refresh button from the Command Bar.

Import Specifications

Import Specification gives you the ability to import specifications from another Group.

This is essential when requiring to maintain specification history from a "In Production" group into a "Development" group prior to going live.

Step 1	A B	With the group open, to import into, in Data Management: A Select the Specification Information task from the Data Management task explorer. Click the Import Specifications button Or B Select DriveWorks Tasks from the Data Management task explorer. Click the Import Specifications task.
Step 2		Select the Browse button on the Group field to launch the Open Group Wizard. From the Open Group Wizard select the Group that contains the specifications to be imported.
Step 3		Enter the User Name and Password (if applicable) to log on to the Group as an Administrator. Click log-on
Step 4		The specifications will be listed in the Specifications window. Click Finish to import all specifications into the group.

Reset Specification Id Pool

The Reset Specification Id Pool will reset the number used for the special variable DWSpecificationId.

To Reset the specification Id pool:

1. Delete all specifications from the group (see above)
2. Click the Reset Specification Id Pool button.

Data Management Filtering

Filtering is available throughout the Data Management Tool.

Filter boxes are found at the top of the file and file location columns in the main window of the following Data Management Tasks:

• Captured Information.
• Projects.
• Specification Information.
• Released Files.
• Released Master Files.

Filtering

To Filter the information select the Data Management Task for which the information is to be filtered.

Once the task has been selected all of the information about that task is presented in the main window. The information is presented in 2 separate columns, which represent:

• File Location
• File Information

If you require to filter based on file location, use the filter box above the left column of the main window.

If you require to filter based on file information, use the filter box above the right column of the main window.

1. Enter the filter criteria in the appropriate filter box
   
   

The information in the corresponding column will be filtered to match the criteria entered.

Clear the Filter

Once a filter has been applied it can be cleared by:

A. Removing the characters from the Filter box by using the backspace or delete keys on the keyboard.

Or

B. Clicking the clear button from the filter box (The black cross that appears once characters are entered).

Upgrade Specification

Specifications created from an older version of a project can be upgraded to the latest version.

In order to upgrade a specification the following must be observed:

• The specification to be upgraded must have access to a running state to trigger upgrade.

  For example in the default Specification Flow, a specification can enter the Specify (running) state by the edit transition from the Saved, Pending or Completed states.

  

  All Specification Flow state names must match between the original specification and the new project used for the upgrade.

• The specification will only be upgraded after transitioning out of the running state.
• The specification must be manually Marked for Upgrade.
• When upgrading, DriveWorks will create a backup of the underlying project file associated to the specification.

  See Specification Extensions for information.

• The last saved version of the project will be used when the Specification is upgraded (not the version when you marked it).
• When the Specification opens, the new project is applied, and it looks for a DriveWorks_OnUpgrade macro in the new project to run.
• Once upgraded, the Upgrade Project flag will be cleared and will not upgrade until it is manually marked again.

Apply Upgrade Functionality to the Project

DriveWorks needs to know what data from the original specification should be passed into the upgraded specification.

The following Specification Tasks assist with passing the data to an upgraded specification.

• Upgrade: Get Previous Constant

  Retrieves the current value of a given Constant before upgrading the specification.

• Upgrade: Get Previous Control Input

  Retrieves the current value of a given Control before upgrading the specification.

• Upgrade: Get Previous Table

  Retrieves the current array of a given simple table before upgrading the specification.

• Upgrade: Transfer Constants

  Decide which Constants are included or excluded from the upgrade process.

• Upgrade: Transfer Forms

  Decide which Forms are included or excluded from the upgrade process.

• Upgrade: Transfer Tables

  Decide which simple Tables are included or excluded from the upgrade process.

The following must be implemented in each project a specification is to be upgraded to:

1. In DriveWorks Administrator open the group that will contain the specifications to be upgraded.

   Ideally the specifications will exist in a production environment.

   We recommend creating some specifications in the development environment so this functionality can be tested before updating the production environment.

2. In Stage 5. Specification Control > Specification Macros, add a macro named DriveWorks_OnUpgrade.
3. Add the required Specification Upgrade tasks to get or transfer the required data from the original specification.

   For example:

   To maintain an original Form Control input add the Upgrade: Get Previous Control Input task.

   Add all other tasks for each data point that is required from the original specification.

   The tasks prefixed with Get will get a single value.

   The tasks prefixed with Transfer will get all data.

   To transfer all control values use the Upgrade: Transfer Forms task.

   

4. Ensure all task connection points are connected.
5. Save the project and return to Data Management to mark the specification for upgrade.

Mark a Specification for Upgrade

1. Select a specification
2. Click the Mark for Upgrade button.

   

3. Select the project the specification is to be upgraded to.

   

   Typically this will be the new version of the project the specification was created from.

   However this step allows a different project to be selected if the original project has been duplicated.

Transition the Specification to a Running State

Go to the Specification Explorer or Specification History page.

Locate the specification and click the button which will transition the specification to the running state.

The specification will now be using the latest version of the project selected when it was marked for upgrade.

Clear Upgrade

The Mark for Upgrade flag can be cleared before the specification is transitioned by:

1. Select the specification previously marked for upgrade.
2. Click the Clear Upgrade button.