Managing Integrators

This chapter covers the following topics:

Managing Integrators

An integrator is a set of metadata that encapsulates all the information needed to integrate a particular Oracle E-Business Suite task with a desktop application. Use the Integrators page to view and manage the integrators defined for your Oracle E-Business Suite installation.

To manage integrators

  1. Navigate to the Integrators page from the Oracle E-Business Suite Navigator by choosing either Desktop Integration Manager: Manage Integrators or a custom responsibility and menu path specified by your system administrator.

  2. Search for the integrators you want to display. You can enter the following search criteria:

    • Integrator Name - Enter the display name of the integrator. You can enter a partial value to search for integrators whose names contain that value.

    • Internal Name - Enter the unique internal name of the integrator. You can enter a partial value to search for integrators whose names contain that value.

    • Application - Select the application that owns the integrator.

    • Enabled - Select Yes to search for integrators that are enabled or No to search for integrators that are disabled.

    • Source - Select Oracle to search for integrators seeded by Oracle E-Business Suite or Custom to search for custom integrators.

    The search criteria fields are all case-insensitive.

    Integrators Page

    the picture is described in the document text

  3. To view an integrator definition in read-only mode, choose the integrator name link for that integrator. See: Defining Integrators.

  4. To update an integrator, choose the update icon for that integrator. See: Defining Integrators.

    Note: You can only update custom integrators.

  5. To delete an integrator, choose the delete icon for that integrator.

    Note: You can only delete custom integrators.

  6. To define a layout for an integrator, select the integrator and select the Define Layout button. See: Defining Layouts, Oracle Web Applications Desktop Integrator Implementation and Administration Guide.

  7. To define a mapping for an integrator, select the integrator and select the Define Mapping button. See: Defining Mappings, Oracle Web Applications Desktop Integrator Implementation and Administration Guide.

  8. To test how an integrator creates a desktop document, select the integrator and select the Preview button. Oracle Web Applications Desktop Integrator then displays the Create Document interface, with the specified integrator selected, to let you finish creating the preview document. See: Creating a Spreadsheet, Oracle Web Applications Desktop Integrator Implementation and Administration Guide.

    Note: When you access the Create Document page in preview mode, the resulting document is intended only for testing purposes to help you check the integrator definition. Consequently, the Save button for saving a shortcut and the Clear button are not displayed.

  9. To define a new integrator, select the Create Integrator button. See: Defining Integrators.

  10. To define a new integrator by copying an existing integrator, select the existing integrator and select the Duplicate button. See: Defining Integrators.

    Note: Some seeded integrators contain product-specific features that cannot be defined or updated through the integrator definition wizard. These integrators cannot be duplicated.

Defining Integrators

Use the integrator definition wizard to create a new integrator, create an integrator by duplicating an existing integrator, update an existing integrator, or view the definition for an existing integrator.

Note: You can only update custom integrators.

To define an integrator

  1. Navigate to the integrator definition wizard by one of the following methods:

    • Choose the Create Integrator button in the Integrators page.

    • Choose the Duplicate button in the Integrators page.

    • Choose the update icon in the Integrators page.

    • From the Oracle E-Business Suite Navigator, choose either Desktop Integration Manager: Create Integrator or a custom responsibility and menu path specified by your system administrator.

    If you are duplicating or updating an existing integrator, then the fields in the wizard are populated with previously defined information for the selected integrator.

  2. In the first step of the wizard, define the basic properties of the integrator. See: To define integrator information.

  3. If you want to use this integrator to upload data from a desktop document to Oracle E-Business Suite, define an interface for the integrator in the second step of the wizard. See: To define interfaces.

  4. In the third step of the wizard, optionally define contents for the integrator. See: To define contents.

  5. If you want to use this integrator to upload data from a desktop document to Oracle E-Business Suite, define the uploader for the integrator in the fourth step of the wizard. See: To define an uploader.

  6. If you want to use this integrator to import uploaded data from Oracle E-Business Suite interface tables to application base tables, define the importer for the integrator in the fifth step of the wizard. See: To define an importer.

To view an integrator definition

  1. Navigate to the integrator definition wizard by choosing the integrator name link in the Integrators page. The integrator definition appears in the wizard in read-only mode.

  2. Use the Next and Back buttons to navigate among the pages of the wizard. For more information about the fields displayed in each page, see: To define integrator information, To define interfaces, To define contents, To define an uploader, and To define an importer.

  3. Choose the Cancel button in the Integrator Information, Interfaces, Contents, Uploader, or Importer page to return to the Integrators page.

To define integrator information

Integrator Information Page

the picture is described in the document text

  1. In the Integrator Information region of the Integrator Information page, enter the display name of the integrator.

    When you duplicate an integrator, Oracle E-Business Suite Desktop Integration Framework creates a default display name for the new integrator by adding Copy of before the name of the original integrator. It is recommended that you update the display name to better describe the new integrator.

  2. Enter a unique internal name for the integrator. The internal name can include only the following characters:

    • Uppercase letters from A through Z

    • Numerals from 0 through 9

    • The underscore character (_)

    Oracle E-Business Suite Desktop Integration Framework uses the internal name of the integrator to generate internal names for the supporting objects associated with the integrator, such as interfaces, contents, layouts, and mappings.

    When you duplicate an integrator, Oracle E-Business Suite Desktop Integration Framework creates a default internal name for the new integrator by adding COPY_ before the name of the original integrator. It is recommended that you update the internal name to better describe the new integrator.

    Note: To preserve consistency, you cannot update the internal name of an existing integrator.

  3. Select the application that owns the integrator.

    Note: To preserve consistency, you cannot update the application of an existing integrator. You also cannot update the application for an integrator created as a duplicate of an existing integrator.

  4. If you want to use this integrator only for exporting data from Oracle E-Business Suite to a desktop document, select the Reporting Only option. In this case the document serves as a report of the Oracle E-Business Suite data that can be viewed in the desktop application. If you want to use this integrator to upload data from a desktop document to Oracle E-Business Suite, do not select this option.

  5. In the Enabled field, select Yes to enable this integrator or No to disable this integrator. If you disable an integrator, its definition remains available for reference, but you cannot use it to define layouts or mappings, create a document, or download or upload Oracle E-Business Suite data.

  6. If you want your users to be able to select this integrator in the Create Document interface within Oracle Web Applications Desktop Integrator, select the Display in Create Document Page option. In this case you must also add the relevant functions as security rules for this integrator in step 11.

    If you will include the functionality to create documents within the functional page flow of your own application, then you do not need to select this option.

  7. To specify parameters for the integrator, expand the Integrator Parameters region. See: Managing Parameters.

  8. Select the server-side upload parameter list.

  9. Select the document parameter list that contains any runtime parameters that can be referenced in layouts for the integrator to be included when a document is created. See: To define a document parameter list and Defining Layouts, Oracle Web Applications Desktop Integrator Implementation and Administration Guide.

  10. Select the session parameter list.

  11. The Security Rules region displays a list of functions through which the integrator can be accessed. A user must have menu access to at least one of these functions in order to use this integrator, including creating a desktop document, downloading data into the document, using a list of values based on Oracle E-Business Suite data within the desktop document, and uploading data to Oracle E-Business Suite. To add functions to the list, select Add Functions. You can repeat this step to allow access through additional functions.

    If you selected the Display in Create Document Page option in step 6, then you must add the following two functions as security rules to enable this integrator to appear in the list of integrators that users can select in the Create Document interface:

    • BNE_CREATE_DOCUMENT

    • BNE_ADI_CREATE_DOCUMENT

  12. Select Next.

    • If you did not select the Reporting Only option, then the integrator definition wizard displays the Interfaces page. See: To define interfaces.

    • If you selected the Reporting Only option, then you do not need to define an interface. In this case the integrator definition wizard proceeds directly to the Contents page. See: To define contents.

