Selectable Fields for Business Objects

Alternate owner 1

Returns the altowner1 for the business object

Alternate owner 2

Returns the altowner2 for the business object

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.

The value for the attribute as it was entered by the user, regardless of the normalized value

Returns the input value as it was entered

If the value was entered with no units specified, this selectable returns the default unit.

Returns the input unit as it was entered

Attribute[ATTRNAME] and attribute [ATTRNAME].value also return the normalized value.

Returns the default (normalized) value

The defined default units for the dimension

Returns the default (normalized) unit

Unitvalue[UNITNAME] is not a stand-alone selectable because it would simply return UNITNAME. It has subselects as defined below.

Returns the converted value in the unit UNITNAME.

Converts the specified value to a text string including the values and units

Returns "attribute.*value attribute.*unit"

Returns the unit in the system SYSTEMNAME corresponding to the unit selected off of the attribute.

Converts the specified value to a text string including the values and units

Returns the value and unit of the system SYSTEMNAME.

Returns the value converted to the unit in the system SYSTEMNAME corresponding to the unit selected off of the attribute

Attribute value on this instance

Value

Context identifier

Returns current user context information

Context role

Returns the name of the context role. With [], returns TRUE/FALSE, depending on whether the string in [] matches the context role.

Current State

State name (see also Selectable Fields for Policy)

Allowed accesses for the current user.

current.access[ACCESS_TYPE] accepts minorrevise as an ACCESS_TYPE.

Returns a string of all permissions (with comma separator) for the current user. For example:

read,modify,revise,show

Note: The keyword revise is output rather than minorrevise in order to maintain upward compatibility.

Actual date

Value

Actual date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator)

Value

Is current state?

True/False

Is disabled?

True/False

Isenabled?

True/False

State name

Value

Is overridden?

True/False

Requirements and accesses on the state

State name

requirements.access[].*

Accesses for defined users

Returns a string of all permissions (with comma separator)

Program

Program name

Can be autopromoted?

True/False

Program

Program name

Is checkout history enabled?

True/False

Is the signature requirement satisfied?

True/False

Requirements identifier

Value

State name

Value

Notify message

Value

owneraccess

Accesses for owner use

Returns a string of all permissions (with comma separator)

Accesses for public use

Returns a string of all permissions (with comma separator)

requirements.minorrevisionable

Is revisionable?

True/False

Person/group to reassign

User name

Signature instance

Name of signature or signer - See state.signature expansion below and in policy state.

requirements.versionable

Does have versions?

True/False

Is revisionable?

True/False

Are requirements satisfied?

True/False

Scheduled date

Value

Scheduled date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator)

Value

Signature instance

Signature properties and accesses

signature.approved

Approved?

True/False

signature.comment

Comments from the signer

Comments

signature.hasapprove

Has been approved?

True/False

signature.hasignore

Has been ignored?

True/False

signature.hasreject

Has been rejected?

True/False

signature.ignored

Ignored?

True/False

signature.name

Signature name

Signature name

signature.rejected

Has been rejected?

True/False

signature.satisfied

Signature requirement is satisfied?

True/False

signature.signed

Signed?

True/False

Signer ID

Signer ID

Is versionable?

True/False depending on how set.

The date on which the object first entered the state.

Date value. Value is an empty string if the object has never been in the state. This differs from the actual date in that the actual date is modified every time the object is promoted or demoted into the state.

The date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) on which the object first entered the state.

Date value. Value is an empty string if the object has never been in the state. This differs from the actual date in that the actual date is modified every time the object is promoted or demoted into the state.

Date on which the object was last in the given state.

Date value. Value is an empty string if the object has never been in the state.. Value is 'NOW' for the current state.

Date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) on which the object was last in the given state.

Date value. Value is an empty string if the object has never been in the state.. Value is 'NOW' for the current state.

Time spent in the state.

Value is the number of seconds spent in the state. If an object is in a state more than once, this is a cumulative value. Value is an empty string if the object has never been in the state.

Default format for the definition object

Name of Default Format (see Selectable Fields for Formats)

Default format definition object

