Request Type Field Paths (for Adams pre-4.5)
Posted by Mont Rothstein on 02 August 2011 11:50 PM
Request Type Field Paths
This document outlines how to format Field Paths in a Request Type Definition File (Visio file).
A Field Path is a dot '.' separated series of data fields. They provide access to both custom and standard data fields by navigating the data structure.
Within a Request Type Definition (a single Tab in Visio) all Field Paths are related to the current request. Everything starts from the current request and moves out from there.
A field path with a single item (no dot) would be referring to a field on the Request.
A field, followed by a dot, followed by another field, refers to a field on the item referred to before the dot. For example to access the Folder Number of the Folder (aka asset folder, aka case) that the Request belongs to you first specified the AssetFolder field on the Request and then the FolderNumber field on the AssetFolder.
To refer to a step within the Request and a field of that step place an @ in from of the step name.
If the Request has a parent request then the parent request, and all of its data, can be accessed by using the "parent" special field name.
child.<subprocess key>.<field path>
If a Request has a sub-request for which it must wait, in which case it must have a Key set, then it can access that sub-request's data by using the "child" special field name and the Key.
A hyperlink/URL to open an existing request in another window can be provided to the user by using the "link" special field name. This is most commonly used in conjunction with the "parent" special field name.
When the exhibit datatype is used it can represent different types of data. It can be an Asset a Property Item or a simple String. Once it is referred to it can be treated like the type that it is (i.e. an Asset, PropertyItem, or String).
// When exibit is an asset
// When exhibit is a property item
// When exhibit is a property ID (from foreign system)