To define interfaces

An interface is a set of metadata that determines how the integrator uploads data from a desktop document to Oracle E-Business Suite. Use the Interfaces page of the integrator definition wizard to create and manage an interface.

Important: Oracle Web Applications Desktop Integrator currently supports only one interface per integrator. Consequently, when you define a custom integrator, you should create only one interface in the Interfaces page.

Note: If you selected the Reporting Only option while defining the integrator information, do not manually define an interface for the integrator. Oracle E-Business Suite Desktop Integration Framework automatically defines a default placeholder interface for reporting-only integrators.

Interfaces Page

the picture is described in the document text

  1. If an interface is already defined for this integrator, the Interfaces page displays the list of interfaces.

    • To update the name of an interface, enter the new name in the Interface Name field.

    • To delete an interface, choose the delete icon for that interface.

      Note: When you duplicate an integrator, you cannot delete an interface that was copied from the original integrator.

    • To create a new interface, select the Create Interface button. The Interface Information region appears.

    Interface Information Region

    the picture is described in the document text

    If no interface has yet been defined for the integrator, then the Interfaces page displays the Interface Information region in place of the interfaces list.

  2. In the Interface Information region, enter the interface name.

  3. Select the interface type, either table, API - procedure, or API - function.

    Note: When you duplicate an integrator, you cannot update the interface type for an interface that was copied from the original integrator.

  4. For a table interface, select the table name. Oracle E-Business Suite Desktop Integration Framework creates an interface attribute for each column in the table.

    If you create custom application tables, you must register those tables to make them available for selection in the Table Name field. See: Table Registration API, Oracle E-Business Suite Developer's Guide.

    Note: The values available for selection in the Table Name field include only tables. You cannot create a table interface based on a view.

    Note: When you duplicate an integrator, you cannot update the table name for an interface that was copied from the original integrator.

  5. For a procedure interface, enter the package name and procedure name. Oracle E-Business Suite Desktop Integration Framework creates an interface attribute for each input argument in the procedure. You can also optionally specify whether the procedure returns an error message or an FND message code if it encounters an error.

    Note: The PL/SQL procedure for an interface must not contain any commit statements. A commit statement in this procedure can cause inconsistencies during data upload: if an upload is submitted with both valid and invalid records, the valid records may be uploaded although Oracle Web Applications Desktop Integrator returns a message that no rows were uploaded.

    Note: When you duplicate an integrator, you cannot update the package name and procedure name for an interface that was copied from the original integrator.

  6. For a function interface, enter the package name and function name. Oracle E-Business Suite Desktop Integration Framework creates an interface attribute for each input argument in the function. If the function returns more details about any error that it encounters, select the Returns Error Information option. You can also optionally specify whether the function returns an error message or an FND message code if it encounters an error.

    Note: The PL/SQL function for an interface must not contain any commit statements. A commit statement in this function can cause inconsistencies during data upload: if an upload is submitted with both valid and invalid records, the valid records may be uploaded although Oracle Web Applications Desktop Integrator returns a message that no rows were uploaded.

    Note: When you duplicate an integrator, you cannot update the package name and function name for an interface that was copied from the original integrator.

  7. Choose Apply.

  8. In the Interfaces page, select an interface in the list to display its details, including interface attributes.

    Interfaces Page with Interface Attributes Region and Refresh Message

    the picture is described in the document text

    • For a procedure interface, you can optionally update whether the procedure returns an error message or an FND message code if it encounters an error.

    • For a function interface, you can optionally update whether the function returns more details about any error that it encounters and whether the function returns an error message or an FND message code if it encounters an error.

  9. The Interface Attributes region initially displays the attributes that were automatically created for the interface based on the specified table columns or API arguments. These attributes are referred to as real interface attributes. To define an additional custom interface attribute that can appear in a layout, choose Add Attribute. See: To define an interface attribute.

    Note: If you want to define an attribute group, you should define a custom attribute to use as the parent attribute for the group.

  10. You can optionally choose Refresh in the Interface Attributes region to update the real interface attributes if the definition of the underlying table, procedure, or function has changed. The Interfaces page displays a message to notify you if Oracle E-Business Suite Desktop Integration Framework detects that the underlying object definition has changed since the interface was last updated.

    Oracle E-Business Suite Desktop Integration Framework can automatically refresh the interface and its real interface attributes for the following types of changes in the underlying object definition:

    • For new columns added at the end of the underlying table, or new input arguments added at the end of the argument list for a procedure or function, Oracle E-Business Suite Desktop Integration Framework adds the corresponding new real interface attributes.

    • For changes in the data type of a table column or API argument, the size of a table column, or whether a table column can be null, Oracle E-Business Suite Desktop Integration Framework updates the corresponding interface attribute details.

    • If a function now returns error information when it previously did not, or vice versa, Oracle E-Business Suite Desktop Integration Framework updates the corresponding detail in the interface definition.

    Interfaces Page - Interface Attributes Region with Refresh Status Column

    the picture is described in the document text

    After you choose Refresh, the Interface Attributes region displays a Refresh Status column with an icon for each attribute. The icon is enabled if the underlying table column or API argument for the attribute has changed and disabled if there was no change. You can sort the list by the Refresh Status column to group all the changed attributes at the beginning or end of the list for easier review. For the changed attributes, choose the icon in the Refresh Status column to open a popup window that displays the details of the changes. To save the changes and complete the refresh, choose Submit.

    After you refresh interface attributes for an existing integrator that allows uploading data to Oracle E-Business Suite, you should also update the content, mapping, and layout for the integrator as needed to accommodate the changed interface attributes.

    Note: You do not need to perform a refresh for the default placeholder interface for a reporting-only integrator. If you add content columns for a reporting-only integrator, Oracle E-Business Suite Desktop Integration Framework automatically updates the default placeholder interface and mapping lines accordingly.

    Note: Oracle E-Business Suite Desktop Integration Framework cannot automatically refresh interface attributes for certain types of changes in the underlying object definition, including the following

    • Columns were removed from the underlying table, or input arguments were removed from the underlying procedure or function.

    • Columns or arguments were added in a position other than at the end of the existing sequence.

    • The name of a column or argument was changed.

    • An underlying procedure was changed to a function, or vice versa.

    If the updated table or API definition includes any of these changes, then Oracle E-Business Suite Desktop Integration Framework displays an error message when you attempt to perform a refresh. In this case no refresh is performed and no changes are made in the interface definition. Instead, you must manually create a new interface definition to specify how the integrator should work with the updated table or API.

  11. You can update some attribute details directly in the Interface Attributes region.

    • Enter a prompt to appear to the left of the attribute if it appears in the header region of a document. This prompt is also used as the display name of the attribute.

    • Select whether the attribute is enabled for use in a layout.

    • Select whether the attribute is available for display in a layout.

    • Optionally select the source type from which the default value for the attribute is derived, either Constant, Environment Variable, Parameter, Profile Option, Sequence, SQL Query, or Lookup.

    • Enter a default value for the attribute corresponding to the selected type.

      Note: For an attribute that contains a date value, the format of the default value should match the date format defined for the integrator in the integrator LDT file.

    You can also choose the update icon for an attribute to update additional attribute details. See: To update an interface attribute.

  12. To delete a custom interface attribute, choose the delete icon for that attribute.

    Note: You cannot delete real interface attributes.

  13. If validation of one interface attribute depends on the value of another attribute, or if several attributes are validated the same way, you can associate those attributes with each other by defining an attribute group and perform validation for all attributes in the group together. To view and manage groups, choose View Groups. See: To manage interface attribute groups.

  14. To proceed to the Contents page, select Next, or to save this integrator definition without defining contents or an uploader or importer, select Submit.

