Configuring Permissions in a Form Template

Objectives
After completing this lesson, you will be able to:

After completing this lesson, you will be able to:

  • Configure permissions in a form template

Button Permission

Button Permissions apply to the buttons and pods available in a form template.

Several buttons and pods can be enabled and disabled in Form Template Settings.

  • If a button or pod is enabled (or not disabled), we can further restrict it with button permissions.
  • If a button or pod is disabled (or not enabled) in Form Template Settings, we cannot enable it with button permissions. 

Buttons

Buttons are available from the route map or the lower right-hand corner of the performance form.

Pods are available along the top of the performance form and populate with data from the performance form.

Select the Start button to access pods via the review form.

Button Permissions Configuration

Select the arrow to learn how button permissions are configured in Manage Templates and XML.

Available Button Permission Options

In the General Settings in Manage Templates and in the meta section of the XML template, the following button permissions can be configured.

Select the Start button to begin.

Ask for Feedback

Ask for Feedback gives the ability to ask feedback to several users at the same time, internal users as well as external users. If a customer does not want to use the option to ask feedback to external participants, it can be disabled from Form Template Settings.

This feature is generally available for the direct managers but matrix and HR managers can also see forms from Team Overview if they are in the workflow. Team Overview is a dashboard where users can keep track of where employees are in the progress of reviews, and they have the ability to loop in another person to give feedback on that employee. Feedback then populates the Support Information pod along the top of the form.

Ask for Feedback data has been added to the Performance Management schema in Table Reports (Ad Hoc Reporting). As a result, you can now view Ask for Feedback information, such as, who requested the feedback, when it was requested and who responded. Note that this will not include the actual content of the feedback provided.

Ask for Feedback is now supported in American and British English in the text replacement. Customers can customize verbiage to be more specific to their needs simply by going to Text Replacement from the Action Search bar.

If the customer does not want to use the option to ask feedback to external participants, it can be disabled from Form Template Settings.

Ask for Feedback Permissions

Feedback is an essential part of the Performance Review cycle so it is important that employee have visibility into the feedback that has been provided to them by their peers. Ask for Feedback responses can be displayed in the performance form in the Supporting Information Pod to any permissioned user including the employee.

Previously, the Supporting pod on the Performance Review form displayed the Ask for Feedback responses only to those users who had requested the feedback. For example, in the Performance Review process, if a manager had requested feedback for an employee, that feedback information was visible only to the manager. Other stakeholders in the review process, including the employee, were not able to view the feedback.

To enable the permissions for the Ask for Feedback responses, the switch is in Form Template Settingsselect the form templateEnable Ask for Feedback Responses in Supporting Pod permissions. If this switch is not enabled, the Ask for Feedback responses will use the original permission model which is to only be displayed to the user who requested the feedback.

It is important to note that enabling this will automatically enable the Ask for Feedback responses for all roles in all route map steps for completed, in progress and new forms. If permissions need to be applied, the best practice is to use this feature for new forms, not in progress forms.

Once it is enabled in Form Template Settings, you can grant permission for a role at route map steps. To permission the feedback, we navigate to Manage Templatesselect the same form templateGeneral SettingsShow Advanced options…Ask for Feedback data in Supporting Information Pod Permission(s) defined. Click to modify.

The permissions are either "None" or "Read".

These permissions can also be configured in the Form Template XML.

Form Template XML – Ask for Feedback Permissions

Code snippet
<askforfeedback-permission type="none"> <role-name>*</role-name> <route-step stepid="*"/> </askforfeedback-permission> <askforfeedback-permission type="read"> <role-name>E</role-name> <role-name>EM</role-name> <route-step stepid="*"/> </askforfeedback-permission>Expand
Note

If this feature is permissioned, it is best to first grant None permission for all roles in all steps and then grant the desired Read permissions.

When this option is enabled, the feedback provided on the employee is visible to everyone who has permission to view it.

These permissions are only applied to the Performance Form page. The Team Overview page only shows the feedback received to the requester.

The copy of the form which is kept in the En Route folder will apply the permissions that were assigned to the step when the performance form left the user’s inbox. The supporting information pod will continue to update with new feedback if the user had permission in that step. It means that in this case, the supporting information pod is not a snapshot of when the form was sent.

Other's Ratings Tab

The Ratings from Others Tab permission grants the end user the ability to view or not view the rating completed by the other user who rated the form.

Watch this video to learn about how to configure the other’s rating tab permission.  

XML example of Other’s Rating Tab permission

In <fm-meta> in the XML: <others-ratingtab-permission>.

Others’ Rating Tab Permission Type "Removed" in XML

