Get Values Using HCM Params
You can use get values from HCM Params global function when defining your autocomplete rule.
This table describes the global functions using an HCM Params
Function |
Variable Type |
HCM Params Name |
Available in Actions |
Description |
---|---|---|---|---|
Get string value from HCM Params | String | EMP_ModuleIdentifier | All employment flows | Returns the module name for employment flows. |
Get string value from HCM Params | String | TERM_TerminationLevel |
|
Indicates the termination level. For work relationship level, the HcmParam value is WR. For assignment level, the HcmParam value is ASG. Note: This HcmParam is applicable for V3 Terminations only. |
Get string value from HCM Params | String | EMP_SensorProcessName |
|
Indicates the current flow that’s started. For Terminate Employment flow, when you perform a work relationship level termination, the HcmParam value is Terminations. When you perform an assignment level termination in the same flow, the HcmParam value is AssignmentTerminations. For Resign from Employment flow, when you do a work relationship level resignation, the HcmParam value is Resignation. When you do an assignment level resignation in the same flow, the HcmParam Value is AssignmentResignation. The following lists the module, value, and the level where this HcmParam is used. Module -- Value -- Level Terminate Employment -- Terminations -- WR Resign From Employment -- Resignation -- WR Terminate Employment -- AssignmentTerminations -- ASG Resign From Employment -- AssignmentResignation -- ASG Correct Termination -- CorrectTermination -- WR Correct Termination -- AssignmentCorrectTermination -- ASG Note: This HcmParam is applicable for V3 Terminations only. |
Get date value from HCM Params | Date | EMP_Groovy_V3NotificationDate |
|
Indicates the notification date selected for the flow.
|
Get date value from HCM Params | Date | EMP_Groovy_V3TerminationDate |
|
Indicates the termination date selected for the flow. |
Get string value from HCM Params | String | CSA_StudioRules | Employment flows that include Salary section such as Hire, Promote, Local and Global Transfer |
Parameter will be set to Y when in salary section. Use it when you want the validation rules written on Salary business object to trigger when the user tries to move out of the salary section by clicking on Continue or navigating to previous or next section. Valid values are Y, N, or Null. |
Get boolean value from HCM Params | Boolean | IS_REST_SERVICE | All employment flows |
Returns Y if the interface is Worker REST Service. Valid values are Y or N. |
Get string value from HCM Params | String | CMP_Download_Salary | Change Salary | Returns Y when Salary is being loaded from Download Salaries
tool. Valid values are Y, N, or Null. |
Get string value from HCM Params | String | isSalaryRateBatchProcess | N/A | Returns Y when creating or correcting salary through Run
Rates-based Salary process. Valid values are Y or Null. |
Get string value from HCM Params | String | EMP_Groovy_OfferMode | Create and Edit Job Offer | Returns CreateOffer if the offer is being created. Returns EditOffer if the offer is being edited. Returns DuplicateOffer if the offer is being duplicated. |
Get string value from HCM Params | String | DOR_UX | All Document Record flows | Returns Y if the document record is managed through the UI.
Valid values are Y or Null. Note:
|
Get string value from HCM Params | String | GOALS_ACTION |
|
|
Get string value from HCM Params | String | GOALS_ESS_FLOW |
|
Returns Y when goal is modified in the ESS flow. |
Get string value from HCM Params | String | GOALS_HDL_LOAD | Loading goals | Returns Y when goal is modified in HDL flow. |
Get string value from HCM Params |
String |
CSA_RespOfferFlow |
|
Returns Y when responsive offer flows are used. Valid values are Y or Null. |
Get string value from HCM Params |
String |
CSA_MobileFlow |
|
Returns Y when Salary section is visited Valid values are Y or Null. |
Get string value from HCM Params |
String |
POS_ActionReason |
|
Returns the related action reason of the position. |
Get date value from HCM Params |
Date |
POS_ActionDate |
|
Returns the related action date of the position. |
Get string value from HCM Params |
String |
JobRequisitionCreationSource |
|
Returns the source of requisition creation. Values are:
|
Get string value from HCM Params |
String |
isRecruitingCandidate |
|
Returns Y if it's a recruiting candidate. |
Get string value from HCM Params | String | EMP_AssignmentId |
|
Returns the Assignment ID on the assignment. |
Get string value from HCM Params |
String |
EMP_Groovy_GradeStepName |
Returns the grade step name for a specific assignment. |
|
Get string value from HCM Params |
String |
EMP_Groovy_GradeStepId |
Returns the grade step ID for a specific assignment. |
|
Get string value from HCM Params |
String |
EMP_Groovy_ActionTypeCode |
|
Returns the related action type code of the action being used in the rule, such as EMPL_ADD_EMP for the Hire an Employee action. Note: Use this HcmParam if you’re authoring a rule based on the action or action type in employment update flows such as Change Assignment, Promote, Transfer, and so on. |
Get string value from HCM Params |
String |
EMP_Groovy_ActionReasonCode |
|
Returns the related action reason code of the action reason being used in the rule. Values are listed on the Action Reasons page on My Client Groups tab. Note: Use this HcmParam if you’re authoring a rule based on the action or action type in employment update flows such as Change Assignment, Promote, Transfer, and so on. |
Get string value from HCM Params | String | EMP_Groovy_ActionCode |
|
Returns the related action code used in the rule. Note: Use this HcmParam if you’re authoring a rule based on the action or action type in employment update flows such as Change Assignment, Promote, Transfer, and so on. |
Get string value from HCM Params |
String |
EMP_Groovy_LegislationCode |
|
Returns the legislation code of the legal employer on the assignment, such as IN for India legislation. Values are listed on Configure Legislation for Human Resources page in the Setup and Maintenance work area. Query to get legislation code - Note: For hire flows, this hcm param returns the legislation code.
For global transfer, this hcm param returns the source legislation
code.
|
Get string value from HCM Params |
String |
EMP_FteValue |
|
Returns the FTE value as a string type. |
Get string value from HCM Params |
String |
EMP_Groovy_LegalEntityId |
|
Returns the legal entity ID of the legal employer on the assignment, such as 202 for Vision Corporation. Values are listed on the Manage Legal Entity HCM Information page in the Setup and Maintenance work area. Note: For global transfer, this hcm param returns the source legal
entity ID.
|
Get string value from HCM Params |
String |
EMP_Groovy_PeriodType |
|
Returns the period type from the worker's work relationship. For example, E for employee. Values are:
|
Get string value from HCM Params |
String |
EMP_Groovy_NewLegislationCode |
|
Returns the legislation code of the new legal employer on the assignment, such as US for United States. Values are listed on Configure Legislation for Human Resources page in the Setup and Maintenance work area. Query to get legislation code - Note: For global transfer, this hcm param returns the target
legislation code.
|
Get string value from HCM Params |
String |
EMP_Groovy_NewLegalEntityId |
|
Returns the legal entity ID of the new legal employer on the assignment, such as 202 for Vision Corporation. Values are listed on the Manage Legal Entity HCM Information page in the Setup and Maintenance work area. Note: For hire flows, this hcm param returns the legal entity ID.
For global transfer, this hcm param returns the target legal entity
ID.
|
Get string value from HCM Params |
String |
EMP_Groovy_TerminationRegion |
V3 Actions
V2 Actions
|
Indicates the current section in which you are operating for a flow. For the different sections, the HcmParam values are as follows:
Note: The last 4 values are applicable only for V3 Terminations. In addition, the value for Termination Info in V2 is TerminationDetails |
Get string value from HCM Params | String | LegislationCode |
|
Returns the legislation code of the legal employer on the assignment, such as IN for India legislation. Values are listed on the Configure Legislation for Human Resources page in the Setup and Maintenance work area. Query to get legislation code - |
Get string value from HCM Params |
String |
CmpRespLMgrSalary |
|
Returns Y when My Team - Change Salary action is used. Valid values are Y or Null. |
Get string value from HCM Params |
String |
CmpRespAdminSalary |
|
Returns Y when My Client Groups - Change Salary action is used. Valid values are Y or Null. |
Get string value from HCM Params |
String |
CmpRespAdminHistory |
|
Returns Y when Salary History action is used. Valid values are Y or Null. |
Get string value from HCM Params |
String |
PAY_ADD_ASSIGNMENT |
Available only in payroll objects in these flows:
|
Returns Y when a transaction created through the available actions stated, for example, Add Contingent Worker, and so on. Valid values are Y or Null. |
Get string value from HCM Params |
String |
isHDLoad |
|
Returns Y for loading a Salary object using HCM Data Loader or HCM Spreadsheet Data Loader. Valid values are Y, N, or Null. |
Get string value from HCM Params |
String |
IsSalaryRestService |
|
Returns Y for loads using the Salaries REST resource. Valid values are Y, N, or Null. |
Get boolean value from HCM Params |
Boolean |
EMP_UX |
|
Returns true for a responsive UI for employment actions. Valid values are Y or N. |
Get string value from HCM Params |
String |
isHDLWorker |
|
Returns Y for an HCM Data Loader or HCM Spreadsheet Loader load for employment actions. Valid values are Y or N. |
Get date value from HCM Params |
Date |
ChangeDate |
N/A |
Returns the date for changes in person name, marital status, person address, visa and permits, and contact relationship in the person employee self-service mobile responsive UIs only. |