Asset Search Activity

Activity Description:

This activity enables the user to retrieve details of Assets from AIM-A.

Application Scenario:

Typical application scenario would be that the end-user would like to get the list of Assets from AIM-A. As there would be large number of Assets in AIM-A, the Asset Search activity will facilitate retrieval of assets effectively based on the search criteria.

Workflow Variables for Asset Search Activity:

Steps to define variables for use in the Asset Search activity

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

Variables for capturing Asset Search Response

The SearchResponse for the Asset Search Activity can be retrieved using a variable of type string, with the following syntax:

"^" + currentAction.Name + "SearchResponse"

Activity Properties:

The Asset Search Activity must 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.

• Search Request Content: This property specifies the http request that contains criteria for filtering Assets in AIM-A.

The Asset Search 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

Example for AIM Asset Search Activity

With the help of the designed workflow, you can get the list of the Assets from AIM-A based on the search criteria.

Step 1: Design a workflow as shown in the figure below.

Step 2: In the Start Activity declare the variables in case you want the search parameters to be passed dynamically. For example, if you want to get the asset data on a particular page with particular number of records on a page, you can pass page size in PAGESIZE variable and current page in PAGE variable. Also declare a variable to store response from the Asset Search activity.

Step 3: In the For-Loop Activity, define the count to get asset values.

Step 4: In the Asset Search activity properties, define the Search Request Content in JSON format. Example is as shown below:

For more information on creating Asset Search criteria JSON format, refer to AIM-A documentation.

Based on the Search Request Content, the Asset Search activity returns matching Assets in AIM-A as a JSON response as shown below.