Data Pipeline Admin Dashboard - Edit Tenant

The onboarded tenants can be updated to adjust various behavioral settings, including the starting date, schedule, enable/disable status, tenant name, filtering options, and more. Each tenant in the system must remain unique, with uniqueness determined by criteria that differ depending on the connected DMS type, combined with the Connect Account ID and Connect Asset ID.

Uniqueness rules by DMS type:

• Assai: Project Code, Asset Code, Subclass Code, Context

• Aconex: Project Code, Context

• SharePoint with Graph API: Root Folder, Drive Name, Context

• SharePoint ACS: Root Folder, Context

• OpenText: Root Folder, Context

Uniqueness‑defining properties are locked and cannot be updated after onboarding. If changes are required, the existing tenant must be removed and a new tenant created.

Note: SharePoint ACS tenants cannot be modified as Microsoft is fully retiring SharePoint ACS as of April 2, 2026. For any changes, contact AVEVA Support.

Edit tenant

Existing tenants can be updated by clicking on the tenant's name on the Tenants tab.

After clicking on the tenant name the user is redirected to the Edit tenant page.

Edit disabled tenant

When editing a tenant which is disabled the user will be presented a message about the fact that by editing a disabled tenant will enable it.

 

Edit enabled tenant

If a tenant is currently enabled, its status can be changed to disabled when modifying its configuration only if it is not in a Running state.

On the Edit Tenant page under the Basic information view the tenant name, schedule a tenant, schedule a pull of data can be changed.

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

Schedule a 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 specified date as it allow capturing any new data automatically.

A tenant’s execution can be scheduled by specifying the desired schedule in the Scheduled Job field. The values entered in this field must follow the required scheduling format and rules.

Schedule the pull

A tenant can be configured to begin pulling documents and metadata starting from a specific date. This value must be entered in the StartDate field from the date time picker and must be provided in UTC format.

First Load

A tenant can be configured to perform a full pull of documents and metadata from the connected Document Management System. When a full pull is enabled, no StartDate value must be provided.

Other edit options

When editing a tenant, updating the credentials is optional.

If the existing credentials remain valid, they can be left unchanged while other configuration sections are modified. If credential updates are required, the new values must be revalidated during the process.

For security reasons, previously saved credentials are never displayed. As a result, credential fields appear empty when a tenant configuration is opened for editing.

DMS Configuration — Assai

Note: For Assai tenants that are using the optional subclass_code delta query parameters this is displayed in edit mode. Given is part of the uniqueness rules mentioned at the beginning of the page, it cannot be removed or edited. If changes are required, the existing tenant must be removed, and a new tenant is created.

After all modifications are completed, the final view provides an opportunity to review the configuration before the changes are saved.

On the Review configuration view the configuration can be reviewed.

The configuration can be downloaded by pressing the button.

The review section does not contain any details about the Authentication section as it was not changed.

If the Authentication section is updated the review must contain a placeholder for authentication sensitive details:

After pressing the Download Configuration the output does not contain the authentication credentials as these are sensitive values and must be manually adjusted.