Custom adapters

IMPORTANT: Consult File Analysis Suite support for guidance before creating custom adapters.

Custom adapters allow you to analyze and manage data that resides on systems outside of File Analysis Suite default support. A custom adapter allows you to build a connection between File Analysis Suite and any third-party data repository that offers programmatic connection using remote APIs or a client SDK.

You must create and deploy a dedicated File Analysis Suite processing agent service using the agent’s custom adapter framework. This allows on-premises agents to interact with the data using the source’s specific connectivity protocols. You will define the custom adapter properties required to instantiate, configure, and operate the custom adapter service

Custom adapters can be edited as needed. Any changes you make to the custom adapters affect existing sources and repositories based on the custom adapter.

Custom adapters that are associated with a source cannot be deleted. You must remove the association to the source (delete the source) before you can delete the custom adapter. If associations exist, you are notified when you attempt to delete the custom adapter.

  1. From the primary navigation panel, click Repositories > Custom Adapters.

    The Custom Adapters page opens.

  2. Click NEW CUSTOM ADAPTER.

    The New Custom Adapter dialog opens.

  3. Complete the General options for the new custom adapter.

    Option Description
    Type

    Enter a name for the type of custom adapter.

    Limits: Maximum 20 characters, alpha-numeric and underscore only.
    Display Name

    Enter a display name for the custom adapter. The display name is presented as a source type when creating a source.

    Limits: Maximum 50 characters.
    Adapter Port Enter a valid port number to be used by the custom adapter.
    Icon

    Set the icon to display for this custom adapter when it is enabled.

    Limits: Valid image file; will be resized to fit the space in the UI.

    Click UPLOAD to navigate to and select the desired icon.
    Disabled Icon

    Set the icon to display for this custom adapter when it is disabled.

    Limits: Valid image file; will be resized to fit the space in the UI.

    Click UPLOAD to navigate to and select the desired icon.

    Click NEXT.

  4. Optionally, add any desired Filter Types. The filter types represent document types to filter for as part of the adapter. Data items that match the defined filter types will be identified in repositories of the associated source and managed by File Analysis Suite.

    Option Description
    [type]

    (Optional) Type the name of the desired document type.

    Limits: Maximum 50 characters.

    To include additional filter types, click the add icon (add icon); click the remove icon (remove icon) to remove a filter type.

    Click NEXT.

  5. Complete the Adapter Configuration options for the new custom adapter. These options will be applied to all sources that will be based on this custom adapter and cannot be modified at the source or repository level. These options are not presented when you create a source based on a custom adapter.

    Option Description
    Encrypted Specify whether the value for this option should be encrypted. Click the toggle to select (Toggle select on) or deselect (Toggle select off) the option.

    • When enabled (selected), the values are encrypted and your entry is obfuscated (displays as ***) as you type the value for this option.

    • When not enabled (deselected), the values are not encrypted and display as plain text as you type the value for this option.

    IMPORTANT: Fields that support encryption, such as passwords, should be encrypted. Verify that the defined fields for the third-party data repository support encryption.
    [name]

    Enter a name for the custom configuration option. This represents the parameter name within the configuration of the third-party data repository.

    Limits: Maximum 50 characters.
    [value]

    Enter a value to correspond to the configuration option

    To include additional adapter configurations, click the add icon (add icon); click the remove icon (remove icon) to remove an adapter configuration.

    Click NEXT.

  6. Complete the Repository Options for the new custom adapter. You will have the option of defining these options for any repository that will be based on this custom adapter. These options are presented as part of the Primary Capture Rules when you create a repository for a source that is based on a custom adapter.

    Option Description
    [name]

    Enter a name for the repository option. This represents the parameter name within the configuration of the third-party data repository.

    Limits: Maximum 50 characters.
    [display name]

    Enter a display name to correspond to the repository option. The display name is presented as the option in the Primary Capture Rules when you create a repository.

    Limits: Maximum 50 characters.
    [selection type]

    Select whether this option is presented in the repository wizard as a Textbox (default), a Toggle, or as an Encrypted text box.

    If an encrypted text box, your entry for this option in the repository wizard is obfuscated (displays as ***).
    [description]

    Enter a description for this repository option. The description is presented as a tip (more information) for the option in the Primary Capture Rules when you create a repository.

    Limits: Maximum 250 characters..

    To include additional repository options, click the add icon (add icon).

  7. Click FINISH.

    The custom adapter is created and can be selected as a source type when creating a source.

  1. On the Custom Adapters page, click the name of the custom adapter you want to edit.

    TIP: You can also click or hover over the row of the desired custom adapter and then click the edit icon (edit icon).

  2. Edit the custom adapter as desired.

  3. Click FINISH.

    The custom adapter is updated as well as all sources and repositories associated with this custom adapter.

  1. On the Custom Adapters page, click or hover over the row for the custom adapter you want to delete.

    Action icons display in the right column.

  2. Click the delete icon (delete icon) associated with the desired custom adapter.

  3. In the confirmation dialog, click YES to confirm the action.

    NOTE: If the custom adapter is associated with one or more sources, you will see a notification. You must review your sources and delete any associated repositories and sources before you can remove the selected custom adapter. Click OK to close the message.

    The selected custom adapter is deleted.