Name of business object

What files are present?

If file name is specified in [ ], returns True if that file is associated with the format instance. Otherwise, returns False.

If file name is not specified, returns list of all files associated with the format instance.

?

Captured file name

Format object instance

(see Selectable Fields for Formats)

Host machine from which the file was checked in.

Host name

Location object where file is located.

(see Selectable Fields for Location)

Name of checked- in file.

Name

Returns all locations holding a copy of the file that has been marked as obsolete (needing synchronization), regardless of user's site preference.

List of locations

default/format.file.path

Path from which file was checked in.

Path

With Version 9 and higher, the output from the format.file.path selectable has changed to use forward slashes (/) instead of back slashes (\). For example, c:\mydocs\testfile.txt now appears as /c/mydocs/testfile.txt.

default/format.file.size

File size in Mb

Value(s)

Store object where file is located.

(see Selectable Fields for Store)

Returns all locations holding synchronized versions of the checked in file(s), regardless of user preference.

List of locations.

Format definition object

Name of Format (see Selectable Fields for Formats)

Is a file present?

True/False

Returns the last checkin dates of specified filenames in the specified format.

Last check in dates.

Value

Evaluate the named expression against the business object

Value

Evaluate the specified expression string against the business object

Value

Used with no other selectable; Asks: Does this object exist?

Returns true/false if it is the only selectable entered. Otherwise an error occurs.

Revisions of an object

Returns the revision identifier of the requested object. Works the same as in the next level in revisions[ ].

Instances of all format objects

If a name is specified, returns True if an instance of format name actually exists and False if not; if nothing or a pattern is in [] then returns all format type names allowed.

Locations where files are synchronized, obsolete or none.

If a name is specified, returns True if an instance of format name actually exists and False if not; if nothing or a pattern is in [] then returns all format type names allowed. When it contains multiple values, lists values in square brackets.

Use format2.file.synchronized to identify the locations where files are synchronized.

Use format2.file.needsynchronization to identify files needing synchronization from one store/location to another store/location. Returns True or False.

Use format2.file.status to display status of the file. Returns store and all locations in brackets and displays status of file: synchronized, obsolete or none.

from relationships

If the specified relationship exists returns True; otherwise False. If nothing or a pattern is specified in [ ], lists names of all the associated relationships.

[??]

Value

User(s) to whom access is granted

Value

Grantee accesses

Value

Have signature accesses been granted?

True/False

Grant identifier

Value

User granting access

Value (seeSelectable Fields for User)

Text log of history

If history[n] = returns the nth history entry. If nothing is specified in [ ], returns log of all entries.

Text log of history

Returns a list of approve history records

Text log of history

Returns a list of changename history records

Text log of history

Returns a list of changeowner history records

Text log of history

Returns a list of changepolicy history records

Text log of history

Returns a list of changetype history records

Text log of history

Returns a list of changevault history records

Text log of history

Returns a list of checkin history records

Text log of history

Returns a list of checkout history records

Text log of history

Returns a list of connect history records

Text log of history

Returns a list of create history records

Text log of history

Returns a list of custom history records

Text log of history

Returns a list of demote history records

Text log of history

Returns a list of disable history records

Text log of history

Returns a list of enable history records

Text log of history

Returns a list of grant history records

Text log of history

Returns a list of ignore history records

Text log of history

Returns a list of lock history records

Text log of history

Returns a list of minor revision history records

History records say:

history.revise = revisioned - user: NAME ...

History records say:

history.majorrevise = majorrevisioned - user: NAME ...

Text log of history

Returns a list of modify history records

Text log of history

Returns a list of modifyattribute history records

Text log of history

Returns a list of movedoid history records

Text log of history

Returns a list of override history records

Text log of history

Returns a list of promote history records

Text log of history

Returns a list of purge history records

Text log of history

Returns a list of reject history records

Text log of history

Returns a list of removedoid history records

Text log of history

Returns a list of removefile history records

Text log of history

Returns a list of revoke history records

Text log of history

Returns a list of schedule history records

Text log of history

Returns a list of all states the object was in when operations were performed on it.

