PET User Documentation

PET is designed to be easily usable. However, running the default V-Modell XT process provider requires some 'groundwork' as it needs a V-Modell XT project file. This project file has to be created using the Project Assistant which is a part of the V-Modell XT tools and thus not distributed with PET. This page provides a common process transformation scenario, explains how PET supports it and will guide you through a sample run of PET.

Scenario

The scenario we will look at is the creation of a Microsoft Word document template for the V-Modell XT product (artifact) Product Manual.
As basis we use an English V-Modell XT 1.3 which is not tailored. For the model a System Development Project (Acquirer) is created using the V-Modell XT Project Assistant (you can download the finished project file below). Afterwards the resulting project file is read by PET which generates the final document template, depicted in the following image.

ProductTemplate2.png

PET terminology

  • A Process provider is a plugin that reads a process model and maps its information onto the PET meta model. E.g. the V-Modell XT process provider loads a tailored V-Modell XT project file.
  • A Tool provider is a plugin that uses the previously initialized meta model to create data needed by a certain external tool. E.g. the TFS tool provider generates a process template for Microsoft’s Team Foundation Server.

Installation

To use PET it must be installed on the user's machine. PET runs on Windows XP, Vista and 7, the .NET Framework 3.5 runtime has to be installed. The installation follows the Windows guidelines; the default settings can be used. For this chapter we also assume you use Microsoft Word 2010 and have access to a Microsoft Team Foundation Server (TFS) 2008 as well as a SharePoint Services (SP) 2007 server.

PET Wizard

The application's user interface resembles a Windows wizard which means it consists of several pages displayed in a defined order. To advance from one page to the next, the user has to first enter all necessary information for the current page and click the Next button.

Scenario_1.png

The screenshot shows PET's welcome page and asks the user to either create a new PET process transformation project or load an existing one. To follow this page's scenario please click New Project; note, that the subsequent steps are analog if you load an existing project. On the next page the available process providers and their descriptions are listed. At the moment the official PET package contains only the V-Modell XT (VMXT) process provider. Please select it and click Next to get to its configuration page.

Scenario_2.png Scenario_3.png

Process Provider -- V-Modell XT

During the VMXT provider's configuration, the user has to select the V-Modell XT XML file to be used as well as the belonging project file (VMP). As mentioned before we use a standard V-Modell XT 1.3 that is distributed as part of the PET package and can be found in PET\pluginData\vmxt\en. For this scenario please use this project file: VMXT-Project.vmp. Note, that you will probably not be able to open the downloaded project file in the V-Modell XT project assistant as the application is heavily dependent on the V-Modell XT XML file's exact location. PET however is much more flexible and will use this VMP without problems.

Once the Next button is clicked the provider loads the process model into the PET intermediate model. After the intermediate model is initialized PET allows the user to select the tool provider(s) for the generation of the desired output. If multiple tool providers are selected they are run sequentially ordered alphanumerically by their name. This unproblematic as the intermediate model (except for the ExtendedData field) is read-only. For the scenario please tick the Docx Generator check box and click Next.

Scenario_4.png Scenario_5.png

Tool Provider -- Word-DocX

The DocX tool provider uses generation template documents and the information from the initialized intermediate model to create document templates for artifacts in the Office Open Document Format (OODF, e.g. .docx). Generation template documents are OODF files containing placeholders that determine the structure of the final document template. This allows the user to customize the results generated by the provider. For example it is possible to have the document templates reflect the software development project's design or a corporate identity. The location of the generation template documents as well as the output path for the resulting documents must be provided by the user. Furthermore the configuration page gives the user the ability to specify the name and company of the project for which the document templates are generated as well as their author. These information are put into the generated artifacts at the respective placeholders as well as in the documents' meta data. Optionally a VMXT template texts XML file can be used to include content in the generated document templates. Note that the use of the VMXT template texts file is completely independent of the used process provider; using it with a SPEM process provider would be possible. Last but not least the artifacts for which document templates are to be generated must be selected in the belonging section of the configuration page. The artifact tree's first level groups the artifacts by their discipline, checking one selects all contained artifacts. Level two are the artifacts themselves. On the next levels in the tree it is possible to explicitly select which topics and template texts should appear in the final document.

For the scenario please enter some arbitrary values for Project name, Company and Author. Afterwards set the template path to the generation template documents shipping with PET (PET\pluginData\docx\vmodellxt\de). Optional: if you have a VMXT template texts file please use the Browse button to specify its location. Now select a Output path of your choice and select the artifact Project Manual which you find in the discipline Planning and Control. By default all topics of the artifact are selected and thus included in the generated document template. If you are done with the settings on this configuration page click Next to proceed to the actual generation process.

Scenario_6.png Scenario_7.png

When the generation process is completed click Next again. PET's last page allows you to save the project for later use. This means all process and tool provider settings are written to a file and can be loaded in a new PET session. To exit PET click Close wizard. If you followed the scenario correctly you should find the generated document template in YourOutputFolder\Planning and Control\Project Manual.docx.

Further Reading

For more details on the DocX document generation provider and all other tool providers part of the PET package, please refer to the Wiki pages TFS, SharePoint and Office Word.

Last edited Jan 23, 2011 at 9:05 PM by MtodaT, version 12

Comments

No comments yet.