Hello ServiceNow Community.
The following article will detail the steps to configure an additional field and adding additional employee data points into the At a Glance section within the HR Agent Workspace.
Role required:
sn_hr_agent_ws.admin, sn_hr_core.admin
What to expect:
The At a Glance section is updated based on the use case:
- The expectation is that the Agent Workspace for HR Case Management plugin is active. This is the plugin for the configurable workspace for HR Agents.
- Add an additional data field to the <user>Team section within the At a Glance pane.
- The UI Builder for Agent Workspace for HR Case Management will be used to add additional containers.
- We will extend the hr_atAGlanceUIBUtilsSNC script include by making our changes in the hr_atAGlanceUIBUtils script include.
- This is an example where the Business Entity, a custom field on the User table, was added to the At a Glance section of the record.
Steps to achieve this functionality:
- Locate the hr_atAGlanceUIBUtils script include and extend it by entering your own code to facilitate your use case.
- In this example, the extended script include contains the custom Business Entity field that was created on the User form. This is a section within the script include that includes other code that was extended. This takes some technical skills, but you can find additional information here.
- Open the UI Builder for Agent Workspace for HR Case Management.
- Open the Case SRP page.
- If you already have a copy of the Case SRP page you can skip this step, otherwise go to the Settings tab, then click the Duplicate link
- This will create a duplicate of the OOtB Page. This is the leading practice to copy the OOtB pages when modifications are required.
- Navigate to the Order field and make your copy of the SRP Page a lower number than the OOTB SRP page. Note: This may require you to set your page’s order to -1 if the OOtB Case SRP page is set at 0. In my example, the copy is set to 0 because the OOtB Case SRP page was set to 50. The lower the number dictates which page (variant) will be used.
- Within the Editor tab, navigate to the At a Glance section of the page. Highlight the Team card container.
- Right click and select Add Component after.
- Select the Container object.
- The component was added lower than where we want so click and hold on the Container 2 (Flex) and drag it just under the Department value as seen in the image below.
- The move will look as follows:
- Click on the newly created Container2 (Flex) then click the Container 2 section in the top of the right pane.
- Rename the container. In our example we are renaming it Business Entity with aag prefixing the Component ID to identify it as an At a Glance container. Click the Apply button after renaming the object.
Now the Department label and Department value objects will be copied and moved under the new Business Entity container.
- Highlight the Department label object, right click and select Duplicate.
- Move the new Stylized Text 3 object below the Business Entity container created earlier. Click and hold the Stylized text 3 field and move it under the Business Entity container.
- Highlight the Department value object, right click and select Duplicate.
- Move the new Stylized Text 4 object below the Business Entity’s Stylized Text 3 object created earlier.
- Click and hold the Stylized text 4 field and move it under the Stylized text 3 field. Note: The fields should line up. If the Stylized text 4 field is further to the left, you can click and drag it above the Stylized text 3 field, then move the Stylized text 3 field back on top of the Stylized text 4 field. The result will look like the image below.
- Next the Business Entity label and Business Entity value will be updated. Click on the first sub-container below your new Business Entity container then click on the Config tab in the right pane.
- In the Text field update the value to Business Entity.
- Click on the Stylized text 3 header and update the value to the following:
- Component label: Business Entity label
- Component ID: aag_business_entity_label
- Click the Apply button.
- Click on the Stylized Text 4 field, then click the Stylized Text 4 heading in the right pane.
- Update the values to the following, then click the Apply button:
- Component label: Business Entity value
- Component ID: aag_business_entity_value
- The next step is how we will get the Business Entity value from the entry in the Script include that was done at the start of this configuration. Navigate to the Business Entity value component. Once highlighted, click on the Config tab.
- In the Text field you can dot walk to the parameter by typing @Data.
- Select hrUICtrl then type another period to get the next parameter in the configuration. Then select atAGlance.
- After the atAGlance is selected, type another period to get the next dot-walked parameter data, then select it in the drop-down list.
- After the data. In the Text field, type the following information to get the business entity data - u_business_entity.displayValue
- The full value of the entire parameter for the Text field is - @Data.hrUiCtrl.atAGlance.data.u_business_entity.displayValue
- The finished value should look like the following:
- Save the changes by clicking the Save button in the upper-right corner of the window.
- Test your work. You should now see the Business Entity data for the user. Again, this was a field created on the User table for demonstration purposes.
The next step we will add a parameter to hide the field when there is no Business Entity value for the Subject Person.
- Click on the Business Entity container, then click on the eye icon in the upper-right corner of the right pane. This will expose the Hide Component toggle.
- Toggle the Hide Component to active. This will expose the selectable icons. Select the Bind Data icon.
- In the Hide component field, you can dot-walk to the data resource, but to simplify things the parameter to hide the business entity is below. This is using this to hide the container when there is no Business Entity for the Subject Person.
- !@data.hrUiCtrl.atAGlance.data.u_business_entity.displayValue
- Save your changes by clicking the Save button in the upper right of the UI Builder window.
- The resulting step will appear in the field as seen below:
Important Note: The Department label and Department value objects were created so we can use the presets that were provided for the Data Resource. In our example no custom presets were needed, we just reused the provided presets. The Presets are shown below for the Business Entity label and the Business Entity value fields.
Business Entity label
Business Entity value
@michaelj_sherid Is there anyway to recreate the Org info in the new HR Workspace? I don't think this is prebuilt in the new workspace.
@michaelj_sherid I opted to use the repeater instead as it does the same thing. Loop through the Direct Reports and show them.
I created multiple look up data source and it is returning the correct values in the preview but it's not showing the correct data in the actual.
Data Source:
Repeater
Actual Result:
The output is showing an entirely different data than it's supposed to.
