PeopleSoft Enterprise CRM Advanced Configurator 9.1 PeopleBook

Using Administration Tools

Designing and developing a model begins with the PeopleSoft Visual Modeler. The model defines selection points, domain members, and constraints. Domain members and constraints can be stored externally.

After you create the mode, you build the web site application using extensions for Dreamweaver, or more directly, using the PeopleSoft JSP templates for HTML form controls. Your web site application connects standard HTML form controls to your model.

At runtime, the web site sends user picks to the PeopleSoft Configurator engine through the Web Client Processor and the Client Operations Processor (COP). The engine processes the picks and returns the state of each item in the form controls to the web site. The engine also returns explanations for constraints that have been violated.

If the model has external domain members or constraints, the engine gets them from the Configuration Data Manager. If the model has pricing, the Client Operations Processor calculates the pricing information.

The diagram on the next page shows PeopleSoft Configurator’s design, compile, and runtime environments.

Administration Console

PeopleSoft Configurator Administration console helps you develop, test, and deploy both component models and compound models.

The Administration console can internalize model data. It can import externally referenced model data and translate it into internally defined data. The model then becomes self-contained. The console can internalize data that is stored in a database as well as attribute list files.

On Windows NT, start the Administration tool by clicking Start and selecting Programs, PeopleSoft Applications, Configurator 9.1, Administration.

Alternatively, access the console directly from a browser with the uniform resource locator (URL) http://<host>:<port>/ConfigServerAdmin.

The Administration console enables you to do the following actions with an Advanced Configurator component model:

Compile

You can compile a model that is anywhere on the network, using any server on the network. To compile, select the model’s XML file, the server, and the port.
Run

You can run the compile version of any model on the network. This launches the PeopleSoft Configurator Model Tester, which the PeopleSoft Visual Modeler also uses to test models. With the test client, you can submit the model with various options—such as pricing, auto-submission, sorting, and formatting—and reset the model.
Deploy

You can deploy a model from anywhere on the network to any host server and port on the network. Deploying a model copies it to another machine for use there. You can deploy a compile version of a model, a major version of a model, or all versions of a model.
Disable

You can disable a compile version of a model that is anywhere on the network. Disabling a model restricts its use to the Administration console, which can still run the model. If a model is disabled, the test client or a midtier application can’t run it. Disabling a model does not delete it.
Enable

If a model is disabled, you can enable it.
Remove

You can remove—that is, delete—a model (including a compound model) from the network. You can remove a compile version of a model, a major version of a model, or all versions of a model.

Warning! During a model compile, the model version number is incremented based on the latest version of the model that is present on the server. Therefore, do not remove the latest version of a model before you recompile, because the new version may be given the version number of the deleted latest version.

Note. Removing the model from the server doesn't cause the model to be removed from server memory if it has been loaded into memory. The server must be restarted to force the model to be removed from memory. The model load settings for the server may also need to be changed.
Update data

You can update any version of a model with model data (domain members and constraints) that is stored in an external database.
Generate a self-contained model

If a model’s data is stored externally, you can read that data into the model for internal storage and access. That compilation of the model then becomes self-contained and can be deployed in a configuration environment needing no access to the product database. You can also include additional attributes in the internalization process.

Note. The Visual Modeler can also internalize data; however, it can internalize only data that is used within the model. Externally referenced data that is not used in the model, such as descriptions, can’t be internalized by the Visual Modeler.

Furthermore, the internalize processes in the Visual Modeler are a one-time effort. After a model is internalized in the Visual Modeler, the source is internal and all subsequent compilations produce versions that are internal as well.
View

You can view the following types of files that are created in the compile version directory when a model is compiled: GCL, RTP, SGCL, TMAP, and XML. This lets you describe the state of these files if you need help.

In addition, the Administration console enables you to manage compound models:

Upload

You can upload a compound model (in XML format) to the server.
Cross-check

