2 Configuring OracleAS Adapters for Tuxedo in Oracle Studio

Configuring a Tuxedo OracleAS Adapter

To work with Oracle Connect, you must configure the adapter definition on the platform where OracleAS Adapters for Tuxedo run to handle the interactions to and from a Tuxedo service.

Perform the following steps using Oracle Studio to specify these definitions:

1. From the Start menu, select Programs, Oracle and then select Studio.

2. In the Configuration Explorer, expand the machine defined in Configuring OracleAS Adapters for Tuxedo in Oracle Studio.

3. Expand the Bindings. The binding configurations available on this computer are listed.

4. Expand the binding where you want to define the adapter. The binding configuration includes branches for data sources and adapters that are located on the machine.

5. Right-click Adapters and select New Adapter to open the New Adapter wizard.

6. Enter a name for the adapter.

   Note:

   The word event is a reserved word and cannot be used to name an adapter.

7. Select Tuxedo as the adapter type from the Type list, as shown in the following figure:

   Figure 2-5 The New Adapter screen

   
   Description of "Figure 2-5 The New Adapter screen"
   
   

   Select Create event queue for the adapter to create an event queue for the adapter.

8. Click Finish. The adapter is added to the adapters list and its definition opens for editing.

   Note:

   Other adapters that are displayed in the Type list are not supported with the version of Oracle Connect installed at the site.

Starting Outbound Interactions Metadata Import

Oracle Connect requires metadata describing the adapter interactions, including the structures used to pass information to and from the adapter.

If either BEA JOLT bulk loader file or Tuxedo configuration and FML or VIEW source files describing the adapter are available, you can import them using the Metadata Import wizard in Oracle Studio Design perspective to generate interaction metadata. If either BEA JOLT bulk loader file or Tuxedo configuration and FML or VIEW source files describing the input and output structures are not available, you must manually define the metadata. For more information of the metadata definition, see Advanced Tuning of the Metadata.

The following information is required during the import procedure:

BEA JOLT bulk loader file or Tuxedo configuration and FML or VIEW source files. These are copied to the computer running Oracle Studio as part of the import procedure.

Using Oracle Studio, complete the Metadata Import steps to generate interaction metadata, as follows:

1. From the Start menu, select Programs, Oracle and then select Studio.

2. In the Configuration Explorer, expand the machine where you are using the Tuxedo adapter defined in Configuring OracleAS Adapters for Tuxedo in Oracle Studio.

3. Expand Bindings. The binding configurations available on this computer are listed.

4. Expand the binding with the adapter you are using.

5. Expand the Adapters.

6. Right-click the Tuxedo adapter defined in Configuring a Tuxedo OracleAS Adapter.

7. Select Show Metadata View to open the Metadata tab, with the Tuxedo adapter displayed under the adapters list.

8. Right-click the Tuxedo adapter and select New Import. The New Metadata Import screen is displayed.

9. Enter a name for the import. The name can contain letters and numbers and the underscore character only.

10. Select the metadata import type. You can import the metadata either from a BEA JOLT file or from Tuxedo record definition files (FML or VIEW files).

    Note:

    A JOLT file consists of definitions of Tuxedo services along with the metadata, using the BEA JOLT Bulk Loader. FML and VIEW files are metadata files used by Tuxedo with a configuration file that includes the Tuxedo services.

    For a JOLT file, select Tuxedo Import Manager Using Jolt Bulk Loader File. For FML or VIEW files, select Import Manager Using VIEW Files as shown in the following figure:

    Figure 2-6 The Metadata Import screen

    
    Description of "Figure 2-6 The Metadata Import screen"
    
    

11. Click Finish. The Metadata Import wizard is displayed.

    If JOLT files are used, see Getting a JOLT Input File for Tuxedo Adapter and follow the instructions.

    If FML or VIEW files are used, see Getting an FML or VIEW Import File for Tuxedo Adapter.

The metadata is imported based on the options specified and it is stored on the computer where OracleAS Adapter for Tuxedo runs. An XML representation of the metadata is generated.

After the import is complete, you can view the metadata in Oracle Studio Design perspective Metadata tab. You can also make any fine adjustments to the metadata and maintain it, as necessary.

Getting a JOLT Input File for Tuxedo Adapter

If you selected the Tuxedo Import Manager using JOLT Bulk Loader File, the first step is Get Input Files.

Figure 2-7 Get Input Files (JOLT)

Description of "Figure 2-7 Get Input Files (JOLT)"

In this step you must select the JOLT file where you are importing the metadata. Do the following to select a JOLT file.

1. In the Get Input File step that is displayed in the Editor, click Browse. The Select From Resources screen is displayed, which provides the option to select files from the local computer or to copy the files from another computer.

