11 Oracle Application Server Packaged-Application Adapter

11.4.1.2.1 Level 1: Top-Level Validation

At the top level, you can validate DOMResult against the XML schema. Though this sort of validation is useful, it does not provide translation context information, such as the line and the column in the native stream where this error occurred. However, this validation can control the publishing of invalid records and provide XML validation errors. The following code snippet enables XML validation:

<schema xmlns="http://www.w3.org/2001/XMLSchema"
       xmlns:nxsd="http://xmlns.oracle.com/pcbpel/nxsd"
       targetNamespace="http://xmlns.oracle.com/pcbpel/nxsd/smoketest"
       elementFormDefault="qualified"
       attributeFormDefault="unqualified"
       nxsd:stream="chars"
       nxsd:version="NXSD"
       nxsd:validation="true"
       >

11.4.1.2.2 Level 2: Field-Level Validation

Type validation support at the field level - XML schema type validation is performed for each token read from the native stream. In case of an error, an error is reported with the line and column number in the native stream, and the corresponding XML type where this validation failure occurred.

The following code snippet enables field-level validation:

<schema xmlns="http://www.w3.org/2001/XMLSchema"
       xmlns:nxsd="http://xmlns.oracle.com/pcbpel/nxsd"
       targetNamespace="http://xmlns.oracle.com/pcbpel/nxsd/smoketest"
       elementFormDefault="qualified"
       attributeFormDefault="unqualified"
       nxsd:stream="chars"
       nxsd:version="NXSD"
       nxsd:fieldValidation="true"
       >

Note that, currently, field-level validation does not support XML schema patterns and facet-level validation.

11.4.2.1.1 Use Case 1: Moving a File from a Local Folder on the File System to Another Local Folder

You will model only a part of this procedure by using the wizard because the corresponding Oracle JDeveloper Wizard is not available. You will complete the rest of the procedure by configuring the generated WSDL file manually.

The following are the steps to move a file from a local folder on the file system to another local folder:

1. Create an empty BPEL process, as shown in Figure 11-1.

   Figure 11-1 An Empty BPEL Process

   
   Description of "Figure 11-1 An Empty BPEL Process"
   
   

2. Drag and drop File Adapter from the BPEL Services list for the outbound service.

   The Adapter Configuration Wizard is displayed.

3. Click Next. The Service Name page is displayed.

4. Enter a service name, and optionally enter a description, as shown in Figure 11-2, and then click Next.

   Figure 11-2 The Service Name Page

   
   Description of "Figure 11-2 The Service Name Page"
   
   

5. In the Operation page, select Synchronous Read File as the operation, as shown in Figure 11-3. You may optionally change the name of operation, and then click Next.

   Figure 11-3 The Operation Page

   
   Description of "Figure 11-3 The Operation Page"
   
   

   Note that you have selected Synchronous Read File as the operation because the WSDL file that is generated as a result of this operation is similar to the one required for the file IO operation.

6. In the File Directories page, select a dummy directory for now, which will not be used, as shown in Figure 11-4, and then click Next. You will change the directory manually in a later step.

   Figure 11-4 The File Directories Page

   
   Description of "Figure 11-4 The File Directories Page"
   
   

7. In the File Name page, select a dummy file for now, as shown in Figure 11-5, which will not be used, and then click Next. You will change the file name manually in a later step.

   Figure 11-5 Specifying a Dummy File Name

   
   Description of "Figure 11-5 Specifying a Dummy File Name"
   
   

8. In the Messages page, as shown in Figure 11-6, select Native format translation is not required (Schema is opaque), and then click Next.

   Figure 11-6 The Messages Page

   
   Description of "Figure 11-6 The Messages Page"
   
   

9. Click Finish.

10. Create an invoke activity for the MoveFileService service that you just created, as shown in Figure 11-7.

    Figure 11-7 The Invoke Activity

    
    Description of "Figure 11-7 The Invoke Activity"
    
    

    The next step is to modify the generated WSDL file for MoveFileService service and configure it with the new interaction specification for the move operation.

