AvePoint Docs
Contact support
Contact support
English

    Home > Settings > Connector

    Export to PDF

    Connector

    The Connector page allows you to configure connections to connect AvePoint Opus to any systems that hold information to enable content lifecycle management.

    To manage Connector records, follow the steps below in order:

    1. Create connections to connect AvePoint Opus to the system that holds information to enable content lifecycle management. Refer to Create a Connection.

    2. Create terms to classify records, create rules to identify records with rule criteria, and then associate terms with rules. Refer to Manage Terms and Manage Rules.

    3. Submit records to AvePoint Opus using API. Refer to POST api/connector/SubmitRecords.

    4. [Optional] You can search for records, and then perform additional operations on search results, including viewing record details, reclassifying record with a new term, placing record on hold, and exporting records. See Search.

    5. Retrieve records that need to be destroyed using API. Refer to API for Connector.

    6. [Offline] Manually destroy records in the content source.

    7. Update the status of destroyed records as Destroyed in AvePoint Opus using API. Refer to API for Connector.

    Create a Connection

    Refer to the following steps to create a connection:

    1. On the Connector page, click Create on the ribbon.

    2. On the Create page, enter a Connection name and optional Description.

    3. In the Data properties field, the built-in properties are displayed. Each connection has a hidden property, Row ID, which will be used later.

    4. If you want to add more record properties, you can create custom columns of different types.

      Click New column, complete the following information, and click Save to add the column.

      • Name – Enter a display name for the column.

        *Note: The display name of properties in a connection cannot be duplicate.

      • Type – Select a type from the drop-down list.

        • Single line of text – Value should be a single line of text.

        • Multiple lines of text – Value should be multiple lines of text.

        • Date and Time – Value should be a date and/or time.

        • Choice (single selection) – Value should be the option order, not the option name.

        • Choice (multiple selections) – Value should be option orders separated by commas in square brackets.

        • Person or Group – Value should be the full email address of users and/or groups separated by commas in square brackets.

          If the user or group does not exist in AvePoint Opus, AvePoint Opus will query it in the Microsoft Entra that is authorized via the app profile in AvePoint Online Services.

        • Number – Value should be a number.

    5. Click Save to save the connection.

    Manage Connections

    The following actions can be performed on the Connector page:

    - **Delete** – Select one or multiple connections and click **Delete** to delete the selected connections. A warning message will appear confirming the deletion. Click **OK** to proceed with the deletion, or click **Cancel** to return to the **Connector** page without deleting the connections. > ***Note**: If a connection is deleted, all records associated with this connection will not be available for search in AvePoint Opus. - **Edit** – Click the connection name to access the connection details page, where you can edit the connection. - **Download** – Click the Download (![Button: Download](/en/avepoint-opus/settings/images/image196.png "Button: Download")) button to the right of a connection to download the JSON file of the connection. You can prepare the information of records based on the JSON file, and import the record information to AvePoint Opus via API for the content lifecycle management. For detailed information on the AvePoint Opus APIs for Connector, refer to [API for Connector](#missing-link).