2. If the files are on another computer, right-click My FTP Sites and select Add or double-click Add FTP site. The Add FTP Site screen is displayed.

3. Enter the name or IP address of the server where the JOLT bulk loader file or the FML or VIEW files reside and enter a valid OracleAS Adapter and password to access the computer (if anonymous connection is used, select Anonymous connection), then click OK.

4. Right-click the required computer and select Set Transfer Type. Enter the transfer type (ASCII or BINARY) and click OK.

5. Click the added site and locate the necessary file. To change the root directory, right-click the computer and select Change Root Directory. Enter the root directory and click OK.

6. Select the required file or files and click Finish. The selected file or files are displayed in the Get Input File step.

7. Click Next to for Applying Filters for Tuxedo Adapter (JOLT).

Applying Filters for Tuxedo Adapter (JOLT)

In the Applying Filters step the filters are applied automatically as shown in the figure below.

Figure 2-8 The Apply Filters screen

Description of "Figure 2-8 The Apply Filters screen"

Click Next to analyze and convert the source file. The next step is for Generating Interactions (JOLT).

Generating Interactions (JOLT)

The Select Interactions step is used to select the interactions to be used. This step is displayed below. The screen lists the services from the input JOLT file as interactions, along with the input and output structures to use with each interaction.

Figure 2-9 The Select Interactions screen

Description of "Figure 2-9 The Select Interactions screen"

Select the interactions to implement from the list, and click Next. The next step for Configuring Tuxedo Records for Tuxedo Adapter.

Configuring Tuxedo Records for Tuxedo Adapter

The Configure Tuxedo Records screen is displayed. It is used to specify how the Tuxedo records should be configured, as shown in the following figure:

Figure 2-10 The Configure Tuxedo Records screen

Description of "Figure 2-10 The Configure Tuxedo Records screen"

Click Next for Importing the Metadata Definitions for Tuxedo Adapter.

Importing the Metadata Definitions for Tuxedo Adapter

In the Import Metadata step, select Yes to transfer the metadata from the Windows computer to the computer where the Tuxedo Gateway adapter runs, and then click Finish.

The metadata is imported based on the options specified and it is stored on the computer where OracleAS Adapter for Tuxedo runs. An XML representation of the metadata is generated.

After performing the import, you can view the metadata in Oracle Studio Design perspective Metadata tab. You can also make any fine adjustments to the metadata and maintain it, as necessary.

Getting an FML or VIEW Import File for Tuxedo Adapter

In this step you can add Tuxedo configuration files and Tuxedo record definition files (FML or VIEW). The step is displayed in the Editor as shown below.

Figure 2-11 Get Input Files Step

Description of "Figure 2-11 Get Input Files Step"

This step is optional for both types of files. To get the import files, do the following.

1. In the Get Input Files step that is displayed in the Editor, click Add for either type of file. The Add button is at the top and bottom of the screen. The Select Resources screen is displayed, which provides the option to select files from the local computer or to copy the files from another computer.

2. If the files are on another computer, right-click My FTP Sites and select Add or double-click Add FTP site. The Add FTP Site screen is displayed.

3. Enter the name or IP address of the server where the JOLT bulk loader file or the FML or VIEW files reside and enter a valid OracleAS Adapter and password to access the computer (if anonymous connection is used, select Anonymous connection), then click OK.

4. Right-click the required computer and select Set Transfer Type. Enter the transfer type (ASCII or BINARY) and click OK.

5. Click the added site and locate the necessary file. To change the root directory, right-click the computer and select Change Root Directory. Enter the root directory and click OK.

6. Select the required file or files and click Finish. The selected file or files are displayed in the Get Input File step.

   Note:

   Each file should be of equal size.

7. Click Next for Adding FML Records for Tuxedo Adapter (FML and View).

Adding FML Records for Tuxedo Adapter (FML and View)

The Add FML records step is displayed in the Editor as shown below.

Figure 2-12 Get Tuxedo Records Step

Description of "Figure 2-12 Get Tuxedo Records Step"

In this step, add FML records by selecting fields from the files imported in the first step. If you did not import any files, you can skip this step and add records in the Getting Tuxedo Records for Tuxedo Adapter (FML and View Files) step.

To add FML records

1. In the Records column, enter a name for the record.

   Notes:

   • Use an expression to filter the records displayed in the list.

   • User the + and - buttons to change the record order in the list.

2. From the Available Fields section, select a field or multiple fields to add to the record.

3. Click the Use Selected Button to add the selected fields to the record. The Use Selected button is a blue triangle that points up.

   Note:

   To use all of the fields, click the Use All button (the button with the double triangle pointing up).

4. Click Next for Getting Tuxedo Records for Tuxedo Adapter (FML and View Files).

To remove fields from an FML record

1. Select a record from the Records column.