In the XML below, line 1 indicates that the permission has been removed, the permission type equals "none". In line 2, the employee role is represented by "E". In lines 3 and 4, the selected route steps are permissioned

Code snippet
<others-ratingtab-permission type="none"> <role-name>E</role-name> <route-step stepid="M1"/> <route-step stepid="M2"/> </others-ratingtab-permission>Expand

Others’ Rating Tab Permission Type "Enabled" in XML

In the XML code below, line 1 indicates that the permission has been enabled. Role names are found in lines 2–6. Lines 7,8,9 are examples of defining one’s own step IDs in the route map. If no step IDs are defined by the user, then computer generated IDs will default in the step ID field in the route map. Lines 10 and 11 represent the generated IDs which are long strings of numbers.

Code snippet
<others-ratingtab-permission type="enabled"> <role-name>EM</role-name> <role-name>EX</role-name> <role-name>EH</role-name> <role-name>EHM</role-name> <role-name>EMM</role-name> <route-step stepid="M1"/> <route-step stepid="M2"/> <route-step stepid="mannysignature"/> <route-step stepid="10362654251537189"/> <route-step stepid="10363296120179310"/> </others-ratingtab-permission>Expand

Other’s Rating Tab Item Permission Type (XML only)

The others-rating-tab-item-permission defines access on a field level within the Other's Rating tab.

The others-rating-tab-item-permission can be defined in each goal (objective), development, or competency sections. The following is an example of the XML code to use below the field permission.

Code snippet
<others-ratingtab-item-permission type="none"> <role-name>E</role-name> <tab-item refid="item-rating"/> <route-step stepid="M1"/> <route-step stepid="M2"/> </others-ratingtab-item-permission>Expand

Tab Permission

The tab permission grants the end-user the ability to view different tabs on an item in a goal or competency section. The available tabs are the following:

  • Learning Activities learning-activities: Only applicable to development goal sections.

  • Other Ratings others-rating: Applicable to performance goal, development goal, and competency sections.

  • Last Review Rating last-review-rating: Only applicable to competency sections.

  • Goal Details goal-details: Applicable to performance goal and development goal sections.

  • Other Details other-details: Applicable to performance goal and development goal sections.

  • Achievements achievements: Applicable to performance goal and development goal sections with Continuous Performance Management integration.

Currently, this can only be configured in XML and not in Admin Center.

Section Permission

Section permissions determine whether a user can see the section during route map steps.

Watch this video to learn how to configure the Section Permissions in Manage Templates

Example of Section Permissions Configuration in XML

Action Permission

Action permissions are used to define two actions in the goal and competency sections: add item and remove item.

Watch this video to learn how to configure the Action Permissions.

Example of Action Permissions Configuration in XML

Field Permission

Field permissions are used to remove or grant access to specific fields within a section.

Watch this video to learn how to configure the Field Permissions in Manage Templates.

Example of Field Permission Configuration in XML:

The following fields can be permissioned:

Fields that can be permissioned

DescriptionOption from Manage TemplatesOption from XML
Manager’s rating of subject in rating-opt="3" or rating where everyone can access in rating-opt="0"Item Rating"item-rating"
Subject's rating of self in rating-opt="1" or Anyone with their own rating in rating-opt="2"Unofficial User Rating"item-cmt-rating"
Objective or competency item weightsItem Weight"item-weight"
Overall section weight that is validated in the summary sectionSection Weight"sect-weight"
Overall section weight that is validated in the Overall Objective Competency Summary sectionThis option is not currently available in Manage Templates"sect-weight-4–objcomp-summary"
Comment per competency/objectiveItem Comments"item-comments"
Subject’s rating of self in rating-opt="3" split ratingsSubject Rating"subject-item-rating"
Comment box for the entire sectionSection Comments"section-comments"
Custom fields added to objective/competency/custom sectionsCustom Fields<ekey>

Goal Plan State Configuration

Goal Plan State Permissions are used to automatically change the goal plan state when an action is triggered in the performance form.

Watch this video to learn how to configure the Goal Plan States Permissions in Manage Templates

Example of Goal Plan States Permission Configuration in XML.

Required Field Permission

Required field permissions require any existing field to be completed prior to sending the form to the next route step or signing the form.

Watch this video to learn how to configure the Required Field Permissions.

Example of Required Field Configuration in XML:

Configure Permissions

Business Example

Your client asks you to create permissions and assign them to the roles and various steps of the route map.

For the following scenarios, assume this is the route map:

In this exercise, you will create button, ratings from others, section, action, field, and required field permissions that satisfy the following conditions. You can apply these permissions, wherever applicable, from Manage Templates or XML.

