Data Pipeline Admin Dashboard - Add Tenant

Selecting Add Tenant launches the Add Tenant workflow that is divided into several sequential configuration screens.

Navigation and Controls

• Back to Dashboard – Returns to the Tenants tab.

• Back to Assets – Returns to the asset list.

• View configuration documentation – Opens the relevant documentation page.

• Upload Configuration – Allows importing a pre-populated sample configuration.

Onboarding Options

You can onboard a tenant using one of two methods:

• Upload Configuration

• Manual Entry

  

• Upload Configuration: Upload a preconfigured sample configuration file. The system automatically populates all DMS‑specific fields based on the uploaded values.

  

• Manual Entry: Enter all required fields across the configuration screens.

Basic Information

Displayed Fields

• Tenant Name – Friendly name for the tenant.

• Source Type – The DMS source type.

• Scheduled Job – Frequency for pulling documents and metadata from the DMS.

• Start Date – Date (UTC) from which files begin being pulled from the DMS.

• Enabled – Toggles document and metadata processing to the Data Pipeline.

• First Load – Triggers a full data pull from the DMS source system.

Refer to Data Pipeline Admin Dashboard Portal - DocConnector Configuration.

Navigation

• Next – Moves to the Authentication screen.

Enabling and disabling a tenant

A tenant’s execution can either follow its assigned schedule or be deferred. To allow a tenant to run according to its schedule, ensure that the Enabled checkbox is selected. If the tenant is not enabled, its execution will be deferred until it is re-enabled.

Schedule a tenant

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, refer Data Pipeline Admin Dashboard Portal - DocConnector Configuration for more information.

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.

Authentication

Displayed Fields

• Authorize API – DMS authorization API endpoint.

• Client ID – Client Id provided by the DMS.

• Client Secret– Client Secret provided by the DMS.

For Assai, OpentText and SharePoint with Graph API the Authentication section have the same inputs.

Authentication - Aconex

For Aconex, additional optional fields may be added:

• User ID – The user ID of the linked Aconex account for the user. This does not need to be specified if there is only one Aconex account linked to the Lobby account.

• User Site – The URL of the Aconex instance on which the linked Aconex account is located. This does not need to be specified if there is only one Aconex account linked to the Lobby account.

  

Navigation and Controls

• Validate Credentials – Validates the authentication details.

  

• Previous – Returns to Basic Information.

• Next – Moves to the DMS Configuration screen.

DMS Configuration

This section varies depending on the selected DMS source type.

DMS Configuration — Assai

Displayed Fields

• DMS Base URL – Base URL of the Assai DMS source system.

• Download Files – Enables downloading physical documents.

• Delta Endpoint (read‑only) – API endpoint for retrieving document revisions.

• Delta Query Parameters

  • Polling – Enables polling on the document revision API.

  • Project Code – Project code from which document revisions are retrieved.

  • Asset Code (optional)– Asset code used for filtering document revision downloads

  • Additional Delta Options (optional): Additional delta query parameters can be added by checking this box.

    

  • Upon selecting the Additional Delta Options checkbox, the Add Option () button is displayed.

  • Clicking the Add Option button displays an optional delta query parameter section where:

    • Option: represents the key of the parameter. You must add all lowercase letters and follow Assai documentation.

    • Value: contains the actual value for the given key.

    • Delete: removes the optional delta query parameter.

      

    • Multiple additional delta query parameters can be added individually by pressing the Add Option button.

      

• Enable Delete Audit – Enables the deletion‑audit feature.

• Delete Audit Endpoint (read‑only) – API endpoint for retrieval of deleted document data.

• FileTypeLookup – Column within document revisions used to detect file extensions.

• Download Document Asset – Enables downloading document‑level assets.

• Download Projects – Enables downloading project metadata.

• Download Packages – Enables downloading package metadata.

• Document API Address (read‑only) – API endpoint for retrieving document assets. Displayed only when Download Document Asset is enabled.

• Last Refresh Date Time URL (read‑only) – Endpoint for retrieving the last refresh timestamp from the DMS.