To define an interface attribute

Interface Attribute Definition Page

the picture is described in the document text

  1. In the Interface Attribute Definition page, enter a unique internal name for the attribute. The name can include only the following characters:

    • Uppercase letters from A through Z

    • Numerals from 0 through 9

    • The underscore character (_)

  2. Select the attribute data type.

    • Number - This data type holds a number value.

    • String - This data type holds a string value.

    • Date - This data type holds a date value without a time component.

    • DateTime - This data type holds a date value with a time component that is both stored in the Oracle E-Business Suite database and displayed in the desktop document according to the server time zone.

    • DateTimeTZ - This data type holds a date value with a time component that is stored in the Oracle E-Business Suite database according to the server time zone but is displayed in the desktop document according to the user's preferred time zone, as specified in the Client Timezone (CLIENT_TIMEZONE_ID) profile option. Oracle Web Applications Desktop Integrator converts values with this data type to the client time zone when they are downloaded to a document and converts these values to the server time zone when they are uploaded to Oracle E-Business Suite.

      Additional Information: See: User-Preferred Time Zones, Oracle E-Business Suite Setup Guide.

  3. For an attribute derived from an interface table column with a data type of number or string, review the attribute length, which is determined by the size of the corresponding interface table column.

  4. Select whether the attribute is enabled for use in a layout.

  5. Select whether the attribute is available for display in a layout.

  6. Select whether the attribute is required to be included in all layouts for this integrator.

  7. Select whether the attribute can be summed to form a total value.

  8. Select whether the attribute is read-only. A read-only attribute is placed in the context section of the desktop document and users cannot change its value.

  9. Select whether the attribute is enabled for use in a mapping, to be mapped to a content column.

  10. For an attribute derived from an interface table column, the Not Null checkbox indicates whether that interface table column must not be null.

  11. Optionally select the source type from which the default value for the attribute is derived, either Constant, Environment Variable, Parameter, Profile Option, Sequence, SQL Query, or Lookup.

    Note: The default value for an attribute is not inserted into the document when the document is created. Instead, if no other value has been specified for the attribute, the default value is derived and inserted when a user performs an upload.

    If you select Sequence as the source type, then you should also mark this attribute as read-only, and you should specify the name of a database sequence as the default value. In this case, when a user performs an upload, the upload process sets the attribute value for each row that is uploaded to the next value generated by that database sequence (Sequence.NextValue). That is, each row will be assigned a separate sequence value.

    You can also define an interface attribute that assigns the same sequence value to all rows processed in a particular upload, to serve as an upload batch ID. To define this type of attribute, select SQL Query as the source type, mark this attribute as read-only, and set the default value to the following query:

    Select SequenceName.nextval from dual

  12. Enter a default value for the attribute corresponding to the selected type.

    Note: For an attribute that contains a date value, the format of the default value should match the date format defined for the integrator in the integrator LDT file.

  13. Select the validation type for the attribute, either Descriptive Flexfield, Descriptive Flexfield Context, Descriptive Flexfield Segment, Group, Java, Key Flexfield, Key Flexfield ID, Key Flexfield ID Segment, Key Flexfield Segment, or Table. If you only want to validate the data type, length, and not null requirement for the attribute, then you can leave the validation type blank.

  14. If the attribute should be validated as part of an attribute group, select the group name. See: To manage interface attribute groups.

  15. For descriptive flexfield validation, specify the following validation details.

    • Enter the validation entity for the attribute. The default validation entity is oracle.apps.bne.integrator.validators.BneDFFValidator.

    • Select the descriptive flexfield to use for validation.

    • Select Yes or No to indicate whether the descriptive flexfield segment values should be concatenated.

  16. For descriptive flexfield context validation, specify the following validation details.

    • Select the descriptive flexfield to use for validation.

    • Select Yes or No to indicate whether the descriptive flexfield segment values should be concatenated.

  17. For descriptive flexfield segment validation, specify the following validation details.

    • Enter the segment number.

  18. For group validation or Java validation, specify the following validation details.

    • Enter the validation entity for the attribute.

  19. For key flexfield or key flexfield ID validation, specify the following validation details.

    • Enter the validation entity for the attribute. The default validation entity is oracle.apps.bne.integrator.validators.BneKFFValidator.

    • Select the key flexfield to use for validation.

    • Select Yes or No to indicate whether the key flexfield segment values should be concatenated.

    Note: To use a WHERE clause for the key flexfield as part of the validation, you must define a parameter named field:whereClause in the parameter list associated with the flexfield component. See: To define a parameter list to use a WHERE clause with a key flexfield component.

    To use a data set identifier for the key flexfield as part of the validation, you must define a parameter named field:datasetCol in the parameter list associated with the flexfield component. See: To define a parameter list to use a data set identifier with a key flexfield component.

  20. For key flexfield segment validation or key flexfield ID segment validation, specify the following validation details.

    • Enter the segment number.

  21. For table validation, specify the following validation details:

    • Enter the column in the validation entity that contains the internal ID for each value.

    • Enter the column in the validation entity the contains the meaning of the value.

    • Enter the column in the validation entity that contains the full description of the value.

    • Enter the validation entity for the attribute, such as the view that provides access to the values.

    • Enter a WHERE clause that specifies the conditions defining the data to select.

      To create a dependent list of values when the value of this attribute depends on the value of another attribute, you can include a token in the WHERE clause to reference the value of that attribute. The WHERE clause can include multiple such tokens if the list of values depends on multiple other attributes. Use the following syntax for the token for a referenced attribute:

      $INTERFACE$.<INTERFACE_ATTRIBUTE>

      Replace <INTERFACE_ATTRIBUTE> with the name of the referenced attribute.

      For example, an attribute that contains the city of birth for a person may depend on a value that contains the region of birth. In this case, the WHERE clause could be defined as follows:

      STATE_ABBREV = $INTERFACE$.REGION_OF_BIRTH

  22. Select the component name that defines the list of values to use for validation. See: Managing Components.

  23. Select the type of list of values that the component uses, either None, Pop List for a predefined static set of values, or Standard for a dynamic set of values based on Oracle E-Business Suite data.

    Note: The maximum number of values that can appear in a Pop List is 255. If your list includes more than 255 values, use a Standard list of values instead.

  24. Enter a prompt to appear to the left of the attribute if it appears in the header region of a document. This prompt is also used as the display name of the attribute.

  25. Optionally enter a prompt to appear above the attribute if it appears in the lines region of a document.

  26. Optionally enter hint text to provide users further guidance on the attribute. The hint text appears between the header region and the lines region in the document.

  27. Choose Apply.