Text log of history

Returns a list of the timestamps of every history record.

Text log of history

Returns a list of the timestamps in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) of every history record.

Text log of history

Returns a list of unlock history records

Text log of history

Returns a list of all users who have operated on the object

Subset of entire history log

With no dates included, returns a list of all history records.

When dates are included, they must adhere to the date format of the system.

If both FROMDATE and TODATE are provided, the list includes events that occurred between the 2 dates, inclusive of FROMDATE but exclusive of TODATE.

If only FROMDATE is included, the list includes events that occurred between the date specified and the present date, inclusive of both FROMDATE and the present date.

If only TODATE is specified, the list includes events that occurred before the date specified, exclusive of TODATE.

History log count

With no dates included, returns an integer which is the total number of history records for the object.

When dates are included, they must adhere to the date format of the system.

If both FROMDATE and TODATE are provided, the list includes events that occurred between the 2 dates, inclusive of FROMDATE but exclusive of TODATE.

If only FROMDATE is included, the list includes events that occurred between the date specified and the present date, inclusive of both FROMDATE and the present date.

If only TODATE is specified, the list includes events that occurred before the date specified, exclusive of TODATE.

List of history log details

Returns a list of entries for each history record, that includes any fields other than state, user, event, or date concatenated together. Differs depending on the event.

List of history log details

When between.dates are included, they must adhere to the date format of the system.

If both FROMDATE and TODATE are provided, the list includes events that occurred between the 2 dates, inclusive of FROMDATE but exclusive of TODATE.

If only FROMDATE is included, the list includes events that occurred between the date specified and the present date, inclusive of both FROMDATE and the present date.

If only TODATE is specified, the list includes events that occurred before the date specified, exclusive of TODATE.

List of history events

Returns a list of all history events that have occurred for the object.

List of users

Returns the user responsible for each history record. When between.dates are included, they must adhere to the date format of the system.

If both FROMDATE and TODATE are provided, the list includes events that occurred between the 2 dates, inclusive of FROMDATE but exclusive of TODATE.

If only FROMDATE is included, the list includes events that occurred between the date specified and the present date, inclusive of both FROMDATE and the present date.

If only TODATE is specified, the list includes events that occurred before the date specified, exclusive of TODATE.

List of history event times

Returns the timestamps of history events.

When between.dates are included, they must adhere to the date format of the system.

If both FROMDATE and TODATE are provided, the list includes events that occurred between the 2 dates, inclusive of FROMDATE but exclusive of TODATE.

If only FROMDATE is included, the list includes events that occurred between the date specified and the present date, inclusive of both FROMDATE and the present date.

If only TODATE is specified, the list includes events that occurred before the date specified, exclusive of TODATE.

List of history event times

Returns the timestamps in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) of history events.

When between.dates are included, they must adhere to the date format of the system.

If both FROMDATE and TODATE are provided, the list includes events that occurred between the 2 dates, inclusive of FROMDATE but exclusive of TODATE.

If only FROMDATE is included, the list includes events that occurred between the date specified and the present date, inclusive of both FROMDATE and the present date.

If only TODATE is specified, the list includes events that occurred before the date specified, exclusive of TODATE.

Object identifier

Value

Is checkin allowed only if the object is locked?

True if enforced locking is turned on. False if not.

Revisions of an object

Returns the revision identifier of the requested object. Works the same as in the next level in revisions[ ].

Vault name

Value (see Selectable Fields for Vault)

Is this object locked?

True/False

Administrative object

User that Locked object

A business object identifier. A logical id is a global identifier shared by all members of a revision sequence.

This selectable is only available if your database has been upgraded to use physical and logical IDs.

Value

?

Returns all programs that are associated as methods

Modification time and date

Value

Modification time and date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator)

Value

Business object name

Value

Revisions of an object

Returns the revision identifier of the requested object. Works the same as in the next level in revisions[ ].

Creation time and date

Value

Creation time and date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator)

Value

?

Value (see Selectable Fields for User)

Organization(s) that own the business object

Value(s) or blank if none

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