• Document Download Endpoint (read‑only) – Endpoint used to download the physical document files.

• Filtering

  Supports filtering documents based on metadata values. This is optional.

  

  • Validation Expression: filtering condition based on the identifiers already created and the logical operators in use OR and AND.

  • Add Item: Action to be used to add a filtering item

  • Filtering item:

    

• Mapping: the actual filtering name. The supported values are: class_code, subclass_code, company_code, document_type, discipline_code, asset_code, status_code, approval_code, publication_file, active_ind.

• Value: the actual value against which the filtering is done.

Navigation & Controls

• Previous – Navigate to Authentication Configuration.

• Next – Navigate to Register Configuration.

DMS Configuration — Aconex

Displayed Fields

• DMS Base URL – Base URL of the Aconex DMS source.

• Project Code – Project code used to retrieve document revisions and files.

• Download Files – Enables downloading physical files.

• Delta Endpoint (read‑only) – Document revision API endpoint.

• Delta Query Parameters:

  • Return Fields – List of document fields to be returned (e.g., registered).

  • Page Size – Page size for retrieval. Must be a multiple of 25, max 250.

• Is Metadata To Store – Enables saving document metadata.

• Delta Mapping

  • ID – Mapping for the document identifier.

  • Document Download Link (read‑only) – API endpoint for downloading the document.

  • Metadata Download Link (read‑only) – API endpoint for downloading document metadata.

    Note: If docNo is added under Return Fields, then documentNumber must be used in Delta Mapping >> ID.

• Filtering

  Supports filtering documents based on metadata values. This is optional.

  

  • Validation Expression: filtering condition based on the identifiers already created and the logical operators in use OR and AND.

  • Add Item: Action to be used to add a filtering item

  • Filtering Item:

    

  • Mapping: the actual filtering name. These are the supported values:

    • Confidential

    • FileType

    • DocumentType

  • Value: the actual value against which the filtering is done; it can contain a list of values separated by commas.

Navigation & Controls

• Previous – Navigate to Authentication Configuration.

• Next – Navigate to Register Configuration.

DMS Configuration — SharePoint Graph API

Displayed Fields

• DMS Base URL – Base SharePoint site URL (tenant + site).
  Example: https://s5m4v.sharepoint.com/sites/GraphApiSandbox

• Download Files – Enables downloading files.

• Root Folder – Root folder within the SharePoint structure from which documents will be retrieved.

• Drive Name – Name of the document library in the SharePoint site.

• Delta Endpoint (read‑only) – Document revision query endpoint.

• Delta Request Body Parameters

  • Region – Region of the SharePoint instance (e.g., EUR, APC).

  • Size – Page size (e.g., 250).

• Filtering

  Supports filtering documents based on metadata values. This is optional.

  

  • Validation Expression: filtering condition based on the identifiers already created and the logical operators in use OR and AND.

  • Add Item: Action to be used to add a filtering item

  • Filtering Item:

    

  • Mapping: the actual filtering name.

  • Value: the actual value against which the filtering is done. The supported values are: Name, webUrl, ParentReference.driveId, ParentReference.id

Navigation & Controls

• Previous – Navigate to Authentication Configuration.

• Next – Navigate to Register Configuration.

DMS Configuration — OpenText

Displayed Fields

• DMS Base URL – Base URL of the OpenText source system.

• Download Files – Enables downloading physical files.

• Root Folder – Root folder in the OpenText structure.

• Delta Endpoint (read‑only) – Endpoint for retrieving document revisions.

• Blob ID Endpoint (read‑only) – Endpoint for downloading document metadata.

• Delta Query Parameters

  • Items per page – Pagination size (e.g., 250).

• Folder Query Parameters

  • Items per page – Pagination size for folder-level queries.

• Is Metadata To Store – Enables saving document metadata.

• Delta Mapping

  • Document Download Link – API used to download the document.

  • Metadata Download Link – API used to download metadata.