To update an interface attribute

  1. Use the Interface Attribute Definition pop-up window to update attribute details that are not displayed in the Interfaces page.

    Note: To preserve consistency, you cannot update the interface attribute name, length, or attribute type. Additionally, you cannot update the data type for attributes with a data type of Number or String.

  2. For an attribute that stores a date value, select the data type.

    • Date - This data type holds a date value without a time component.

    • DateTime - This data type holds a date value with a time component that is both stored in the Oracle E-Business Suite database and displayed in the desktop document according to the server time zone.

    • DateTimeTZ - This data type holds a date value with a time component that is stored in the Oracle E-Business Suite database according to the server time zone, but is displayed in the desktop document according to the user's preferred time zone specified in the Client Timezone (CLIENT_TIMEZONE_ID) profile option. Oracle Web Applications Desktop Integrator converts values with this data type to the client time zone when they are downloaded to a document and converts these values to the server time zone when they are uploaded to Oracle E-Business Suite.

      Additional Information: See: User-Preferred Time Zones, Oracle E-Business Suite Setup Guide.

  3. Select whether the attribute is required to be included in all layouts for this integrator.

  4. Select whether the attribute can be summed to form a total value.

  5. Select whether the attribute is read-only. A read-only attribute is placed in the context section of the desktop document and users cannot change its value.

  6. Select whether the attribute is enabled for use in a mapping, to be mapped to a content column.

  7. For an attribute derived from an interface table column, the Not Null checkbox indicates whether that interface table column must not be null.

  8. Select the validation type for the attribute, either Descriptive Flexfield, Descriptive Flexfield Context, Descriptive Flexfield Segment, Group, Java, Key Flexfield, Key Flexfield ID, Key Flexfield ID Segment, Key Flexfield Segment, or Table. If you only want to validate the data type, length, and not null requirement for the attribute, then you can leave the validation type blank.

  9. If the attribute should be validated as part of an attribute group, select the group name. See: To manage interface attribute groups.

  10. For descriptive flexfield validation, specify the following validation details.

    • Enter the validation entity for the attribute. The default validation entity is oracle.apps.bne.integrator.validators.BneDFFValidator.

    • Select the descriptive flexfield to use for validation.

    • Select Yes or No to indicate whether the descriptive flexfield segment values should be concatenated.

  11. For descriptive flexfield context validation, specify the following validation details.

    • Select the descriptive flexfield to use for validation.

    • Select Yes or No to indicate whether the descriptive flexfield segment values should be concatenated.

  12. For descriptive flexfield segment validation, specify the following validation details.

    • Enter the segment number.

  13. For group validation or Java validation, specify the following validation details.

    • Enter the validation entity for the attribute.

  14. For key flexfield or key flexfield ID validation, specify the following validation details.

    • Enter the validation entity for the attribute. The default validation entity is oracle.apps.bne.integrator.validators.BneKFFValidator.

    • Select the key flexfield to use for validation.

    • Select Yes or No to indicate whether the key flexfield segment values should be concatenated.

    Note: To use a WHERE clause for the key flexfield as part of the validation, you must define a parameter named field:whereClause in the parameter list associated with the flexfield component. See: To define a parameter list to use a WHERE clause with a key flexfield component.

    To use a data set identifier for the key flexfield as part of the validation, you must define a parameter named field:datasetCol in the parameter list associated with the flexfield component. See: To define a parameter list to use a data set identifier with a key flexfield component.

  15. For key flexfield segment validation or key flexfield ID segment validation, specify the following validation details.

    • Enter the segment number.

  16. For table validation, specify the following validation details:

    • Enter the column in the validation entity that contains the internal ID for each value.

    • Enter the column in the validation entity the contains the meaning of the value.

    • Enter the column in the validation entity that contains the full description of the value.

    • Enter the validation entity for the attribute, such as the view that provides access to the values.

    • Enter a WHERE clause that specifies the conditions defining the data to select.

      To create a dependent list of values when the value of this attribute depends on the value of another attribute, you can include a token in the WHERE clause to reference the value of that attribute. The WHERE clause can include multiple such tokens if the list of values depends on multiple other attributes. Use the following syntax for the token for a referenced attribute:

      $INTERFACE$.<INTERFACE_ATTRIBUTE>

      Replace <INTERFACE_ATTRIBUTE> with the name of the referenced attribute.

      For example, an attribute that contains the city of birth for a person may depend on a value that contains the region of birth. In this case, the WHERE clause could be defined as follows:

      STATE_ABBREV = $INTERFACE$.REGION_OF_BIRTH

  17. If the attribute should use a list of values defined in a component, select the component name. See: Managing Components.

  18. Select the type of list of values that the component uses, either None, Pop List for a predefined static set of values, or Standard for a dynamic set of values based on Oracle E-Business Suite data.

    Note: The maximum number of values that can appear in a Pop List is 255. If your list includes more than 255 values, use a Standard list of values instead.

  19. Optionally enter a prompt to appear above the attribute if it appears in the lines region of a document.

  20. Optionally enter hint text to provide users further guidance on the attribute. The hint text appears between the header region and the lines region in the document.

  21. Choose Apply.

To manage interface attribute groups

  1. The Interfaces: View Groups region displays a list of the interface attribute groups defined for this interface.

    Interfaces: View Groups Region

    the picture is described in the document text

    To define a new group, choose Define Group.

    Interfaces: Define Group Region

    the picture is described in the document text

  2. In the Interfaces: Define Group region, enter a unique name for the group.

  3. Select the name of the attribute to use as the parent attribute for the group. The parent attribute should be a custom attribute that is not uploaded. Instead, it serves as a placeholder for validation for the group.

  4. Select the validation type associated with the parent attribute, either Descriptive Flexfield, Group, Java, Key Flexfield, or Key Flexfield ID.

  5. For descriptive flexfield validation, specify the following validation details.

    • Select the descriptive flexfield to use for validation.

    • Select the interface attribute that corresponds to the context for the descriptive flexfield. This attribute should have the validation type Descriptive Flexfield Context.

      Note: For the Oracle Web Applications Desktop Integrator descriptive flexfield list of values to populate the descriptive flexfield context and segment values in the desktop document, the descriptive flexfield's reference field must either be empty or be one of the following:

      • $PROFILES$.<PROFILE_OPTION_NAME>

      • CONTEXT

      • CONTEXT3

      • ACCOUNT_NUM (used in Oracle General Ledger only)

      For a descriptive flexfield whose reference field is specified as Block.Field, users can manually enter values in the document and upload those values. However, Oracle Web Applications Desktop Integrator does not support displaying a list of values for such a descriptive flexfield.

    • Enter the validation entity for the group. The default validation entity is oracle.apps.bne.integrator.validators.BneDFFValidator.

    • Select Yes or No to indicate whether the descriptive flexfield segment values should be concatenated.

    • Select the component name that defines the list of values to use for validation. See: Managing Components.

  6. For group validation or Java validation, specify the following validation details.

    • Enter the validation entity for the group.

    • Select the component name that defines the list of values to use for validation. See: Managing Components.

  7. For key flexfield or key flexfield ID validation, specify the following validation details.

    • Select the key flexfield to use for validation.

    • Enter the validation entity for the group. The default validation entity is oracle.apps.bne.integrator.validators.BneKFFValidator.

    • Select Yes or No to indicate whether the key flexfield segment values should be concatenated.

    • Select the component name that defines the list of values to use for validation. See: Managing Components.

  8. Select the attributes you want in the Available list and move them to the Selected list.

  9. Choose Apply.

  10. In the Interfaces: View Groups region, to display the attributes that belong to a group, choose the Details icon for the group.

  11. To remove an attribute from the group, choose the Ungroup icon for the attribute in the group attributes list.

  12. To add more attributes to the group, choose the Add to Group icon for the group in the list of groups.

  13. After you finish managing interface attribute groups, choose Return to Interfaces.

