This file contains information on installing and using the current release of Serena® Prototype Composer™.
This document also describes requirements for integrating Prototype Composer with Serena® Dimensions® RM, Serena® Business Mashups, and Microsoft® Visual Studio® 2005 Team System.
To get help with the product, visit the Serena Connect Community at www.serenaconnect.com.
The minimum system requirements are:
Client Systems - Minimum | |||
---|---|---|---|
Platform |
Memory |
Screen resolution |
System Colors |
Windows 2000 or Windows XP |
256 MB |
1024x768 |
65,536 colors |
The recommended system requirements are:
Client Systems - Recommended | |
---|---|
Platform |
Memory |
Windows 2000 Professional or Windows XP Professional |
512 MB |
.NET Framework version 1.1 or greater must also be installed on the system.
Microsoft® Word 2003 (either the standalone version or the version supplied with Microsoft Office Professional Edition 2003) or Microsoft Office Word 2007 is required to generate documents in the Document Publisher. The XML support supplied with these specific versions is needed to generate documents.
This section explains how to install Serena Prototype Composer. You must perform the following installation procedures on all client machines where necessary.
NOTE:
You will not be able to open projects created in Prototype Composer 2.4 in prior versions of Prototype Composer.
To install Serena Prototype Composer:
Follow the instructions until the installation is complete.
You can upgrade directly to Prototype Composer 2.4 from Prototype Composer 2.3. Projects are now stored in the \My Documents\Prototype Composer Projects directory. When you open an existing project, you will be prompted whether you want to move the project to the new directory.
Prototype Composer 2.4 is a minor maintenance release that fixes an issue which will cause Prototype Composer to stop working on January 3, 2008. Additional branding changes were also made in the product.
The requirements for the integrations with Prototype Composer are outlined in this section.
The system requirements for the Prototype Composer with Microsoft VSTS integration are as follows:
See Serena Prototype Composer Integration Guide for Microsoft Visual Studio 2005 Team System for information on installing the integration files onto Team Foundation Server.
The system requirements for the Prototype Composer with Business Mashups integration are as follows:
For Business Mashups browser support, see the Serena® Business Mashups readme.
The system requirements for the Prototype Composer with Dimensions® RM integration are as follows:
The integration between Serena Prototype Composer and Serena Dimensions® RM works only with Dimensions® RM version 10.1.1 and later.
For Dimensions® RM Browser support, go to support.serena.com.
DEF87416: If you are using Business Mashups version 6.3 to manage Business Mashups based reviews, you must download the request file attached to the Business Mashups task to your local machine and open the request file from there.
DEF78077: If you have Microsoft Office Document Image Writer configured as your default printer driver, you may get an unhandled exception error message if you cancel out of the Save As dialog accessed from Print Preview.
DEF88820: While Prototype Composer can import and execute a wide variety of Web Services as part of an application prototype, some services, such as those containing recursive type definitions, may not execute successfully. Developers who help you populate the set of IT Services for use in application prototypes are advised to test those services for proper execution within Prototype Composer before making them available to you.
DEF88930: Dimensions® RM must be properly configured for Prototype Composer to successfully publish model items to it. In certain circumstances you may see an error message that indicates the publishing failed. In this case you need to ensure that the Tablespace setting for tables used to store Prototype Composer model items and requirements is sufficient to contain the items published. For example, Microsoft Word documents can be very large and will overflow the available space if it is not reconfigured. You should also ensure that the temporary directories that may be used by both the Dimensions® RM Web service and Dimensions® RM itself are writable by the Web service and Dimensions® RM processes.
DEF86108, DEF84168: While in most cases the Web Capture utility in Prototype Composer will import and convert simple Web pages with high fidelity, pages with dynamic content or complex HTML elements may result in less than optimal capture results. Examples include:
Web pages with data tables converted to bitmaps with text objects representing the data records.
Web pages with scrolling panels vertically truncated and the panels converted to bitmaps.
You are advised to perform test captures and adjust the capture controls to maximize the quality of imported Web content.
DEF88549: Images of process or activity flow maps included in published documents may not scale to the full extent possible depending upon the aspect ratio of the image. These images can be selected and scaled manually following the generation of the document.
DEF93725: Reviewers participating in Business Mashups managed reviews must have the Business Mashups permission, Add Attachments to Any Item, granted in order to enable the attachment of a response file when submitting review responses. If a reviewer attempting to submit a response file does not have this permission set, the response file will not be successfully attached and submitted. The Business Mashups Web services will not return an error message warning of the failed attachment. When the reviewer exits Prototype Composer, the response file will be deleted and the review responses will be lost.
For more information on permissions required for the Business Mashups integration, see Serena Prototype Composer Integration Guide for Serena Business Mashups.
DEF98689: When downloaded the Prototype Composer installer checks the local machine to see if the required .NET Framework version 1.1 (or greater) is present. If it is not present, the Prototype Composer installer attempts to access the InstallShield Web site and download the redistributable .NET Framework program (dotnetfx.exe) to the local machine and install it. If the Prototype Composer installer fails to run, it might be due to an inability to download .NET Framework. Check that you have internet access to the InstallShield Web site. If this site is down or you are otherwise prevented from accessing it, download and install .NET Framework from the Microsoft web site. When .NET Framework is finished installing, run Prototype Composer24.exe located in the installer ZIP file.
The integration of Prototype Composer with Microsoft Visual Studio 2005 Team System (VSTS) requires the installation and implementation of any VSTS process template on Team Foundation Server (TFS). A Serena specific ("Prototype Composer ready") process template is available that you can import into VSTS and use immediately in the integration. The Prototype Composer ready process template is a collection of XML files that defines processes and artifacts for use in VSTS, including Prototype Composer model items, scenarios, requirements and work item types. The Prototype Composer ready process template simplifies the process of mapping Prototype Composer items to items in VSTS.
The other options that are available for configuring a process template are to extend an existing process template or create a new one. All options are implemented using the VSTS Process Template Manager. Using the Process Template Manager requires administrative rights to VSTS.
The following sections provide details on the options available for configuring the process template.
NOTE:
For information and instructions on how to use the VSTS Process Template Manager to configure a process template, see the Microsoft documentation.
To get you up and running quickly with the Prototype Composer/VSTS integration, it is suggested that you install a Prototype Composer ready process template and create a new project based on it. To install the Prototype Composer ready process template, upload (import) the Serena specific process template from the \ Composer CMMI Process Improvement sub-directory of the VSTS integration installation directory on TFS.
You can create a new process template to work with the Prototype Composer/VSTS integration. If you choose to create your own process template (or extend an existing one), you must incorporate the modifications described in the section, Extending an Existing Process Template. See the Microsoft documentation for information on creating and importing process templates in VSTS.
You can extend an existing process template by incorporating the following suggested changes to the files that make up the process template. These modifications apply to process templates that are based on the Microsoft CMMI Process Improvement. These suggestions are provided as a general guide. To further assist you in making these modifications, see the corresponding fields in the Prototype Composer ready process template provided.
To extend (modify) an existing process template, download (export) an existing process template, for example, MSF for CMMI Process Improvement - v4.0, save it, and make the following suggested changes to your process template XML files. When you are finished making the modifications, upload (import) the process template to make it available for use by a VSTS project.
To complete the update of your process template, you’ll need to copy some files from the Prototype Composer ready process template to your process template directory. The Prototype Composer ready process template files are located in the \Composer CMMI Process Improvement sub-directory of the VSTS integration installation directory on TFS.
Update the ProcessTemplate.xml file by adding appropriate information for the <name> and <description> tags as in the following examples.
Update the process template name as follows:
<ProcessTemplate>
...
<metadata>
...
<name>MyProcessImprovement</name>
...
</metadata>
...
</ProcessTemplate>
Update the process template description as follows:
<ProcessTemplate>
...
<metadata>
...
<description>Description of MyProcessImprovement</description>
...
</metadata>
...
</ProcessTemplate>
Update the WorkItems.xml file by adding new workitemtypes and queries.
Add the following new workitemtypes exactly as typed in the following example.
<tasks>
<task id="WITs" name="WorkItemType definitions" plugin="Microsoft.ProjectCreationWizard.WorkItemTracking" completionMessage="WorkItemTypes created">
...
<taskXml>
...
<WORKITEMTYPES>
...
<WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\Model.xml"/>
<WORKITEMTYPE fileName="WorkItem Tracking\TypeDefinitions\Prototype.xml"/>
...
</WORKITEMTYPES>
...
</taskXml>
...
</task>
...
</tasks>
To add new queries, add the following new queries under the <QUERIES> tag exactly as typed as follows.
<tasks>
<task id="Queries" name="Stored Query Definitions" plugin="Microsoft.ProjectCreationWizard.WorkItemTracking" completionMessage="Queries uploaded">
...
<taskXml>
...
<QUERIES>
...
<Query name="Models" fileName="WorkItem Tracking\Queries\Models.wiq" />
<Query name="Prototypes" fileName="WorkItem Tracking\Queries\Prototypes.wiq" />
...
</QUERIES>
...
</taskXml>
...
</task>
...
</tasks>
Update the CustomerRequirements.wiq by adding a new OR clause to the query to include additional workitemtypes. Refer to the following example.
<WorkItemQuery Version="1">
<Wiql>
SELECT [System.Id], [System.IterationId], [System.State], [Microsoft.VSTS.Common.Priority], [System.Title]
FROM WorkItems WHERE [System.TeamProject] = @project AND [System.WorkItemType] = 'Requirement'
AND ([Microsoft.VSTS.CMMI.RequirementType] = 'Scenario' OR [Microsoft.VSTS.CMMI.RequirementType] = 'Quality of Service'
OR [Microsoft.VSTS.CMMI.RequirementType] = 'Business' OR [Microsoft.VSTS.CMMI.RequirementType] = 'User'
)
...
ORDER BY [System.Id]
</Wiql>
</WorkItemQuery>
Locate this file in the directory of the Prototype Composer ready process template provided and copy it to the same location in your process template directory.
Locate this file in the directory of the Prototype Composer ready process template provided and copy it to the same location in your process template directory.
Update the Requirement.xml file by adding new requirement types, a new field to hold the ID of the related Prototype Composer requirement and a new control for the Prototype Composer ID field.
Add a new requirement type field as in the following example.
<WITD>
...
<WORKITEMTYPE>
...
<FIELDS>
...
<FIELD name="Requirement Type">
...
<ALLOWEDVALUES>
...
<LISTITEM value="Business"/>
<LISTITEM value="User"/>
...
</ALLOWEDVALUES>
...
</FIELD>
...
</FIELDS>
...
</WORKITEMTYPE>
...
</WITD>
Add a new field to hold the Prototype Composer ID as in the following example. Add this field to the bottom of the list of field elements.
<WITD>
...
<WORKITEMTYPE>
...
<FIELDS>
...
<FIELD name="Composer Id"refname="Serena.VSTS.CMMI.ComposerId" type="String">
<HELPTEXT>Id of the related Prototype Composer requirement
</HELPTEXT>
</FIELD>
...
</FIELDS>
...
</WORKITEMTYPE>
...
</WITD>
Add a new control for the Prototype Composer ID field as follows:
<WITD>
...
<WORKITEMTYPE>
...
<FORM>
...
<Layout>
...
<Group name="Status">
...
<Column PercentWidth='50'>
...
</Column>
<Column PercentWidth='50'>
...
<Control Type="FieldControl" FieldName="Serena.VSTS.CMMI.ComposerId" Label="&Composer Id:" LabelPosition="Left"/>
...
</Column>
...
</Group>
...
</Layout>
...
</FORM>
...
</WORKITEMTYPE>
...
</WITD>
Locate this file in the directory of the Prototype Composer ready template provided and copy it to the same location in your process template directory.
Locate this file in the directory of the Prototype Composer ready template provided and copy it to the same location in your process template directory.
Create a new VSTS team project that uses the new Prototype Composer ready process template and create a project on Prototype Composer. In Prototype Composer, enable the VSTS integration and configure mappings.
For complete information on enabling the integration, creating mappings, and using the integration, see the Serena Prototype Composer online help, Serena Prototype Composer Getting Started Guide, and Serena Prototype Composer Integration Guide for Microsoft Visual Studio 2005 Team System.
End Readme
Copyright © 2003-2008 Serena Software, Inc. All rights reserved.