Shinydocs Pro

Configure Shinydocs Pro Control Center for eDOCS

Requirements

  • Network connection to eDocs API

    • e.g. https://edocs.example.com:8443/edocsapi/

  • eDocs account with at least read permission for the content you want to analyze

There is no configuration required in eDocs beyond an account with appropriate access (minimum Read).

Add eDOCS as a source in Shinydocs Pro

  1. In Shinydocs Pro Control Center, select Add source. It is on the Overview page and the Sources page.

  2. On the New tab, select eDOCS, then select Next. To add another source to an eDOCS connection you already set up, use the Existing tab instead.

    cc-src-26-5-picker.png
  3. Enter your connection details:

    cc-src-26-5-edocs-connection.png
    • Connection name: leave as is, or enter a name of your own.

    • Server URL: the base URL of the eDOCS DM REST API, including the deployment path, for example https://edocs.example.com:8443/edocsapi.

    • User ID: the account with access to the eDOCS content you want to analyze.

    • Password: the password for that account.

    • Primary library (optional): the library the User ID logs on to, shown as Primary in the eDOCS web client. The server’s other (remote) libraries are reached through it. Leave it blank to log on to each library directly; this reaches only the libraries the User ID can log on to.

    • Document web link URL (optional): the base URL of the eDOCS web client, used for direct document links in the Catalog, for example https://edocs.example.com:8443/#/doc/{library}/{docnum}. Replace the host and port with yours; your eDOCS instance may use a different pattern.

    • Document web link action (optional): what a document link opens in the eDOCS web client: profile (the profile details), open (the document in the browser) or download.

    • Search Authentication Type (optional):

      • Hidden - Exclude from Search (default): eDOCS content is left out of Shinydocs Search. It is still in the Catalog.

      • Public - No Authentication Required: eDOCS content is fully searchable. Use this only if all of the content should be viewable by every user. Opening a result in eDOCS still asks the user to sign in with their own eDOCS account.

  4. Select Next. Control Center checks the connection before you continue. A source can only be added while an agent is online.

  5. Under Libraries & folders (optional), enter what to analyze. Use one entry per source:

    cc-src-26-5-edocs-source.png
    • A library name crawls the whole library, for example DOCS.

    • LIBRARY:FOLDERID crawls a single folder, for example DOCS:0123456.

    • Leave it blank to crawl all libraries.

    Select Add for another entry, or Add multiple to paste several at once. Leave Capture profile & custom columns selected to bring across the documents’ eDOCS profile fields and custom columns.

  6. Optionally, select More options to set the Schedule (Daily or None), then Return.

    cc-src-26-5-schedule.png
  7. Select Start analysis.

The new source runs the analysis set for eDOCS connections under Settings > Analysis. To change what runs for this source, open it from the Sources page. See Shinydocs Pro Control Center Guide.

Change the password

Control Center signs in to eDOCS with the User ID and Password of its service account. When that password changes, for example under your password policy, update it in Control Center straight away: crawls can’t sign in until you do.

In Control Center

  1. Go to Sources, find the group for the connection, and select Edit. You can also go to Settings > Connections, choose the connector, and select Edit connection.

  2. In Password, delete the asterisks (**********) and enter the new value. If you leave the asterisks, Control Center keeps the old value.

  3. Select Save changes. Control Center checks the new credential through an agent before saving, so an agent must be running. If the check fails, nothing is saved and the dialog shows the error.

The change applies to every source that shares the connection. Crawls that start after you save use the new credential, and nothing needs to change on the agents. To check the connection again later, select Run tests in Settings > Connections.

If the password is wrong, Control Center shows: eDOCS rejected the supplied username or password.