To define contents

A content is a set of metadata that determines what data the integrator uses to populate the desktop document that it creates. Use the Contents page of the integrator definition wizard to manage and create contents.

Contents Page

the picture is described in the document text

  1. The Contents page displays the list of contents defined for the integrator.

    • To update the name of a content, enter the new name in the Content Name field.

    • To delete a content, choose the delete icon for that content.

    • To create a new content, select the Create Content button. The Create Content region appears.

    Create Content Region

    the picture is described in the document text

  2. In the Create Content for Integrator region, enter the content name.

  3. Select the content type, either Java, SQL query, or text file.

    • For a Java content, enter the Java class that returns the Oracle E-Business Suite data you want to download, and the number of arguments for that Java class. Oracle E-Business Suite Desktop Integration Framework creates a content column for each argument. You can include logic in your Java class to perform additional processing on the downloaded data before inserting the data into the desktop document.

    • For a SQL query content, enter in the Query field the query code that selects the Oracle E-Business Suite data you want to download.

      Note: The maximum length of the query is 4,000 characters. If you enter a longer query, Oracle E-Business Suite Desktop Integration Framework truncates the query after 4,000 characters. It is recommended that you remove any extra spaces from the query if necessary to reduce its length.

      Choose the Test Query button to validate the query syntax. If the query is not valid, Oracle E-Business Suite Desktop Integration Framework displays the Oracle syntax error that was found in order to help you correct the query.

      When the SQL query content is saved, Oracle E-Business Suite Desktop Integration Framework creates a content column for each column selected in the query.

      Note: The SQL query for a content can include additional parameters whose values can be modified or entered by the end user when the integrator is run. The query can also include conditions based on environment variables or on functions such as SYSDATE. When preparing the query to be run, Oracle Web Applications Desktop Integrator parses the query and replaces any parameters and environment variables with the appropriate values.

      The syntax for a parameter is:

      $param$.<parameter_name>

      The syntax for an environment variable is:

       $env$.<variable>

      The environment variables supported for use within a SQL query are:

      • $env$.appid
      • $env$.userid    
      • $env$.language    
      • $env$.respid    
      • $env$.sessionid

      This sample query shows an example of including an environment variable and a parameter in the query conditions.

      SELECT 
   APPLICATION_ID,
   INTEGRATOR_CODE,
   ENABLED_FLAG,
   UPLOAD_PARAM_LIST_APP_ID,
   UPLOAD_PARAM_LIST_CODE,
   UPLOAD_SERV_PARAM_LIST_APP_ID,
   UPLOAD_SERV_PARAM_LIST_CODE,
   IMPORT_PARAM_LIST_APP_ID,
   IMPORT_PARAM_LIST_CODE,
   UPLOADER_CLASS,
   DATE_FORMAT,
   IMPORT_TYPE,
   CREATE_DOC_LIST_APP_ID,
   CREATE_DOC_LIST_CODE,
   NEW_SESSION_FLAG,
   USER_NAME,
   UPLOAD_TITLE_BAR,
   UPLOAD_HEADER,
   LAYOUT_RESOLVER_CLASS,
   LAYOUT_VERIFIER_CLASS,
   SESSION_CONFIG_CLASS,
   SESSION_PARAM_LIST_APP_ID,
   SESSION_PARAM_LIST_CODE,
   DISPLAY_FLAG,
   SOURCE
FROM BNE_INTEGRATORS_VL WHERE APPLICATION_ID = $env$.appid AND USER_NAME LIKE $param$.INTG_USER_NAME_PARAM

    • For a text file content, enter the number of columns that the text file contains. Oracle E-Business Suite Desktop Integration Framework creates a content column for each column in the text file.

  4. If you want to use this content only for downloading data from Oracle E-Business Suite to the desktop, select the Reporting Only option.

  5. Choose Apply.

  6. In the Contents page, select a content in the list to display its details including the content columns and parameter list.

  7. Expand the Content Columns region to view the columns that were automatically created for the content. You can optionally update the display name for each column. You can also select the Read Only option to specify that the column is read-only and cannot be updated.

    You can also optionally add columns to the content. For example, you can add columns if the Java class has been updated to include additional arguments, if you need to update the SQL query to select additional columns, or if the text file has been updated to include additional columns.

    • For a Java content or a text file content, choose Add Column. The new column will be added at the end of the list of columns for the content.

    • For a SQL query content, select Add Columns. In the popup window that appears, review the existing SQL query and enter a comma-separated list of column names or expressions that you want to add to the SELECT clause of the query. Then choose Save. The new columns will be added at the end of the SELECT clause.

    Oracle E-Business Suite Desktop Integration Framework displays the details for each newly added column at the end of the list in the Content Columns region.

    After you add a column to a content for an existing integrator, you should also update the layout for the integrator as needed to accommodate the new column. If this integrator allows uploading data to Oracle E-Business Suite, ensure that you also update the interface and mapping as needed. For a reporting-only integrator, Oracle E-Business Suite Desktop Integration Framework automatically updates the default placeholder interface and adds the new mapping line when you add a column to a content.

    Contents Page - Content Columns Region and Content Parameters Region

    the picture is described in the document text

  8. If the content requires additional parameters, select a parameter list in the Content Parameters region. See: Managing Parameters.

    Note: For a text file content, you can optionally define parameters that let you specify default values for the character to use as the file delimiter, whether to ignore consecutive delimiters, and the line at which to start importing. If you choose to use these parameters, you must include them in the parameter list associated with the text file content. See: To define a parameter list to specify handling for a text file content.

    Users can override the default values for these parameters when creating a document. See: Creating a Spreadsheet, Oracle Web Applications Desktop Integrator Implementation and Administration Guide.

  9. To proceed to the Uploader page, select Next, or to save this integrator definition without defining an uploader or importer, select Submit.

To define an uploader

An uploader is a set of metadata that determines what options are available to a user in the upload parameters window when the user uploads data from a desktop document to Oracle E-Business Suite. Use the Uploader page of the integrator definition wizard to create and manage the uploader for an integrator.

Note: If you selected the Reporting Only option for this integrator, then you do not need to define an uploader.

  1. If an uploader has not yet been defined for the integrator, then the Uploader page displays the Uploader field.

    Uploader Page with Uploader Field

    the picture is described in the document text

    In the Uploader field, select the method by which to create the uploader.

    • None - Select this option if you do not want to use this integrator to upload data from a desktop document to Oracle E-Business Suite. In this case no uploader is created. To proceed to the Importer page, select Next, or to save this integrator definition without defining an importer, select Submit.

    • From Template - Use the standard template provided by Oracle E-Business Suite Desktop Integration Framework as the basis for the uploader definition. After selecting this option, choose the Create button to create the uploader.

    • Copy From Existing Definition - Use the definition of an existing uploader from another integrator as the basis for the uploader definition. After selecting this option, select the existing uploader definition that you want to copy. Then choose the Create button to create the uploader.

      Note: You can copy an uploader definition only from another integrator that belongs to the same application as the integrator you are defining.

    Uploader Page

    the picture is described in the document text

  2. In the Uploader page, specify the display name of the uploader. The default name is <Integrator Name> - Uploader. You can optionally enter a different name.

  3. To delete the existing uploader definition for the integrator, choose the Delete Uploader button. The Uploader page then displays the Uploader field to let you either create a new uploader or proceed without defining an uploader.

  4. To preview how the upload parameters window will be displayed to users based on the current uploader definition, choose the Preview button.

  5. In the Uploader Parameters region, specify the title that should appear in the browser title bar of the upload parameters window. The default title is Upload Page. You can optionally enter a different title.

  6. Specify the header that should appear within the upload parameters window. The default header is Upload Parameters. You can optionally enter a different header.

  7. If you created this uploader using the standard template, then Oracle E-Business Suite Desktop Integration Framework automatically creates the following parameters:

    • Rows to Upload (bne:rows) - Determines whether to upload all rows in the spreadsheet, or only those rows marked with an upload flag. Oracle Web Applications Desktop Integrator marks all changed rows with an upload flag.

    • Validate Before Upload (bne:validation) - Determines whether to validate data before uploading the data to Oracle E-Business Suite.

    • Automatically Submit Import (bne:import) - Determines whether to submit an import process to move the uploaded data from Oracle E-Business Suite interface tables to base application tables automatically after the upload. If you include this parameter, then you should define an importer for this integrator to specify the import process that will be submitted.

    • Commit Rows (bne:commitrows) - Determines whether to commit the uploaded rows only if all the rows are valid, or commit each uploaded row that is valid, even if other rows are invalid.

    If you created this uploader as a copy of an existing uploader definition, then Oracle E-Business Suite Desktop Integration Framework automatically creates copies of all the parameters defined for the existing uploader.

    You can update or delete any of the automatically created parameters or define additional parameters as needed.

  8. You can update some parameter details directly in the Uploader Parameters region.

    • Enter the display name for the parameter.

    • Select whether the parameter is displayed in the upload parameters window.

    • Select whether the parameter is enabled for users to enter a value in the upload parameters window.

    • Select whether users are required to enter a value for the parameter in the upload parameters window.

    You can also choose the update icon or the view icon for a parameter to view and update additional parameter details. See: To define an upload parameter.

  9. To delete a parameter, choose the delete icon for that parameter.

  10. To define a new upload parameter, choose the Add Parameter button. See: To define an upload parameter.

    Note: If you plan to define an importer for this integrator, you should define the Automatically Submit Import (bne:import) upload parameter within the uploader to enable the import process to be submitted automatically after the upload.

  11. To change the order in which the parameters appear in the upload parameters window, choose the Reorder button. Select one or more parameters in the list, and use the arrow buttons to move those parameters to the desired position. Then choose Apply.

    Note: You can only reorder parameters when the list contains two or more parameters.

  12. To proceed to the Importer page, select Next, or to save this integrator definition without defining an importer, select Submit.

To define an upload parameter

Uploader: Define Upload Parameter Page

the picture is described in the document text

  1. In the Uploader: Define Upload Parameter page, optionally select an existing parameter definition to copy. The remaining fields in the page then display the values copied from that parameter. You can update these values as needed.

  2. Enter a unique internal name for the parameter.

  3. Enter the display name for the parameter.

  4. Select the data type of the parameter: String, Number, Date, Boolean, or Key Flexfield.

  5. Select the category to which the parameter belongs.

    • Miscellaneous

    • Position

    • Appearance

    • Behavior

    • Data

    • Field

  6. Optionally enter a default value of the appropriate data type for the parameter.

    • For Boolean parameter, select either Yes or No as the default value.

    • For a key flexfield parameter, select the flexfield structure. The Default Value region displays the ID of the application to which the flexfield belongs and the numerical ID for the flexfield.

  7. If you entered a default value, enter a description for that value.

  8. Select the validation type for the parameter: None, Value Set, Fnd Lookup, or Bne Query.

  9. Depending on the selected validation type, enter the value set, lookup type, or SQL query against which you want to validate the parameter value.

    For a SQL query, select whether you want to use a simple or complex query.

    • For a simple query, you can enter the following common query details and let Oracle E-Business Suite Desktop Integration Framework generate the complete query syntax for you.

      • A list of one or more tables from which to select data, separated by commas

      • The ID column to select, and an alias for that column

      • The meaning column to select, and an alias for that column

      • The description column to select, and an alias for that column

      • A list of additional columns to select

      • A WHERE clause that specifies the conditions defining the data to select

      • A list of the columns by which the query results should be ordered

    • For a complex query, you must enter the complete query syntax yourself.

    After entering the query, choose the Validate Query button to validate the query syntax.

  10. Select whether the parameter is displayed in the upload parameters window.

  11. Select whether the parameter is enabled for users to enter a value in the upload parameters window.

  12. Select whether users are required to enter a value for the parameter in the upload parameters window.

  13. Optionally enter a prompt to appear to the left of the parameter.

  14. Optionally enter a prompt to appear above the parameter.

  15. Optionally enter a hint to display to provide users further guidance on the parameter.

  16. Select the display type for the parameter.

    • For a string parameter, you can select Check Box, Radio Button, List Box, Text Area, or Password.

    • For a number or date parameter, you can select Radio Button, List Box, Text Area, or Password.

    • For a Boolean parameter, you can select Check Box, Radio Button, List Box, or Text Area.

    • A key flexfield parameter must use the Text Area display type.

  17. If you selected the display type Radio Button, select whether the radio buttons should be displayed in a vertical or horizontal style.

  18. Enter the maximum size for the parameter value.

  19. Enter the display size for the parameter value. The display size must be equal to or less than the maximum size.

  20. Choose Apply.

To define an importer

An importer is a set of metadata that determines how Oracle Web Applications Desktop Integrator moves uploaded data from Oracle E-Business Suite interface tables to base application tables. Use the Importer page of the integrator definition wizard to define the importer for an integrator.

Ensure that you define the uploader for an integrator before defining an importer. Additionally, ensure that you define the Automatically Submit Import (bne:import) upload parameter within the uploader to enable the import process to be submitted automatically after the upload.

Note: If you selected the Reporting Only option for this integrator, then you do not need to define an importer.

Importer Page: Importer Type

the picture is described in the document text

  1. In the Importer page, select the importer type.

    • Asynchronous concurrent request - Oracle Web Applications Desktop Integrator submits the specified concurrent program after completing the upload and returns the concurrent request ID to the user, but does not wait for the import program to complete. This importer type reduces user wait time by deferring the import process, and gives system administrators more flexibility in load balancing the resources involved in importing data. However, users may need to verify later that the import completed successfully.

      If you select this importer type, it is recommended that you define pre-import rules to validate the data at the time of upload. If the pre-validation fails, then Oracle Web Applications Desktop Integrator does not upload the data to the interface tables or invoke the import program, but returns an error message to the user instead.

    • Synchronous concurrent request - Oracle Web Applications Desktop Integrator submits the specified concurrent program after completing the upload, waits for the program to complete, and then returns the results to the user. This importer type gives users immediate feedback about the success of the import, but can increase the load on resources as well as user wait time.

    • PL/SQL API - Oracle Web Applications Desktop Integrator calls the specified API after completing the upload, waits for the API processing to complete, and then returns the results to the user. This importer type gives users immediate feedback about the success of the import and partly reduces user wait time by bypassing the concurrent processing queue. However, it can increase the load on resources.

    Importer Page

    the picture is described in the document text

  2. Enter a unique name for the importer.

  3. If you want to perform validation or other processing before the import process, choose the Add Rule button in the Pre-Import Rules region. See: To define a pre-import rule.

  4. To update a pre-import rule, choose the update icon for that rule. See: To define a pre-import rule.

  5. To delete a rule, choose the delete icon for that rule.

  6. The Importer Rules region displays a list of possible rule types for the import process itself, according to the importer type. An asterisk marks required rule types.

    • To define an importer rule, choose the define/update icon for that rule type.

    • To delete a rule definition, choose the delete icon for that rule type. The rule type still appears in the list to let you create a new rule definition later if you choose.

  7. To save the integrator definition, select Submit.