2. From the Selected Fields section, select a field or multiple fields to remove from the record.

3. Click the Remove Selected button to remove the selected fields. The Remove Selected button is a blue triangle that points down.

   Note:

   To remove all of the fields, click the Remove All button (the button with the double triangle pointing down).

Getting Tuxedo Records for Tuxedo Adapter (FML and View Files)

The Get Tuxedo Records step is displayed in the Editor as shown below.

Figure 2-13 Get Tuxedo Records Step

Description of "Figure 2-13 Get Tuxedo Records Step"

In this step, add additional simple record definitions that are not included in the FML or VIEW files used for the import.

Enter the name of the record and select the buffer type from the list in the Field Type field.

Select one of the following message buffer types:

• A message buffer of type STRING is wrapped within a record containing a single field of type string.

• A message buffer of type CARRAY is wrapped within a record containing a single field of type binary with a fixed size.

• A message buffer of type XML is wrapped within a record containing a single field of type XML.

Click Next for Generating Interactions for Tuxedo Adapter (FML and View Files).

Generating Interactions for Tuxedo Adapter (FML and View Files)

In the Add Interaction step, you can add interactions to the Tuxedo Gateway adapter. The Add Interaction screen is displayed in the following figure.

Click Add to add as many interactions as required. Provide the following information for each interaction:

Figure 2-14 The Add Interactions screen

Description of "Figure 2-14 The Add Interactions screen"

• Name: The name of the interaction. You can change the default name.

• Mode: The interaction mode. You can select one of the following:

  • sync-send-receive: The interaction sends a request and expects to receive a response. This is the default mode.

  • sync-receive: The interaction expects to receive a response.

  • sync-send: The interaction sends a request and does not expect to receive a response.

• Input: Identifies an input record. The input record is the data structure for the interaction. The records generated from the input files specified at the beginning of the procedure are listed. Select the relevant record for the interaction.

  Note:

  You must specify an input record for each interaction before you can click Next.

  If the interaction does not require an input record, the record specified here is ignored.

• Output: Identifies an output record. The output record is the data structure for the results of the interaction. The records generated from the input files specified at the beginning of the procedure are listed. Select the relevant record for the interaction.

  The records include those generated from the input files, and those defined in the previous step

  Note:

  You must specify an output record for the interaction if the mode is set to sync-send-receive or sync-receive, before you can click Next.

• Description: Free text describing the interaction.

• Interaction-Specific Parameters: Tuxedo specific parameters, as listed in the following table:

  Table 2-1 Interaction-specific Parameters

  Parameter	Description
  Input Buffer Type	The type of buffer used for the input.
  Output Buffer Type	The type of the buffer to use for the results of an outbound interaction.
  No Transaction	Enables to run a service, regardless of transaction context. This parameter should always be checked.
  No Reply Expected	For future use.
  No Blocking Request	Avoids a FROM request submission if a blocking condition exists.
  No Timeouts	Ignores blocking timeouts.

  
  

• Signal Restart: When selected, if a signal interrupts any underlying system calls, the interrupted system call is reissued.

• Interaction Type: Your options are:

  • SERVICE: Sends a request and synchronously awaits its reply. This is the default setting.

  • ENQUEUE: Places a message in the queue.

    If you select this option, you must also fill in the fields Queue Space Name and Queue Name with the relevant values to assign the queue where the message is to be placed.

  • POST: Places a message into one or more queues, according to rules and filters predefined according to events that have been subscribed to.

    If you select this option, you must also fill in the field Event Name.

Click Next for Configuring Tuxedo Records for Tuxedo Adapter.

Starting Interactions Metadata Import

Inbound interactions are defined as events in Oracle Studio. An event adapter is defined automatically when you selected the Tuxedo adapter with Create event queue for the adapter selected, as described in Configuring a Tuxedo OracleAS Adapter. The event adapter is defined with the same name as the adapter with the word event appended to it.

The adapter and the event adapter are linked by Oracle Studio. You can skip from the adapter definition to the event definition by right-clicking the adapter, or event, in the Configuration explorer, and selecting Linked Event or Linked Adapter, respectively.

The event adapter requires metadata describing the inbound interactions, including the structure used to pass the information.

During the import procedure, the BEA JOLT bulk loader file or Tuxedo configuration and FML or VIEW source files are used. These are copied to the computer running Oracle Studio as part of the import procedure.

Perform the Metadata Import steps to generate inbound interaction metadata, as follows:

1. In the Configuration Explorer, right-click the Tuxedo adapter defined in Configuring a Tuxedo OracleAS Adapter.

2. Select Linked Event to skip to the event adapter.

3. Right-click the event adapter and select Open.

4. Click the Properties tab to add the names of Oracle Application Server users who can retrieve inbound interactions and users who can send inbound interactions.