11. Open the MoveFileService.wsdl file and modify the jca:operation, as shown in the following example.

    You will configure the WSDL file with the source, target directory, and file details. You can either hardcode the source, target directory, and file details in the WDL file or use header variables to populate them. In this example, you will use header variables.

    <jca:operation
       InteractionSpec="oracle.tip.adapter.file.outbound.FileIoInteractionSpec"
       SourcePhysicalDirectory="foo1"
       SourceFileName="bar1"
       TargetPhysicalDirectory="foo2"
       TargetFileName="bar2"
       Type="MOVE">
    </jca:operation>
    

    Note:

    Note that you have modified the className attribute, and added SourcePhysicalDirectory, SourceFileName,TargetPhysicalDirectory, TargetFileName and Type. Currently, the values for the source and target details are dummy. You will populate them at runtime. You can also hardcode them to specific directories or filenames.

    The Type attributes decides the type of operation. Apart from MOVE, the other acceptable values for the Type attribute are COPY and DELETE.

12. Now that you have configured the WDL file with dummy source and target details, you will need to specify headers so that you can override them at runtime. First, you will need to modify fileAdapterOutboundHeader.wsdl, and then add the new headers, as shown in the following example:.

    <types>
            <schema ..>
                <element name="OutboundFileHeaderType">
                    <complexType>
                        <sequence>
                            <element name="fileName" type="string"/>
                            <element name="directory" type="string"/>
                            <element name="sourceDirectory" type="string"/>
                            <element name="sourceFileName" type="string"/>
                            <element name="targetDirectory" type="string"/>
                            <element name="targetFileName" type="string"/>
                        </sequence>
                    </complexType>
                </element>
            </schema>
        </types>
    

    This is required because you will use the BPEL header mechanism to override the source, target directory, and file details at runtime.

13. Create a header variable for the invoke activity, as shown in Figure 11-8.

    Figure 11-8 Creating a Header Variable

    
    Description of "Figure 11-8 Creating a Header Variable"
    
    

14. Create a new header variable, as shown in Figure 11-9 , and configure it with the OutboundHeader_msg message type from the fileAdapterOutboundHeader.wsdl file.

    Figure 11-9 Creating a Header Variable

    
    Description of "Figure 11-9 Creating a Header Variable"
    
    

15. Create an assign activity to assign the header variable values for sourceDirectory, sourceFileName, targetDirectory and targetFileName, as shown in Figure 11-10.

    Figure 11-10 Creating an Assign Activity

    
    Description of "Figure 11-10 Creating an Assign Activity"
    
    

16. Similarly, create a copy operation for sourceFileName, targetDirectory and targetFileName. Now, the assign operation appears in the BPEL source view, as shown in the following code snippet.

    <assign name="AssignFileDetails">
          <copy>
            <from expression="'C:\source'"/>
            <to variable="outHeader" part="outboundHeader"
                query="/ns2:OutboundFileHeaderType/ns2:sourceDirectory"/>
          </copy>
          <copy>
            <from expression="'in.zip'"/>
            <to variable="outHeader" part="outboundHeader"
                query="/ns2:OutboundFileHeaderType/ns2:sourceFileName"/>
          </copy>
          <copy>
            <from expression="'C:\target'"/>
            <to variable="outHeader" part="outboundHeader"
                query="/ns2:OutboundFileHeaderType/ns2:targetDirectory"/>
          </copy>
          <copy>
            <from expression="'out.zip'"/>
            <to variable="outHeader" part="outboundHeader"
                query="/ns2:OutboundFileHeaderType/ns2:targetFileName"/>
          </copy>
          
        </assign>
    

    Note that you have hardcoded the source and target details here. You can also provide these details as run-time parameters.

17. Finally, add an initial receive or pick activity.

    You have completed moving a file from a local folder on the file system to another local folder.

11.4.2.1.2 Use Case 2: Copying a File from a Local Folder on the File System to Another Local Folder

The following are the steps to copy a file from a local folder on the file system to another local folder:

1. Follow steps 1 through 10 in Section 11.4.2.1.1, "Use Case 1: Moving a File from a Local Folder on the File System to Another Local Folder".

2. Change the value of the TYPE attribute to COPY in the jca:operation, as shown in the following example in Step 11 in Section 11.4.2.1.1, "Use Case 1: Moving a File from a Local Folder on the File System to Another Local Folder".

   <jca:operation
             InteractionSpec="oracle.tip.adapter.file.outbound.FileIoInteractionSpec"
             SourcePhysicalDirectory="foo1"
             SourceFileName="bar1"
             TargetPhysicalDirectory="foo2"
             TargetFileName="bar2"
             Type="COPY">
         </jca:operation>
   

