Business Object Keys - User Documentation

Overview

Various extensions will use a key map for an object.

The key can be used in the following way

Document Number ${number}

The following are available

Latest version: 1.3

Object Keys

Key Description
number Number of the object
name Name of the object
oid Unique id of the object
creator Full name of the creator
creatorid User id of the creator
modifier Full name of the last modifier
modifierid User id of the last modifier
user Full name of current user
userid User id of the current user
createdate Date of creation*
createdatetime Date and time of creation*
modifydate Last modified date*
modifydatetime Last modified date and time*
revision Revision e.g. A
iteration Current iteration
stateinternal Internal state
statedisplay State display name
filename Filename of PDF
pbonumber Number of the seed business object e.g. Promotion
pboname Name of the seed business object e.g. Promotion
pbostateinternal Internal state of the seed business object e.g. Promotion
pbostatedisplay Internal state of the seed business object e.g. Promotion
contextname Name of context aka Container
contextdesc Description of context aka Container

Instance Based Attributes

iba:[internal name] - String representation of value, multivalues will become a comma separated list

General Keys

Keys not associated with the object, but are system and extensions specific

Key Description
nowdate Date now*
nowdatetime Date and time now*
nowyear Current year e.g. 2019
clientid PTC client id
clientname PTC Client Name

Task Keys

Key Description
task-userid User ID
task-fullname Full name
task-role Role
task-date Date of the action*
task-date-time Date and Time of the action*
task-vote Vote that user used
task-comments Comments
task-priority Priority
task-required Required
task-complete Complete
task-obj-number Process Object Number
task-obj-name Process Object Name
task-obj-type Process Object Type

Change Keys

Key Description
change-need-date Need Date
change-need-date-time Need Date and Time
change-resolved-date Resolved Date
change-resolved-date-time Resolved Date and Time
change-complexity Change Complexity

All date and time formats are typically set by the configurtion of the extension

If you require a new key, not shown here, please contact wincom support
Was this article helpful? Votes: 2
Article details:
Published date: 02/02/2021 10:12PM
Last updated: 07/05/2021 7:44PM (simonh@wincom-plm.com - simonh@wincom-plm.com)
Share article: 
Author: simonh@wincom-plm.com (simonh@wincom-plm.com)
Permalink: https://wex.wincom-plm.com/kb/articles/extension-business-object-key