AllFusion^® Process Modeler r7.2 Readme

10.0 Contact Technical Support

1.0 Welcome

Welcome to AllFusion Process Modeler r7.2, a member of the AllFusion Modeling Suite. This file contains product installation considerations, operating system support, known issues, and information about contacting CA Technical Support.

2.0 Operating System Support

AllFusion Process Modeler (AllFusion PM) r7.2 requires that you have one of the following operating systems installed:

• Microsoft Windows Server 2003

• Microsoft Windows XP (Service Pack 2)

• Microsoft Windows 2000 (Service Pack 3)

3.0 System Requirements

The following requirements must be met or exceeded for AllFusion PM r7.2 to install and run correctly:

• Intel Pentium III or equivalent

• 150 MB hard disk space

• 1 GB RAM (2 GB recommended for large models)

4.0 Installation Considerations

Installation procedures for this release of AllFusion PM are in the AllFusion PM User Guide.

If you intend to share your process models with others using AllFusion MM, you must install AllFusion PM on all workstations on which the model may be saved or opened.

If you previously installed a release of AllFusion PM Version 4.1.4 (including one of the service packs), the AllFusion PM r7.2 installation program does not overwrite it; it installs separately from Version 4.1.4. This means that if you install r7.2 on a machine on which you have installed Version 4.1.4, both programs are present.

If you want to preserve spell checking dictionaries that contain user additions from AllFusion PM Version 4.0, do not uninstall AllFusion PM Version 4.0 before installing AllFusion PM r7.2. Install AllFusion PM r7.2 in a different folder than AllFusion PM Version 4.0. The spell checking dictionaries are copied from AllFusion PM Version 4.0 to AllFusion PM r7.2 automatically.

5.0 General Considerations

This section contains general information you should know before using AllFusion PM:

• Support for AllFusion Model Manager

  See the AllFusion MM Readme file and the AllFusion MM Administrator Guide for installation instructions and advisory notes for using AllFusion MM with AllFusion PM.

• AllFusion PM API sample application

  Information regarding the sample application that is within the AllFusion PM API is no longer contained in the file readme_AllFusion_Process_Modeler_Sample_App.html. See the section AllFusion Process Modeler API Sample Application for this information.

Important! The purpose of the sample application is to provide an integrator with an example of a simple AllFusion PM API client. It is not a utility or a functioning part of AllFusion PM.

6.0 Known Issues

No known issues at this time.

7.0 Published Fixes

All published fixes for this product can be found through Published Solutions on SupportConnect.

8.0 AllFusion Process Modeler API Sample Application

8.1 Installation Considerations

This section describes the installation considerations for the sample application.

Dependencies

AllFusion PM r7.2 must be installed. The following components must also be installed and successfully registered:

• AllFusion PM API (PM_SCAPI.dll)

• Microsoft Data Formatting Object Library (msstdfmt.dll)

Note: The implementation code is only compatible with Microsoft Visual Studio 6.0 and not the Microsoft .NET development environment.

Installing the Add-in Component

To install the sample application as an add-in component in AllFusion PM, follow these steps:

1. Register PM_SCAPI_AddinDLL.dll using the program regsvr32.exe.

   Note: If AllFusion PM was installed using the Complete install option, or the PM_SCAPI sample was selected in the Custom install option, PM_SCAPI_AddinDLL.dll is already registered.

2. Start AllFusion PM.

3. Open an existing project or create a new one.

4. Click Add-Ins and then Customize from the Tools menu.

   The Add-In Manager dialog opens.

5. Click the Add Menu Item button.

   The Add New Menu Item dialog opens.

6. Select Command in the Menu Type group, and then select Com Object.

7. Type API Sample in the Name field.

   This will be the name of the menu item in the Tools, Add-Ins menu.

8. Type PM_SCAPI_AddinDLL.PM_SCAPIAddin in the COM ProgID field or click the browse button to select the ID from a list. If PM_SCAPI_AddinDLL.PM_SCAPIAddin does not show up in the list, perform step 1 to register PM_SCAPI_AddinDLL.dll.

9. Type Run in the Function Name field.

10. Click OK to close the Add New Menu Item dialog.

11. Click Save in the Add-In Manager dialog.

To test the add-in component, select Tools, Add-Ins, then API Sample.

8.2 General Considerations

Published Fixes

All published fixes for this product can be found through Published Solutions on SupportConnect.

Sample Application Files

The following files are used to implement the sample application in Microsoft Visual Basic 6.0:

• DeleteNonScalarValue.frm

• Main.bas (used for the standalone executable only)

• ModifyObject.frm

• NewProject.frm

• PM_SCAPI_AddinDll.vbp (Visual Basic project file for the add-in component)

• PM_SCAPI_Sample_Exe.vbp (Visual Basic project file for the standalone executable)

• PM_SCAPIAddin.cls (used for the add-in component only)

• ProjectView.frm

• ProjectView.frx

• ReallocateArrayForm.frm

• SelectProject.frm

• SelectProject.frx

• UtilFunctions.bas

The following files are used to execute the sample applications:

• PM_SCAPI_AddinDLL.dll (Add-in component)

• PM_SCAPI_Sample_Exe.exe (Standalone executable)

Using the Sample Application

The sample application is provided within the AllFusion Process Modeler Script Client API (AllFusion PM API).

