Enabling the individual planner

This document describes the procedure to follow in order to enable the individual planner in the beqom Web Application. By default, the individual planner will not be available from the (Undefined variable: CompoVariables_WA.Organization) or from a process grid (even if rounds are configured and published in the (Undefined variable: CompoVariables_WA.CompPlan)), until the procedure below is put in place.

Preamble

The employee attributes and the individual planner security are based on hierarchy security. This procedure stipulates that you have already created a hierarchy security for the relevant users and hierarchies in the beqom Admin Portal.

Prerequisites

In order to be able to perform the actions described below (specifically run the API method POST/api/comp-planner-tree-security-payee-access/{id}), the profile that you are currently using must have been granted full access to the individual planner in the permission management screen (Admin Portal), as follows:

• In Admin Portal, under (Undefined variable: CompoVariables_AP.Admin2) > Functional Admin > Profiles > <ProfileName> > Admin > Functional Admin > Comp Planner, all permissions must be checked (Assign, Create, Delete, Modify, Read)

• In Admin Portal, under (Undefined variable: CompoVariables_AP.Admin2) > Functional Admin > Profiles > <ProfileName> > Compensation Planner, the profile must have access to the component (padlock opened) AND in the "Modules Tree" panel of the component, full permissions must be granted for Individual Planner (Modify, Read)

Configuring the Security for the Individual Planner

Retrieving the ID of the Hierarchy Security

To start configuring the hierarchy security for the individual planner, you first need to retrieve the ID of the hierarchy security that you want to use. To do so, you can use one of two methods

• Run an SQL statement on the database

• From your Web browser

To retrieve the id_tree_security parameter from the application database, simply run an SQL query for this parameter.

To retrieve the id_tree_security parameter from the application, proceed as follows:

1. Open the Admin Portal application, and then navigate to ORG > Administration > Hierarchy Security).

2. Locate, in the hierarchy security, the item whose ID you want to retrieve and click the corresponding record in the grid.

3. Open the developer tool of your Web browser, and go to Network > Headers.

4. Select the method get_tree_security in the Name column. The ID of the hierarchy security will be displayed as follows:

Creating Permissions for the Individual Planner

The creation of the permissions for the individual planner requires the use of the Compensation Planner service.

Use the following method:

Service	Action	Endpoint	Parameters	Body Sample
Compensation Planner	POST	/api/comp-planner-tree-security-payee-access/{id}	Where {id} is the UID of the id_tree_security	Copy {     "idTreeSecurity": <id_tree_security>,     "allowReadEmployeeBasic": true,     "allowEditEmployeeBasic": true,     "allowReadEmployeeComp": true,     "allowEditEmployeeComp": true,     "allowAccessComp": true,     "allowEditActiveRoundValue": true,     "allowEditInactiveRoundValue": true, }

The following table details the permissions:

Permission	Description
allowReadEmployeeBasic	This permission enables the user to view the basic attribute form of the payee when the payee is selected in the organization. This permission is required to load the hierarchy from the (Undefined variable: CompoVariables_WA.Organization).
allowEditEmployeeBasic	This permission enables the user to edit the basic attribute form of the payee.
allowReadEmployeeComp	This permission enables the user to view the payee individual planner form.
allowEditEmployeeComp	This permission enables the user to edit the payee individual planner form.
allowAccessComp	This permission shows the individual planner icon in the process grid and in the payee list.
allowEditActiveRoundValue	This permission enables the user to edit values in active comp rounds.
allowEditInactiveRoundValue	This permission enables the user to edit values in inactive comp rounds.