Add an AIM-A Tenant to the Data Pipeline
- Last UpdatedMay 17, 2024
- 2 minute read
This section describes the information required to get a new AIM tenant onboarded into the AVEVA Data Pipeline as an asset. This is a mandatory step and is required before the AVEVA Data Pipeline can be used to publish data into any AIM environment.
Note: For APCM integration with AIM-A, the target AIM environment must be added as an asset to the respective deployment of the AVEVA Data Pipeline. Without this information, the integration does not work and Ingestion API does not accept any data from APCM.
Request Details:
For adding a new asset to the AVEVA Data Pipeline, you need to provide the following information:
|
Parameter |
Required? |
Description |
|---|---|---|
|
AIM ASSET TYPE |
Yes |
AIM-A |
|
AIM STAGE NAME (OR URL) |
Yes |
Identifier of the AIM deployment. If you can't find the stage, share the AIM website URL. |
|
CONNECT ACCOUNT NAME |
Yes |
Name of the CONNECT Account for the AIM environment. |
|
CONNECT FOLDER NAME |
Yes |
Name of the CONNECT Folder for the AIM environment. If the AIM environment is enabled at account level, provide CONNECT Account Name in this field as well. |
|
ROOT CONTEXT |
Yes |
The Root Context for all the data in the target AIM environment. This should be the fixed part of the Context, which does not change for any data. |
|
AIM BUSINESS UNIT |
Yes |
The name of the business unit stated in the request to AVEVA to create the AIM environment. This corresponds to the top-level root (context) of all the data that will populate the AIM instance. |
|
REPORTING REQUIRED? |
No |
Yes, if you need reporting database to be enabled for this asset and you already have an Azure reporting database connection string. Default: No. |
|
REPORTING DATABASE CONNECTION STRING |
No |
If reporting database is required, specify the reporting database connection string. Solution Delivery can obtain this value from CDO. |
|
REPORTING INTERVAL |
No |
If reporting database is required, the amount of time in minutes after which you want the AVEVA Data Pipeline to publish to the reporting database. Default: 240 min. |
|
APCM INTEGRATION REQUIRED? |
No |
If APCM integration is required for the target AIM environment. |
|
AIM PUBLISH INTERVAL |
No |
The amount of time in minutes after which you want the AVEVA Data Pipeline to publish to the target AIM environment. Default: 120 min. |