Managing the payee attribute form

In the (Undefined variable: CompoVariables_WA.Organization) of the beqom application, two different types of payee attribute forms are available:

• The basic attribute form: accessible from the payee details panel of the application, it gives non-confidential information about the payee, such as their full name, or their email address.

• The individual planner attribute form: visible in the individual planner interface, this form gives additional detail about the payee, such as their family situation or their grade. It is only visible to the payee's manager and the payee themselves.

Both forms aggregate a number of parameter values defined in the Admin Portal application for the payee.

The visibility of these forms can be configured and, in the case of the individual planner payee attribute form, access must be granted to individual users.

Basic Employee Attribute Form

The basic employee attribute is available for everyone in the organization. It contains the following information:

• First name

• Last name

• E-mail address

• Job name

• Title name

• Department name

Individual Planner Employee Attribute Form

The individual planner employee attribute form is available only for the relevant payee and the compensation manager. It contains the following information:

• Payee code

• First name

• Last name

• Family situation

• Number of children

• Start date of the current situation

• End date of the current situation

• Company start date

• Company end date

• Grade

• Job

• Title

• Department

• Organization

• Nationality

• Country

Loading the Values of the Form

To load the values of the form, i.e. synchronize the form values in the Web Application interface, execute the following API method:

Service	Action	Endpoint	Parameters
Gateway	GET	/api/Data/GetFormValues	{itemId}: payee ID {formId}: itemID ID of the object groupType: 2

Granting the Access to the Form

Once the form values have been loaded, you need to grant access to the form. To do so, execute the following API method:

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

The following table details form-related 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).
allowReadEmployeeComp	This permission enables the user to view the payee's individual planner form.

Limitations

In the current state of the implementation, the following limitations are in place related to employee attribute forms:

• Attributes can only be added and removed using the database

• It is not possible to show/hide specific attributes. All attributes in the form are visible

• The forms are not editable from the (Undefined variable: CompoVariables_WA.Organization)