5. To add Oracle Application Server users, expand the Routers, right-click user, and then select Add Item, to open the following screen:

   Figure 2-15 The Adapter Properties screen

   
   Description of "Figure 2-15 The Adapter Properties screen"
   
   

6. Enter the name of the Oracle Application Server user in the Value column for the item added.

7. To add users, expand the Senders, right-click Users, and then select Add item. A new entry is added under User.

8. Enter the name of the user in the Value column for the item added.

9. Click Save to save the changes.

10. Right-click the event adapter in the Configuration Explorer and select Show Metadata View to display the Metadata tab with the event adapter displayed under the Events list.

11. Right-click Imports and select New Import. The New Import screen is displayed.

12. Enter a name for the import. The name can contain letters, numbers and the underscore character only.

13. Select Event Queue Import Manager Using Tuxedo View/FML Files as the import type, and then click Finish.

    After defining an import type, the Metadata Import wizard opens in Oracle Studio.

14. In the Get Input Files step that is displayed in the Editor, click Add for either type of file. The Add button is at the top and bottom of the screen. The Select Resources screen is displayed, which provides the option to select files from the local computer or to copy the files from another computer.

15. If the files are on another computer, right-click My FTP Sites and select Add or double-click Add FTP Site. The Add FTP Site screen is displayed.

16. Enter the server name or IP address where the FML or VIEW files reside and enter a valid OracleAS Adapter and password to access the computer (if anonymous access is used, select Anonymous connection), then click OK. The FTP site is added to the list of available sites.

    Note:

    The selected server is accessed using the OracleAS Adapter as the high-level qualifier, enabling you to browse and transfer files.

17. Right-click the computer and select Set Transfer Type. Enter the transfer type (ASCII or BINARY) and click OK.

18. Expand the added site and locate the necessary FML or VIEW files. To change the high-level qualifier, right-click the computer and select Change Root Directory. Enter the new high-level qualifier enclosed in quotes, and click OK.

19. Select the required FML or VIEW file or files and click Finish.

    The selected file or files are displayed in the Metadata Import wizard, as shown in the following figure:

    Figure 2-16 The Get Input Files screen

    
    Description of "Figure 2-16 The Get Input Files screen"
    
    

20. Click Next.

21. Click Next to analyze and convert the selected FML or VIEW files.

    The Add Events screen is displayed.

22. Click Add to add an event.

    The Add Events screen is displayed.

23. Add as many interactions as required. For each interaction, provide the required information, as listed in the following table:

    Table 2-2 Interaction Parameters

    Property	Description
    Name	The name of the interaction. You can change the default name.
    Mode	The Interaction mode.
    async-send	The interaction sends a request and does not expects to receive a response.
    Input	Identifies an input record. The input record is the data structure for the interaction. The records generated from the FML or VIEW files specified are listed. Select the relevant record for the interaction. Note: You must specify an input record for each interaction before you can click Next
    Description	Free text describing the interaction.

    
    

24. Click Next to generate the metadata definitions for the adapter.

25. For Do you want to transfer the metadata to the server, select Yes to transfer the data from the Windows computer to the target platform, then click Finish.

26. The metadata is imported based on the options specified. An XML representation of the metadata is also generated. After performing the import, you can view the metadata in Oracle Studio Design perspective Metadata tab. You can also make any fine adjustments to the metadata and maintain it, as necessary.

    See Also:

    Advanced Tuning of the Metadata for details about fine tuning the adapter metadata

Configuring the Tuxedo Queue Adapter

To work with Oracle Connect, you must configure the queue adapter definitions on the platform where OracleAS Adapter for Tuxedo Queue runs to handle the events from a Tuxedo Queue.

Perform the following steps to specify these definitions:

1. From the Start menu, select Programs, Oracle and then select Studio.

2. In the Configuration Explorer, expand the computer defined in Configuring OracleAS Adapters for Tuxedo in Oracle Studio.

3. Expand the Bindings. The binding configurations available on this computer are listed.

4. Expand the binding where you want to define the adapter. The binding configuration includes branches for data sources and adapters that are located on the computer.

5. Right-click Events and select New Event.

   The New Event wizard is displayed.

6. Enter a name for the event queue.

   Note:

   The word event is a reserved word and cannot be used to name an event.

7. Select Tuxedo Queue as the event type from the Type list, as shown in the following figure:

   Figure 2-17 The New Event screen

   
   Description of "Figure 2-17 The New Event screen"
   
   

8. Click Finish.

Generating Inbound Interactions

The queue adapter requires metadata describing the inbound interaction, including its structure.

During the import procedure, Tuxedo FML or VIEW configuration source files are copied to the computer running Oracle Studio as part of the import procedure. Alternatively, this procedure enables you to manually define the queue adapter metadata.

