a!controlPanelRecordHierarchyMetadata Function

Function

a!controlPanelRecordHierarchyMetadata( controlPanel, recordUuid )

Returns relevant information for the specified category or type and its parent(s). This includes record fields and other information associated with the category or type, such as the display name, icon, and color.

This function can only be used to reference control panel objects and the record types associated with them.

See also:

• a!controlPanelRecord

Parameters

Keyword	Type	Description
controlPanel	Control panel object reference	A reference to a control panel object. The reference structure is: controlPanel![control panel name].
recordUuid	Text	The UUID of the individual record for the specified category or type. This is the value of the "uuid" field in the Hierarchy record type.

Returns

Record metadata

Usage considerations

Security and permission levels

Here are the security rolemaps and permissions that the function does or does not check in the control panel object and associated objects.

• The function does check:
  • The security rolemap of the control panel object to see that the user has at least Viewer permissions to the control panel object.
  • The security and permissions for the associated record types.
• The function does not check:
  • The security rolemap for any of the control panel hierarchy items used by the control panel object.

Feature compatibility

The table below lists this function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Partially compatible	Can be used with Appian Portals if it is connected using an integration and web API.
Offline Interfaces	Partially compatible	Can be used with offline interfaces if loaded at the top of the interface.
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Partially compatible	If autoscale is enabled, can be used to configure a supported process event node (such as a start event or timer event).
Process Autoscaling	Compatible	Can be used in autoscaled processes.
Event Consumer Filter Conditions	Incompatible	Cannot be used in filter conditions.
Event Consumer Event Handlers	Incompatible	Cannot be used in event handler expressions.

Feedback