HumanResources.Governance.GovernancePolicies Entity

Namespace: HumanResources.Governance

Policies represent the identity of an internal rule, policy, procedure, guideline, or job description. A policy defines what the rule is about, how it is named and classified, and how it is organized (e.g. in folders). The actual text of the policy and its changes over time are stored as separate policy revisions. Entity: Hrm_Governance_Policies (Introduced in version 26.2.0.88)

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault
API access: ReadWrite

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

HumanResources.Governance.GovernancePolicies

Attributes

Name	Type	Description
Code	string (32)	Human-friendly unique identifier (e.g. HR-REMOTE-WORK). `Required` `Filter(eq;like)` `ORD`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExternalId	string	The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]
ExternalSystem	string	The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]
Id	guid
IsActive	boolean	Indicates whether the policy is active as a concept. `Required` `Default(true)` `Filter(eq)`
Name	MultilanguageString (256)	Policy name as spoken by users (e.g. "Remote Work Policy"). `Required` `Filter(like)`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
PolicyKind	PolicyKind	Classification of the policy. `Required` `Filter(eq)`

Attribute Details

Code

Human-friendly unique identifier (e.g. HR-REMOTE-WORK). Required Filter(eq;like) ORD

Type: string (32)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 32
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ExternalId

The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]

Type: string
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ExternalSystem

The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]

Type: string
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsActive

Indicates whether the policy is active as a concept. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

Name

Policy name as spoken by users (e.g. "Remote Work Policy"). Required Filter(like)

Type: MultilanguageString (256)
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

PolicyKind

Classification of the policy. Required Filter(eq)

Type: PolicyKind
Category: System
Allowed values for the PolicyKind(HumanResources.Governance.GovernancePolicies.md#policykind) data attribute
Allowed Values (HumanResources.Governance.GovernancePoliciesRepository.PolicyKind Enum Members)

Value	Description
JobDescription	Job Description. Stored as 'JOB'. Database Value: 'JOB' Model Value: 0 Domain API Value: 'JobDescription'
Guideline	Guideline. Stored as 'GDL'. Database Value: 'GDL' Model Value: 1 Domain API Value: 'Guideline'
Rule	Rule. Stored as 'RUL'. Database Value: 'RUL' Model Value: 2 Domain API Value: 'Rule'
Procedure	Procedure. Stored as 'PRC'. Database Value: 'PRC' Model Value: 3 Domain API Value: 'Procedure'
Policy	Policy. Stored as 'POL'. Database Value: 'POL' Model Value: 4 Domain API Value: 'Policy'
Other	Other. Stored as 'OTH'. Database Value: 'OTH' Model Value: 5 Domain API Value: 'Other'

Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

user
The user.
Type: Users
notificationClass
The notification class.
Type: string
subject
The notification subject.
Type: string

priority
The notification priority.
Type: Systems.Core.NotificationsRepository.Priority
Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

Value	Description
Background	Background value. Stored as 1. Model Value: 1 Domain API Value: 'Background'
Low	Low value. Stored as 2. Model Value: 2 Domain API Value: 'Low'
Normal	Normal value. Stored as 3. Model Value: 3 Domain API Value: 'Normal'
High	High value. Stored as 4. Model Value: 4 Domain API Value: 'High'
Urgent	Urgent value. Stored as 5. Model Value: 5 Domain API Value: 'Urgent'

Optional: True
Default Value: Normal

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules