Consuming the Hyland Adapter - Enterprise Integration Server - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - Standard - external - Standard - Premier

Enterprise Integration Server
Platform
OnBase
Product
Enterprise Integration Server
Release
Foundation 23.1
License
Standard
Premier

To consume the Hyland Adapter from a BizTalk Server project in Visual Studio:

  1. Select the Solution Explorer tab.
  2. Right-click the name of the project.
  3. Select Add | Add Generated Items.
  4. In the Add Generated Items dialog box, in Installed Templates, select Consume Adapter Service. Then, select Consume Adapter Service:
  5. Click Add.
  6. The Consume Adapter Service dialog box is displayed:
  7. From the Select a binding drop-down list, select hylandAdapterBinding.
  8. Click Configure.
  9. The Configure Adapter dialog box is displayed:
  10. On the Security tab, configure the following:

    Security

    Description

    Client credential type

    Select Username from this drop-down list.

    User name

    Type the name of the OnBase Service Account.

    Password

    Type the password of the OnBase Service Account.
    Note:

    For more information on OnBase Service Accounts, see the System Administration documentation.

  11. Select the URI Properties tab, and configure the following:

    URI Properties

    Description

    Application

    Type the virtual directory of the OnBase Application Server. For example, appserver.

    DataSource

    Type the name of the OnBase database.

    EnableSSL

    If the OnBase Application Server requires an HTTPS binding, set this to True. If the OnBase Application Server does not require an HTTPS binding, set this to False.

    Hostname

    Type the name of the OnBase Application Server.

    Port

    Type the number of the port that will be used by the adapter to connect to the Application Server. If EnableSLL is set to True and the Port is left blank, it will be set to 80 by default. If EnableSLL is set to False and the Port is left blank, it will be set to 443 by default.
    Note:

    The additional options available on this tab allow you to configure your solution to work with Microsoft Windows Azure. For more information, see Configuration for Windows Azure.

  12. Select the Binding Properties tab, and configure the following:

    Binding Properties

    Description

    AllowAutoFillExpansion

    When creating E-Forms with the E-Form Create operation, this binding property controls whether AutoFill Keyword Sets used on E-Forms should be automatically expanded when the primary Keyword Type is received.

    When set to True, AutoFill Keyword Sets used on E-Forms are automatically expanded when the primary Keyword Type is received. Secondary Keyword Types do not appear in the schema.

    When set to False, AutoFill Keyword Sets used on E-Forms are not automatically expanded when the primary Keyword Type is received. You are required to map all Keyword Types in the schema.

    For more information on using AutoFill Keyword Sets on E-Forms, see Enterprise Integration Server E-Form Design Overview.

    EnableSafeTyping

    This option controls whether or not safe typing is enabled. When EnableSafeTyping is set to True, EIS will be able to pass Keyword Types that use the following data types:

    • Date

    • Date & Time

    • Currency

    • Specific Currency

    If EnableSafeTyping is set to False, EIS will not be able to pass Keyword Types that use those data types.

    MaxDocumentsPerCall

    The option specifies the number of documents received by the adapter every time it polls the Application Server. By default, this option is set to 1000.

    PollingInterval

    The interval (in milliseconds) between each instance of the Hyland Adapter polling the OnBase Application Server for document notification events.

    RespectDocumentLock

    The option specifies the desired behavior when attempting to update OnBase documents that have been locked. By default, EIS will ignore locks and update the document. If this option is set to true and EIS encounters a lock when trying to update, the update will not occur due to the lock and a response = 2 will be returned.

    UseCanonicalSchema

    Set this option to true to configure the Hyland Adapter for use with the Web Services Publishing module. When this option is set to true, only operations with canonical schemas can be generated. The EIS Operations list is populated with web services that have been created using the Web Publishing tab within Studio, even if those web services have not actually been published. See the Web Services Publishing documentation for more information on creating web services.

    Using canonical schemas also allows you to more easily move an EIS project from one data repository to another by exporting the WSP project in Studio then importing it into the new environment (for example, a test environment to a production environment). You then only need to update the endpoint within the BizTalk application.

    This is because XML elements in the BizTalk binding generated by consuming the Hyland Adapter match up to object names within Web Services Publishing, not to literal object identifiers such as Document Type numbers or Keyword Type numbers (as with non-canonical schemas).

    Set this option to false to configure the Adapter for use with standard EIS. When this option is set to false, only non-canonical operations with strongly named schemas can be generated.
    Note:

    The additional options available on this tab allow you to configure your solution to work with Microsoft Windows Azure. For more information, see Configuration for Windows Azure.

  13. Click OK.
  14. Ensure that the Configure a URI field accurately reflects the information you entered on the URI Properties tab. For example, hyland://[Hostname]/[Application]/service.asmx?datasource=[DataSource]&EnableSSL=[EnableSSL setting].
  15. Click Connect to connect to the OnBase Application Server.
  16. After successfully connecting to the Application Server, your screen resembles the following:
    Note:

    If you modify your OnBase configuration using the OnBase Configuration module after connecting to the Application Server, you must disconnect from the Application Server and reconnect for configuration changes to be reflected on this screen.

  17. Select one of the following from the Select contract type drop-down list:

    • Client (Outbound operations)- Select to configure one of the operations and categories described in Outbound Operations.

    • Service (Inbound operations)- Select to configure one of the operations and categories described in Inbound Operations.

  18. In the Select a category pane, expand the EIS Operations node.
  19. Available categories and operations are displayed:
  20. In the Select a category pane, expand one of the operations described in Operations and select a category.
    Note:

    For Entity operations, parent Entity Types are displayed in the Select a category pane. Child Entity Types are not displayed.

    Note:

    For Workflow operations, life cycles and queues are displayed in the Select a category pane.

  21. The corresponding OnBase objects are displayed in the Available categories and operations pane:
    The Name column displays the name of the Enterprise Integration Server operation, followed by the name of the OnBase object. For example, Update AutoFill - AP - Checks Information. The Node ID column displays the name of the Enterprise Integration Server operation, followed by the OnBase object's numeric ID. For example, AutoFill/Update/117.
    For WorkView operations, the Name column displays the name of the Enterprise Integration Server category, followed by the name of the WorkView class. For example, Create - Work Order. The Node ID column displays the name of the Enterprise Integration Server operation, followed by the WorkView application's numeric ID, followed by the numeric ID of the WorkView class, followed by the name of the Enterprise Integration Server category. For example, WorkView/1001/1003/Create.
    For Entity operations, the Name column displays the operation, followed by the name of the entity. For example, Update - Agenda Item. The Node ID column displays the name of the Enterprise Integration Server operation, followed by the name of the module whose fields you are configuring, followed by the numeric ID of the Entity, followed by the name of the Enterprise Integration Server category. For example, Entity/agendaandminutes/25957/Update.
    For scan queue operations, the Name column displays the operation, followed by the name of the scan queue process option. For example, EISPreIndex.
    To filter the list of Available categories and operations, type search criteria in the Search in category field and click the corresponding search button:
    Search criteria can pertain to values in the Name or Node ID columns.
    Note:

    The asterisk character can be used to perform wildcard searches.

    Note:

    For WorkView operations, you cannot filter using the name of the WorkView application.

  22. Select an OnBase object from the Available categories and operations pane.
  23. To view the WSDL definition for the selected OnBase object, click Properties. The WSDL definition is an overview of the schema that the Hyland Adapter is going to be creating for the selected operation and OnBase object.
  24. To add the OnBase object, click Add.
  25. The OnBase object is displayed in the Added categories and operations pane:
  26. Repeat steps 20 through 25 to add additional objects.
    You can remove added objects by double-clicking them or selecting them in the Added categories and operations pane and clicking Remove. You can remove all added objects by clicking Remove All.
  27. Click OK to close the Consume Adapter Service dialog box.