You can verify a compound model against its component models to verify that selection points and domain members that are required by the compound model exist.
View

You can view a compound model in XML format.

Note. The Administration console does not provide security, but is based on industry standards for security. The information technologist and system administrator must provide and limit access to PeopleSoft Configurator servers on the network.

Testing Solutions

You can use the Solution Tester to develop and test Configurator solutions outside of the complete CRM environment.

The Solution Tester simulates the integrated CRM/Configurator environment, enabling you to test a solution without setting up configurable products or creating quotes or orders.

The Solution Tester enables you to test:

Model operation.
Page display.
User interaction.
Configuration pricing.
Configuration details request and display.

It also provides access to parameters and details about the operation of the solution that aren’t available in normal operation within the CRM environment. The Solution Tester runs completely within the Configurator Server.

The Solution Tester is organized into three sections. The top section contains a number of buttons that perform the operations that are provided by the Solution Tester. The middle section displays the results of the operations, including the user interface for a solution and the display of the configuration details for a particular solution configuration. The bottom section allows values to be specified that are passed into the Configurator solution when it is launched. These sections are described in detail in the following section.

Page Used to Test Solutions

The Solution Tester top panel controls the tester operations and displays the status that is returned from certain operations.

Access the Solution Tester page by selecting Start, Programs, PeopleSoft Applications, Configurator 9.1, Server Index Page. Then select Solution Tester.

New

Start a new configuration.

Clicking the New button starts a new configuration using the solution that was selected in the solution drop-down list. The solution’s user interface is displayed in the center section of the Solution Tester. Interaction with the interface allows a new configuration to be created (see Configuring).

The New operation requires that a valid solution be selected in the solution drop-down list. The ConfigID and RetCode fields are cleared when you start a new configuration.

Restore

Restore an existing configuration.

Clicking the Restore button restores an existing configuration from the database. The solution’s user interface appears in the center section of the Solution Tester with the current configuration values. Interaction with the interface modifies the current configuration (see Configuring).

The Restore operation requires that you select a valid solution in the Solution drop-down list and specify the Configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field. When you restore a configuration, the RetCode field is cleared.

Configuring

Configuring (from New or Restore).

Solutions that are designed to run within the integrated CRM/Advanced Configurator environment usually provide buttons that enable the user to exit the configuration without saving the current changes, or to save the current configuration and return (the labels on the buttons are defined in the user interface for the solution and cannot be Cancel and Return). Clicking these buttons on a solution’s user interface within the Solution Tester initiates the same operations. Clicking Cancel returns the center section to the No Solutions Loaded state without saving the configuration. Clicking Return saves the current state of the configuration, updates the ConfigID and RetCode fields, and initiates the operation of retrieving and displaying the configuration details.

The status codes that are returned are:

0: Success.

101: Solution not found.

102: Invalid Config ID or Error restoring the configuration.

103: Error saving the configuration.

104: Error creating the configuration.

Copy

Copy an existing configuration.

Clicking the Copy button makes a copy of an existing configuration. A new configuration ID is returned and the ConfigID field is updated.

The Copy operation requires that you select a valid solution in the Solution drop-down list and specify the Configuration ID for an existing (saved) configuration of the appropriate solution type in the ConfigID field.

The status codes that are returned are:

0: Success.

101: Solution not found.

102: Invalid Config ID or Error restoring the configuration.

103: Error saving the configuration.

104: Error creating the configuration.

List Configurations

List the saved configurations. Clicking this button displays information about the configurations that is currently saved in the database. If you select a solution in the Solution drop-down list, only configurations of that type are displayed. If you don't select a solution, all of the saved configurations are displayed. Selecting a configuration from the list updates the Solution and ConfigID fields for use with the other operations.

View Details

View configuration details.

Clicking the View Details button requests, retrieves, and displays the returned configuration details for a configuration. The details are formatted using the style sheet that is defined for the solution.