Before generating the interactions, note the following:

• All the events described in a single Tuxedo Queue adapter, should have the same Tuxedo buffer type.

• In case that FML/FML32 buffer type is used, a common field with the same FBName must be included in all events. This field should contain the record/event name.

• The interaction is of async-send type (it does not expect to receive a response).

Perform the following steps to generate inbound interaction metadata:

1. In the Configuration Explorer, select the Tuxedo Queue adapter defined in Configuring the Tuxedo Queue Adapter.

2. Right-click the queue adapter in the Configuration Explorer and select Show Metadata View.

   The Metadata tab is displayed, with the queue adapter displayed under the Adapters list.

3. Right-click Imports and select New Import.

   The New Import screen is displayed.

4. Enter a name for the import. The name can contain letters, numbers and the underscore character only.

5. Select the import type from the Import Type list. You have the following options:

   • Tuxedo Queue Import Manager for XML/STRING/CARRAY Buffers: This option does not require importing any files. It enables you to manually define the required Tuxedo record.

   • Tuxedo Queue Import Manager for VIEW/VIEW32 Buffers:

   • Tuxedo Queue Import Manager for FML/FML32 Buffers:

6. Click Finish.

   The next step depends on the selected import type. If either the VIEW/VIEW32 Buffers or the FML/FML32 Buffers options is selected, then the Metadata Import wizard opens, in which case, proceed to the following step. If the XML/STRING/CARRAY Buffers option is selected, proceed now to Defining the Tuxedo Queue Unstructured Records.

7. Click Add.

8. The Select Resources screen is displayed, which provides the option to select files from the local computer or copy the files from another computer.

9. If the files are on another computer, right-click My FTP Sites and select Add. Optionally, double-click Add FTP Site. The Add FTP Site screen is displayed.

10. Enter the server name or IP address where the required reside and enter a valid OracleAS Adapter and password to access the computer (if anonymous access is used, select Anonymous connection), then click OK. The FTP site is added to the list of available sites.

    Figure 2-18 The Select Resources screen

    
    Description of "Figure 2-18 The Select Resources screen"
    
    

11. Right-click the computer and select Set Transfer Type. Enter the appropriate transfer type, and click OK.

12. Expand the added site and locate the files. To change the directory, right-click the computer and select Change Root Directory. Enter the new directory name, and click OK.

13. Select the required file or files and click Finish.

    The selected file or files are displayed in the Metadata Import wizard, as shown in the following figure:

    Figure 2-19 The Get Input Files screen

    
    Description of "Figure 2-19 The Get Input Files screen"
    
    

14. Click Next.

    The Configure Tuxedo Records screen is displayed, as shown in the following figure:

    Figure 2-20 The Configure Tuxedo Queue Records screen

    
    Description of "Figure 2-20 The Configure Tuxedo Queue Records screen"
    
    

15. Ensure that the settings are correct for the following properties:

    • Buffer type: Indicates the buffer type, as read from the FML/VIEW file. This property should not be modified.

    • Get Tuxedo Queue header field in the output record: Indicates that the header field of each record is read. The default setting is true.

    • Read strings from buffer as null terminated: Indicates that strings are handled as null terminated. The default setting is true.

16. Specify the FBName of the field that contains the event name. This field is common to all incoming events and it should include the record name. This property is required only for FML/FML32 files.

17. Click Next to generate the metadata definitions for the queue adapter.

18. Specify if you want to transfer the data to the server, then click Finish.

The Import wizard generates record structures, which are used for the record structures for the inbound interactions, and the metadata is imported based on the options specified and it is stored on the target platform.

An XML representation of the metadata is also generated. After performing the import, you can view the metadata in Oracle Studio Design perspective Metadata tab, under the Imports for the Queue adapter. You can also make any fine adjustments to the metadata.

Defining the Tuxedo Queue Unstructured Records

You can manually define the required Tuxedo records when all the events in the Tuxedo queue are of the same type and are unstructured. Only one record is defined.

Perform the following steps to manually define the required Tuxedo records, as follows:

1. In the Configuration Explorer, select the Tuxedo Queue adapter defined in Configuring the Tuxedo Queue Adapter.

2. Right-click the Tuxedo Queue adapter and select Show Metadata View.

   The Metadata tab is displayed, with the queue adapter displayed under the Adapters list.

3. Right-click Imports and select New Import.

   The New Import screen is displayed.

4. Enter a name for the import. The name can contain letters, numbers and the underscore character only.

5. Select Tuxedo Queue Import Manager for XML/STRING/CARRAY Buffers from the Import Type list.