Note
Solutions for each scenario are created as stand-alone permissions. For example, there will be several duplicate Remove Permission chunks of code because if you only encountered that one scenario and none of the others in this document, that would be the solution. You only need to remove permission for all roles once, then can build read-only and edit permission on top of that permission. The exception is required field permissions, which do not need to be removed first.
Caution
Be careful if using the asterisk (*) to remove permission for all route steps, otherwise fields and sections where permission has been removed may not be visible in the Completed route step.

Example of when it’s okay to use the asterisk to remove permission for all route steps: Summary section is hidden from the subject of the form (E) at all route steps, including completed. However, the manager should be able to see the summary section when the form is completed, so the EM should not be included in this permission that removed section visibility at all route steps.

Hint

The route map step IDs in this document are specific to writer of this document’s route map. You will need to swap in your own route map IDs, or change the IDs in your route map (Manage Route Maps, and then select route map and select each step and expand Show advanced options) to match the IDs in this document. But be aware, changing the step IDs should never be done in a real scenario, as existing form permissions would be broken.

Solution code must occasionally be broken into small sections to include the entire section. Copy and paste each section in order in your XML data model for the section to function correctly.

Task 1: Configure Button Permissions

Learn how to set up permissions for the different buttons and pods in the performance form template.

Steps

  1. Create a permission that satisfies the following condition: The subject of the form should have the ability to get feedback (comments only) during the Employee Self-Evaluation step.

    1. Remove all button permissions, like this example:

      Code snippet
      <button-permission type="none"> <role-name>*</role-name> <button refid="reject"/> <button refid="send"/> <button refid="sign"/> <button refid="overall-score-pod"/> <button refid="gap-analysis-pod"/> <button refid="incomplete-items-pod"/> <button refid="team-rank-pod"/> <button refid="supporting-information-pod"/> <button refid="send-back"/> <button refid="delete"/> <button refid="get-comments"/> <button refid="get-edits"/> <route-step stepid="*"/> </button-permission>Expand
    2. Grant button permission to the employee.

      Code snippet
      <button-permission type="enabled"> <role-name>E</role-name> <button refid="get-comments"/> <route-step stepid="M1"/> </button-permission>Expand
  2. Create a permission that satisfies the following condition: The employee and manager should be able to send the form to the next step during the Modify stage of the route map.

    1. Grant button permission to both roles for all steps in the Modify stage.

      Code snippet
      <button-permission type="enabled"> <role-name>E</role-name> <role-name>EM</role-name> <button refid="send"/> <route-step stepid="M1"/> <route-step stepid="M2"/> <route-step stepid="1to1meeting"/> </button-permission>Expand
  3. Create a permission that satisfies the following condition: The employee and manager should be able to sign the form during the signature stage.

    Code snippet
    <button-permission type="enabled"> <role-name>E</role-name> <role-name>EM</role-name> <button refid="sign"/> <route-step stepid="S1"/> <route-step stepid="S2"/> </button-permission> Expand
  4. Create a permission that satisfies the following condition: The subject of the form should be able to see the supporting information and incomplete item pods in all steps.

    Code snippet
    <button-permission type="enabled"> <role-name>E</role-name> <button refid="incomplete-items-pod"/> <button refid="supporting-information-pod"/> <route-step stepid="*"/> </button-permission>Expand
  5. Create a permission that satisfies the following condition: The manager should be able to see all pods that are available on the form in all steps.

    1. Grant button permission to the manager.

      Code snippet
      <button-permission type="enabled"> <role-name>EM</role-name> <button refid="overall-score-pod"/> <button refid="gap-analysis-pod"/> <button refid="incomplete-items-pod"/> <button refid="team-rank-pod"/> <button refid="supporting-information-pod"/> <route-step stepid="*"/> </button-permission>Expand
    2. Select Done.

    3. Select Save to save all the changes in the template.

Task 2: Configure Other Ratings tab Permissions

Learn how to set up permissions for the Other Ratings tab in the performance form template.

Steps

  1. Create a permission that satisfies the following condition: The ratings from others tab should not be visible to the subject of the form when completing the Employee Self-Evaluation step.

    1. In General Settings, select Show advanced options….

    2. Select Other’s Rating Tab Permission(s) defined. Click to modify.

      Code snippet
      <others-ratingtab-permission type="none"> <role-name>E</role-name> <route-step stepid="M1"/> </others-ratingtab-permission>Expand
  2. Create a permission that satisfies the following condition: The manager will be able to see other's ratings in all route steps. (OPTIONAL, it is implied)

    1. Grant permission to the manager for all steps.

      Code snippet
      <others-ratingtab-permission type="enabled"> <role-name>EM</role-name> <route-step stepid="*"/> </others-ratingtab-permission>Expand
    2. Select Done.

    3. Select Save to save all the changes in the template.

