This block allows you to display and optionally change a worker's emergency contacts, dependents, and beneficiaries.
The block has these additional settings:
Parameter | Example Usage | Description |
---|---|---|
Data source | Applaud HR Person Contacts | The Data source to use to display the list of contacts. Unless you wish to customize the default Data source, you can nearly always just use Applaud HR Person Contacts. |
Order by | nvl(transaction_step_id, -1) DESC, emrg_contact_flag DESC, emrg_contact_flag DESC, formatted_name | The order to return the items from the Data source. This should be a valid SQL ORDER BY clause that only contains columns available in the Data source. The Example here is the recommended sort order and in most cases, you can use this. |
Joining columns | Checked with joining columns overridden | Advanced users only. You will not need to use this unless you customize the Data source and you change the column names or aliases for any of these joining columns. If you do, you should select the renamed column here from the customized Data source. |
View formula | XXX_BK_CONTACTS_VIEW | The Fast Formula that controls the display of contacts. See Personalizing the display of contacts below. |
No items text | No emergency contacts, dependents or beneficiaries. Why not create your first contact now? | The text to display when no contacts are on record, or when the user does not have permission to view any contacts from the Data source. |
If you are upgrading from an earlier version of the app, you may be required to perform some additional configuration steps to personalize the viewing and editing of a contact's basic details, phones, and addresses. Please refer to Upgrading contacts.
Personalizing the display of contacts
You can personalize the display of contact information by editing the View formula. For example, you can:
- Set the text that is displayed for an emergency contact, and the type of emergency contact.
- Set the relationship the contact has with the worker
The formula provides the following Inputs that are available for you to use in your logic:
Input | Example Value | Description |
---|---|---|
Transaction_Type | INSERT UPDATE DELETE | If the contact is going through workflow, this indicates whether it's a new contact (INSERT), a change to an existing contact (UPDATE), or a contact being removed (DELETE). |
Transaction_Step_id | 12345 | The Transaction Step Id from the hr_api_transaction_steps table. This is used to set Pending_Person_id, which is required for correct processing. |
Workflow_Status_Code | PENDING SFL APPROVED RFC ERROR | Only set when a contact is going through the workflow. PENDING = Pending approval SFL = Saved for later APPROVED = Approved but not saved to database RFC = Returned for correction ERROR = Workflow error |
Workflow_Status_Meaning | Pending approval | A user-friendly value for the Workflow_Status_Code. See Workflow_Status_Code. |
Contact_Person_Id | 12345 | The contact's Person Id in per_all_people_f. New contacts going through workflow will not be assigned a Contact Person Id until the workflow is approved and completed. |
Formatted_Name | John Doe | The formatted name of the contact (see Person name formats). When a new contact is going through workflow this will not have a value; you can use First_Name_p and Last_Name_p instead. |
First_Name_p | John | When a contact is going through workflow, this is the new or changed value for the contact's First Name. |
Last_Name_p | Doe | When a contact is going through workflow, this is the new or changed value for the contact's Last Name. |
Contact_Type_Meaning | Spouse Child | The relationship to the worker. When a new contact is going through workflow this will not have a value; you can use Contact_Type_Meaning_p instead. |
Contact_Type_Meaning_p | Spouse Child | When a contact is going through workflow, this is the new or changed value for the contact's relationship to the worker. |
Emrg_Contact_Flag | Y N | Y if this contact is an emergency contact; N otherwise. |
Primary_Contact_Flag | Y N | Y if this contact is the worker's primary contact; N otherwise. |
You can return the following Outputs in the formula:
Input | Example Value | Description |
---|---|---|
Delete_Allowed | Y N | Set to Y if the user is allowed to remove the contact; N otherwise |
Person_Id | 12345 | When Contact_Person_Id has a value, set this to the same value |
Pending_Person_Id | 12345 | When Pending_Person_Id has a value, set this to the same value |
Status_Icon | ice | Deprecated and no longer used. This was used in older versions of the app. |
Status_Color | red #CC0000 | When Status_Text is specified, this sets the background color behind that text. |
Status_Text | New: draft Updated: pending approval | Sets some text that shows the status of this contact. |
Main_Text | John Doe | The main text shown against a contact typically used to display their name |
Sub_Text | Spouse | Secondary text about a contact is typically used to display the contact's relationship to the worker |
The default install sets up a contact block on the Personal Information page with a best practice View formula. You can inspect this formula to see how these Inputs and Outputs are used in the default install.