Setting Up the Modeling Environment

This chapter discusses:

Click to jump to parent topicCommon Elements in this Chapter

Open the Overview Window.

Save and compile the model.

Compile and run the model.

Open the Viewer dialog, which contains the Find tab, where objects are listed.

and

Standard Windows “show and hide” indicator buttons. Appear in the model structure view to control display of hierarchy items. Also indicate that the domain members of the node are internal.

In the model structure view, this icon appears next to external domain members. Internal domain members are indicated by the plus and minus symbols.

Add button for the component properties table. Adds rows—properties—to a class or subclass.

Add button for the component properties table. Adds a row—properties—for defining attributes on selection points.

Click to jump to parent topicConnecting to Third-Party Software

This section discusses setup procedures for:

Click to jump to top of pageClick to jump to parent topicSource Control Software

The Visual Modeler supports the latest version of the Microsoft Source Control (MSC) interface. An installed source control application that complies with the correct MSC version is shown as an option in the Visual Modeler.

  1. Create or obtain a user account and login for your source control tool.

  2. In Visual Modeler, go to Tools, Options, then click the Source Control tab.

  3. Choose a provider from the “Source Control Provider to Use” drop down. This drop down displays MSC-compatible applications installed on your system.

    Optionally, select the source control options best suited to your project:

    Option

    Explanation

    Get files when opening the workspace.

    Automatically get the latest versions of all .cms files in this project whenever a workspace is opened.

    Check in files when closing the workspace

    If this option is checked, you must remember to save before closing the workspace. If files are saved before the workspace closes, the all files will be checked in. If unsaved files are open when the workspace is closed, the files will be checked in, but any files previously not saved will be checked out again.

    Prompt to add files when inserted

    When a .cms file is inserted into the project, prompt to add the file to source control.

    Perform background status updates

    Not all source control tools support this option. If background status updating is supported, the IDE can change the appearance of a file in the File View when a file under source control is altered by an external checkin.

    Use dialog for checkout

    Specify that a comment dialog automatically appears when a file is checked out.

    Add new projects to source control

    Automatically add new projects (.csp file) to source control.

    Automatically add new files to source control

    Automatically add new .cms files to source control.

  4. Enter the source control login name in the Login field, then click OK. You will be notified that the provider change will not take effect until you restart the Visual Modeler. The changes will be available when the Visual Modeler is restarted.

    Once the source control tool is selected, it is possible to set Advanced options. Select Tools, Options then click the Source Control tab. Click the Advanced button. An Options window appears. Consult your source control documentation for information on the options displayed.

Click to jump to top of pageClick to jump to parent topicDatabase Interface Configuration

Advanced Configurator supports Microsoft SQL Server, Oracle, IBM DB2 database connections.

Note. If your database is Oracle, you must install an Oracle client on the machine where Visual Modeler is installed. Your system will then have the Oracle ODBC Driver, which ensures compatibility with Oracle.

Before proceeding, you need certain system information:

The Visual Modeler relies on the ODBC Data Source Administrator for connection information. Setting up an ODBC data source allows you to view external domain members in the Visual Modeler.

See Connecting to a Database from Visual Modeler.

To compile a model, Advanced Configurator uses the Java Naming and Directory Interface (JNDI) Database connection. This connection requires customizing two properties files.

See Configuring JNDIDBName.properties.

Configuring an ODBC Data Source for Microsoft SQL Server

Use the Windows data source wizard to configure an ODBC data source.

To connect Advanced Configurator to Microsoft SQL Server:

  1. Open My Computer, Control Panel, Administrative Tools, and Data Sources.

  2. Click the Add button.

  3. Select a driver from the list, then click Finish. The data source connection dialog appears.

  4. Enter the indicated information in the fields. Choose a name carefully. The name is case-sensitive, and it will be used to identify the data source both in the properties files and in the Visual Modeler database interface.

  5. Click Finish. The authentication dialog appears.

  6. Select an authentication option. If a password is not required, click “With Windows NT authentication of the login ID”, then click Next.

    If the database has a login and password, click “With SQL Server authentication using a login ID and password entered by the user,” then click “Connect to SQL Server to obtain default settings for the additional configuration options.” Enter the database login and password, then click Next. The remaining screens address DSN Configuration options that are not critical for the connection. Click Next, then on the last screen click Finish.

  7. Configure JNDIDBName.properties.

    See Configuring JNDIDBName.properties.

