QPR MEA Integration: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 16: Line 16:
</pre>
</pre>


== Operations ==
=== CreateObject ===
=== CreateObject ===
Performs [CreateObject](https://kb.qpr.com/qpr2025-1/createobject2.html) function call.
Performs CreateObject function call (https://kb.qpr.com/qpr2025-1/createobject2.html), and returns the MEA ID of the created object.


Parameters:
Parameters:
* '''namespaceId''': String
* '''namespaceId''' (String): 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): Defines the type of the new object.
* '''objectTypeName''': String
* ''' name''' (String): Defines name for the new object.
      1. Defines the type of the new object.
* '''parentIds''' (String or String*): MEA ID of parent object. If array is given, every array element specifies one ID.
* ''' name''': String
* '''attributes''' (Dictionary): Key/value pairs of &lt;attribute&gt;/&lt;attribute value&gt; to be set for the created object.
      1. Defines name for the new object.
* '''options''' (String): Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options
* '''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 &lt;attribute&gt;/&lt;attribute value&gt; 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.


Example: Connects to the configured QPR MEA and creates a new top-level comment-action.
<pre>
<pre>
ProjectByName("TestProject")
ProjectByName("TestProject")
Line 43: Line 34:
   .CreateObject("PO", "Comment", "Test comment", "", #{"description": "Test comment description"});
   .CreateObject("PO", "Comment", "Test comment", "", #{"description": "Test comment description"});
</pre>
</pre>
Connects to the configured QPR MEA and creates a new top-level comment-action.


===DeleteObject ===
===DeleteObject ===
Performs DeleteObject function call (https://kb.qpr.com/qpr2025-1/deleteobject2.html).
Performs DeleteObject function call (https://kb.qpr.com/qpr2025-1/deleteobject2.html) and returns _empty.


Parameters:
Parameters:
* '''objectIds''': String / array of strings
* '''objectIds''' (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.
      1. One or more MEA IDs of objects to be deleted.
* '''options''' (String): Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options.
      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.


<pre>
<pre>
Line 69: Line 51:


=== GetAttribute ===
=== GetAttribute ===
Performs GetAttributeAsString function call (https://kb.qpr.com/qpr2025-1/getattributeasstring.html).
Performs GetAttributeAsString function call (https://kb.qpr.com/qpr2025-1/getattributeasstring.html), and returns the value of given object's attribute as a string.


Parameters:
Parameters:
* '''objectId''': String
* '''objectId''' (String): MEA ID of an object from which the attribute is fetched.
      1. MEA ID of an object from which the attribute is fetched.
* '''attribute''' (String): Name of the attribute that is queried. See [supported attributes](https://kb.qpr.com/qpr2025-1/supported_parameters.html).
* '''attribute''': String
* '''options''' (String): Optional options for the query. See (https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options.
      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.
Example: Connects to the configured QPR MEA and returns the name of object identified by MEA object ID: PG.785401983.683494101.


<pre>
<pre>
Line 92: Line 68:
   );
   );
</pre>
</pre>
Connects to the configured QPR MEA and returns the name of object identified by MEA object ID: PG.785401983.683494101.


=== QueryObjects ===
=== QueryObjects ===
Performs QueryObjects function call (https://kb.qpr.com/qpr2025-1/queryobjects.html).
Performs QueryObjects function call (https://kb.qpr.com/qpr2025-1/queryobjects.html), and returns the result of the query as a hierarchical dictionary object (#48320#) following the hierarchy of ResultSet-object returned by QPR MEA.


Parameters:
Parameters:
* '''query''': String
* '''query''' (String): 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): Comma-separated list of attributes that are included in the results.
* '''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).
       2. See [supported attributes](https://kb.qpr.com/qpr2025-1/supported_parameters.html).
* '''criteria''': String
* '''criteria''' (String): Criteria used to filter the results by.
      1. Criteria used to filter the results by.
       2. See 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): Comma-separated list of attributes to sort the results by.
