Selectable Fields for Relationships

This section lists the selectable fields for relationship objects.

Selectable Fields for Relationship
Field Description Output

abstract

Is this Relationship defined as abstract?

True/False

access

The category of access

Private/Protected/Public

application

Application owning this relationship

Application name

attribute[].*

Attribute instance

If attribute[name] is specified, then default is value; if not, default is a list of all associated attribute names separated by commas.

derivative[].*

All child relationships

If [name] is specified, returns True if name is child of this object; False if not. If no name is specified, returns names of all child relationships.

derived.*

Parent relationship

Name of the parent relationship definition

description

?

Value

fromaction

?

Returns the name of the action rule (None, Float, or Replicate) on the from side of relationship

fromcardinality

from object

Returns from cardinal ID

fromcloneaction

from clone rule

Returns the name of the clone rule (None, Float, or Replicate) on the from side of relationship

frommeaning

from object

Returns from meaning

fromreviseaction

from revision rule

Returns the name of the revision rule (None, Float, or Replicate) on the from side of relationship

fromtype[].*

from object

If type[] is specified, returns True if it is a type on the from side of relationship for this object; False if not. If no name is specified, returns names of types on the from side of the relationship.

hidden

Is this attribute defined as hidden?

True/False

id

Relationship identifier

Value

immediateattribute[].*

Non-inherited attributes

 

immediatederivative[].*

The immediate child relationships

Returns first level children, see derivative for defaults.

immediatetrigger[].*

The triggers defined directly by the relationship excluding parent triggers

 

kindof[].*

relationship.kindof[RELATIONSHIP_IN_HIERARCHY] can do the following:

list all children of the specified parent relationship.

Show the parent of the specified child relationship

resolve a parent/child relationship to TRUE or FALSE

 

modified

The time and date the administration object was modified

Value

modified.generic

The time and date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) the administration object was modified

Value

name

The attribute name

Value

object[ ]

a corresponding business object

Returns a business object where the type matches the string in [ ] and the name is the same as the relationship's name. If no string is given, the object type is relationship, with case ignored. In a case sensitive environment if more than 1 type meets that criteria (such as both a Person type and a PERSON type), OR if there are more than 1 object with the same type and name that are not in the same revision chain, the object with the latest originated date is returned. When objects with same type and name are in the same revision chain, the latest revision is returned.

originated

The time and date the administration object was created

Value

originated.generic

The time and date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) the administration object was created

Value

ownership[].organization

Organization(s) that own the relationship

Value(s) or blank if none

See the MQL Guide > Working with Metadata > Ownership for details.

See also Selecting Ownerships, below.

ownership[].project

Project(s) that own the relationship

Value(s) or blank if none

See the MQL Guide > Working with Metadata > Ownership for details.

See also Selecting Ownerships, below.

ownership[].comment

Comment included in the ownership definition

Value or blank if none

See the MQL Guide > Working with Metadata > Ownership for details.

See also Selecting Ownerships, below.

ownership[].access

Security token(s) specifying the ownership access mask of the relationship

Value(s)

See the MQL Guide > Working with Metadata > Ownership for details.

See also Selecting Ownerships, below.

ownership[].businessobject

The ID of the ownership parent business object

Value or blank if none

See the MQL Guide > Working with Metadata > Ownership for details.

See also Selecting Ownerships, below.

ownership[].relationship

The ID of the ownership parent relationship

Value or blank if none

See the MQL Guide > Working with Metadata > Ownership for details.

See also Selecting Ownerships, below.

preventduplicates

Prevent duplicate relationships?

True/False

property[].*

The associated properties

If property[ ] is specified, returns property names and values. If blank, returns all property names and values.

toaction

?

Returns the name of the action rule (None, Float, or Replicate) on the to side of relationship

tocardinality

to object

Returns to cardinal ID

tocloneaction

to clone rule

Returns the name of the clone rule (None, Float, or Replicate) on the to side of relationship

tomeaning

to object

Returns to meaning

toreviseaction

to revision rule

Returns the name of the revision rule (None, Float, or Replicate) on the to side of relationship

totype[].*

to object

If type[] is specified, returns True if it is a type on the to side of the relationship for this object; False if not. If no name is specified, returns names of types on the to side of the relationship.

trigger[]

any trigger configured for the relationship

Returns list of triggers in this format:

trigger = EVENT_INVOCATION:PROGRAM_NAME(ARGS)

Include a program name in square brackets to check for the existence of that program: TRUE/FALSE will be returned to indicate if that program is or is not configured as a trigger. If you do not include a PROGRAM_NAME, all triggers are listed.

warnduplicates

Warning at attempt to create relationship with duplicate name?

True/False

Selecting Ownerships

There are generally three types of ownership that may be selected:

  • Ownerships with organization/project. The organization/project fields are displayed and the businessobject/relationship fiields are blank.
  • Ownerships with a parent object. The businessobject field is displayed and the organization/project/relationship fields are blank.
  • Ownerships with a parent relationship object. The relationship fields is displayed and the organization/project/businessobject fields are blank.

Each ownership has a name that is constructed from the previous fields. A name pattern may be used to select a single (or group) of ownerships rather than retrieving the whole list. The name may be formatted in one of two ways, and wildcards may be used:

  • Names for ownerships with organization/project are formatted as ORGANIZATION|PROJECT|COMMENT.
  • Names for ownerships with a parent entity (either a business object or relationship) are formatted as OBJECT_ID|COMMENT.

The following are some examples of selecting ownerships:

  • This gets all ownerships based on organization/project: select ownership[*|*|*]
  • This gets all ownerships with a parent object: select ownership[*|*]
  • This gets all ownerships based on an OEM organization: select ownership[OEM|*|*]
  • This gets all ownerships with parent objects and the comment "workspace": select ownership[*|workspace]