Creating a New IDoc Mapping - Business Indexing Connector for use with SAP ArchiveLink - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Business Indexing Connector for use with SAP ArchiveLink

Business Indexing Connector for use with SAP ArchiveLink
Foundation 23.1

To create a new mapping:

  1. Click the Add IDoc button or select Action | Add.
  2. Open the appropriate IDoc Sample. See Opening IDocs for Configuration for more information.
  3. A NEW IDOC is displayed in the pane.
  4. Select the NEW IDOC. The following screen is displayed.
  5. Enter a descriptive name in the Name field.
  6. Enter an Id String. You can either type the name of the string or you can left-click on the string in the Sample IDoc window and drag it to the Id String field. The Id String is the root of the IDoc's fields.

    You can right-click in this field and cut or copy its contents and paste it into other fields.

  7. Enter the corresponding message type to the Message ID field.
  8. Select the Business Object Lookup tab.
  9. Enter the Link Table that contains information pertaining to links between OnBase documents and SAP business objects. You can configure overrides based on Sender IDs for multiple link tables. See Configuring Multiple Link Tables for more information on overrides. The SAP administrator will provide the necessary information concerning the appropriate link table.
  10. Drag the appropriate IDoc fields from the Sample IDoc window to the Object Key field. These fields compose the Object ID within SAP. The appropriate fields must be placed in the correct order within the Object Key field to identify the Object ID correctly. Click Add after the Object Key field is complete. You can add multiple Object Keys to the configuration by repeating this step until all Object Keys are added. If you want to receive any IDoc, you can add a blank Object Key to the configuration by clicking Add. You can remove an object key by selecting it and clicking Delete.

    In some instances, you must configure a complex key. See Configuring Complex Keys for more information.

  11. Select the Keyword Mappings tab.
  12. Create appropriate field mappings. Click the Add Mapping button or drag the appropriate field from the Sample IDoc window to the field box. You can edit a field by double-clicking on it.
  13. Double-click under the Keyword Type Name column next to the new field. A drop-down list containing the available Keyword Types in the OnBase system is displayed.
  14. Select the appropriate Keyword Type from the drop-down to which you want to map the IDoc field.
  15. Repeat steps 12-14 until all appropriate fields are mapped.
  16. When the configuration is completed, click the Save button.

    The customer's SAP administrator will prepare the object key to keyword type mapping.

The configuration is stored in the config.xml file. Where the config.xml file is stored is specified in <appSettings> within the web.config file found in the root of the ArchiveLink virtual directory. The following setting specifies where the file will be saved:

<add key="configFile" value="c:\inetpub\wwwroot\ArchiveLink\config.xml"/>

You can edit a mapping by selecting it, making appropriate changes, and saving.


Any time a change is made in the configuration tool, you must restart IIS or reset the cache of the OnBase Application Server for changes to take effect. In addition, any time the SAP system is restarted, you must restart IIS or reset the cache of the OnBase Application Server, as well as restart the BIC service.


Using the Reset Cache option in OnBase Configuration or the Reset Server Cache option in OnBase Studio may have a negative impact on system performance. Requests to the Application Server will be forced to wait until the cache is rebuilt before they can be processed. Depending on the size of the OnBase system, as well as the current server load, the performance impact of resetting the cache may be severe. To avoid performance issues, only reset the cache of the Application Server during off-peak hours. For more information about the Reset Cache option in OnBase Configuration, see the System Administration documentation. For more information about the Reset Server Cache option in OnBase Studio, see the Studio documentation.