11.4.2.1.3 Use Case 3: Deleting a File from a Local File System Folder

To delete a file, the parameters you require are TargetPhysicalDirectory and TargetFileName. Note that you do not require SourcePhysicalDirectory and SourceFileName to delete a file from a local file system folder.

The following are the steps to delete a file delete_me.txt from /home/alex:

1. Follow steps 1 through 10 in Section 11.4.2.1.1, "Use Case 1: Moving a File from a Local Folder on the File System to Another Local Folder"

2. Change the value of the TYPE attribute to DELETE in the jca:operation in Step 11 in Section 11.4.2.1.1, "Use Case 1: Moving a File from a Local Folder on the File System to Another Local Folder", as shown in the following example:

   <jca:operation
             InteractionSpec="oracle.tip.adapter.file.outbound.FileIoInteractionSpec"
             TargetPhysicalDirectory="/home/alex"
             TargetFileName="delete_me.txt"
             Type="DELETE">
         </jca:operation>
   

11.4.2.1.4 Use Case 4: Working with Huge CSV Files

Consider the following scenario:

You have a large CSV file of size 1 gigabyte coming on the source folder, and you need to perform the following:

1. Translate the CSV into XML.

2. Transform the resulting XML using XSL.

3. Finally, translate the result from the transform operation into a fixed length file.

This use case is similar to the FlatStructure sample in the BPEL samples directory for 121.FileAdapter. The difference is that the three steps will occur in a single File IO interaction.

Note that all the three steps occur in a single File IO interaction only if all the records in the data file are of the same type.

The following are the steps to perform the three operations on the CSV file:

1. Copy the address-csv.xsd and address-fixedLength.xsd files from the FlatStructure sample into the xsd directory of your project.

2. Copy addr1Toaddr2.xsl from the FlatStructure sample into the xsl directory of your project.

3. Configure the File IO interaction, as shown in the following example. At a high level, you will need to specify the source and target schemas as well as the XSL in the interaction specification along with the source, target folder, and file details, as shown in the following example:

   <jca:operation
             InteractionSpec="oracle.tip.adapter.file.outbound.FileIoInteractionSpec"
             SourcePhysicalDirectory="C:\inputDirectory"
             SourceFileName="input.csv"
             TargetPhysicalDirectory="C:\outputDirectory"
             TargetFileName="output_fixedLength.txt"
             SourceSchema="address-csv.xsd"
             SourceSchemaRoot ="Root-Element"
             SourceType="native"
             TargetSchema="address-fixedLength.xsd"
             TargetSchemaRoot ="Root-Element"
             TargetType="native"
             Xsl="addr1Toaddr2.xsl"
             Type="MOVE">
         </jca:operation>
   

   Note that you have provided the following additional parameters:

   • SourceSchema: Relative path to the source schema.

   • SourceSchemaRoot: The root element in the source schema.

   • SourceType: The type of data. The other possible type is XML.

   • TargetSchema: Relative path to the target schema.

   • TargetSchemaRoot: The root element in the target schema.

   • TargetType: The type of data. The other possible type is XML.

   • XSL: Relative path to the XSL file.

11.4.2.1.5 Use Case 5: Moving a File from a Remote Folder to Another Remote Folder on the Same FTP Server

The IO use-cases for the FTP adapter are very similar to those for File adapter. However, there are a few nuances that need attention.

Note that you are moving a file within the same folder, so it seems more like a rename operation on the same server. Most FTP servers support the RNFR, and the RNTO FTP commands that allow you to rename a file on the FTP server.

However, even if the RNFR, and the RNTO commands are not supported, moving a file within the same folder is still possible by virtue of a binding property UseNativeRenameOperation. If this property is set to TRUE, then the FTP adapter uses the native RNFR and RNTO commands. However, if this property is set to FALSE, then the FTP adapter uses the Get and Put commands followed by a Delete command to emulate a move operation. By default, UseNativeRenameOperation is set to FALSE in which case the FTP adapter emulates a move operation. If your FTP server supports the RNFR and RNTO commands, then set this property to TRUE.

