QPR MEA Integration: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
QPR ProcessAnalyzer is able to establish a connection to a QPR MEA (QPR Suite) instance, and call Web Service operations. | QPR ProcessAnalyzer is able to establish a connection to a QPR MEA (QPR Suite) instance, and call Web Service operations. | ||
MEA Web Service documentation: https://kb.qpr.com/qpr2025-1/qpr_web_service.html | |||
== MEA Connection String == | == MEA Connection String == | ||
| Line 13: | Line 15: | ||
{ "url": "https://<hostname>/QPR/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp", "logOnName": "MyUser", "password": "MyPassword" } | { "url": "https://<hostname>/QPR/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp", "logOnName": "MyUser", "password": "MyPassword" } | ||
</pre> | </pre> | ||
=== CreateObject === | === CreateObject === | ||
| Line 22: | Line 20: | ||
Parameters: | Parameters: | ||
* '''namespaceId''': String | |||
1. MEA ID of the namespace into which the object is to be created. | 1. MEA ID of the namespace into which the object is to be created. | ||
* '''objectTypeName''': String | |||
1. Defines the type of the new object. | 1. Defines the type of the new object. | ||
* ''' name''': String | |||
1. Defines name for the new object. | 1. Defines name for the new object. | ||
* '''parentIds''': String / array of strings | |||
1. MEA ID of parent object. | 1. MEA ID of parent object. | ||
2. If array is given, every array element specifies one ID. | 2. If array is given, every array element specifies one ID. | ||
* '''attributes''': Dictionary | |||
1. Key/value pairs of <attribute>/<attribute value> to be set for the created object. | 1. Key/value pairs of <attribute>/<attribute value> to be set for the created object. | ||
* '''options''': String | |||
1. Additional options for the query. | 1. Additional options for the query. | ||
2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options). | 2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options). | ||
3. Optional. | 3. Optional. | ||
Returns the MEA ID of the created object. | |||
<pre> | <pre> | ||
| Line 52: | Line 50: | ||
Parameters: | Parameters: | ||
* '''objectIds''': String / array of strings | |||
1. One or more MEA IDs of objects to be deleted. | 1. One or more MEA IDs of objects to be deleted. | ||
2. If array is given, every array element specifies one ID of object to be deleted. | 2. If array is given, every array element specifies one ID of object to be deleted. | ||
* '''options''': String | |||
1. Additional options for the query. | 1. Additional options for the query. | ||
2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options). | 2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options). | ||
| Line 71: | Line 69: | ||
=== GetAttribute === | === GetAttribute === | ||
Performs | Performs GetAttributeAsString function call (https://kb.qpr.com/qpr2025-1/getattributeasstring.html). | ||
Parameters: | Parameters: | ||
| Line 98: | Line 96: | ||
=== QueryObjects === | === QueryObjects === | ||
Performs | Performs QueryObjects function call (https://kb.qpr.com/qpr2025-1/queryobjects.html). | ||
Parameters: | Parameters: | ||
* '''query''': String | |||
1. The actual query. For more information, see the [query syntax documentation](https://kb.qpr.com/qpr2025-1/query_syntax.html) | 1. The actual query. For more information, see the [query syntax documentation](https://kb.qpr.com/qpr2025-1/query_syntax.html) | ||
* '''attributes''': String | |||
1. Comma-separated list of attributes that are included in the results. | 1. Comma-separated list of attributes that are included in the results. | ||
2. See [supported attributes](https://kb.qpr.com/qpr2025-1/supported_parameters.html). | 2. See [supported attributes](https://kb.qpr.com/qpr2025-1/supported_parameters.html). | ||
* '''criteria''': String | |||
1. Criteria used to filter the results by. | 1. Criteria used to filter the results by. | ||
2. See [criteria documentation](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=globalparameters). | 2. See [criteria documentation](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=globalparameters). | ||
* '''sortBy''': String | |||
1. Comma-separated list of attributes to sort the results by. | 1. Comma-separated list of attributes to sort the results by. | ||
* '''options''': String | |||
1. Additional options for the query. | 1. Additional options for the query. | ||
2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options). | 2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options). | ||
| Line 136: | Line 134: | ||
Parameters: | Parameters: | ||
* '''objectIds''': String / array of strings | |||
1. MEA ID of an object from which the attribute is fetched. | 1. MEA ID of an object from which the attribute is fetched. | ||
2. If array is given, every array element specifies one ID. | 2. If array is given, every array element specifies one ID. | ||
* '''attribute''': String | |||
1. Name of the attribute that is queried. | 1. Name of the attribute that is queried. | ||
2. See [supported attributes](https://kb.qpr.com/qpr2025-1/supported_parameters.html). | 2. See [supported attributes](https://kb.qpr.com/qpr2025-1/supported_parameters.html). | ||
3. Attribute must be writeable. | 3. Attribute must be writeable. | ||
* '''value''': String | |||
1. Value to be set for given object's attribute. | 1. Value to be set for given object's attribute. | ||
* '''options''': String | |||
1. Additional options for the query. | 1. Additional options for the query. | ||
2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options). | 2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options). | ||
3. Optional. | 3. Optional. | ||
Sets the value of the attribute. | |||
<pre> | <pre> | ||
Revision as of 22:53, 8 April 2026
QPR ProcessAnalyzer is able to establish a connection to a QPR MEA (QPR Suite) instance, and call Web Service operations.
MEA Web Service documentation: https://kb.qpr.com/qpr2025-1/qpr_web_service.html
MEA Connection String
To connect to QPR MEA, a MEA connection string needs to be created and stored as a secret.
The MEA connection string is a json object with following properties:
- url: URL to the webHttp endpoint of the QPR MEA Web Service to be connected to.
- logOnName: Log on name of the user who will access the QPR MEA Web Service.
- password: User's password in QPR MEA.
Example connection string:
{ "url": "https://<hostname>/QPR/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp", "logOnName": "MyUser", "password": "MyPassword" }
CreateObject
Performs [CreateObject](https://kb.qpr.com/qpr2025-1/createobject2.html) function call.
Parameters:
- namespaceId: String
1. MEA ID of the namespace into which the object is to be created.
- objectTypeName: String
1. Defines the type of the new object.
- name: String
1. Defines name for the new object.
- parentIds: String / array of strings
1. MEA ID of parent object.
2. If array is given, every array element specifies one ID.
- attributes: Dictionary
1. Key/value pairs of <attribute>/<attribute value> to be set for the created object.
- options: String
1. Additional options for the query.
2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options).
3. Optional.
Returns the MEA ID of the created object.
ProjectByName("TestProject")
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
.CreateObject("PO", "Comment", "Test comment", "", #{"description": "Test comment description"});
Connects to the configured QPR MEA and creates a new top-level comment-action.
DeleteObject
Performs DeleteObject function call (https://kb.qpr.com/qpr2025-1/deleteobject2.html).
Parameters:
- objectIds: String / array of strings
1. One or more MEA IDs of objects to be deleted.
2. If array is given, every array element specifies one ID of object to be deleted.
- options: String
1. Additional options for the query.
2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options).
3. Optional.
Returns _empty.
ProjectByName("TestProject")
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
.DeleteObject("PO.0.985518423");
Connects to the configured QPR MEA and deletes object with ID PO.0.985518423.
GetAttribute
Performs GetAttributeAsString function call (https://kb.qpr.com/qpr2025-1/getattributeasstring.html).
Parameters:
- objectId: String
1. MEA ID of an object from which the attribute is fetched.
- attribute: String
1. Name of the attribute that is queried.
2. See [supported attributes](https://kb.qpr.com/qpr2025-1/supported_parameters.html).
- options: String
1. Additional options for the query.
2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options).
3. Optional.
Returns the value of given object's attribute as a string.
ProjectByName("TestProject")
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
.GetAttribute(
"[PG.785401983.683494101]",
"name"
);
Connects to the configured QPR MEA and returns the name of object identified by MEA object ID: PG.785401983.683494101.
QueryObjects
Performs QueryObjects function call (https://kb.qpr.com/qpr2025-1/queryobjects.html).
Parameters:
- query: String
1. The actual query. For more information, see the [query syntax documentation](https://kb.qpr.com/qpr2025-1/query_syntax.html)
- attributes: String
1. Comma-separated list of attributes that are included in the results.
2. See [supported attributes](https://kb.qpr.com/qpr2025-1/supported_parameters.html).
- criteria: String
1. Criteria used to filter the results by.
2. See [criteria documentation](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=globalparameters).
- sortBy: String
1. Comma-separated list of attributes to sort the results by.
- options: String
1. Additional options for the query.
2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options).
3. Optional.
Returns the result of the query as a hierarchical dictionary object (#48320#) following the hierarchy of ResultSet-object returned by QPR MEA.
ProjectByName("TestProject")
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
.QueryObjects(
"[PG.1374444994].Subprocess",
"name, typename",
`Find("Account", Name)`,
"name",
"MaxCount=3"
);
Connects to the configured QPR MEA and returns name and typename of all the subprocesses in model identified by MEA object id PG.1374444994 whose name contains text "Account". Results are ordered by name and only at most three results are returned.
SetAttribute
Performs [SetAttribute](https://kb.qpr.com/qpr2025-1/setattribute.html) function call.
Parameters:
- objectIds: String / array of strings
1. MEA ID of an object from which the attribute is fetched.
2. If array is given, every array element specifies one ID.
- attribute: String
1. Name of the attribute that is queried.
2. See [supported attributes](https://kb.qpr.com/qpr2025-1/supported_parameters.html).
3. Attribute must be writeable.
- value: String
1. Value to be set for given object's attribute.
- options: String
1. Additional options for the query.
2. See [supported options](https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options).
3. Optional.
Sets the value of the attribute.
ProjectByName("TestProject")
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
.SetAttribute(
"[UM.0.123]",
"name",
"ChangedUser"
);
Connects to the configured QPR MEA and changes the name of the user identified by MEA object ID: UM.0.123 to "ChangedUser".