8 Defining CAVS Routing Setup IDs

This chapter provides an introduction to CAVS routing setup IDs, and how to create, search, and modify them. It also provides information about setting up routing configurations without creating routing setup IDs.

Composite Application Validation System (CAVS) routing setups are used when CAVS test definitions call services that in turn, call CAVS simulators and when actual applications and services call CAVS simulators instead of calling subsequent actual services.

This chapter includes the following sections:

Section 8.1, "Introduction to CAVS Routing Setup IDs"
Section 8.2, "How to Create CAVS Routing Setup IDs"
Section 8.3, "How to Search for CAVS Routing Setup IDs"
Section 8.4, "How to Modify Routing Setup IDs"
Section 8.5, "How to Set Up CAVS Routing Configurations Without Creating Routing Setup IDs"

8.1 Introduction to CAVS Routing Setup IDs

CAVS routing setup IDs are used to route the service calls to the CAVS simulators. Use the pages covered in this chapter to set up CAVS routing setup IDs before executing tests. These CAVS routing setup IDs are stored as RouteToCAVS properties in the AIAConfigurationProperties.xml file in <AIA_HOME>/aia_instances/$INSTANCE_NAME/AIAMetaData/config. This file is read during run time to determine whether routing needs to be made to a CAVS simulator or to an actual system.

For example, you could create three routing setup IDs for the scenarios illustrated below.

To test the requester Application Business Connector Service (ABCS) or when the provider ABCS is not available, you would want the requester ABCS to call a simulator instead of actual Oracle AIA services. For this scenario, create a routing setup ID to set the RouteToCAVS property to TRUE on the requester ABCS. This will ensure that the message is routed to the CAVS simulator, as indicated in red.

Note:

An actual participating application or test definition can be used to invoke the requester ABCS.
To test the provider ABCS or when the provider application is not available, you would want the provider ABCS to call a simulator instead of an actual provider application service. For this scenario, create a routing setup ID to set the RouteToCAVS property to TRUE on the provider ABCS. This will ensure that the message is routed to the CAVS simulator, as indicated in blue.

Note:

If there is more than one callout from the provider ABCS, the CAVS user can have fine-grained control over the routing by setting the routing at the PartnerLink level (and optionally at the operation level). This is indicated in the figure.
To test the requester ABCS and the provider ABCS together, you would create a routing setup ID to set the RouteToCAVS property to FALSE on the requester ABCS so that it can go on to call the provider ABCS and TRUE on the provider ABCS.

Figure 8-1 helps to illustrate the need for different routing setup IDs to test each of these three scenarios. When creating test definitions that will be used to initiate these test scenarios, CAVS enables you to associate the test definition with a specific routing setup ID. This routing setup ID determines the configuration that is required and automatically applies it before executing the test.

Figure 8-1 Sample Scenarios for Using CAVS Routing Setup IDs

This image is described in surrounding text

For example, if these three test scenarios are grouped into a single test group for execution, each test requires a different routing setup. In this case, you would create three routing setup IDs, 1001, 1002, and 1003, for example.

Each routing setup ID is required by one of the scenarios. You assign routing setup ID 1001 to the test definition for scenario 1, 1002 to the test definition for scenario 2, and so forth. When these three test definitions are executed as a part of the test group, the CAVS system automatically applies routing setup IDs 1001, 1002, and 1003 when executing the appropriate test definition. This eliminates the need to manually modify routing configurations between test scenario executions.

If, for example, you did not associate routing setup ID 1002 with the test definition for scenario 2, the test definition for scenario 2 would use routing setup ID 1001, because it was the last applied routing setup ID.

For more information about assigning a routing setup ID to a test definition, see Section 4.1, "How to Create a Test Definition."

Another option for applying routings is to directly modify them on the Configuration page.

For more information about the Configuration page, see Section 8.5, "How to Set Up CAVS Routing Configurations Without Creating Routing Setup IDs."

8.2 How to Create CAVS Routing Setup IDs

To create CAVS routing setup IDs:

Access the Oracle Application Integration Architecture (AIA) Home Page. In the Composite Application Validation System area, click the Go button. Select the Routing Setup tab. Click the Create button. The Create Routing Setup page displays as shown in Figure 8-2.

Figure 8-2 Create Routing Setup Page

Upon access, the Create Routing Setup page displays routing information for all services with a RoutetoCAVS property defined in the AIAConfigurationProperties.xml file in <AIA_HOME>/aia_instances/$INSTANCE_NAME/AIAMetaData/config.

Use this page to perform a one-time setup of routing setup IDs that you can later associate with test definitions using the SetupId field on the Create Test page. By making this association, the required routing setup will be automatically applied during the execution of the test definition.

For more information about the SetupId field, see Section 4.1, "How to Create a Test Definition."

Data saved on this page is stored in a CAVS table, rather than in the AIAConfigurationProperties.xml file.

For more information about how to quickly define a routing configuration that is stored in AIAConfigurationProperties.xml, see Section 8.5, "How to Set Up CAVS Routing Configurations Without Creating Routing Setup IDs."

Use the page elements on the Create Routing Setup page to create a new CAVS routing.

Available elements on the Create Routing Setup page are discussed in Table 8-1.

Table 8-1 Create Routing Setup Page Elements

