QPR Knowledge Base 2012.1

PG Object Functions

PG Object Functions

Previous topic Next topic  

PG Object Functions

Previous topic Next topic  

The PG (QPR Modeling Client) object contains functions for retrieving information from QPR Modeling Client models.

 

 

Functions available for the PG object:

 

SubObjects

Product: All folders and published models.

Folder: Folders and models in that folder.

Model: All the objects in the model.

Subprocess: All the model objects linked to the subprocess, all the model objects in the subprocess level.

ModelObject: All the model objects linked to the model object.

 

ChildObjects (hierarchy=<hierarchy name>)

Product: Models and folders in the top level of the model hierarchy.

Folder: Folders and models in that folder.

Subprocess: All the subprocesses in this subprocess.

OrganizationUnits/Notes/InformationItems/Resources: All the sub-objects in given hierarchy. If resource pools are to be used instead of resource groups, "hierarchy=resourcepools" must be given as parameter.

 

ParentObjects (hierarchy=<hierarchy name>)

Folder: Parent folder (if any).

Subprocess: All parent subprocesses of this subprocess.

OrganizationUnits/Notes/InformationItems/Resources: All parent objects in given hierarchy. If resource pools are to be used instead of resource groups, "hierarchy=resourcepools" must be given as parameter.

 

Folders

Product: All folders.

Folders: All folders in the folder.

 

Models

Product: All models.

Folder: All models in the folder.

 

RootModels

Product: All root models.

Folder: All root models in the folder.

 

Branches

Product: All branches.

Root model: All branches in the root models.

 

ModelVersions

Product: All model versions.

RootModel: All model versions in the root model (not recursively from branches).

Branch: All model versions in the branch.

 

ElementTypes

Model: All element types.

 

 

<typename>

Valid type names:

Product level:

Model

RootModel

Folder

Branch

Model level:

<model object type group (corresponding attribute: typegroupname)>

ElementType

ProcessStepType

FlowType

InformationItemType

StoreType

Type

ResourceType

ElementType

ProcessStep

Flow

Note

InformationItem

Store

Group

Measure

OrganizationItem

Resource

Element

<model object type (corresponding attribute: typename)>

<element type defined for the model (e.g. "Activity")>: If the name contains spaces, you can omit those. For example Core Process can be called as CoreProcess.

 

<relationname>

Valid relations by type:

Model

oBaseModel: Base model defined for the model.

oChildModels: Child models for which the Model is a base model.

Model object

oInformationItems: Information items connected to the model object

oNotes: Notes connected to the model object

oResources: Resources connected to the model object

oElementType: Model object's element type

o<custom attribute relations>: Any custom attributes defined for the model object type.

 

<hierarchyname>

Valid hierarchies:

ProcessLevels: Process level hierarchy. If the IgnoreHidden parameter is set to true, the returned hierarchy does not contain process levels set as hidden in the process level hierarchy.

OrganizationUnits: Organization unit hierarchy.

InformationItems: Information item hierarchy.

Notes: Note hierarchy

ResourcePools: Resource pool hierarchy

ResourceGroups: Resource group hierarchy.

<element hierarchy symbol>: Element hierarchy with a matching element symbol.