IQL query properties
Properties
Property elements specify properties an object may have, and appear in the report as columns in a list. Furthermore, most can be used to filter report results. The following table lists all the available property elements (including those that represent relationships). See Enterprise Object Relationships for more detailed information on relationships.
| Property | Applies To | Possible Values |
|---|---|---|
| accountable (.resource, .role) | All | |
| acknowledgementApplicant | Documents, WebDiagrams, ExternalFiles, Reports | username of the user started the running cycle |
| acknowledgementCycleLog | Documents, WebDiagrams, ExternalFiles, Reports | All actions that take place in acknowledgement cycles |
| acknowledgementCycleParticipation | Documents, WebDiagrams, ExternalFiles, Reports | Acknowledged By usernames |
acknowledgementGroupActionCompleted | Documents, WebDiagrams, ExternalFiles, Reports | Users who have acknowledged in the cycle (only accessible if a cycle is running on the respective version) |
| acknowledgementGroupActionPending | Documents, WebDiagrams, ExternalFiles, Reports | Users the acknowledgement cycle is waiting on (only accessible if a cycle is running on the respective version) |
| acknowledgementGroupUsers | Documents, WebDiagrams, ExternalFiles, Reports | All users in the acknowledgement cycle (only accessible if a cycle is running on the respective version) |
| acknowledgementStartDate | Documents, WebDiagrams, ExternalFiles, Reports | Date when the active, in-progress acknowledgement cycle started |
| acknowledgementState | Documents, WebDiagrams, ExternalFiles, Reports | CycleState |
| allocation | Resources | |
| ancestor | All | Access objects that have this common ancestor |
| approvalApplicant | Documents, WebDiagrams, ExternalFiles, Reports | username of the user started the running cycle |
| approvalCycleLog | Documents, WebDiagrams, ExternalFiles, Reports | All actions that take place in approval cycles |
| approvalCycleParticipation | Documents, WebDiagrams, ExternalFiles, Reports | Vote Approval Yes, Vote Approval No by usernames |
| approvalDate | Documents, WebDiagrams, ExternalFiles, Reports | Date when approved |
| approvalDateOmitVersion | Documents, WebDiagrams, ExternalFiles, Reports | Date when any version of the object was last approved |
| approvalGroupActionCompleted | Documents, WebDiagrams, ExternalFiles, Reports | Users who have voted in the cycle (only accessible if a cycle is running on the respective version) |
| approvalGroupActionPending | Documents, WebDiagrams, ExternalFiles, Reports | Users the approval cycle is waiting on (only accessible if a cycle is running on the respective version) |
| approvalGroupUsers | Documents, WebDiagrams, ExternalFiles, Reports | All users in the approval cycle (only accessible if a cycle is running on the respective version) |
| approvalNextStartDate | Documents, WebDiagrams, ExternalFiles, Reports | Date when next scheduled approval cycle will start |
| approvalStartDate | Documents, WebDiagrams, ExternalFiles, Reports | Date when the active, in-progress approval cycle started |
| approvalState | Documents, WebDiagrams, ExternalFiles, Reports | CycleState |
| approved | Documents, WebDiagrams, ExternalFiles, Reports | true/false |
| approvers | Documents, WebDiagrams, ExternalFiles, Reports | |
| audits | Business Rules | |
| benefitProvidedBy | All Enterprise Objects, (Web-authored) Diagram, (Client-authored) IGX Document, IGX Diagram, IGX Sheet, External File, Web Address | |
| changeDate | All | date/time |
| checkedOutDate | Documents, WebDiagrams, ExternalFiles, Reports | date/time |
| checkedOutTo | Documents, WebDiagrams, ExternalFiles, Reports | username |
| child | All | |
| comment | Documents, WebDiagrams, ExternalFiles, Reports | check-in comment |
| comments (.author, .content, .resolved) | WebDiagrams, IGX Diagrams | comments.resolved: true/false |
| consulted (.resource, .role) | All | |
| controls | Business Rules | |
| createDate | All | date/time |
| creator | All | username |
| currentApprovedVersionID | Documents, WebDiagrams, ExternalFiles, Reports | The version ID of the current approved version of the object. The value is zero if it has not been approved or if there is no current approved version. |
| currentRiskData.factDate | Risks, Risk Instances | date/time |
| currentRiskData.factFinancialImpact | Risks, Risk Instances | |
| currentRiskData.factValue | Risks, Risk Instances | |
| currentRiskData.inherentRisk | Risks, Risk Instances | |
| currentRiskData.initialRisk | Risks, Risk Instances | |
| currentRiskData.reason | Risks, Risk Instances | |
| currentRiskData.residualRisk | Risks, Risk Instances | |
| currentRiskData.risk:appetite | Risks, Risk Instances | Level |
| currentRiskData.risk:impact | Risks, Risk Instances | Level |
| currentRiskData.risk:likelihood | Risks, Risk Instances | Level |
| currentRiskData.savedBy | Risks, Risk Instances | Username |
| custom:xxxx | Any | Custom Properties and their custom types are user defined for specific object types |
| deliveredBy | Product, Business Service | |
| delivers | Capability | |
| depth | All | Depth in the repository tree hierarchy (0=Root, 1 = within a top level folder, etc.) |
| describes | Diagram and WebDiagram | Can also access this relationship for diagram elements on the diagram as diagramElement.describes |
| describesState | WebDiagram and Diagram Elements | Contains information if the diagram itself or the respective diagram element describe an object in your enterprise model. Possible values are
|
| diagramElement (.ID, .name, .shapeNumber) | Diagram and WebDiagram | Special relationship to access Custom Properties on objects inside a diagram (via .custom:property) |
| elementType | Diagram and WebDiagram | Can also access element type for diagram elements in the diagram as diagramElement.elementType |
| documents | Documents, WebDiagrams, WebAddresses, ExternalFiles | |
| electiveWatchers | All | List of users who have elected to watch the object |
| enabledBy | Process/Activity, Journey/Moment/Touch | |
| enables | Capability | |
| endorsed | Documents, WebDiagrams, ExternalFiles, Reports | true/false |
| endorsementApplicant | Documents, WebDiagrams, ExternalFiles, Reports | username of the user started the running cycle |
| endorsementCycleLog | Documents, WebDiagrams, ExternalFiles, Reports | All actions that take place in endorsement cycles |
| endorsementCycleParticipation | Documents, WebDiagrams, ExternalFiles, Reports | Endorsed By usernames |
| endorsementDate | Documents, WebDiagrams, ExternalFiles, Reports | Date when endorsed |
| endorsementDateOmitVersion | Documents, WebDiagrams, ExternalFiles, Reports | Date when any version of the object was last endorsed |
| endorsementGroupActionCompleted | Documents, WebDiagrams, ExternalFiles, Reports | Users who have endorsed the cycle (only accessible if a cycle is running on the respective version) |
| endorsementGroupActionPending | Documents, WebDiagrams, ExternalFiles, Reports | Users the endorsement cycle is waiting on (only accessible if a cycle is running on the respective version) |
| endorsementGroupUsers | Documents, WebDiagrams, ExternalFiles, Reports | All users in the endorsement cycle (only accessible if a cycle is running on the respective version) |
| endorsementNextStartDate | Documents, WebDiagrams, ExternalFiles, Reports | Date when next scheduled endorsement cycle will start |
| endorsementStartDate | Documents, WebDiagrams, ExternalFiles, Reports | Date when the active, in-progress endorsement cycle started |
| endorsementState | Documents, WebDiagrams, ExternalFiles, Reports | CycleState |
| endorsers | Documents, WebDiagrams, ExternalFiles, Reports | |
| flows (.from, .to) | Work Product | |
| folderName | All | |
groupRoleAssignments | All | The groups and respective item roles directly assigned on an object.
|
| hasCapability | Resource, External Agent | |
| hasControlInstance | Control | |
| hasGoal | Enterprise Objects | |
| hasLocation | Resources | |
| hasOpportunity | All Enterprise Objects, (Web-authored) Diagram, (Client-authored) IGX Document, IGX Diagram, IGX Sheet, External File, Web Address | |
| hasOpportunityInstance | Opportunity | |
| hasRequirement | Enterprise Objects | |
| hasRisk | All Enterprise Objects, (Web-authored) Diagram, (Client-authored) IGX Document, IGX Diagram, IGX Sheet, External File, Web Address | Associated risk objects of an Enterprise Object through the Has Risk relationship |
| hasRiskInstance | Enterprise Objects | Associated risk instance objects of an Enterprise Object through the Has Risk Instance relationship |
| hasSAPLogicalComponent | SAPProcessSteps, SAPMasterData, SAPInterfaces | |
| hasStrategy | Enterprise Objects | |
| ID | All | Repository ID or Diagram Element ID |
| implements | Process/Activity, Journey/Moment/Touch, Capability, Product, Business Service, Work Products | |
| informed (.resource, .role) | All | |
| isAccountableFor (.object, .role) | Resources | |
| isAllocatedTo | Resources | |
| isAuditedBy | Enterprise Objects | |
| isCapabityFor | Capability | |
| isCheckedOut | Documents, WebDiagrams, ExternalFiles, Reports | true/false |
| isConsultedAbout (.object, .role) | Resources | |
| isControlInstanceFor | Control Instance | |
| isControlledBy | Enterprise Objects | |
| isDescribedBy | Enterprise Objects | |
| isDescribedByDiagramElement | Enterprise Objects | |
| isDocumentedBy | Enterprise Objects | |
| isDocumentedByUrl | Enterprise Objects | |
| isGoalOf | Goals | |
| isImplementedBy | Control, Control Instance, Class | |
| isInformedAbout (.object, .role) | Resources | |
| isKeyControl | Control, Control Instance | |
| isLocationOf | Resources | |
| isMeasuredBy | Enterprise Objects | |
| isOpportunityFor | Risk, Risk Instance,Opportunity, Opportunity Instance | |
| isOpportunityInstanceFor | Risk Instance, Opportunity Instance | |
| isRequirementOf | Requirement | |
| isResponsibleFor (.object, .role) | Resources | |
| isRiskFor | Risk, Risk Instance, Opportunity, Opportunity Instance | |
| isRiskInstanceFor | Risk Instance | |
| isRolledUpIn | Performance Indicator | |
| isSAPLogicalComponentFor | SAP Logical Component | |
| isStrategyOf | Strategy | |
| isSupportedBy (.object, .sapInScope) | Enterprise Objects (most) | |
| linkedUrl1 | Web Diagrams, IGX Diagrams | |
| linksObject | All | References repository objects that are linked in diagram elements and diagram element notes, summary, purpose or description. |
| ME | User mapped to Resource | Returns the Resource Object associated with the logged-in user. Only available as filter property. |
| measures | Performance Indicator | |
| modifier | All | username |
| modifyDate | All | date/time |
| name | All | |
| objectLinkedBy | All | References objects that contain diagram elements, notes, summary, purpose or instructions that link to this repository object |
| openCommentsCount | WebDiagrams, IGX Diagrams | number |
| owner | All | username |
| parent | All | |
| piDataSeriesType | Performance Indicators | PIDataSeriesType |
| piFactIdentifer | Performance Indicators | |
| piPreempt | Performance Indicators | true/false |
| piRatingSystem | Performance Indicators | PIRatingSystem |
| piType | Performance Indicators | PIType |
| piUnit | Performance Indicators | |
| piWeighting | Performance Indicators | PIWeighting |
| posesThreatTo | All Enterprise Objects, (Web-authored) Diagram, (Client-authored) IGX Document, IGX Diagram, IGX Sheet, External File, Web Address | |
| processOwner | Diagrams, Processes | Indicates the person (not resource object) that is the Process Owner for this object |
| projectEndDate | Documents, WebDiagrams, ExternalFiles, Reports | date/time |
| projectName | Documents, WebDiagrams, ExternalFiles, Reports | |
| projectPercentComplete | Documents, WebDiagrams, ExternalFiles, Reports | |
| projectStartDate | Documents, WebDiagrams, ExternalFiles, Reports | date/time |
| proposedObject | WebDiagrams and Diagram Elements | If the describesState of a diagram is Existing Object Proposed , this property will contain the object that was proposed for the describes relationship. |
| providesBenefitTo | All Enterprise Objects, (Web-authored) Diagram, (Client-authored) IGX Document, IGX Diagram, IGX Sheet, External File, Web Address | |
| purpose | All | |
| rating | Controls, Control Instances | Control Rating |
| receives (.from, .workProduct) | Process, Activity, External Agent | |
| requiredFor | Capability | |
| requiredGroupWatchers | All | List of groups that are required to watch the object |
| requiredUserWatchers | All | List of users that are required to watch the object |
| requirementType | Requirements | RequirementType |
| requires | Moment, Touch, Product, Business Service | |
| resourceAttended | Resources | Only applies to Resources of type Bot |
| resourceAvailabilityPercentage | Resources | |
| resourceAvailabilityTimeAwayExpression | Resources | |
| resourceAvailabilityTimeAwayUnit | Resources | TimeUnit |
| resourceCount | Resources | |
| resourceCountUnlimited | Resources | true/false |
| resourceHourlyRate | Resources | |
| resourceLatitude | Resources | |
| resourceLongitude | Resources | |
| resourceMaximumHourlyOvertimePerDay | Resources | |
| resourceOvertimeHourlyRate | Resources | |
| resourcePerUseCost | Resources | |
| resourceInstance | ResourceType | Access RESOURCE objects from RESOURCE_TYPE object |
| resourceType | Resources | Access RESOURCE_TYPE object from RESOURCE object |
| responsible (.resource, .role) | All | |
| reviewApplicant | Documents, WebDiagrams, ExternalFiles, Reports | username of the user started the running cycle |
| reviewCycleLog | All | All actions that take place in review cycles |
| reviewCycleParticipation | All | Reviewed By usernames |
| reviewDate | Documents, WebDiagrams, ExternalFiles, Reports | Date when reviewed |
| reviewDateOmitVersion | Documents, WebDiagrams, ExternalFiles, Reports | Date when any version of the object was last reviewed |
| reviewed | Documents, WebDiagrams, ExternalFiles, Reports | true/false |
| reviewers | Documents, WebDiagrams, ExternalFiles, Reports, Enterprise Objects | |
| reviewGroupActionCompleted | Documents, WebDiagrams, ExternalFiles, Reports | Users who have reviewed the cycle (only accessible if a cycle is running on the respective version) |
| reviewGroupActionPending | Documents, WebDiagrams, ExternalFiles, Reports | Users the review cycle is waiting on (only accessible if a cycle is running on the respective version) |
| reviewGroupUsers | Documents, WebDiagrams, ExternalFiles, Reports | All users in the review cycle (only accessible if a cycle is running on the respective version) |
| reviewNextStartDate | Documents, WebDiagrams, ExternalFiles, Reports | Date when next scheduled review cycle will start |
| reviewStartDate | Documents, WebDiagrams, ExternalFiles, Reports | Date when the active, in-progress review cycle started |
| reviewState | Documents, WebDiagrams, ExternalFiles, Reports | CycleState |
| risk:category | Controls, Control Instances, Risks, Risk Instances | Risk Category |
| riskDataSeriesType | Risk and Risk Instances | |
| riskFinancialImpactUnit | Risk and Risk Instances | |
| riskPreempt | Risk and Risk Instances | |
| riskWeighting | Risk and Risk Instances | |
| rollsUp | Performance Indicator | |
| rootResourceType | ResourceType Objects | RootResourceType |
| sapCustomTransaction | SAP Transactions | true/false |
| sapDocumentBlueprintRelevant | Documents, WebDiagrams, ExternalFiles, Reports | true/false |
| sapDocumentStatus | Documents, WebDiagrams, ExternalFiles, Reports | SAPStatus |
| sapDocumentType | Documents, WebDiagrams, ExternalFiles, Reports | |
| sapInScope | SAP objects | true/false |
| sends (.to, .workProduct) | Process, Activity, External Agent | |
| shapeLibraryUsedBy | Web Diagram | |
| shortcuts | All | |
| shortcutTo | Shortcuts | |
| size | Documents, WebDiagrams, ExternalFiles, Reports | |
| specialResourceType | ResourceType Objects | SpecialResourceType |
| subtype | Controls, Control Instances, Performance Indicators, Risks, Risk Instances | The sub type of the type. Examples include Business Rule, Control, Gap, Measurement, Instance and Compliance |
| summary | All | |
| supports (.object, .sapInScope) | Process/Activity, Class, Interface/Service, Journey/Moment/Touch, Capability, Product, Business Service, External Agent, Operation, Resource, SAP Branch/SAP Scenario/SAP Process/SAP Process Step, SAP Interface, SAP Service, SAP Master Data, SAP Transaction | |
| text | All | Fulltext search for words included in string fields and document content. Only available as filter property. |
| threatPosedBy | All Enterprise Objects, (Web-authored) Diagram, (Client-authored) IGX Document, IGX Diagram, IGX Sheet, External File, Web Address | |
| type | All | ObjectType |
| url | Web Addresses | |
| userRoleAssignments | All | The users and respective item roles directly assigned on an object.
|
| usesShapeLibrary | Shape Library | |
| version | Documents, WebDiagrams, ExternalFiles, Reports | User Displayable version of object |
| versionID | Documents, WebDiagrams, ExternalFiles, Reports | Internal version of object |
| workProductLayer | Work Products | WorkProductLayer |
This property does not show item roles inherited from ancestors, only group assignments made on the object itself.
SAP functionality is retired. Existing SAP objects are retained, though new SAP objects and connections may no longer be made.
Custom Properties
When you create custom object properties in a repository, they are assigned a display name and a property name. The property name must start with a letter, and use only letters, numbers, and underscores. This is required so that you can use this custom property name as an element in report filter strings.
To use a custom property in a report filter string, prefix it with "custom:".
For example, if you had a custom property named "kpiCategory" you could use it in a report filter string as "custom:kpiCategory".