Task 3: Configure Action Permissions in Goal and Competency Sections

Learn how to set up action permissions for the Goal and Competency sections in the performance form template.

Steps

  1. Create a permission that satisfies the following condition: Employees should be able to add goals only during the Employee Self-Evaluation step.

    1. Select to expand Edit Fields and Sections.

    2. Select the Goals section

    3. Select Show advanced options….

    4. Select on Action Permission(s) defined . Click to modify.

    5. Before granting specific permission to the Employee in the next step, remove permission for all actions/roles/steps as example below:

      Code snippet
      <action-permission type="none"> <role-name>*</role-name> <action refid="add-item"/> <action refid="remove-item"/> <route-step stepid="*"/> </action-permissionExpand
    6. Grant permission to the employee to add goals only during the mentioned step.

  2. Create a permission that satisfies the following condition: Managers should be able to add and remove goals during the Manager Evaluation and 1:1 Meeting steps.

    1. Grant permission to the manager for the mentioned steps.

      Code snippet
      <action-permission type="enabled"> <role-name>EM</role-name> <action refid="add-item"/> <action refid="remove-item"/> <route-step stepid="M2"/> <route-step stepid="1to1meeting"/> </action-permission>Expand
    2. Select Done

    3. Select Save to save all the changes in the template

  3. Create a permission that satisfies the following condition: No one should be able to add or remove competencies, except the manager, who should be able to add and remove competencies to the job specific competencies section during the 1:1 meeting step.

    1. Ensure the Allow users to add competencies is enabled in job specific competencies section. configurable="true"

    2. Select Action Permission(s) defined. Click to modify.

    3. Remove permission for all actions/roles/steps.

      Code snippet
      <action-permission type="none"> <role-name>*</role-name> <action refid="add-item"/> <action refid="remove-item"/> <route-step stepid="*"/> </action-permission>Expand
    4. Grant permission to manager as requested.

      Code snippet
      <action-permission type="enabled"> <role-name>EM</role-name> <action refid="add-item"/> <action refid="remove-item"/> <route-step stepid="1to1meeting"/> </action-permission> Expand
    5. Select Done.

    6. Select Save to save all the changes in the template.

Task 4: Configure Other Permissions

Learn how to set up other permission types in the performance form template.

Steps

  1. Create a permission that satisfies the following condition: The summary section should be disabled to the subject of the form at any route step.

    1. Expand Edit Fields and Sections.

    2. In the summary section, select Section Permission(s) defined. Click to modify.

    3. Define Disabled in section permission for employee in all steps, including Complete step (select All radio button)

      Code snippet
      <section-permission type="disabled"> <role-name>E</role-name> <route-step stepid="*"/> </section-permission>Expand
  2. Create a permission that satisfies the following condition: The Manual Overall Rating in the summary section should be a required field for the manager before moving to the next step in Manager Evaluation and 1:1 Meeting steps.

    1. In summary section, select Required Field Permission(s) defined. Click to modify.

    2. Define Required Field Permission for the manager, to provide Manual Overall Rating in the Manager Evaluation and 1:1 Meeting steps.

      Code snippet
      <required-fields> <role-name>EM</role-name> <field refid="manual-overall-rating" min-value="-1.0" max-value="-1.0"/> <route-step stepid="M2"/> <route-step stepid="1to1meeting"/> <send-action sendid="next_step"/> </required-fields>Expand
    3. Select Done.

    4. Select Save to save all the changes in the template.

  3. Create a permission that satisfies the following condition: The custom section should be hidden to the employee.

    1. Select to expand Edit Fields and Sections.

    2. In the Evaluation of Potential section, select Section Permission(s) defined. Click to modify.

    3. Remove section permission to the Employee.

      Code snippet
      <section-permission type="hidden"> <role-name>E</role-name> <route-step stepid="*"/> </section-permission>Expand
  4. Create a permission that satisfies the following condition: The Signature section should only be visible at the Signature stage.

    1. Expand Edit Fields and Sections.

    2. Select Signatures section.

    3. Select Show advanced options….

    4. Select Section Permission(s) defined. Click to modify.

    5. Define Hidden permission for all roles in all steps, except the Signature steps.

      Code snippet
      <section-permission type="hidden"> <role-name>*</role-name> <route-step stepid="M1"/> <route-step stepid="M2"/> <route-step stepid="1to1meeting"/> </section-permission>Expand
    6. Select Done.

    7. Select Save to save all the changes in the template.

Log in to track your progress & complete quizzes