Ingestion Activity

Activity Description

This activity enables the user to download a file from the AVEVA Cloud Storage and transfer it to the Ingestion API endpoint for processing.

Application Scenario

Typical application scenario would be that the end-user would like to ingest a file present in the AVEVA Cloud Storage, upon approval by an authorized user, through the Ingestion API endpoint into AIM-A..

Quickflow Variables for Ingestion Activity:

Steps to define variables for use in the Ingestion activity

This section describes how to define variables for use in Ingestion Activity. It gives the syntax for creating the variables and typical examples for different cases.

Variables for capturing TransactionId

The Transaction Id for the Ingestion Activity can be retrieved using a variable of type string, with the following syntax:

"^" + currentAction.Name + "TransactionId"

Variables for capturing ServiceResponse

The ServiceResponse for the Ingestion Activity can be retrieved using a variable of type string, with the following syntax:

"^" + currentAction.Name + "ServiceResponse"

Note: To see the Response coming from Ingestion API, set DebugLevel to 2 in Central Configuration.

Activity Properties

The Ingestion Activity has to be configured by specifying appropriate values for the different properties in the Activity Properties area. The Activity Properties can be accessed by clicking on the Activity Properties tool in the Tool Bar or by selecting the appropriate option from the right click menu for the Ingestion Activity. The Activity Properties are organized under the following groups of related properties. The properties under each group are described in this topic.

Name & Description

The properties in the Name & Description group have been described below. You can use these properties to specify the name and description for the activity.

Name - This property can be used to specify a name for the activity.

Description - This property specifies a brief description to be displayed for the activity.

Configuration

Use the configuration properties to configure the functionality of the activity.

• Base Address: This property specifies the Base address of the Ingestion API end point.

• Access Token: This property specifies the security token used to authenticate the communication with configured Base address.

• File Name: This property specifies the value that points to the uploaded file on AVEVA Cloud Storage.

• Register Identifier: (Not mandatory) This property specifies the value that identifies the ingestion file to be routed to the correct registered gateway during Orchestration.

• Context: This property specifies an identification scope in AIM. The context is used, for example, to specify a Plant that has tagged assets for a site having more than one Plant.

• Publish to AIM: This property specifies whether the ingested file needs to be published to AIM during Orchestration.

• Target: This property specifies the below values. Select the value from the drop-down list.

  • CL: Class Library

  • AC2D: AutoCAD

  • Regi: ID Data

  • DE: Data Extraction

  • Model: 3D Model

  • MS2D: Microstation

    Note: If you select Target value as CL, keep Register Identifier blank.

The AVEVA File Download Activity gives the following Outputs:

• BadRequest(400)

• Unauthorized(401)

• Forbidden(403)

• NotFound(404)

• MethodNotAllowed(405)

• NotAcceptable(406)

• ProxyAuthenticationRequired(407)

• RequestTimeout(408)

• UnsupportedMediaType(415)

• InternalServerError(500)

• NotImplemented(501)

• BadGateway(502)

• ServiceUnavailable(503)

• GatewayTimeout(504)

• HttpVersionNotSupported(505)

• Successful

• UnSuccessful