Important! The purpose of the sample application is to provide an integrator with an example of a simple AllFusion PM API client. It is not a utility or a functioning part of AllFusion PM.

The AllFusion PM API can be used within a standalone executable or within an add-in component that is run within the environment of AllFusion PM. An example of each type of client written in Visual Basic is provided. For more information regarding the AllFusion PM API, see the API Reference Guide.

Whether you run the sample application as a standalone executable or as an add-in component, the functionality is the same. To run the sample application as a standalone executable, run PM_SCAPI_Sample_Exe.exe. To view the implementation as a standalone executable, load PM_SCAPI_Sample_Exe.vbp into Visual Basic. To run the sample application as an add-in component, you must install the add-in component first if you have not already installed it. From the Tools menu within AllFusion PM, click Add-Ins, and then API Sample. To view the implementation as an add-in component, load PM_SCAPI_AddinDLL.vbp into Visual Basic.

Model Selection

The first dialog box of the sample application allows you to select the AllFusion PM models to view or to output to a text file. If the sample application was invoked as an add-in component from within AllFusion PM, the models that are currently open are displayed by default. If the sample application was invoked as a standalone executable, the list of projects is empty at first. All the models listed are either displayed or written to a text file. The list of models can be modified by creating a new model, adding an existing model, or removing a model from the list. The functionality of this dialog is implemented in SelectProject.frm.

Select any of the following to modify the list of models:

• Click on Add Project to add an existing model to the list.

• Click on Remove Selected Project to remove the selected model from the list. This only removes the selected model and does not delete it.

• Click on New Project to create a new project. Note that this project will not be saved unless it is explicitly saved in the Project View.

Select any of the following to perform on the listed models:

• Click on View to display the Project View, which shows the models in a tree view.

• Click Output to File to export the data in the models to a text file.

• Click Cancel to exit from the sample application.

Project View

The Project View displays the contents of the selected models in a tree view. When an AllFusion PM object is selected in the tree view, its properties and property values are displayed. The functionality of this dialog is implemented in ProjectView.frm.

The Properties box displays the following information regarding each property:

• Name of property

• SCAPI property value type

• If the property is scalar or non-scalar

• Property values

The following functions can be performed on a model object by right-clicking the model object:

Create new child

Lets you create a new child for the selected model object. The pull right menu displays the valid children types for the selected object.

Modify object

Lets you modify the property values of the selected model object.

Delete object

Lets you delete the selected model object.

Save model

Lets you save the model to which the object belongs. This saves all modifications to the .bp1 file.

The following function can be performed on an object type by right-clicking on the object type:

Create new object

Lets you create a new object of the selected object type.

The Project View also demonstrates the filtering capabilities of the AllFusion PM API. The following options control what model objects to display or hide in the tree view and are listed under Object View Options:

• View all objects

• View only user-defined objects. View only objects such as UDPs.

• Hide user-defined objects. Hides objects such as UDPs.

The following options control the type of properties to display for the selected object. These options are listed under Property View Options:

• View all properties

• View only scalar properties

• View only non-scalar properties

To close the Project View, click Close.

Note: Any modifications made will not be saved unless the model is explicitly saved using the Save command on the pop-up menu for a model object.

Object Modification

A dialog displays when a model object is being created or modified by using the commands on the pop-up menu in the tree view. In this dialog, the property values of the object are displayed and can be modified. The functionality of this dialog is implemented in ModifyObject.frm.

In general, most of the properties can be directly modified in the text fields. However, there are some special cases such as deleting a property value or modifying the number of values for a non-scalar property when you use the Edit menu instead. The Edit menu provides the following functions:

Reallocate array

Lets you change the number of values for a non-scalar property. This menu item is only enabled if the selected property is non-scalar.

Delete

Lets you delete the property. If the property is non-scalar, you are prompted to either delete just the single value that is selected or to delete all the property values.

Click OK to accept the changes.

Note: This will only display the changes in the Project View. The modifications will not be saved until the model is explicitly saved using the Save command on the pop-up menu for a model object.

Click Cancel to ignore the modifications.

9.0 Documentation

Updated guides for this product are available at http://ca.com/support.

The PDF guides for this product are as follows:

• AllFusion Process Modeler r7.2 API Reference Guide

• AllFusion Process Modeler r7.2 User Guide

• AllFusion Process Modeler r7.2 Business Process Modeling Design Guide

• AllFusion Process Modeler r7.2 Data Flow Diagramming Design Guide

• AllFusion Process Modeler r7.2 Process Flow Modeling Design Guide

• AllFusion Process Modeler r7.2 Release Summary

To view PDF files, you must download and install the Adobe Reader from the Adobe website if it is not already installed on your computer.

9.1 Release Numbers on Documentation

The release number on the title page of a document might not correspond to the current product release number; however, all documentation delivered with the product, regardless of release number on the title page, will support your use of the current product release. The release number changes only when a significant portion of a document changes to support a new or updated product release. If no substantive changes are made to a document, the release number does not change. For example, a document for r7 may still be valid for r7.1. Documentation bookshelves always reflect the current product release number.

Occasionally, we must update documentation outside of a new or updated release. To indicate a minor change to the documentation that does not invalidate it for any releases that it supports, we update the edition number on the cover page. First editions do not have an edition number.

10.0 Contact Technical Support

For online technical assistance and a complete list of locations, primary service hours, and telephone numbers, contact Technical Support at http://ca.com/support.