Configuring an ODBC Data Source for Oracle

Use the Windows data source wizard to configure an ODBC data source.

To connect Advanced Configurator to an Oracle data source:

  1. Open My Computer, Control Panel, Administrative Tools, and then Data Sources.

  2. Click the Add button.

  3. Select a driver from the list, then click Finish. The data source connection dialog appears.

  4. Enter the indicated information in the fields. Choose a name carefully. The name is case-sensitive, and it will be used to identify the data source both in the properties files and in the Visual Modeler database interface. In most cases it is appropriate to accept the default settings for Database Options, Application Options, and Translation Options. Consult your database administrator. Click OK.

  5. Configure JNDIDBName.properties.

    See Configuring JNDIDBName.properties.

Configuring an ODBC Data Source for IBM DB2

To connect Advanced Configurator to an IBM DB2 data source:

  1. Launch the IBM DB2 setup tool (Programs, IBM DB2, Set-up Tools, Configuration Assistant).

  2. Select Selected, Add Database Using Wizard. The wizard appears.

  3. In window 1, Source, select Manually configure a connection to a databaseand click Next.

  4. In window 2, Protocol, select your protocol.

  5. In window 3, assign the appropriate values to the fields.

  6. In window 4, Database, enter the database name and alias.

  7. In window 5, Datasource, select Register this database for ODBC and As system data source. Enter a value for Data source name.

  8. In window 6, Node Options, specify the operating system and the remote instance name.

  9. In window 7, System Options, specify System name, Host name, and Operating system.

  10. In window 8, Security Options, specify Use authentication in server's DBM Configuration. Click Finish. The wizard closes and the Configuration Assistant reappears with the connection listed in the pane.

  11. Select Selected, Test Connection to verify the connection.

Click to jump to top of pageClick to jump to parent topicConfiguring JNDIDBName.properties

By default JNDIDBName,properties is located on the Advanced Configurator Server:

C:\bea\wlserver_10.3.1\config\CalicoDomain\applications\CalicoApp\Web-inf\config

Note. You may not need to hand-edit this file. If you are using data from the database specified during installation the file will be updated based on the information entered with a (datasource) name of “PSCFG.”

Only the portion of the file relevant to your database needs to be changed. All entries except the machine name are case-sensitive and must match your environment exactly. Substitute your information as follows:

  1. Replace sqldb, oracledb or DB2DB with your data source name. This name is defined when the ODBC driver is configured. The “name”(the portion before the first '.') should match the name of the data source specified for the classes in the model.

    See Database Interface Configuration.

  2. Replace username and password with the user name or login defined for your database account. The square brackets [ ] used to delimit the sample must be deleted.

    If you specified “Windows NT authentication using the network login ID,” the fields may be left blank.

  3. Save a copy of the customized.properties file in a location outside the Advanced Configurator tree. The properties file will be overwritten if an upgrade is installed.

  4. Bounce the server so that JNDIDBName changes can take affect.

The JNDIDBName properties file is shown below.

Begin ================================================ 

# example for setting up a SQL server database with the Microsoft driver 
# SQL server default PortNumber is 1433 
sqldb.url=jdbc:sqlserver://[ServerName]:[PortNumber];DatabaseName=[Database⇒
Name];sql70=true;charset=Cp1252 
sqldb.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver 
sqldb.username=[username] 
sqldb.password=[password] 

# example for setting up an Oracle database with the Oracle driver 
# Oracle default PortNumber is 1521 
oracledb.url=jdbc:oracle:thin:@[HostName]:[PortNumber]:[OracleSID] 
oracledb.driver=oracle.jdbc.OracleDriver 
oracledb.username=[username] 
oracledb.password=[password] 

