Open Documentation Menu

Configuring the use cases in the web interface

Calling the configuration page

The easiest way to reach the configuration page is via the Linked pages of the d.ecs monitor for d.3 repositories process in d.ecs monitor.

Alternatively, you can directly access the configuration of d.ecs monitor for d.3 repositories via the following URL:

https://<base-address>/monwd3r<hostname>/config/repositories

Working with the configuration list

The first view shows the configuration list. On this page you will get an overview of all currently existing monitoring of the application. The table lists the following information:

  • Active: Indicates whether monitoring is currently being performed.

  • Title: The name of the monitoring.

    The name is composed of the values you assigned to the configuration. Thus, the name best describes the content of the configuration.

In edit mode, the New configuration button is additionally available. This button allows you to create new configurations.

Working with the detail view

Clicking on an entry of the configuration list opens the detail view of the corresponding configuration.

In the detail view of a configuration you can see the overview and make adjustments of all monitoring values. There are two ways to access the details pages:

  • Open the detail page via the configuration list.

  • Open the detail page in d.ecs monitor in the Actions section.

In the menu bar of the configuration, in the edit mode, you can test the current configuration values via the push button Execute test.

Overview of the function values

The values have the following meanings:

  • Active: Allows you to disable or enable a configuration. Only one active configuration is monitored.

  • Repository: Settings for the d.3 repository to be monitored.

Within this form area, there is a jumping off point that can help you determine what inputs you need. Jump to different configurations of other apps using the corresponding icon. A valid base URI must be specified for this function in each case.

Note

These navigations only work if the currently logged in user can also access the linked configurations via d.ecs shell or d.ecs identity provider.

  • Base URI: The address of d.ecs http gateway where the d.3 repository is available.

  • API access key: An authorized access key from d.ecs identity provider. The permissions must allow access to the d.3 repositories.

    Here you can jump to the configuration of the access keys in d.ecs identity provider.

  • d.3 user name: The user name matching the specified API access key.

  • Type: The selection option in which way the d.3 repository is to be addressed.

    The type specifies against which of the following interfaces the test is to be made:

    • d.3one

      For the d.3one type, the test is performed against the d.3one interface.

    • d.3 server

      For the type d.3 server, the test is executed against the d.3 server interface.

  • Repository: The display name of the d.3 repository. A corresponding query within the dropdown menu lists all possible repositories for selection, if any are available based on the information given above.

Overview the use cases

You determine which actions are to be executed for testing or monitoring in the d.3 repository. For a repository, the individual use cases can be activated and configured as desired.

The following use cases are available for testing the connection of a d.3 repository:

  • Full text search for document ID

  • Property search for document ID

  • Full text search for term

  • Import, search and delete document

For all use cases, there is the following configuration:

  • Interval [min]: Here you specify the runtime of the monitoring of this use case. The information is given in minutes.

    The following minimum values are specified:

    • 1 minute for Full text search by document ID, Property search by document ID and Full text search by term.

      Note

      During each run of a search use case, the respective configured search is performed five times and the average value of the run times is determined.

    • 5 minutes when Import, search and delete document.

The following additional configurations are possible for the specific applications. The respective use case is explained in more detail via an info icon next to the use case title.

  • Full text search for document ID: In this use case, the full text search is monitored for a random document ID.

    Configure a range from range start to range end inclusive by specifying one document ID each. During each analysis run, a random document ID is determined within this range. According to this document ID a full text search is executed via API call.

  • Property search for document ID: In this use case, the property search is monitored for a random document ID.

    Configure a range from range start to range end inclusive by specifying one document ID each. During each analysis run, a random document ID is determined within this range. After this document ID an property search is executed via API call.

  • Full text search for term: In this use case, the full text search is monitored for a search term. Under Search term, enter the text to be searched for in an analysis operation.

  • Import, search and delete document: In this use case, several substeps are monitored.

    Under Document type short, specify the short name for the document type.

    Under File size, specify the desired file size in kilobytes. During each analysis run, a test document with generated content in the specified file size is first imported, then searched for and finally deleted.

    In the Currently used document ID field you can read the document ID that is used for this analysis run. This document ID is determined during the first execution and reused afterwards. For this to work, a release version is initially created for this document ID. For performance reasons and for the traceability of the measured values, the document ID is determined again after 1000 processes.

    Note

    If adjustments are made to the configuration, the document ID may have to be determined again. The generated test document, which is initially imported into the release, can be identified by the remark text "Test document for d.ecs monitor for d.3 repositories".

    Warning

    It is useful to check the document type for different prerequisites for the use case Import, Search and Delete Document:

    • If necessary, create a document type specifically for this use case. This way, no other document type will be filled with "non-relevant" documents.

    • The document type should not be configured for offloading to secondary systems.

    • There should be no connection to rendition and no hook functions.

    • The set user must have the right to import, search, share and delete edit versions of documents.