Configuring Access to Complex Parameter Types

Complex parameter types (CPTs) are user-defined data structures that enable the execution of Liquid Data queries against dynamic content. Such content is known as runtime source, data stream, real-time data, in-flight XML documents, and so forth.

This section describes how to configure access to complex parameter types in the Administration Console. It includes the following topics:

• Creating a Complex Parameter Type Description
• Managing Complex Parameter Types

You will find other important aspects of using CPTs described in:

• Using Complex Parameter Types in Building Queries and Data Views
• Setting Complex Parameter Types in Invoking Liquid Data Queries Programmatically

 

---

Creating a Complex Parameter Type Description

Before you can use a BEA Liquid Data for WebLogic query with a CPT in the Dataview Builder or programmatically, you must:

• Identify a schema that represents the data that will be retrieved using the complex parameter type. For details, see Using Complex Parameter Types in Queries in Building Queries and Data Views.
• Configure the CPT data source through the Administration Console.

To create a complex parameter type description using the Administration Console:

1. In the left pane, click the Liquid Data node.

2. In the right pane, click the Configuration tab (probably already selected).

3. Click the Complex Parameter Types tab.

4. Click the Configure a New Complex Parameter Type Description link.

5. Enter the information described in the following table:

   Table 14-1 Complex Parameter Type Description Information  

   Field	Description	Required?
   Alias	Sets the logical name for the complex parameter type being defined.	Yes.
   Schema	Identifies the schema associated with the complex parameter type. You can find the .xsd file in the <LDrepository> schema folder, described in Server Repository File System Hierarchy. Either enter the schema file name or click Browse Repository to browse the schema folder.	Yes.
   Namespace URI	Identifies the target namespace of the schema file. Example: urn:schemas-bea-com:ld-cptSample	Optional but recommended. If used, Schema Root Element Name must also be supplied.
   Schema Root Element Name	Identifies a unique root element in the schema file. Many schemas only have a single root. In cases where there are multiple root elements, the CPT will only use the identified root element and its sub-elements. For example, the sample schema CustomerOrderReport described in the Liquid Data Getting Started document has only a single root, CustomerOrder.	Optional but recommended. If used, Namespace URI must also be supplied.

   
    

6. Click Create.

The new description appears in the Administration Console summary table.

 

---

Managing Complex Parameter Types

When you click the Complex Parameter Types tab, you will see a list of CPTs that are configured on the current server in the summary table. From the summary list, you can perform the following tasks:

• Navigate to and optionally edit a particular CPT description by clicking on its name.
• Delete an existing CPT definition from the Liquid Data function library by clicking the trash can at the far right of the selected definition.

Modifying a Complex Parameter Type Configuration

Follow these steps to modify a CPT configuration:

1. In the left pane, click the Liquid Data node.

2. In the right pane, click the Configuration tab (probably already selected).

3. Click the Complex Parameter Types tab.

   The table of complex parameter type descriptions appears.

4. Click the CPT description alias name that you want to modify.

5. Change entries as needed.

6. Click Apply.

Removing a Complex Parameter Type Configuration

You can remove a CPT description that you no longer need. To do so:

1. In the left pane, click the Liquid Data node.

2. In the right pane, click the Configuration tab (probably already selected).

3. Click the Complex Parameter Type tab.

4. Find the CPT description that you want to remove and click the trash can icon on the far right column for that description.

5. When prompted, click Yes to confirm removal.

Note: Removing a Liquid Data CPT description does not remove the associated schema. For information on removing such files from the Liquid Data Server repository, see Deleting Folders and Files in the Server Repository.