# example for setting up a DB2 database with the Weblogic driver 
db2db.url=jdbc:db2://[HostName]:[PortNumber];databaseName=[DatabaseName] 
db2db.driver=weblogic.jdbc.db2.DB2Driver 
db2db.username=[username] 
db2db.password=[password] 

PSCFG.username=satst 
PSCFG.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver 
PSCFG.url=jdbc:sqlserver://rtas096:1433;DatabaseName=C910R70B;sql70=true;charset=⇒
Cp1252 
PSCFG.password=satst 

End ================================================

Click to jump to parent topicConnecting to a Database from Visual Modeler

Once the ODBC data source and the properties files have been configured, your environment is ready to support a database connection within Visual Modeler.

Database connection involves two steps:

See Also

Database Interface Configuration

Configuring JNDIDBName.properties

Click to jump to top of pageClick to jump to parent topicSpecify a Database Connection

To specify a database connection:

  1. In the Visual Modeler, select Project, Database References. A dialog for specifying the default database appears.

  2. Click Add. A dialog for specifying or modifying a database connection appears.

  3. Type a name in the Alias field. This is a name of your choice for referring to the database from within this model; it will be displayed in the drop down on the SQL query dialogs.

  4. Type in the Data Source Name exactly as specified in the data source configuration .

  5. Type in the Login ID and password defined for the database. These fields can be left blank if the database uses the Windows NT login. Press OK to view a dialog for setting the default database. The dialog for selecting the default database reappears, now displaying the database alias you specified.

  6. To add another database, repeat steps 2 through 5.

Click to jump to top of pageClick to jump to parent topicSpecify a Default Database

To specify a default database:

  1. In Visual Modeler, select Project, Database References.

  2. Select a the desired database in the database listing. The default database is the same for all database connections in the model.

  3. Make sure the database name appears in the Default Database field at the bottom. Click OK.

  4. Map a class to a database column.

    See Selecting a Primary Table.

The ability to specify a default is a convenience feature. If, at a later time, you need to query a different database, simply redefine the datasource name to refer to the new database.

Click to jump to parent topicGetting Started with Visual Modeler

To start Visual Modeler, select Start, Programs, PeopleSoft Applications, Visual Modeler 9.1, Visual Modeler 9.1. By default, Visual Modeler displays model information in three major windows. The largest area, the model structure view, is the modeling work area.

Click to jump to top of pageClick to jump to parent topicModel Structure View

Visual Modeler provides several tools for viewing and navigation in the Model Structure View.

The model structure view offers a standard windows “show and hide” paradigm for nodes in the class hierarchy. Click the “minus” icon to hide a hierarchy and click the “plus” icon to show all items in the hierarchy. If the node has external domain members, the database icon appears rather than the simple plus/minus icons.

From the View menu you can Show or Hide the following:

The View menu also offers similar options for expanding or collapsing items throughout the model.

Note. Expanding is equivalent to clicking the yellow triangle on an object.

Click to jump to top of pageClick to jump to parent topicComponents and Files View

The Components tab is a navigation aid that displays the model's objects in hierarchical structure. The tab shows classes, subclasses, domain members, selection points, relationships, and expressions. Double-click on a class, domain member, or selection point to display it in the Model Structure view. Double-click on a relationship or expression and its editor appears. Properties for the selected object appear in the Properties Editor.

Click to jump to top of pageClick to jump to parent topicProperties Editor

All objects' properties appear in the property table when they are selected. Use this table-based editor to view, change, add, and delete an object's properties.

Click to jump to top of pageClick to jump to parent topicOverview Window

If the model is large, use the Modeling editor scroll bars to adjust the view. To “zoom” the model, click the Viewer icon to display the Viewer window Overview tab. A miniature view of the model is shown; the viewable area is outlined with a blue dashed line.

To zoom the view, move the slide on the right.

To refocus the model structure view display, click within the view outline; a hand cursor appears. Drag to reposition the view outline over the model.

Click to jump to top of pageClick to jump to parent topicFind Window

To find an object by name, click the Find icon, or select the X icon, then click the Find tab. Select or deselect the Show options to vary the objects displayed.

To find an object:

Click to jump to parent topicUnderstanding Project Files