See also Selecting Ownerships, below.

Project(s) that own the business object

Value(s) or blank if none

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

See also Selecting Ownerships, below.

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.

Security token(s) specifying the ownership access mask of the business object

Value(s)

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

See also Selecting Ownerships, below.

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.

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.

?

Value (seeSelectable Fields for Policy)

A business object identifier. A physical id is a global identifier that is unique to each business object

This selectable is only available if your database has been upgraded to use physical and logical IDs.

Value

Revisions of an object

Returns the revision identifier of the requested object. Works the same as in the next level in revisions[ ].

?

value (see Selectable Fields for Program)

All relationship instances

If the specified relationship exists returns True; otherwise False. If nothing or a pattern is specified in [], lists names of all existing relationships.

Attributes of the relationship

Lists attributes of relationship if nothing specified in []. With a value in [] returns attribute value. (seeSelectable Fields for Attribute)

businessobject.*

The "other" side of the relationship

Returns to object. If used with ".to.relationship", returns name of from object.

Context identifier

Returns current context user.

Business object on from side

Name of from associated business object.

Text log of history

If history [n] = returns the nth history entry. If nothing is specified in [ ], returns log of all entries.

Relationship identifier

Value

Frozen relationship?

Returns list of all relationships with True for frozen, False for not frozen.

Relationship method

Returns the name of the relationship ID

Relationship definition

Relationship name

Timestamp when relationship was originated

Value

propagatemodifyfrom

Is propagatemodify enabled on from businessobject?

True/False

propagatemodifyto

Is propagatemodify enabled on to businessobject?

True/False

Relationship rule that governs that relationship

Returns the name of the relationship rule for that relationship

Business object on to side

Name of to associated business object.

Relationship definition

Relationship type

Boolean indication reserved status of a business object

True/False

Non-empty string or the context user

Name of the person who reserved the object.

The date or timestamp of when the business object was reserved.

Returns the date and time of when that object was reserved.

The date or timestamp in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) of when the business object was reserved

Returns the date and time of when that object was reserved.

Optional comment not exceeding 254 characters from the person reserving the object.

Any comments entered.

Business object revision

Returns the full revision string of the object. If the policy supports both major and minor revisions, this is major-minor.

Existing revisions of an object

If [ ] is left blank, returns the full revision string for all objects in the object's minor revision sequence.

If a revision is specified, returns True if it exists, False otherwise.

True/False

Evaluates to an optional author returned by the search engine

True/False

(see Selectable Fields for Formats)

Host name

(see Selectable Fields for Location)

Name

Path name

Evaluates to an optional search score returned by the search engine

Size

(see Selectable Fields for Store)

Evaluates to an optional document title returned by the search engine.

Returns the url address

States used in the lifecycle of the policy

Returns state names from lifecycle

to relationships

If the specified relationship exists returns True; otherwise, False. If nothing or a pattern is specified in [ ], lists names of all the associated relationships.

any trigger configured for the object

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.

any trigger configured for the object; does not include inherited triggers

Returns list of triggers directly configured for the type 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 an immediatetrigger. If you do not include a PROGRAM_NAME, all immediatetriggers are listed.

to relationships

If the specified relationship exists returns True; otherwise, False. If nothing or a pattern is specified in [ ], lists names of all the associated relationships.

Use to determine whether or not the specified unit is the normalized value for the dimension

Returns TRUE or FALSE indicating whether or not the unit is the default (normalized) unit

Use to determine the multiplier value for the specified unit

Returns the value of the multiplier used to convert data from the input value to the normalized value

Use to determine the offset value for the specified unit

Returns the value of the offset used to convert data from the input value to the normalized value

Use to retrieve the label assigned to the unit

Returns the label of the unit

Use to retrieve the name of the dimension for which the unit is defined

Returns the dimension that the unit is part of

Use to determine the system to which the unit belongs

If an index (systemname) is given, returns the corresonding systemunit. If no index is given, returns a list of all systemunits applied to this unit.

Vault definition

Vault name (see Selectable Fields for Vault)

(See Selectable Fields for Query)