This blog will explain how to configure and monitor user defined message search for an AEX installation (PI Adapter User-Defined Message Search). The user-defined search is one of the many ways to find messages in the Advanced Adapter Engine using the message monitor without the use of TREX.
User Defined Message Search could be accessed in one of the following ways:
- Open a browser and go to http://<host>:<port>/pimon to access the Process Integration tools
- Then choose Configuration and Administration >> Click User Defined Message Search
(Step 1): Create a New Filter
- Now click on the new button to create a filter and provide the values for required fields along with sender and receiver components as shown below. All the values will be available via drop down (search help).
- Enter all the values and Click Save.
Note: The Filter Name can be specified by the User (Eg Test Filter 1, Test Filter 2 or IDOC Search 1)
(Step 2): Enter the Search Criteria as below
- Now we need to create the search criteria for this filter (in the details section).
- Enter Name as “IDOC”
- Select Type as “XPath Expression
- Enter XPath* as /CREMAS03/IDOC/EDI_DC40/DOCNUM (eg.)
- XPath path will vary from one IDOC to another.
- Click Save
The configuration is complete. Now check if the Filter is Active.
(Step 3): Testing Filter Configuration
- Now we can test our filter configuration by using the Test Search Criteria button. Give any message ID relavent for the above Filter.
- Using Message ID, We can retrieve the relevant search result ( In our case, DOCNUM )
(Step 4): Message Monitoring – User Defined Search:
- Now to search any IDOC for the Interface we have already configured in the filter.
- Navigate to the Message Monitoring section In the Message Monitoring->Database>> Advanced >> User Defined Criteria. Make sure the time period is appropriate for the search.
- Check the List Box User-Defined Search Criteria
- Select the configured search filter from the list
- Enter the IDOC number in the Value field to search
- Click OK
- Using IDOC Number (Predefined), we have retrieved Message ID with relevant message details.
Important things to remember:
- For Idocs namespace and message types no need for declaring Prefixes.
- For any other message types we need to configure the namespace prefixes as below:
Suppose the Input XML is as below:
- Filter configuration as mentioned earlier.
- Under Search configuration click on the Prefixes Tab and enter the details as below.
- Now define the search criteria and XPath as below.