To define a pre-import rule

Use pre-import rules to specify validation or other processing that you want to perform on the data being uploaded before importing the data into application base tables. A pre-import rule can perform a SQL query, call a PL/SQL function or procedure, or retrieve the next value of a database sequence.

Importer Page: Pre-Import Rule

the picture is described in the document text

  1. Enter a unique name for the pre-import rule.

  2. Enter a description for the rule.

  3. Select the rule type: SQL Query, PL/SQL API Function, PL/SQL API Procedure, or Sequence.

  4. For a SQL query rule, enter the query. Choose the Test Query button to validate the query syntax.

  5. For a PL/SQL function rule, enter the package name and function name, and specify whether the API returns an error message or an FND message code if it encounters an error.

  6. For a PL/SQL procedure rule, enter the package name and procedure name, and specify whether the API returns an error message or an FND message code if it encounters an error.

  7. For a sequence rule, enter the sequence name. You can optionally also enter a unique reference name by which subsequent rules can refer to this sequence.

  8. Choose Apply. For a SQL query, PL/SQL function, or PL/SQL procedure rule, Oracle E-Business Suite Desktop Integration Framework displays additional details depending on the rule type.

  9. For a SQL query rule, the page displays a list of the columns selected by the query. You can optionally enter a unique reference name for each column by which subsequent rules can refer to the column.

    The page also displays a list of the parameters used in the query.

    • You can optionally enter a unique reference name by which subsequent rules can refer to the parameter.

    • Select the data type for the parameter.

    • Specify the source from which the parameter value will be obtained: Environment Variables, Import, or Upload Parameters.

    • Specify the value based on the selected source. If the source is environment variables, enter the variable to use for the value, such as User ID, Application, Responsibility ID, or Language. If the source is Import, enter the interface attribute or reference parameter to use for the value. If the source is upload parameters, enter the upload parameter to use for the value.

  10. For a PL/SQL function rule, if the function returns more details about any error that it encounters, select the Returns Error Information option.

  11. For a PL/SQL function or procedure rule, specify whether the API returns an error message or an FND message code if it encounters an error.

  12. For a PL/SQL function or procedure rule, the page displays a list of the parameters for the function or procedure.

    • You can optionally enter a unique reference name by which subsequent rules can refer to the parameter.

    • If the parameter is used to retrieve an error message, select the Error Message checkbox.

    • Optionally enter a default value for the parameter.

    • Specify the source from which the parameter value will be obtained: Environment Variables, Import, Interface Table, or Upload Parameters.

    • Specify the value based on the selected source. If the source is environment variables, enter the variable to use for the value, such as User ID, Application, Responsibility ID, or Language. If the source is Import, enter the interface attribute or reference parameter to use for the value. If the source is Interface Table, enter the interface table details. If the source is upload parameters, enter the upload parameter to use for the value.

    • Optionally specify a parameter list to use for key-value lookups.

    • Optionally enter a SQL clause to modify the value, such as TO_CHAR().

  13. Choose Apply.

    Note: If you no longer require this rule definition, you can choose the Delete button to remove it.

To define a group definition importer rule

Use a group definition rule to identify records in the interface table that should be imported together as a group. All other importer rules, except group definition rules and document row - interface attribute mapping rules, are repeated for each group of records in the interface table. An asynchronous or synchronous concurrent request importer submits a separate concurrent request for each record group

To identify the records that form a group, specify one or more interface attributes that together serve as a unique key for the group. All records in the interface table that have the same values in those interface attributes are treated as part of the group.

Importer Page: Group Definition Rule

the picture is described in the document text

  1. Choose the Add Row button.

  2. Select an interface attribute to identify the records in the group.

  3. Optionally repeat steps 1 and 2 to add further interface attributes to identify the records in the group. Each interface attribute you add narrows the group definition.

    To remove an interface attribute from the group definition, choose the delete icon for that attribute.

  4. Choose Apply.

    Note: If you no longer require this rule definition, you can choose the Delete button to remove it.

To define a document row: interface attribute mapping importer rule

Use a document row: interface attribute mapping rule to map rows in the desktop spreadsheet to records in the interface table. To define the mapping, specify one or more interface attributes that together serve as a unique key to match each spreadsheet row with the corresponding interface table record. In most cases the interface attributes that you specify should be the columns that make up the primary key of the interface table.

You can use this mapping to return individual error messages for any records that fail during import.

Note: If there are no columns in the interface table that can identify a one-to-one mapping between the spreadsheet rows and the interface table records, then you cannot report individual error messages for any failed records, only a general error message for the import process as a whole.

Importer Page: Document Row Interface Attribute Mapping Rule

the picture is described in the document text

  1. Choose the Add Row button.

  2. Select an interface attribute by which to identify a record.

  3. Repeat steps 1 and 2 to add further interface attributes as needed to identify a record uniquely.

    To remove an interface attribute from the unique key, choose the delete icon for that attribute.

  4. Choose Apply.

    Note: If you no longer require this rule definition, you can choose the Delete button to remove it.

To define a concurrent program request submission importer rule

Use a concurrent program request submission rule to specify what concurrent program to submit to perform the import, as well as how to obtain the parameter values for the program.

Importer Page: Concurrent Program Request Submission Rule

the picture is described in the document text

  1. Select the concurrent program to perform the import.

  2. Choose Apply.

  3. The page displays a list of the parameters for the program.

    • You can optionally enter a unique reference name by which subsequent rules can refer to the parameter.

    • If the parameter is used to retrieve an error message, select the Error Message checkbox.

    • Optionally enter a default value for the parameter.

    • Specify the source from which the parameter value will be obtained: Environment Variables, Import, or Interface Table, or Upload Parameters.

    • Specify the value based on the selected source. If the source is environment variables, enter the variable to use for the value, such as User ID, Application, Responsibility ID, or Language. If the source is Import, enter the interface attribute or reference parameter to use for the value. If the source is Interface Table, enter the interface table details. If the source is upload parameters, enter the upload parameter to use for the value.

    • Optionally specify a parameter list to use for key-value lookups.

    • Optionally enter a SQL clause to modify the value, such as TO_CHAR().

  4. Choose Apply.

    Note: If you no longer require this rule definition, you can choose the Delete button to remove it.

To define a PL/SQL API call importer rule

Use a PL/SQL API call rule to specify what PL/SQL API to call to perform the import, as well as how to obtain the parameter values for the API.

Importer Page: PL/SQL API Call Rule

