QPR MEA Integration: Difference between revisions
No edit summary |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 19: | Line 19: | ||
</pre> | </pre> | ||
Example to store | Example to store secret: | ||
<pre> | <pre> | ||
ProjectById(1).SetSecret("QprMea", "MeaConnection", `{ "url": "https://<hostname>/QPR/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp", "logOnName": "MyUser", "password": "MyPassword" }`); | ProjectById(1).SetSecret("QprMea", "MeaConnection", `{ "url": "https://<hostname>/QPR/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp", "logOnName": "MyUser", "password": "MyPassword" }`); | ||
| Line 25: | Line 25: | ||
== MEA Web Service Operations == | == MEA Web Service Operations == | ||
=== QueryObjects === | |||
Calls QueryObjects and returns query results as a hierarchical dictionary. More information: https://kb.qpr.com/qpr2025-1/queryobjects.html. | |||
Parameters: | |||
* '''Query''' (String): Actual query. See https://kb.qpr.com/qpr2025-1/query_syntax.html. | |||
* '''Attributes''' (String): Comma-separated list of attributes that are included in the results. See https://kb.qpr.com/qpr2025-1/supported_parameters.html. | |||
* '''Criteria''' (String): Results filtering criteria. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=globalparameters. | |||
* '''Sort By''' (String): Comma-separated list of attributes for sorting results. | |||
* '''Options''' (String): Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options. | |||
Example: Return name and typename of all the subprocesses in a model whose name contains text "Account". Results are ordered by name and only at most three results are returned. | |||
<pre> | |||
ProjectByName("TestProject") | |||
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"}) | |||
.QueryObjects( | |||
"[PG.1374444994].Subprocess", | |||
"name, typename", | |||
`Find("Account", Name)`, | |||
"name", | |||
"MaxCount=3" | |||
); | |||
</pre> | |||
=== CreateObject === | === CreateObject === | ||
Calls CreateObject and returns the MEA ID of the created object. More information: https://kb.qpr.com/qpr2025-1/createobject2.html. | Calls CreateObject and returns the MEA ID of the created object. More information: https://kb.qpr.com/qpr2025-1/createobject2.html. | ||
Parameters: | Parameters: | ||
* ''' | * '''Namespace ID''' (String): MEA ID of the namespace into which the object is to be created. | ||
* ''' | * '''Object type name''' (String): Defines type of the new object. | ||
* ''' | * '''Name''' (String): Defines name for the new object. | ||
* ''' | * '''Parent IDs''' (String or String*): MEA ID of parent object. If array is given, every array element specifies one ID. | ||
* ''' | * '''Attributes''' (Dictionary): Key/value pairs of <attribute>/<attribute value> to be set for the created object. | ||
* ''' | * '''Options''' (String): Optional options for the operation. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options. | ||
Example: Connect to the configured QPR MEA and create a new top-level comment action. | Example: Connect to the configured QPR MEA and create a new top-level comment action. | ||
| Line 43: | Line 67: | ||
</pre> | </pre> | ||
===DeleteObject === | === DeleteObject === | ||
Calls DeleteObject. More information: https://kb.qpr.com/qpr2025-1/deleteobject2.html. | Calls DeleteObject. More information: https://kb.qpr.com/qpr2025-1/deleteobject2.html. | ||
Parameters: | Parameters: | ||
* ''' | * '''Object IDs''' (String or String*): One or more MEA IDs of objects to be deleted. If array is given, every array element specifies one ID of object to be deleted. | ||
* ''' | * '''Options''' (String): Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options. | ||
Example: Connect to the configured QPR MEA and delete an object. | Example: Connect to the configured QPR MEA and delete an object. | ||
| Line 61: | Line 85: | ||
Parameters: | Parameters: | ||
* ''' | * '''Object ID''' (String): MEA ID of an object from which the attribute is fetched. | ||
* ''' | * '''Attribute''' (String): Name of the attribute that is queried. See https://kb.qpr.com/qpr2025-1/supported_parameters.html. | ||
* ''' | * '''Options''' (String): Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options. | ||
Example: Returns the name of an object. | Example: Returns the name of an object. | ||
| Line 72: | Line 96: | ||
"[PG.785401983.683494101]", | "[PG.785401983.683494101]", | ||
"name" | "name" | ||
); | ); | ||
</pre> | </pre> | ||
| Line 102: | Line 103: | ||
Parameters: | Parameters: | ||
* ''' | * '''Object IDs''' (String or String*): MEA ID of an object from which the attribute is fetched. If array is given, every array element specifies one ID. | ||
* ''' | * '''Attribute''' (String): Name of the attribute that is queried. See https://kb.qpr.com/qpr2025-1/supported_parameters.html. | ||
* ''' | * '''Value''' (String): Value to be set for given attribute. | ||
* ''' | * '''Options''': Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options. | ||
Example: Change the name of a user to "ChangedUser". | Example: Change the name of a user to "ChangedUser". | ||
Latest revision as of 22:31, 9 April 2026
QPR ProcessAnalyzer is able to connect to a QPR MEA (QPR Suite) instance and call its Web Service operations. To use the MEA connection, the following steps are required:
- Create a connection string and store it as a secret.
- Create a connection object.
- Call web service operations using the connection object.
QPR MEA Web Service documentation: https://kb.qpr.com/qpr2025-1/qpr_web_service.html.
MEA Connection String
To connect to QPR MEA, the 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 of the QPR MEA Web Service endpoint.
- 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" }
Example to store secret:
ProjectById(1).SetSecret("QprMea", "MeaConnection", `{ "url": "https://<hostname>/QPR/Portal/QPR.Isapi.dll/wsforward/MainService.svc/webHttp", "logOnName": "MyUser", "password": "MyPassword" }`);
MEA Web Service Operations
QueryObjects
Calls QueryObjects and returns query results as a hierarchical dictionary. More information: https://kb.qpr.com/qpr2025-1/queryobjects.html.
Parameters:
- Query (String): Actual query. See https://kb.qpr.com/qpr2025-1/query_syntax.html.
- Attributes (String): Comma-separated list of attributes that are included in the results. See https://kb.qpr.com/qpr2025-1/supported_parameters.html.
- Criteria (String): Results filtering criteria. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=globalparameters.
- Sort By (String): Comma-separated list of attributes for sorting results.
- Options (String): Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options.
Example: Return name and typename of all the subprocesses in a model whose name contains text "Account". Results are ordered by name and only at most three results are returned.
ProjectByName("TestProject")
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
.QueryObjects(
"[PG.1374444994].Subprocess",
"name, typename",
`Find("Account", Name)`,
"name",
"MaxCount=3"
);
CreateObject
Calls CreateObject and returns the MEA ID of the created object. More information: https://kb.qpr.com/qpr2025-1/createobject2.html.
Parameters:
- Namespace ID (String): MEA ID of the namespace into which the object is to be created.
- Object type name (String): Defines type of the new object.
- Name (String): Defines name for the new object.
- Parent IDs (String or String*): MEA ID of parent object. If array is given, every array element specifies one ID.
- Attributes (Dictionary): Key/value pairs of <attribute>/<attribute value> to be set for the created object.
- Options (String): Optional options for the operation. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options.
Example: Connect to the configured QPR MEA and create a new top-level comment action.
ProjectByName("TestProject")
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
.CreateObject("PO", "Comment", "Test comment", "", #{"description": "Test comment description"});
DeleteObject
Calls DeleteObject. More information: https://kb.qpr.com/qpr2025-1/deleteobject2.html.
Parameters:
- Object IDs (String or String*): One or more MEA IDs of objects to be deleted. If array is given, every array element specifies one ID of object to be deleted.
- Options (String): Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options.
Example: Connect to the configured QPR MEA and delete an object.
ProjectByName("TestProject")
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
.DeleteObject("PO.0.985518423");
GetAttribute
Calls GetAttribute and returns the value of given object attribute as a string. More information: https://kb.qpr.com/qpr2025-1/getattributeasstring.html.
Parameters:
- Object ID (String): MEA ID of an object from which the attribute is fetched.
- Attribute (String): Name of the attribute that is queried. See https://kb.qpr.com/qpr2025-1/supported_parameters.html.
- Options (String): Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options.
Example: Returns the name of an object.
ProjectByName("TestProject")
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
.GetAttribute(
"[PG.785401983.683494101]",
"name"
);
SetAttribute
Calls SetAttribute to set an attribute value. More information: https://kb.qpr.com/qpr2025-1/setattribute.html.
Parameters:
- Object IDs (String or String*): MEA ID of an object from which the attribute is fetched. If array is given, every array element specifies one ID.
- Attribute (String): Name of the attribute that is queried. See https://kb.qpr.com/qpr2025-1/supported_parameters.html.
- Value (String): Value to be set for given attribute.
- Options: Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options.
Example: Change the name of a user to "ChangedUser".
ProjectByName("TestProject")
.CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
.SetAttribute(
"[UM.0.123]",
"name",
"ChangedUser"
);