* '''sortBy''': String
* '''options''' (String): Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options.
      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.


Example: 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.
<pre>
<pre>
ProjectByName("TestProject")
ProjectByName("TestProject")
Line 127: Line 93:
   );
   );
</pre>
</pre>
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 ===
=== SetAttribute ===
Performs [SetAttribute](https://kb.qpr.com/qpr2025-1/setattribute.html) function call.
Performs SetAttribute (https://kb.qpr.com/qpr2025-1/setattribute.html) function call to set an attribute value.


Parameters:
Parameters:
* '''objectIds''': String / array of strings
* '''objectIds''' (String or String*): MEA ID of an object from which the attribute is fetched. If array is given, every array element specifies one ID.
      1. MEA ID of an object from which the attribute is fetched.
* '''attribute''' (String): Name of the attribute that is queried. See [supported attributes](https://kb.qpr.com/qpr2025-1/supported_parameters.html). Attribute must be writeable.
      2. If array is given, every array element specifies one ID.
* '''value''' (String): Value to be set for given object's attribute.
* '''attribute''': String
* '''options''': Optional options for the query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options.
      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.


Example: Connects to the configured QPR MEA and changes the name of the user identified by MEA object ID: UM.0.123 to "ChangedUser".
<pre>
<pre>
ProjectByName("TestProject")
ProjectByName("TestProject")
Line 159: Line 113:
   );
   );
</pre>
</pre>
Connects to the configured QPR MEA and changes the name of the user identified by MEA object ID: UM.0.123 to "ChangedUser".

Revision as of 22:59, 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" }

Operations

CreateObject

Performs CreateObject function call (https://kb.qpr.com/qpr2025-1/createobject2.html), and returns the MEA ID of the created object.

Parameters:

  • namespaceId (String): MEA ID of the namespace into which the object is to be created.
  • objectTypeName (String): Defines the type of the new object.
  • name (String): Defines name for the new object.
  • parentIds (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 query. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=options

Example: Connects to the configured QPR MEA and creates a new top-level comment-action.

ProjectByName("TestProject")
  .CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
  .CreateObject("PO", "Comment", "Test comment", "", #{"description": "Test comment description"});

DeleteObject

Performs DeleteObject function call (https://kb.qpr.com/qpr2025-1/deleteobject2.html) and returns _empty.

Parameters:

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), and returns the value of given object's attribute as a string.

Parameters:

Example: Connects to the configured QPR MEA and returns the name of object identified by MEA object ID: PG.785401983.683494101.

ProjectByName("TestProject")
  .CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
  .GetAttribute(
    "[PG.785401983.683494101]",
    "name"
  );

QueryObjects

Performs QueryObjects function call (https://kb.qpr.com/qpr2025-1/queryobjects.html), and returns the result of the query as a hierarchical dictionary object (#48320#) following the hierarchy of ResultSet-object returned by QPR MEA.

Parameters:

  • query (String): The actual query. For more information, see the [query syntax documentation](https://kb.qpr.com/qpr2025-1/query_syntax.html)
  • attributes (String): 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): Criteria used to filter the results by.
     2. See https://kb.qpr.com/qpr2025-1/parameters_and_options.html?anchor=globalparameters.

Example: 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.

ProjectByName("TestProject")
  .CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
  .QueryObjects(
    "[PG.1374444994].Subprocess",
    "name, typename",
    `Find("Account", Name)`,
    "name",
    "MaxCount=3"
  );

SetAttribute

Performs SetAttribute (https://kb.qpr.com/qpr2025-1/setattribute.html) function call to set an attribute value.

Parameters:

Example: Connects to the configured QPR MEA and changes the name of the user identified by MEA object ID: UM.0.123 to "ChangedUser".

ProjectByName("TestProject")
  .CreateMeaConnection(#{"ConnectionStringKey": "MeaConnection"})
  .SetAttribute(
    "[UM.0.123]",
    "name",
    "ChangedUser"
  );