6. Click Finish.

   The Get Tuxedo Records screen is displayed, as shown in the following figure:

   Figure 2-21 The Get Tuxedo Records screen

   
   Description of "Figure 2-21 The Get Tuxedo Records screen"
   
   

7. Click Add Record. A new record entry is added to the records list, with a default type.

8. Select the field type from the Field Type list. Your options are:

   • STRING (the default)

   • CARRAY

   • XML

   • X_OCTET

9. Specify the maximum buffer size in the Size column. This is not required if XML was selected as the field type.

10. Click Next.

11. Specify if you want to transfer the data to the target platform, then click Finish.

The record structure is generated, and the metadata is imported to and stored on the target platform.

An XML representation of the metadata is also generated. After performing the import, you can view the metadata in Oracle Studio Design perspective Metadata tab, under the Imports for the Queue adapter. You can also make any fine adjustments to the metadata.

Configuring the Tuxedo Gateway Adapter in Oracle Studio

This section provides details on how to use the Oracle Studio to create an Oracle Tuxedo Gateway adapter.

To work with Oracle Connect, you must configure the adapter definition on the platform where OracleAS Adapters for Tuxedo run to handle the interactions to and from a Tuxedo service.

Perform the following steps using Oracle Studio:

1. From the Start menu, select Programs, Oracle and then select Studio.

2. In the Configuration Explorer, right-click the machine and select New and then Tuxedo Gateway. The following is displayed.

   Figure 2-22 Tuxedo Gateway Adapter Configuration

   
   Description of "Figure 2-22 Tuxedo Gateway Adapter Configuration"
   
   

3. Enter the following information:

   • Name: Enter a name for the new adapter. When you finish this process a new adapter, binding, and workspace are created. The binding and workspace have the same name as the adapter. Do not use a name that is in use as a binding or workspace on your machine.

   • Machine: Select a machine where you want to configure the new adapter. By default, the machine you selected to open the dialog box is selected.

   • Daemon: Select the daemon where you want to create the adapter's workspace.

4. Click Finish to create the new adapter, workspace, and binding.

Setting Properties for the Tuxedo Gateway Adapter

To edit the Tuxedo Gateway adapter properties, open the Oracle Studio Design perspective and find the binding for the Tuxedo Gateway adapter. The binding has the same name you gave to the Tuxedo Gateway adapter. For information on how to create a Tuxedo Gateway adapter, see Configuring the Tuxedo Gateway Adapter in Oracle Studio.

Do the following to edit the Tuxedo Gateway adapter properties.

1. From the Start menu, select, Programs, Oracle, and then select Studio.

2. Expand the Machines folder.

3. Expand the server machine that you are working with.

4. Expand the Bindings folder, and then expand the binding the name of Tuxedo Gateway adapter that you are working with.

5. Expand the Adapter folder.

6. Right-click the adapter and select Open.

   The adapter configuration editor opens in the editor, which displays the properties for the adapter.

7. Edit the adapter parameters as required.

logLevel: To set the logging level for the Tuxedo Gateway adapter select from the following log levels. The log levels are listed in order of completeness (None means that no logs are produced, and Debug produces logs with all possible information).

• None

• API

• Info

• Debug

timeout: Sets the service request timeout in the Oracle Tuxedo Gateway Server. Enter a time in seconds.

tmsConnectTimeout: Sets the connection timeout in the Oracle Tuxedo Gateway TMS. If the transaction level is 0PC, this property is not relevant. The default value is 30 seconds. For information on setting this property, see Starting the Tuxedo Gateway Transaction Group.

transactionLevelSupport: Enter the transaction type supported. The options are:

• 0PC: Does not support transactions

• 2PC: Supports XA transactions.

Starting a Metadata Import for Tuxedo Gateway Adapter

Oracle Connect requires metadata describing the adapter interactions, including the structures used to pass information to and from the adapter.

If either BEA JOLT bulk loader file or Tuxedo configuration and FML or VIEW source files describing the adapter are available, you can import them using the Metadata Import wizard in Oracle Studio to generate interaction metadata. If either BEA JOLT bulk loader file or Tuxedo configuration and FML or VIEW source files describing the input and output structures are not available, you must manually define the metadata.

The following information is required during the import procedure:

BEA JOLT bulk loader file or Tuxedo configuration and FML or VIEW source files. These are copied to the computer running Oracle Studio as part of the import procedure.

Using Oracle Studio, complete the Metadata Import steps to generate interaction metadata, as follows:

1. From the Start menu, select Programs, Oracle and then select Studio.

2. In the Configuration Explorer, expand the machine where you are using the Tuxedo Gateway adapter. For more information, see Configuring OracleAS Adapters for Tuxedo in Oracle Studio.

3. Expand Bindings. The available binding configurations are listed.

4. Expand the binding that was created when you created the adapter. This binding has the same name as the Tuxedo Gateway adapter.

