Data Pipeline Admin Dashboard Portal - DocConnector Configuration

Capabilities

From the Data Pipeline Admin Dashboard Portal, administrators can:

• Onboard new tenants by providing and saving the required configuration details. The capability allows administrators to use the legacy JSON configuration to preload the values.

• View all tenants and review their current configuration status based on the latest available information.

• Update configuration settings for existing tenants.

• Remove tenants that are no longer required.

• Track the onboarding progress of each tenant, from initial setup to full activation.

Accessing the Data Pipeline Admin Dashboard Portal

To use the portal, users must be assigned the Data Pipeline Admin role in CONNECT. Once assigned, you can manage Document Connector configurations and monitor tenant lifecycle states.

The Document Connector Configuration option is available on the left navigation menu. This is available directly in the dashboard for users with the appropriate access role, enabling monitoring and configuration management in a single location. If you do not have the Data Pipeline Admin role, you cannot view this option.

Viewing Document Connector Configuration

The initial view of the Data Pipeline Admin Dashboard displays all assets that the user has access to. For more information about assets, refer View Reports by Asset.

After selecting an asset, you are redirected to a detailed view where Document Connector Configuration and Audit options are available.

Document Connector Configuration

When Document Connector Configuration is selected, two tabs are displayed:

• Tenants (default)

• Requests

Tenants tab

The Tenants tab lists all tenants for the selected asset. Each tenant represents a connection to the respective DMS system.

Tenants Details

For each tenant, the following information is displayed:

• Tenant Name – The tenant's name defined during onboarding. It is recommended to use a unique name for easy identification of tenant.

• Source Type – The configured DMS source type. Supported source types are: Assai, Aconex, SharePoint Graph API and OpenText

• Last Successful Runtime – The last time the job ran successfully.

• Scheduled Job – The scheduled frequency at which the tenant runs. This follows the standard cron job format.

• State – The current state of the tenant.

• Enabled – Indicates whether the tenant is enabled or disabled.

• Actions – Available actions, such as Delete tenant.

Scheduled Job

The Scheduled Job defines how often the Document Connector runs for a tenant.

• The minimum supported execution frequency is every 4 hours.

• Scheduling is defined using a standard cronjob format.

Cronjob

A cronjob schedule consists of five values, read from left to right, that define when a job runs:

• Minute – when within the hour the job runs

• Hour – the hour of the day

• Day of month – the day of the month

• Month – the month of the year

• Day of week – the day of the week

Each value can be a specific number or * to indicate every.

Supported cronjob

Examples:

• Runs every 4 hours, every day: 0 */4 * * *

• Runs every day at 04:00 AM: 0 4 * * *

• Runs every day at 08:00 AM:0 8 * * *

• Runs on a specific date (for example, February 1st on a Monday at 04:00): 0 4 1 2 1

  Note: AVEVA recommends using a repetitive schedule instead of a specific date as it allows capturing any new data automatically.

Tenant List Navigation and Controls

• Back to assets – Returns to the asset list.

• Refresh – Reloads the current view.

• Filter – Filters the tenant list.

• Pagination – Navigation to next page

  

Tenant Filters

• Tenant Name – Enter part of the tenant's name and press Return (for example, products).

  

• Date – Filter by date.

  

• State – Select one or more tenant states. Click outside the list to apply.

  

• Source – Select one or more DMS sources. Click outside the list to apply.

  

To remove filters, select the remove icon for a filter or choose Clear all.

Tenant Actions

• Add Tenant – Select the Add tenant button.

• Delete Tenant – Select the delete icon in the Actions column for the corresponding tenant.

  

Sorting and Time Zone

Certain columns support sorting. Select a column header to sort the data. All timestamps are displayed in UTC.

Requests Tab

The Requests tab displays tracking information for onboarding and management requests until the tenant is fully onboarded. Results are shown in a paginated list.

Request Details

For each request, the following information is displayed:

• Request ID – The request identifier in the AVEVA system.

• Tenant Name – The tenant's name provided during onboarding.

• Message – A short status message.

• Command Type – The command executed for the tenant.

  

• State – The current state of the request.

  

• Created By – The email address of the user who initiated the request.

• Last Updated – The date and time the request was last processed.

• Payload – The configuration used for the executed command.

Requests List Navigation and Filters

• Back to assets – Returns to the asset list.

• Refresh – Reloads the current view.

• Filter – Refines the request list.

• Payload – Select the eye icon to view the request configuration.

• Pagination – Navigation to next page

  

Request Filters

• Tenant Name – Enter a partial tenant name and press Enter (for example, power).

• Created by – Enter part of an email address and press Enter.

• Date – Filter by creation or update date.

• State – Select one or more request states.

• Command Type – Select one or more command types.

To remove filters, select the remove icon for an individual filter or choose Clear all button.

Sorting and Time Zone

• Certain columns support sorting. Select a column header to sort the data.

• All timestamps are displayed in UTC.