Similar to the File IO, you will need model a part of the use case using the Oracle JDeveloper wizard because the corresponding Oracle JDeveloper wizard is not available.

Modeling this use case is similar to Section 11.4.2.1.1, "Use Case 1: Moving a File from a Local Folder on the File System to Another Local Folder" except for the following two differences from Use Case 1:

1. Change InteractionSpec to oracle.tip.adapter.ftp.outbound.FTPIoInteractionSpec

2. Add an endpoint property in the bpel.xml file for the outbound partner link for UseNativeRenameOperation.

   If the FTP server supports the RNFR, and the RNTO FTP commands, then you must set UseNativeRenameOperation to TRUE. Otherwise, you will need to set it to FALSE. Define the property in bpel.xml, as shown in the following example:

   <partnerLinkBinding name="FtpRenameSvc">
               <property name="wsdlLocation">FtpRenameSvc.wsdl</property>
               <property name=" UseNativeRenameOperation">true</property>
               <property name="retryInterval">60</property>
            </partnerLinkBinding>
   

3. Follow the rest of the steps as mentioned in Section 11.4.2.1.1, "Use Case 1: Moving a File from a Local Folder on the File System to Another Local Folder", with changes only to the InteractionSpec class name, as shown in the following example:

   <jca:operation
             InteractionSpec="oracle.tip.adapter.ftp.outbound.FTPIoInteractionSpec"
             SourcePhysicalDirectory="foo1"
             SourceFileName="bar1"
             TargetPhysicalDirectory="foo2"
             TargetFileName="bar2"
             Type="MOVE">
       </jca:operation>
   

11.4.2.1.6 Use Case 6: Copying a File from a Local Folder on the File System to a Remote Folder on the FTP Server

The steps for this use case are the same as in Section 11.4.2.1.5, "Use Case 5: Moving a File from a Remote Folder to Another Remote Folder on the Same FTP Server" except that you must configure the source folder as local and the target folder as remote.

Use the two properties SourceIsRemote and TargetIsRemote to specify whether the source/target file is on the local or remote file system, as shown in the following example:

<jca:operation
          InteractionSpec="oracle.tip.adapter.ftp.outbound.FTPIoInteractionSpec"
          SourcePhysicalDirectory="foo1"
          SourceFileName="bar1"
          SourceIsRemote="false"
          TargetPhysicalDirectory="foo2"
          TargetFileName="bar2"
          Type="COPY">
    </jca:operation>

Notice that you have configured SourceIsRemote as FALSE. In this case, the FTP IO assumes that the source file comes from a local file system. Also, notice that you did not specify the parameter for target because, by default TargetIsRemote is set to TRUE.

11.4.2.1.7 Use Case 7: Copying a File from a Remote Folder on the File System to a Local Folder on the File System

The steps for this use case are the same as in Section 11.4.2.1.6, "Use Case 6: Copying a File from a Local Folder on the File System to a Remote Folder on the FTP Server" except that you must configure the source folder as remote and the target folder as local, as shown in the following example:

<jca:operation
          InteractionSpec="oracle.tip.adapter.ftp.outbound.FTPIoInteractionSpec"
          SourcePhysicalDirectory="foo1"
          SourceFileName="bar1"
          TargetPhysicalDirectory="foo2"
          TargetFileName="bar2"
          TargetIsRemote="false"
          Type="COPY">
    </jca:operation>

Notice that you have configured TargetIsRemote as FALSE. In this case, the FTP IO will assume that the source file comes from a remote file system whereas the target is on a local file-system folder. Also, notice that you did not specify the parameter for source because, by default, SourceIsRemote is set to TRUE.

Also, note that you cannot set both SourceIsRemote and TargetIsRemote as FALSE, because this use case is applicable for a File adapter and not an FTP adapter.

11.4.2.1.8 Use Case 8: Copying a File from One FTP Server to Another

For this use case, you will need to perform Section 11.4.2.1.6, "Use Case 6: Copying a File from a Local Folder on the File System to a Remote Folder on the FTP Server" and Section 11.4.2.1.7, "Use Case 7: Copying a File from a Remote Folder on the File System to a Local Folder on the File System" in a sequential manner. In Use case 6 the file from the FTP server is downloaded to a local directory and in Use case 7 the file is uploaded to another FTP server from the local directory.