• Filtering

  Supports filtering documents based on metadata values. This is optional.

  

  • Validation Expression: filtering condition based on the identifiers already created and the logical operators in use OR and AND.

  • Add Item: Action to be used to add a filtering item

  • Filtering Item:

    

  • Mapping: the actual filtering name.

  • Value: the actual value against which the filtering is done. The supported values is: entries[0].mimeType metadata field.

Navigation & Controls

• Previous – Navigate to Authentication Configuration.

• Next – Navigate to Register Configuration.

Register Configuration

View used to configure the register path settings for the tenant.

Register Configuration - Assai

Displayed Fields

• Context: AIM-A context

• Document Metadata Register – Path where document revisions are stored. Example: Assai/Documents

• Scraped File Register – Visible only when Download Files is enabled. Path where downloaded files are stored. Visible only when Download Files is enabled.Example: Assai/Discovery

• Document Link Register – Visible only when Download Assets is enabled. Path where document assets are stored. Visible only when Download Document Asset is enabled. Example: Assai/Links

• Project Register – Visible only when Downloaded Packages is enabled. Path for storing project metadata. Visible only when Download Projects is enabled.

• Package Register –Visible only when Download Packages is enabled. Path for storing package metadata.Visible only when Download Packages is enabled.

Navigation & Controls

• Previous – Navigate to DMS Configuration.

• Next – Navigate to Data Pipeline Configuration.

Register Configuration - Aconex

Displayed Fields

• Context: AIM-A context

• Document Metadata Register – Path where document revisions are stored. Example: Aconex/Documents

• Scraped File Register – Visible only when Download Files is enabled. Path where downloaded files are stored. Visible only when Download Files is enabled.Example: Aconex/Discovery

• Custom Scraped File Register Patterns: A list of paths for custom name patterns. Every path consists of a rank, a pattern and a path. Use an asterisk character to match any string (for example, *-test-*.txt will match any file that has “- test-” keyword preceded and succeeded by any string - aconex-test-regi.txt).

Navigation & Controls

• Previous – Navigate to DMS Configuration.

• Next – Navigate to Data Pipeline Configuration.

Register Configuration - SharePoint with Graph API

Displayed Fields

• Context: AIM-A context

• Document Metadata Register – Path where document revisions are stored. Example: SharepointGraphApi/Documents

• Scraped File Register – Visible only when Download Files is enabled. Path where downloaded files are stored. Visible only when Download Files is enabled. Example: SharepointGraphApi/Discovery

• Custom Scraped File Register Patterns: A list of paths for custom name patterns. Every path consists of a rank, a pattern and a path. Use an asterisk character to match any string (for example, *-test-*.txt will match any file that has “- test-” keyword preceded and succeeded by any string - aconex-test-regi.txt).

Navigation & Controls

• Previous – Navigate to DMS Configuration.

• Next – Navigate to Data Pipeline Configuration.

Register Configuration - OpenText

Displayed Fields

• Context: AIM-A context

• Document Metadata Register – Path where document revisions are stored. Example: Opentext/Documents

• Scraped File Register – Visible only when Download Files is enabled. Path where downloaded files are stored. Visible only when Download Files is enabled. Example: Opentext/Discovery

Navigation & Controls

• Previous – Navigate to DMS Configuration.

• Next – Navigate to Data Pipeline Configuration.

Data Pipeline Configuration

This section is used to configure the AIM Ingestion settings for the tenant.

Displayed Fields

• Base URL (read‑only) – Dynamically generated ingestion URL based on access configuration.

• Asset ID – Identifier of the asset selected on the initial dashboard.

  

• Processing Units – Processing units define how orchestration is executed (which gateway is used) for each file format.

  

Navigation & Controls

• Previous – Navigate to Register Configuration.

• Next – Navigate to Review Configuration.

Review Configuration

This section displays a summary of all configurations set in previous steps.

Displayed Fields

• Basic Information – Same tenant information entered on the initial Add Tenant screen.

  

• Configuration – Full configuration assembled for onboarding the tenant.

  

Actions

• Download Configuration – Downloads the configuration in JSON format. This will exclude the credentials for security reasons.

• Save Tenant – Saves the configuration and completes the onboarding process.

• Previous – Navigates back to earlier configuration sections.