For easy modification and testing, you can select the request (XML) and style sheet (XSLT) to use in the following way:

The Solution Tester checks the solution test directory (by default, C:\bea_cfg\wlserver_10.3.1\config\CalicoDomain\applications\ CalicoApp\calico\solutiontest) for a request XML file with the name <solutionname>.xml and for a style sheet XSLT file with the name <solutionname>.xslt (where solutionname is the name of the solution used for the configuration). If these are found, they are used for the request XML and the result formatting style sheet XSLT respectively.

If appropriate files are not found, the Solution Tester queries the database for the associated solution schema and attempts to retrieve the request XML and formatting style sheet XSLT that are defined by the schema.

If request XML and formatting XSLT cannot be found in the solution schema, or a solution schema cannot be found, the Solution Tester uses the default details request XML and formatting style sheet XSLT files in the solutiontest directory (ConfigDetailsRequest.xml and default.xslt).

The XML and XSLT data are read every time the details are requested. This sequence allows custom request XML and formatting XSLT to be tested, modified, and retested easily.

The View Details operation is automatically invoked when you return from a New or Restore operation using the return operation on the solution’s user interface.

The View Details operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field.

View Details - XML

View request, response, and style sheet XML.

Clicking this button performs the same sequence of steps as the View Details button, except that the raw XML for the details request, details response, and formatting XSLT appears. Also provided is information indicating the source location and the size of the details request, and formatting XSLT. The three pieces of data are formatted into an XML document with the following structure:

<_details> <_request> [details request XML] </_request> <_response> [details response XML] </_response> <_stylesheet> [XSLT] </_stylesheet> </_details>

The View Details- XML operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field.

Save order

Change the order status of the configuration to saved. The Save Order operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field. When you save an order, the RetCode field is cleared.

Submit order

Change the order status of the configuration to submitted.

The Submit order operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field. When you submit an order, the RetCode field is cleared.

Cancel order

Roll back the current configuration to the state it was in when the order was last saved.

The Cancel order operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field. When you cancel an order, the RetCode field is cleared.

Delete order

Roll back the current configuration to the state it was in when the order was last submitted

The Delete order operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field. When you delete an order, the RetCode field is cleared.

Accessing the Solution Tester

To access the Solution Tester pages, select Start, Programs, PeopleSoft Applications, Configurator 9.1, Server Index Page.

From the Server Index Page, click Solution Tester.

Note. If “500 - Internal Server Error”appears rather than the tester page, verify that your database server is running and that the database entry for Advanced Configurator is valid. This information is entered during Configurator installation and stored in \bea\wlserver_10.3.1\config\CalicoDomain\applications\CalicoApp \WEB-INF\config\JNDIDBName.properties.

iFrame Height

This parameter controls the height in pixels of the center (output) section of the Solution Tester.

Debug

This sets a flag within the Solution Tester and passes a debug parameter to the Configurator solution (debug=false or debug=true). You can use the value of this parameter within a solution user interface to control debugging messages and other debugging or testing operations. When Debug is selected, the Solution Tester sends messages to the console window of the Configurator Server containing information about the operations that are being performed.

Understanding the Output and Solution User Interface

The large main panel displays the results of the operations, including the user interface for a solution when you are performing the New or Restore operations.

Because the main panel is an inline frame (iframe), it may contain an independent scroll bar, depending on the height of the content compared to the height of the iframe. When initiating an operation, you can set the height of the iframe using the iFrame Height field in the bottom section (the height cannot be changed during an operation).

The full URL that the Solution Tester uses to initially navigate the frame appears. This allows inspection of the values that are initially passed to the Configurator solution for New and Restore operations.

Every effort has been made to make the Solution Tester environment (the environment that is provided to the solution running within the tester) match that of the runtime environment of the CRM applications with which the Configurator integrates. However, some technical limitations prevent the two environments from being identical. Therefore, some differences might exist in operation between the Solution Tester and the actual CRM runtime environment.