5. Expand the Adapters.

6. Right-click the Tuxedo Gateway adapter defined in Configuring the Tuxedo Gateway Adapter in Oracle Studio.

7. Select Show Metadata View to open the Metadata tab, with the Tuxedo Gateway adapter displayed under the adapters list.

8. Right-click the Tuxedo Gateway adapter and select New Import. The New Metadata Import screen is displayed.

9. Enter a name for the import. The name can contain letters and numbers and the underscore character only.

10. Select the metadata import type. You can import the metadata either from a BEA JOLT file or from Tuxedo record definition files (FML or VIEW files).

    Note:

    A JOLT file consists of definitions of Tuxedo services along with the metadata, using the BEA JOLT Bulk Loader. FML and VIEW files are metadata files used by Tuxedo with a configuration file that includes the Tuxedo services.

    For a JOLT file, select Tuxedo Import Manager Using Jolt Bulk Loader File. For FML or VIEW files, select Import Manager Using VIEW/FML Files as shown in the following figure:

    Figure 2-23 The Metadata Import screen

    
    Description of "Figure 2-23 The Metadata Import screen"
    
    

11. Click Finish. The Metadata Import wizard is displayed.

    If JOLT files are used, see Getting a JOLT Input File for Tuxedo Adapter and follow the instructions.

    If FML or VIEW files are used, see Getting an FML or VIEW Import File for Tuxedo Adapter.

Getting a JOLT Input File for Tuxedo Gateway Adapter

If you selected the Tuxedo Import Manager using JOLT Bulk Loader File, the first step is Get Input Files.

Figure 2-24 Get Input Files (JOLT)

Description of "Figure 2-24 Get Input Files (JOLT)"

In this step you must select the JOLT file where you are importing the metadata. Do the following to select a JOLT file.

1. In the Get Input File step that is displayed in the Editor, click Browse. The Select Resources screen is displayed, which provides the option to select files from the local computer or to copy the files from another computer.

2. If the files are on another computer, right-click My FTP Sites and select Add or double-click Add FTP site. The Add FTP Site screen is displayed.

3. Enter the name or IP address of the server where the JOLT bulk loader file or the FML or VIEW files reside and enter a valid OracleAS Adapter and password to access the computer (if anonymous connection is used, select Anonymous connection), then click OK.

4. Right-click the required computer and select Set Transfer Type. Enter the transfer type (ASCII or BINARY) and click OK.

5. Click the added site and locate the necessary file. To change the root directory, right-click the computer and select Change Root Directory. Enter the root directory and click OK.

6. Select the required file or files and click Finish. The selected file or files are displayed in the Get Input File step.

7. Click Next to for Applying Filters for Tuxedo Adapter (JOLT).

Applying Filters for Tuxedo Gateway Adapter (JOLT)

In the Applying Filters step the filters are done automatically as shown in the figure below.

Figure 2-25 The Apply Filters screen

Description of "Figure 2-25 The Apply Filters screen"

Click Next to analyze and convert the source file. The next step is for Generating Interactions (JOLT).

Generating Inbound Synchronous Interactions for Tuxedo Gateway Adapter (JOLT)

The Select Interactions step is used to select the interactions to be used. This step is displayed below. The screen lists the services from the input JOLT file as interactions, along with the input and output structures to use with each interaction.

Figure 2-26 The Select Interactions screen

Description of "Figure 2-26 The Select Interactions screen"

Select the interactions to implement from the list, and click Next. The next step for Configuring Tuxedo Records for Tuxedo Adapter.

Configuring Tuxedo Records for Tuxedo Gateway Adapter

The Configure Tuxedo Records screen is displayed. It is used to specify how the Tuxedo records should be configured, as shown in the following figure:

Figure 2-27 The Configure Tuxedo Records screen

Description of "Figure 2-27 The Configure Tuxedo Records screen"

Click Next for Importing the Metadata Definitions for Tuxedo Adapter.

Importing the Metadata Definitions for Tuxedo Gateway Adapter

In the Import Metadata step, select Yes to transfer the metadata from the computer with Oracle Studio to the computer where the Tuxedo Gateway adapter runs, and then click Finish.

The metadata is imported based on the options specified and it is stored on the computer where OracleAS Adapter for Tuxedo runs. An XML representation of the metadata is generated.

After performing the import, you can view the metadata in Oracle Studio Design perspective Metadata tab. You can also make any fine adjustments to the metadata and maintain it, as necessary.

Getting an FML or VIEW Import File for Tuxedo Gateway Adapter

In this step you can add Tuxedo configuration files and Tuxedo record definition files (FML or VIEW). The step is displayed in the Editor as shown below.

Figure 2-28 Get Input Files Step

Description of "Figure 2-28 Get Input Files Step"