A Visual Modeler project has three file types: a project file (.csp), a workspace (.csw), and multiple source files (.cms).

Configurator Source Project (.csp)

When a new project is created, a project file is written to the specified workspace. Typically the workspace and the project file share the same root name, but a single workspace can contain multiple projects if so desired. A Project file lists the .cms files required to describe the model, including standard.cms and any objects stored in separate .cms files.

The .csp file is maintained through Visual Modeler interaction. The File View displays the contents of the .csp file.

As you create objects, filenames are dynamically added to the .csp. Note that deleting an object in the model structure view does not remove its name from the .csp. To remove a file, right-click on a file to raise the context-sensitive menu. Removing a file from the project does not delete it from the workspace. Note that you can also perform source control operations from this menu.

See Source Control Interfaces.

Configurator Source Workspace (.csw)

The Visual Modeler displays one workspace at a time. Each workspace contains one or more projects. When a .csw file is opened, all the projects within it are opened. To view a different workspace, select File, Open Workspace to browse for a workspace, or, select File, Recent Workspace and select a previous workspace. If the current workspace has unsaved changes, you will be given the opportunity to save.

Configurator Model Source (.cms)

Advanced Configurator model source (.cms) files contain an XML representation of one or more model objects, for example, a class or relationship that is created in and saved from Visual Modeler. There can be many .cms files in a project.

By default, Visual Modeler creates a separate file for each class, relationship, and expression. At creation time, Visual Modeler proposes a .cms file name based on the object name. You can specify an alternate new name or an existing file name. If an existing file is specified, the new object is appended to it. A file name can only be specified at creation time; it cannot be changed after the fact. This implies that although the class name is changed in the Visual Modeler, the supporting file name is not affected.

Each Standard model contains a file named standard.cms. This file is included when the project is created. standard.cms contains the root class and must be present in all projects containing standard models.

Team Modeling

The Visual Modeler file structure makes team modeling possible. Using multiple source files, a modeling team can work on the same model simultaneously. Changes can be checked in and checked out using source control. Additionally, most merge tools support the CMS format.

Click to jump to top of pageClick to jump to parent topicCreating a New Project or Workspace

To create a new project in a new workspace, select File, New and click the Projects tab. Select the model type, standard or compound. Click Create new workspace. Browse for or type in a project directory, then type in a Project name; the name will be appended to the project directory path. Click OK.

You can store multiple projects in a single workspace.

To create a new project in an existing workspace, select File, New and click the Projects tab. Click Add to current workspace, then browse for a project directory. Specify the Project Name, then click OK. The new project appears in the specified workspace; it has its own structure, as shown in the File view:

When there are multiple projects in one workspace, you must explicitly set the active project so that Configurator system knows which project to compile. Select Project, Set Active Project to do this.

The File, Save Model As command allows you to save a copy of the model. All of the files in the project will be copied into a new destination directory and all occurrences of the original project name (model name) are replaced with the new project name. Source control status for the project and the source files will be cleared (you will need to add the new project to source control). The new project then becomes the active project.

The File, Save All option saves all model and workspace information for the current project. In addition, a model information file is created in the source workspace path. The filename format is <modelName>.modelinfo.xml. The Configurator Extensions for DreamWeaver use this file.

See Using the Page Editor Extensions for Dreamweaver.

Visual Modeler provides a way to create (save) a description of the model to an HTML file. Select File, HTML Report.

Click to jump to top of pageClick to jump to parent topicSpecifying Model Project Settings

You can specify model-level information in the Project Settings dialog.

Dialog Used to Specify Model Project Settings

Select Project, Settings. In this dialog you can specify compilation options and settings for use at compile time and run time.

Current Version

The number of the current model version before any changes to the Major or Minor Version.

 

Major Version

An arbitrary model version used for model maintenance in <install directory>\ViM\models.

 

Minor Version

An arbitrary minor version used for model maintenance in <install directory>\ViM\models.

 

Server

The server on which WebLogic and Advanced Configurator are installed. For example: my_machine.peoplesoft_config.com.

 

Port

The port number for the WebLogic application server. It is 7777 by default.

 

Test UI

Uses the Model Tester provided with the Advanced Configurator installation (component models only).

  • Auto Submit—Check this box to turn on Auto Submit in the Model Tester. If Auto Submit is on, the page is refreshed with each pick.

  • Columns—The Model Tester displays runtime controls using a table form. Specify the number of columns in the output display.

  • Extern Default—The value to apply to any extern variables at model initiation.

  • Control Type—Select either of Radio Buttons or Dropdown Lists. This selection applies to all controls.

 

Other UI

Use your own JSP pages.

 

Effectivity Settings

Choose test date settings to verify effectivity dates on relationships.

  • Use System Date—Use the local system’s date (usually the current date).

  • Use This Date—Enter a date in or out of an effectivity range.

 

Separator Settings

Specify the character you use in SQL queries for separating the Quantity and Policy values.

 

Incomplete Configuration Explanation

Text to display to the user when a completeness check is run. You can compose the message with these parameters:

  • Selection point name— $(n:$DPNAME)

  • Expression value— $(expr:exprname)

If the name parameter is included within the explanation text, a separate explanation message will be generated for each required selection point that does not have a selection. Otherwise, a single explanation message will be generated for the Incomplete Configuration violation.

Click to jump to top of pageClick to jump to parent topicAdding a Project to Source Control

For a description of the source control interface and instructions on configuring source control options.

See Source Control Interfaces.

  1. To add a project to source control, select one or more components in the Visual Modeler File view.

    If the Visual Modeler does not recognize files that are already in source control, check out the files and check them back into the same location. The Visual Modeler will detect the files and duplicates will not be created.

    Note. Some providers will always prompt for a log in when a workspace or project file is checked in. Consequently, when adding all the files in the File view, you will be prompted to log in once for the .cms files and again for the project file. This is not an extra message. Be sure to provide the project information; do not leave the field blank. This behavior is known to occur with Visual SourceSafe.

  2. Right-click in the tree view, then select Add to Source Control. You will be prompted to add a comment. To retain checked out files, check the “Keep files checked out” option.

  3. Click OK to send the source control request to the provider software; at this point the source control software takes over.

  4. To check out a file, select it in the File view, right-click, then select Check Out.

    The source control status is visually depicted as follows:

    File not in source control.

     

    FIle checked in.

     

    File checked out

     

    Project or Workspace not in source control.

     

    Project or Workspace checked in.

     

    Project or Workspace checked out.

Click to jump to parent topicImporting and Exporting Models

Advanced Configurator provides a means to manage, update, and maintain models by importing and exporting model data. If you have model data that you would like to combine with another model–even if it is not currently an Advanced Configurator model–or if you want to update an older model by overwriting all or some of its components, you can use the export and import commands in the Projects menu.

These commands allow you to import and export all or parts of a model:

Importable models must be created in one of two ways:

The latter method allows you to import a model, partial or complete, from an outside data source.

See PCIF.

Click to jump to top of pageClick to jump to parent topicExporting a Model

To export a model, open it in the Visual Modeler, and choose Projects, Export Model. The Export Model to XML dialog appears.

Click to jump to top of pageClick to jump to parent topicImporting a Model

The dialog box for importing a model is very much like that for exporting a model.

To import an Advanced Configurator model:

  1. Open the target model in the Visual Modeler and select Projects, Import Model.

    The Import dialog appears.

  2. Uncheck any components that you don’t want to appear in the target model.

  3. Select the desired method for handling conflicts that result when a component being imported has the same name as an existing component.

    These options let you control, on a case-by-case basis, whether components are overwritten or not.

  4. Choose the desired filename for the import file (XML) and click OK.

Click to jump to parent topicCompiling a Model

Compiling a model triggers several separate actions.

This process preserves a hierarchy of files.

In the above hierarchy,

Advanced Configurator provides a Model Tester for component models. It is a JSP page for testing model relationships. The Configurator engine must be running in order for the compile to take place.

Note. Compilation takes place for the Active Project, which may not necessarily be the project you are currently viewing in the Visual Modeler. To check the active project, select Project, Set Active Project.