In many cases, identifying and correcting these differences can help provide a better, more robust solution by identifying environment-specific functionality. You should carefully review differences to determine whether the solution is relying on functionality that may not be the same on every platform or environment.

In all cases, you should thoroughly test within the actual CRM runtime environment before deploying a new or updated solution.

Setting Configuration Solution Parameters

Scroll to the bottom panel of the Solution Tester page:

The bottom panel contains a number of fields that enable you to specify parameter values that are passed to the Configurator solution. The parameters that are passed are the same as those that are passed from the CRM applications when you are interfacing with the Configurator. Additional, user-defined parameters can also be passed.

You can modify the values for these parameters before performing operations. When an operation is initiated, changes to the parameter values do not take effect until you initiate a new operation. For instance, after you have started a new configuration by clicking the New button, changing the value of BusinessUnit has no effect until you start another operation, such as starting a new configuration or restoring an existing one.

The labels on the parameter value fields match the names of the parameters that are passed to the Configurator solution. The initial values for the fields are taken from a combination of values that are read from property files (text files in a specific format) and default values that are contained in the Solution Tester. The parameter fields are updated with values when you first open the Solution Tester or when you select a new property file in the Property File list.

The Solution Tester determines the values to use for each parameter in the following sequence:

It looks in the property file that is identified by the Property File list. If it finds a parameter=value pair for this parameter, it uses the value that is specified.
If it doesn't find an appropriate parameter entry, it looks in the default property file (SolutionTest.properties, in the solutiontest directory).
If it doesn't find a parameter entry in the default property file, it uses a default value that is defined within the Solution Tester.
If it doesn't find a default value, it leaves the field blank.

The Solution Tester populates the Property File list with the names of the property files that it finds in the solutiontest directory. The example property file ExternalChannel.properties is included with the installation. This file contains the following code:

# This file contains specific properties that should be used in place of
# those in the 'default' properties file (SolutionTest.properties)
# 
# Channel can be 'A' (internal) or 'W' (external/web)
Channel=W

Notice that the only entry is for the parameter to override. All other values are read from the default property file or the Solution Tester defaults, or they are omitted. If you create a new property file while you are using the Solution Tester, you need to open a new instance of the Solution Tester for it to be added to the Property File list. The Additional URL Parameters field allows any number of additional parameters to be passed to the Configurator solution.

Enter additional parameters in the following way:

To pass a single additional parameter, enter: parameter=value.
To pass more than one parameter, enter: parameter1=value1&parameter2=value2&parameter3=value3.

Model Tester

Configurator also includes a web-based interface that you launch from the Visual Modeler with the Run command.

The Model Tester provides a standard, preformatted, front-end UI for testing a model’s relationships, error message display, expression output, and control specifications. Using it, the modeler can perform the actions of the end user, making selections and entering data so as to observe actual model behavior at runtime.

For you to use the Model Tester, the Configurator Server must be installed and running at the time of its use.