This step is optional for both types of files. To get the import files, do the following.

1. In the Get Input Files step that is displayed in the Editor, click Add for either type of file. The Add button is at the top and bottom of the screen. The Select Resources screen is displayed, which provides the option to select files from the local computer or to copy the files from another computer.

2. If the files are on another computer, right-click My FTP Sites and select Add or double-click Add FTP site. The Add FTP Site screen is displayed.

3. Enter the name or IP address of the server where the JOLT bulk loader file or the FML or VIEW files reside and enter a valid OracleAS Adapter and password to access the computer (if anonymous connection is used, select Anonymous connection), then click OK.

4. Right-click the required computer and select Set Transfer Type. Enter the transfer type (ASCII or BINARY) and click OK.

5. Click the added site and locate the necessary file. To change the root directory, right-click the computer and select Change Root Directory. Enter the root directory and click OK.

6. Select the required file or files and click Finish. The selected file or files are displayed in the Get Input File step.

7. Click Next for Adding FML Records for Tuxedo Gateway Adapter (FML and View).

Adding FML Records for Tuxedo Gateway Adapter (FML and View)

The Add FML records step is displayed in the Editor as shown below.

Figure 2-29 Get Tuxedo Records Step

Description of "Figure 2-29 Get Tuxedo Records Step"

In this step, add FML records by selecting fields from the files imported in the first step. If you did not import any files, you can skip this step and add records in the Getting Tuxedo Records for Tuxedo Gateway Adapter (FML and View Files) step.

To add FML records

1. In the Records column, enter a name for the record.

   Notes:

   • Use an expression to filter the records displayed in the list.

   • User the + and - buttons to change the record order in the list.

2. From the Available Fields section, select a field or multiple fields to add to the record.

3. Click the Use Selected Button to add the selected fields to the record. The Use Selected button is a blue triangle that points up.

   Note:

   If you want to use all of the fields, click the Use All button (the button with the double triangle pointing up).

4. Click Next for Getting Tuxedo Records for Tuxedo Gateway Adapter (FML and View Files).

To remove fields from an FML record

1. Select a record from the Records column.

2. From the Selected Fields section, select a field or multiple fields to remove from the record.

3. Click the Remove Selected button to remove the selected fields. The Remove Selected button is a blue triangle that points down.

   Note:

   If you want to remove all of the fields, click the Remove All button (the button with the double triangle pointing down).

Getting Tuxedo Records for Tuxedo Gateway Adapter (FML and View Files)

The Get Tuxedo Records step is displayed in the Editor as shown below.

Figure 2-30

Description of "Figure 2-30 "

In this step, add additional simple record definitions that are not included in the FML or VIEW files used for the import.

Enter the name of the record and select the buffer type from the list in the Field Type field.

Select one of the following message buffer types:

• A message buffer of type STRING is wrapped within a record containing a single field of type string.

• A message buffer of type CARRAY is wrapped within a record containing a single field of type binary with a fixed size.

• A message buffer of type XML is wrapped within a record containing a single field of type XML.

Click Next for Generating Interactions for Tuxedo Adapter (FML and View Files).

Generating Inbound Synchronous Interactions for Tuxedo Gateway Adapter (FML and View Files)

In the Add Interaction step, you can add interactions to the Tuxedo Gateway adapter.

Click Add to add as many interactions as required. Provide the following information for each interaction. The Add Interaction screen is displayed in the following figure:

Figure 2-31 The Add Interactions screen

Description of "Figure 2-31 The Add Interactions screen"

• Name: The name of the interaction. You can change the default name.

• Mode: The interaction mode. You can select one of the following:

  • sync-send-receive: The interaction sends a request and expects to receive a response. This is the default mode.

  • sync-receive: The interaction (Tuxedo service) that expects to receive a response.

  • sync-send: The interaction sends a request and does not expect to receive a response.

• Input: Identifies an input record. The input record is the data structure for the interaction. The records generated from the input files specified at the beginning of the procedure are listed. Select the relevant record for the interaction.

  Note:

  You must specify an input record for each interaction before you can click Next.

  If the interaction does not require an input record, the record specified here is ignored.

• Output: Identifies an output record. The output record is the data structure for the results of the interaction. The records generated from the input files specified at the beginning of the procedure are listed. Select the relevant record for the interaction.

  The records include those generated from the input files, and those defined in the previous step.

  Note:

  You must specify an output record for the interaction if the mode is set to sync-send-receive or sync-receive, before you can click Next.

• Description: Free text describing the interaction.

• Interaction-Specific Parameters: Tuxedo specific parameters, described below:

  • Output Buffer Type: The type of the buffer to use for the results of an outbound interaction

Click Next for Configuring Tuxedo Records for Tuxedo Adapter.