Advanced Configurator provides tools for maintaining the contents of the \models directory and the temporary files in \TEMP.

See Maintaining the Advanced Configurator System.

To compile a model:

  1. Start the Configurator server by either running <WebLogic home>startConfigurator.cmd, or selecting Start, Programs, PeopleSoft Applications, Configurator 9.1, Start Configurator Server.

  2. Click the Compile and Run icon on the toolbar to compile the model and launch the Model Tester. If you would like to save before compiling, select Tool, Options, then select the Save before Run option on the General tab.

    Alternatively, click the Compile icon on the toolbar to compile the file without launching the Model Tester.

  3. Check the output window (below the Model Structure View by default) for compile-time messages, warnings, or errors.

At least one relationship must be specified in order to compile a model. In addition, each class that participates in a relationship must have a selection point. (Click the Selection Point icon on the toolbar to display the selection points in the Model Structure View.)

Click to jump to parent topicUsing the Model Tester

The Model Tester displays the following information and display options.

Model Name

The name of the model as it appears in the Visual Modeler project.

 

Model Version

Displays the model’s version. The major and minor versions can be set in the Project Settings dialog.

 

Compile ID

The compile ID is based on the time the file was compiled on the application server.

 

Show Elimination Level

If the model contains elimination levels, display them on the Model Tester.

 

Verify Configuration

If Verify Configuration is checked, the Advanced Configurator checks the current set of picks for missing selections (on required controls) and violations. The model is assumed complete and valid if all required selections are made and no violations are detected.

 

Sort By State

Display the most recent pick at the top of the control.

 

Auto Submission of Picks

Refresh the page as soon as a pick is made. If Auto submission is off, make one or more picks, then click the Submit button. This value can be set from the Project Settings dialog.

 

Use Select (List) Controls

If this box is not checked, radio button controls will be used for the entire model. If this box is checked, list control drop downs will be used. When list controls are selected, text indicators, rather than the graphics shown in the Legend box, are displayed:

  • D_S—Default selected (used when None is selected by default)

  • C_S—Computer-selected

  • C_E—Computer-eliminated

  • U_S—User-selected

  • U_E—User-eliminated

 

Show None on Required Controls

None is added to single-select controls at runtime so that if List controls are used the control can initialize with nothing picked. You can hide these values on single-select controls.

 

Number of Controls Per Row

The number of columns in the Model Tester table. This value can be set from the Project Settings dialog.

 

Attribute to Display

Display an attribute that is defined for the domain member instead of the Name. May also display an attribute that is not defined in the model, but is part of the class. For example, a long description could be displayed even though the model knows nothing of that description.

 

Solve Date (YYYYMMDD)

Displays the date that the Model Tester is using to test the model. If the box is initially blank, the system date is being used. If a date appears in the box initially, it is the specified Model Tester solve date for the project. (The model test solve date is set in the Projects Settings dialog.)

You can specify a different date in the Model Tester and re-run the test under the new date by clicking the Submit button. The model is not recompiled.

Note. Be aware that, in the Model Tester, four or more controls placed horizontally may not be displayed properly in Microsoft Internet Explorer.

Click to jump to parent topicInternalizing Model Data

Internalizing the data can be accomplished in the Configurator Administration Console or with the Visual Modeler. If you have auxiliary files that must accompany the data, use the Administration Console. Also, internalizing data in the Visual Modeler is a one-time operation that will create a model with internal data. Internalizing data with the Administration Console preserves the SQL query information in the model, yet still produces a compiled model that doesn't need the database to run. If the database data changes you can re-compile to pick up the new data.

To internalize model data using the Visual Modeler:

  1. Make a copy of the model’s files (in Explorer).

    Note. You must internalize a copy so that there remains a database-connected model for continued maintenance. You will always make a copy of the latest version to use in creating a distributable Mobile Solution Package.

  2. Open the copy of the model in the Visual Modeler.

  3. Select Project, Internalize Model.

  4. Select Yes to internalize data.

Internalization automatically converts model data into domain members and constraints. If the data is very large, this process may be lengthy.