New	Start a new configuration. Clicking the New button starts a new configuration using the solution that was selected in the solution drop-down list. The solution’s user interface is displayed in the center section of the Solution Tester. Interaction with the interface allows a new configuration to be created (see Configuring). The New operation requires that a valid solution be selected in the solution drop-down list. The ConfigID and RetCode fields are cleared when you start a new configuration.
Restore	Restore an existing configuration. Clicking the Restore button restores an existing configuration from the database. The solution’s user interface appears in the center section of the Solution Tester with the current configuration values. Interaction with the interface modifies the current configuration (see Configuring). The Restore operation requires that you select a valid solution in the Solution drop-down list and specify the Configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field. When you restore a configuration, the RetCode field is cleared.
Configuring	Configuring (from New or Restore). Solutions that are designed to run within the integrated CRM/Advanced Configurator environment usually provide buttons that enable the user to exit the configuration without saving the current changes, or to save the current configuration and return (the labels on the buttons are defined in the user interface for the solution and cannot be Cancel and Return). Clicking these buttons on a solution’s user interface within the Solution Tester initiates the same operations. Clicking Cancel returns the center section to the No Solutions Loaded state without saving the configuration. Clicking Return saves the current state of the configuration, updates the ConfigID and RetCode fields, and initiates the operation of retrieving and displaying the configuration details. The status codes that are returned are: 0: Success. 101: Solution not found. 102: Invalid Config ID or Error restoring the configuration. 103: Error saving the configuration. 104: Error creating the configuration.
Copy	Copy an existing configuration. Clicking the Copy button makes a copy of an existing configuration. A new configuration ID is returned and the ConfigID field is updated. The Copy operation requires that you select a valid solution in the Solution drop-down list and specify the Configuration ID for an existing (saved) configuration of the appropriate solution type in the ConfigID field. The status codes that are returned are: 0: Success. 101: Solution not found. 102: Invalid Config ID or Error restoring the configuration. 103: Error saving the configuration. 104: Error creating the configuration.
List Configurations	List the saved configurations. Clicking this button displays information about the configurations that is currently saved in the database. If you select a solution in the Solution drop-down list, only configurations of that type are displayed. If you don't select a solution, all of the saved configurations are displayed. Selecting a configuration from the list updates the Solution and ConfigID fields for use with the other operations.
View Details	View configuration details. Clicking the View Details button requests, retrieves, and displays the returned configuration details for a configuration. The details are formatted using the style sheet that is defined for the solution. For easy modification and testing, you can select the request (XML) and style sheet (XSLT) to use in the following way: The Solution Tester checks the solution test directory (by default, C:\bea_cfg\wlserver_10.3.1\config\CalicoDomain\applications\ CalicoApp\calico\solutiontest) for a request XML file with the name <solutionname>.xml and for a style sheet XSLT file with the name <solutionname>.xslt (where solutionname is the name of the solution used for the configuration). If these are found, they are used for the request XML and the result formatting style sheet XSLT respectively. If appropriate files are not found, the Solution Tester queries the database for the associated solution schema and attempts to retrieve the request XML and formatting style sheet XSLT that are defined by the schema. If request XML and formatting XSLT cannot be found in the solution schema, or a solution schema cannot be found, the Solution Tester uses the default details request XML and formatting style sheet XSLT files in the solutiontest directory (ConfigDetailsRequest.xml and default.xslt). The XML and XSLT data are read every time the details are requested. This sequence allows custom request XML and formatting XSLT to be tested, modified, and retested easily. The View Details operation is automatically invoked when you return from a New or Restore operation using the return operation on the solution’s user interface. The View Details operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field.
View Details - XML	View request, response, and style sheet XML. Clicking this button performs the same sequence of steps as the View Details button, except that the raw XML for the details request, details response, and formatting XSLT appears. Also provided is information indicating the source location and the size of the details request, and formatting XSLT. The three pieces of data are formatted into an XML document with the following structure: <_details> <_request> [details request XML] </_request> <_response> [details response XML] </_response> <_stylesheet> [XSLT] </_stylesheet> </_details> The View Details- XML operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field.
Save order	Change the order status of the configuration to saved. The Save Order operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field. When you save an order, the RetCode field is cleared.
Submit order	Change the order status of the configuration to submitted. The Submit order operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field. When you submit an order, the RetCode field is cleared.
Cancel order	Roll back the current configuration to the state it was in when the order was last saved. The Cancel order operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field. When you cancel an order, the RetCode field is cleared.
Delete order	Roll back the current configuration to the state it was in when the order was last submitted The Delete order operation requires that you select a valid solution in the Solution drop-down list and specify the configuration ID for an existing (saved) configuration of the appropriate type in the ConfigID field. When you delete an order, the RetCode field is cleared.