Custom Connectors

Custom connectors allow you to create additional types of data repositories based on a common set of properties. The custom connectors are based on supported Micro Focus IDOL connectors. Once created, custom connectors are available as source types.

TIP: Use of custom connectors assumes that you have a strong knowledge of the IDOL connectors and their configuration options.

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

Custom connectors 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 connector. If associations exist, you are notified when you attempt to delete the custom connector.

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

    The Custom Connectors page opens.

  2. Click NEW CUSTOM CONNECTOR.

    The New Custom Connector dialog opens.

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

    Option Description
    Type

    Enter a name for the type of custom connector.

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

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

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

    Set the icon to display for this custom connector 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 connector 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 connector. 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 (); click the remove icon () to remove a filter type.

    Click NEXT.

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

    Option Description
    Encrypted Specify whether the value for this option should be encrypted. Click the toggle to select (Toggle to select and deselect an option.) or deselect (Toggle to select and deselect an option.) 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. Check the documentation for the specific connector for more information about fields that support encryption.
    [name]

    Enter a name for the custom configuration option. This represents the parameter name within the configuration of the IDOL connector.

    Limits: Maximum 50 characters.
    [value]

    Enter a value to correspond to the configuration option

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

    Click NEXT.

  6. Complete the Repository Options for the new custom connector. You will have the option of defining these options for any repository that will be based on this custom connector. 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 connector.

    Option Description
    [name]

    Enter a name for the repository option. This represents the parameter name within the configuration of the IDOL connector.

    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 () 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 ().

  7. Click FINISH.

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

  1. On the Custom Connectors page, click the name of the custom connector you want to edit.

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

  2. Edit the custom connector as desired.

  3. Click FINISH.

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

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

    Action icons display in the right column.

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

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

    NOTE: If the custom connector 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 connector. Click OK to close the message.

    The selected custom connector is deleted.