Element	Description
SetupId	Upon saving, a sequentially generated ID is assigned to the routing setup ID.
Description	Enter a description of the routing setup ID you are creating.
InvokingServiceName	Lists all services defined in the AIAConfigurationProperties.xml file in <AIA_HOME>/aia_instances/$INSTANCE_NAME/AIAMetaData/config.
PartnerLink	The PartnerLink that is invoked by the service that you want to route to the CAVS simulator.
Operation	The operation of the PartnerLink that you want to route to the CAVS simulator. Displays a value only when multiple operations on the service are invoked using the same PartnerLink, typically when calling an Enterprise Business Service.
RouteToCavs	Select to indicate that the invoking service should route to the selected CAVS simulator.
SimulatorId	Click Add to access the Search Definitions page, where you can select the simulator definition that you want an invoking service to route to. Upon access, the page displays all available CAVS simulator definition IDs. Select the simulator definition to which you want to route an invoking service and click the Select button. If a simulator definition has already been selected, the simulator ID displays. Click Modify to select a different simulator ID. Click Clear to clear the selection.

8.3 How to Search for CAVS Routing Setup IDs

To search for CAVS routing setup IDs:

Access the AIA Home Page. In the Composite Application Validation System area, click the Go button. Select the Routing Setup tab. The Routing Setup page displays, as shown in Figure 8-3.

Figure 8-3 Routing Setup Page
Use the page elements on the Routing Setup page to search for an existing CAVS routing setup ID, or access functionality to create and delete routings.

Available elements on the Routing Setup page are discussed in Table 8-2.

Table 8-2 Routing Setup Page Elements

Element	Description
SetupId	Enter the ID assigned to the routing setup ID you are searching for.
Description	Enter description text used for the routing setup ID you are searching for.
Search	Click to execute a search for routing setup IDs using the search criteria entered in the Search Routing Setups group box.
Delete	Select one or more routing setup IDs that you want to delete and click Delete to execute the deletion.
Create	Click to access the Create Routing Setup page, where you can create a routing setup ID. For more information, see Section 8.2, "How to Create CAVS Routing Setup IDs."
Apply Routing	After you have created a new routing setup ID, you may apply it to populate the AIAConfigurationProperties.xml file. To do this, select a single routing setup ID and click Apply Routing. If you apply the routing setup ID to the AIAConfigurationProperties.xml file, it becomes a routing configuration that is applied in all executions of the associated invoking service, not just when the routing setup ID is referenced on a test definition.
SetupId	Click to access the Routing Setup page, where you can modify an existing routing setup ID. For more information the Routing Setup page, see Section 8.4, "How to Modify Routing Setup IDs."

Routing Setup Actions

Available elements in the Routing Setup Actions area are discussed in Table 8-3.

Table 8-3 Routing Setup Actions Area Elements

Element	Description
Reset Routing	Click to set all routing configurations to FALSE. This means that all routings to simulators (RoutetoCAVS property settings) in the AIAConfigurationProperties.xml file will be set to FALSE, whether you have defined them through the Routing Setup pages or directly in the file.
View Routing	Click to access the Configuration page, where you can access a read-only view of the last applied, or active, routing setup ID.

8.4 How to Modify Routing Setup IDs

To modify routing setup IDs:

Access the AIA Home Page. In the Composite Application Validation System area, click the Go button. Select the Routing Setup tab. Click a SetupId link. The Routing Setup page displays as shown in Figure 8-4.

Figure 8-4 Routing Setup Page
Use the page elements on the Routing Setup page to modify existing routing setups. Available elements are discussed in Table 8-4.

Data saved on this page is stored in a CAVS table, rather than in the AIAConfigurationProperties.xml file.

If you want to apply the data to the AIAConfigurationProperties.xml file, you must click Apply Routing for the routing setup ID on the Search Routing Setups page.

For more information about the Apply Routings button, see Section 8.3, "How to Search for CAVS Routing Setup IDs."

Table 8-4 Routing Setup Page Elements

Element	Description
SetupId	Displays the ID you assigned to routing setup ID on the Create Routing Setup page.
Description	If applicable, edit the routing setup ID description.
Invoking Service Name	This is the service after which the service routing to CAVS should happen.
PartnerLink	The PartnerLink that is invoked by the service that you want to route to the CAVS simulator.
Operation	The operation of the PartnerLink that you want to route to the CAVS simulator. Displays a value only when multiple operations on the service are invoked using the same PartnerLink, typically when calling an enterprise business service.
RouteToCavs	Select to indicate that the invoking service should route to the selected CAVS simulator.
SimulatorId	Click the icon to access the Search Definitions page, where you can select the simulator definition that you want an invoking service to route to. If a simulator definition has already been selected, the simulator ID displays. Click Modify to select a different simulator ID. Click Clear to clear the selection.

8.5 How to Set Up CAVS Routing Configurations Without Creating Routing Setup IDs

To set up CAVS routing configurations without creating routing setup IDs:

Access the AIA Home Page. In the Setup area, click the Go button. Select the Configuration tab. The AIA Configuration page displays as shown in Figure 8-5.

Figure 8-5 AIA Configuration Page
Use this page to quickly set up a CAVS routing configuration without having to create routing setup IDs. This is particularly useful when you are only interested in using CAVS simulators without CAVS test definitions.

For example, you may only need to use the CAVS simulator feature for your development purposes and you may not need to uptake the complexity involved in setting up routing setup IDs. In this case, you can use this page to directly modify service routing configurations in the AIAConfigurationProperties.xml file.

Note:

If you use this page to modify these service routing configurations, there is no need to manually reload the configurations.

However, if you are using CAVS for extensive testing purposes, we recommend that you use the Routing Setup pages to create your routing setup.

For more information about the Routing Setup page, see Section 8.2, "How to Create CAVS Routing Setup IDs."