the picture is described in the document text

  1. Select the API type, either PL/SQL Function or PL/SQL Procedure.

  2. For a PL/SQL function, enter the package name and function name, and specify whether the API returns an error message or an FND message code if it encounters an error.

  3. For a PL/SQL procedure, enter the package name and procedure name, and specify whether the API returns an error message or an FND message code if it encounters an error.

  4. Choose Apply. Oracle E-Business Suite Desktop Integration Framework displays additional details for the API.

  5. For a PL/SQL function, if the function returns more details about any error that it encounters, select the Returns Error Information option.

  6. Specify whether the API returns an error message or an FND message code if it encounters an error.

  7. The page displays a list of the parameters for the function or procedure.

    • You can optionally enter a unique reference name by which subsequent rules can refer to the parameter.

    • If the parameter is used to retrieve an error message, select the Error Message checkbox.

    • Optionally enter a default value for the parameter.

    • Specify the source from which the parameter value will be obtained: Environment Variables, Import, Interface Table, or Upload Parameters.

    • Specify the value based on the selected source. If the source is environment variables, enter the variable to use for the value, such as User ID, Application, Responsibility ID, or Language. If the source is Import, enter the interface attribute or reference parameter to use for the value. If the source is Interface Table, enter the interface table details. If the source is upload parameters, enter the upload parameter to use for the value.

    • Optionally specify a parameter list to use for key-value lookups.

    • Optionally enter a SQL clause to modify the value, such as TO_CHAR().

  8. Choose Apply.

    Note: If you no longer require this rule definition, you can choose the Delete button to remove it.

To define an error row definition importer rule

Use an error row definition rule to identify records that were not imported successfully. To identify the failed records, specify a SQL query that selects from the interface table. It is recommended to select all columns in the interface table by beginning the query with SELECT * to ensure that all necessary values are retrieved.

Importer Page: Error Row Definition Rule

the picture is described in the document text

  1. Enter the SQL query to identify failed records in the interface table. Choose the Test Query button to validate the query syntax.

  2. Choose Apply.

  3. Oracle E-Business Suite Desktop Integration Framework displays a list of the columns selected by the query. You can optionally enter a unique reference name for each column by which subsequent rules can refer to the column.

    The page also displays a list of the parameters used in the query.

    • You can optionally enter a unique reference name for the parameter by which subsequent rules can refer to the parameter.

    • Select the data type for the parameter.

    • Specify the source from which the parameter value will be obtained: Environment Variables, Import, Interface Table, or Upload Parameters.

    • Specify the value based on the selected source. If the source is environment variables, enter the variable to use for the value, such as User ID, Application, Responsibility ID, or Language. If the source is Import, enter the interface attribute or reference parameter to use for the value. If the source is Interface Table, enter the interface table details. If the source is upload parameters, enter the upload parameter to use for the value.

  4. Choose Apply.

    Note: If you no longer require this rule definition, you can choose the Delete button to remove it.

To define an error message lookup importer rule

Use an error message lookup rule to retrieve the error message to return to the user for records that were not imported successfully. Specify a SQL query that selects only one column, which should contain the error message. Oracle Web Applications Desktop Integrator runs the SQL query for each failed record in the interface table. You can reference the unique key defined in the document row - interface attribute mapping rule to match the individual failed records, with the spreadsheet rows, and use any error codes in the status column in the interface table for each record to retrieve the appropriate error message.

Importer Page: Error Message Lookup Rule

the picture is described in the document text

  1. Enter the SQL query to retrieve the error message. This SQL query should select only one column. Choose the Test Query button to validate the query syntax.

  2. Choose Apply.

  3. Oracle E-Business Suite Desktop Integration Framework displays a list of the parameters used in the query.

    • You can optionally enter a unique reference name for the parameter by which subsequent rules can refer to the parameter.

    • Select the data type for the parameter.

    • Specify the source from which the parameter value will be obtained: Environment Variables, Import, Interface Table, or Upload Parameters.

    • Specify the value based on the selected source. If the source is environment variables, enter the variable to use for the value, such as User ID, Application, Responsibility ID, or Language. If the source is Import, enter the interface attribute or reference parameter to use for the value. If the source is Interface Table, enter the table details. If the source is upload parameters, enter the upload parameter to use for the value.

  4. Choose Apply.

    Note: If you no longer require this rule definition, you can choose the Delete button to remove it.

To define a success message definition importer rule

Use a success message definition rule to specify a message to display to the user when the import process is submitted successfully. For an asynchronous concurrent request importer, Oracle Web Applications Desktop Integrator returns the success message after the import program is submitted, without waiting for the program to complete. For a synchronous concurrent request or a PL/SQL API importer, Oracle Web Applications Desktop Integrator returns the success message only after the import process completes and all records have been imported without error.

Importer Page: Success Message Definition Rule

the picture is described in the document text

  1. Enter the text of the success message.

  2. Choose Apply.

    Note: If you no longer require this rule definition, you can choose the Delete button to remove it.

To define a cleanup importer rule

Use a cleanup rule to specify cleanup processing to perform if errors occurred during any of the previous importer rules.

Importer Page: Cleanup Rule

the picture is described in the document text

  1. Select the type of cleanup processing to run: SQL Query, PL/SQL Function, or PL/SQL Procedure.

  2. For a SQL query, enter the query. Choose the Test Query button to validate the query syntax.

  3. For a PL/SQL function, enter the package name and function name, and specify whether the API returns an error message or an FND message code if it encounters an error.

  4. For a PL/SQL procedure, enter the package name and procedure name, and specify whether the API returns an error message or an FND message code if it encounters an error.

  5. Choose Apply. Oracle E-Business Suite Desktop Integration Framework displays additional details depending on the processing type.

  6. For a SQL query, the page displays a list of the columns selected by the query. You can optionally enter a unique reference name for each column by which subsequent rules can refer to the column.

    The page also displays a list of the parameters used in the query.

    • You can optionally enter a unique reference name for the parameter by which subsequent rules can refer to the parameter.

    • Select the data type for the parameter.

    • Specify the source from which the parameter value will be obtained: Environment Variables, Import, Interface Table, or Upload Parameters.

    • Specify the value based on the selected source. If the source is environment variables, enter the variable to use for the value, such as User ID, Application, Responsibility ID, or Language. If the source is Import, enter the interface attribute or reference parameter to use for the value. If the source is Interface Table, enter the table details. If the source is upload parameters, enter the upload parameter to use for the value.

  7. For a PL/SQL function, if the function returns more details about any error that it encounters, select the Returns Error Information option.

  8. For a PL/SQL function or procedure, specify whether the API returns an error message or an FND message code if it encounters an error.

  9. For a PL/SQL function or procedure, the page displays a list of the parameters for the function or procedure.

    • You can optionally enter a unique reference name for the parameter by which subsequent rules can refer to the parameter.

    • If the parameter is used to retrieve an error message, select the Error Message checkbox.

    • Optionally enter a default value for the parameter.

    • Specify the source from which the parameter value will be obtained: Environment Variables, Import, Interface Table, or Upload Parameters.

    • Specify the value based on the selected source. If the source is environment variables, enter the variable to use for the value, such as User ID, Application, Responsibility ID, or Language. If the source is Import, enter the interface attribute or reference parameter to use for the value. If the source is Interface Table, enter the table details. If the source is upload parameters, enter the upload parameter to use for the value.

    • Optionally specify a parameter list to use for key-value lookups.

    • Optionally enter a SQL clause to modify the value, such as TO_CHAR().

  10. Choose Apply.

    Note: If you no longer require this rule definition, you can choose the Delete button to remove it.