External services preferences

To enable integration with an external service, such as a FileNet Image Services (IS) library, you install and configure a resource adapter and then configure the External services site preference. When an external service is enabled, a user can add a file to an object store that resides in an external repository. The actual content of the file remains in the external repository and cannot be checked out or modified through the application. However, users can view the file and update its properties.

For example, to access files in a FileNet IS library on the same network, you install and configure the FileNet Image Services Resource Adapter (ISRA) on the Application Engine server. In the ISRA configuration, configure the Resource Adapter deployment descriptors so that the JNDI Name property is set to the symbolic name (domain name) of the FileNet Image Services library that you want to access. For example, if your library name is atlas:Pacific, enter atlas.

NOTE  You must install the appropriate resource adapter software before you configure the settings.

Service Name

Each configured external service is listed with a brief description. You can add a new external service or modify or delete an existing service.

To configure an external reference service

  1. Navigate to Site Preferences > External Services.
  2. Click Add New, or click Modify below the name of an existing service. Enter the external services information, using the following table as a guide.
    General Information Description Example using a FileNet IS library as an external service (Workplace only)
    Service Display Name The service name that displays in the Type field of the Select File step when you add or check in a document.

    Image Service

    "Image Service" displays in the Type (of file) column.

    Service Location for Redirect

    The external service vendor's servlet used to retrieve content.

    For a vendor external service, enter the name of the servlet supplied by the vendor.

    For IS, use either of the following methods:

    • getISContent
      (To use the servlet on the server hosting Workplace.)
    • http://otherAppEngine:port
      /Workplace/getISContent

      (To use a servlet on another application server.)
    Referenced Content Type MIME type supplied by the resource vendor (tells Content Engine that this is an external document and identifies the type of document).

    application/x-filenet-external-is

    (MIME type for the FileNet ISRA.)

    Show on Select File page Shows or hides the external service option in the Select File step when you add or check in a document.

    Show

    Select Show to include Image Services on the Add New Document and Checkin Document wizard pages.

    Requires Token Determines whether a user token is passed to the external service to allow access without forcing the user to log in to the service. The default is No.

    Yes

    Select Yes to automatically pass the user credentials to Image Services.

    Include Redirect Flag

    Determines whether the IgnoreRedirect property setting for the document is appended to the Web address. When this value is set to Yes and the IgnoreRedirect property for the document is true, the document content is not redirected to another application but displays in the browser. The default is Yes.

    This preference interacts with the settings in the content_redir.properties file on the Application Engine server. See content_redir.properties file for more information on specifying which files open in which application.

    Yes

    When this value is set to No, the content_redir.properties file on the Application Engine server determines whether the document is opened in the Image Viewer or the browser. The default settings in this file redirect image types (such as BMP, JPG, TIFF, and COLD) to the Image Viewer.

    URI Information (W3C RFC 2396 schema) Description Example
    URI <scheme>:<abs_path> The absolute path to the external resource. The format is scheme:abs_path

    filenet:/is

    Parameterized URI

    An ordered list of the parameters, defined in Parameters {0} through {3}. The format is ?query.

    Enter the parameterized URI without spaces or line breaks.

    ?libraryName={0}&id={1}
    &objectType=document
    &pageNumber={2}

    Defines the fields, as shown in the examples below according to the RFC 2396 schema.

    Parameter {0} display name The first of up to four parameters that display next to the entry fields for the external service when you add or check in a document.

    Library Name

    "Library Name" is the field label. The user is expected to enter a library name.

    Optional format hint for {0} A text hint, or description, for parameter {0}. It appears under the first field.

    (for example, SolarImages)

    Displays this text as a hint under "Library Name."

    Parameter {1} display name The second of up to four parameters that display next to the entry fields for the external service when you add or check in a document.

    Document ID

    "Document ID" is the field label. This field requires the document ID.

    Optional format hint for {1} A text hint, or description, for parameter {1}. It appears under the second field.

    (for example, 123456)

    Displays this text as a hint under "Document ID ."

    Parameter {2} display name

    The third of up to four parameters that display next to the entry fields for the external service when you add or check in a document.

    Page Number

    "Page Number" is the field label. For IS, the user enters a specific page number or a "0" to retrieve all pages.

    Optional format hint for {2} A text hint, or description, for parameter {2}. It appears under the third field.

    (enter a page number, or 0 to retrieve all)

    Displays this text as a hint under "Page Number ."

    Parameter {3} display name The fourth of up to four parameters that display next to the entry fields for the external service when you add or check in a document.

    Not used for IS.

    Optional format hint for {3} A text hint, or description, for parameter {3}. It appears under the fourth field.

     

  3. Save your changes.