Adding Deep Links to Nakisa HR Suite Components from Your Portal

Nakisa HR Suite allows you to create links to specific elements within the application that you can place in corporate portals or other sites. You can link to org charts, \ details panels, the dashboard and other analytics, even search results, if needed. Each Nakisa HR Suite component has required attributes and optional attributes to link to them.

Linking to OrgCharts

Example:

SSP buid

.../app/default.html?component=orgchart&config=default-orgchart&rootId=50006103&rootType=position&currentViews=position-standard+employee-standard&currentStyle=combined&currentPerspective=manager&expanded=position&fitToPage=true&zoom=0.7

OOSP build

.../app/default.html?component=orgchart&config=default-orgchart&rootId=50006103&rootType=orgunit&currentViews=orgunit-standard+position-standard+employee-standard&currentStyle=combined&expanded=orgunit&effectiveDate=1491019200000

Required Elements:

Element Definition

component

Component name. To access the Orgchart component, set this parameter to orgchart

config

Config ID of the Orgchart.

rootId

The ID of the object that is at the root of the OrgChart.

rootType

The type of the root object, the options are orgunit, position or employee.

currentViews

Specifies the view for each entity.

.

Note: When your rootType is position, you must define 2 views: position (position-standard for example) & employee (employee-standard for example). When your rootType is orgunit, you must define 3 views: Orgunit, Position and Employee (orgunit-standard, position-standard, and employee-standard for example) The views must be separated by a '+'.

 

Optional Elements:

Element

Definition

currentStyle

 The selected Orgchart style. The options are defined in OCConfig → styles.

Examples: combined, vertical, standard, horizontal

currentPerspective

The perspective of the chart selected. Default is manager.

Examples: manager, legal, functional

expanded

Specify which Node to expand from the root. Choices are: position, employee, or orgunit.

selectedAnalytics

Dependent on currentViews. You must separate them using '+'. Specify which Analytics are selected in the dropdown of the OrgChart Analytic View. If no selectedAnalytics parameter is defined, the default analytics will be selected.

*Analytic options are specified in the Analytic Values section.

filters

Filters can be applied to Analytic views. The choice of filters are specified in the Filters section of this document.

fitToPage

Orgchart will be fitted to the page when fitToPage=true.

zoom

Sets the zoom on the Orgchart. Value can go from 0.3 to 2.

effectiveDate

Specifies the effective date in milliseconds.

Scenario Component

Example:

.../app/default.html?component=orgchart&config=default-orgchart&rootId=49090077&rootType=position&currentViews=position-standard+employee-standard&currentStyle=combined&expanded=position&planName=3f5c7959-0e63-46b5-9152-8fbbcb3e8d93&planType=OD

Element

Definition

planName

Internal Scenario ID

planType

Type of the Scenario OD (OrgDesign), MD (OrgMerger), PC (eamDesign)

Linking to a Search

Examples:

.../app/default.html?component=search&term=*&type=p_index_view&view=tableview

.../app/default.html?component=search&term=director&type=s_index_view

OOSP build

.../app/default.html?component=search& term=*&type=o_index_view

 

Required Elements

Element Definition

component

Component name. To access a Search component, set this parameter to search.

term

Keyword to search

type

Search on specified view type (i.e. p_index_view, s_index_view or o_index_view)

 

Optional Elements

Element

Definition

view

View type. Either standard or tableview.

filters

Filters can be applied to Analytic views. The choice of filters are specified in the Filters section

effectiveDate

Specifies the effective date in milliseconds.

.

Scenario Component

Example:

.../app/default.html?component=search&term=director&type=s_index_view&planName=993ff368-ee54-4cc8-a480-c716ca860513&planType=OD&effectiveDate=1372651200000

Element Definition

planName

Internal Scenario ID

planType

Type of the Scenario OD (OrgDesign), MD (OrgMerger), PC (eamDesign)

 

Linking to a Details Panel

Example:

.../app/default.html?component=detail&config=employee&objectId=70819

.../app/default.html?component=detail&config=orgunit&objectId=50006103

Element

Definition

component

Component name. To access a Detail component, set this parameter to detail.

config

position, employee or orgunit

objectId

Object's identifier

effectiveDate

Specifies the effective date in milliseconds.

 

Scenario Component

Example:

.../app/default.html?component=detail&config=position&objectId=50006103&planName=993ff368-ee54-4cc8-a480-c716ca860513&planType=OD&effectiveDate=1372651200000

.../app/default.html?component=detail&config=orgunit&objectId=50006103&effectiveDate=1372651200000

Element Definition

planName

Internal Scenario ID

planType

Type of the Scenario OD (OrgDesign), MD (OrgMerger), PC (eamDesign)

 

Linking to the Dashboard

Example:

.../app/default.html?component=dashboard&type=p_index_view&chartIds=chart2+chart8+chart14&chartNames=age-distribution+gender-distribution+nationality-location&view =table+table+standard&maximized=true+false+false&effectiveDate=1341115200000

.../app/default.html?component=dashboard&type=p_index_view&chartIds=chart2+chart8+chart14&chartNames=age-distribution+gender-distribution+nationality-location&view =table+table+standard&maximized=true+false+false&planName=993ff368-ee54-4cc8-a480-c716ca860513&planType=OD

Required Elements

Element

Definition

component

Component name. To access a Dashboard component, set this parameter to dashboard.

type

Specifies the index type of the dahsboard component.

chartIds

Specifies which charts to display. Chart ID is required and are specified in the Dashboard Charts section of this document.

chartViews

View type for each chart specified in chartIds parameter. Each value specified in chartViews corresponds to a view to a value in chartIds, the order matters. Options are: tableview or standard. The parameter chartName must be specified for view to work.

chartName

Name of the chart. Chart names are required and are specified in the Dashboard Charts section of this document.

Optional Elements

Element

Definition

maximized

Chart is shown in full view when maximized is set to true. Options are true or false. Note that only one chart can have maximized set to true, otherwise only the first will be maximized.

filters

Filters can be applied to Analytic views. The choice of filters are specified in the Filters section of this document.

effectiveDate

Specifies the effective date in milliseconds.

 

Scenario Component

Element

Definition

planName

Internal Scenario ID

planType

Type of the Scenario OD (OrgDesign), MD (OrgMerger), PC (eamDesign)

.

Linking to Trends

Examples:

.../app/default.html?component=trends&config=p_index_view&chartIds=trendschart16&from=1341115200000&to=0&mode=1

Required Elements

Element

Definition

component

Component name. To access a Trends component, set this parameter to trends.

config

Config name. (example: p_index_view, s_index_view or o_index_view)

chartIds

ID of the charts to show. These are specified in the Trends Charts section of this document.

Optional Elements

Element

Definition

from

From date shown in Trends charts in milliseconds, this has to be the first of January at 5:00 AM of the specified year. If not specified, this will default to Sun Jul 01 2012 00:00:00.

to

To date shown in Trends charts in milliseconds, this has to be the first of January at 5:00 AM of the specified year. If not specified, this will default to today's date.

type

Chart type. Choices are either 'bar' or 'line'.

Linking to the OrgOverview

Examples:

.../app/default.html?component=sunburst&position=position&objectId=50006103&filter_s_city_city_s=Chicago&effectiveDate=1420088400000

../app/default.html?component=sunburst&position=orgunit&objectId=50006103&effectiveDate=1420088400000

Required Elements:

Element

Definition

component

Component name. To access an OrgOverview component, see this parameter to sunburst.

position

 

objectId

The ID of the root entity from which the orgchart overview will be loaded from.

effectiveDate

Specifies the effective date in milliseconds.

Scenario Component

Example

.../app/default.html?component=sunburst&position=position&objectId=50006103&planName=993ff368-ee54-4cc8-a480-c716ca860513&planType=OD

Element

Definition

planName

Internal Scenario ID

planType

Type of the Scenario OD (OrgDesign), MD (OrgMerger), PC (eamDesign)

.

Linking to the Employee Map

Example:

.../app/default.html?component=employeemap&type=p_index_view&filter_s_city_city_s=Chicago&filter_dateOfBirth_dateOfBirth=60-70&effectiveDate=1420088400000

.../app/default.html?component=employeemap&type=p_index_view&filter_s_city_city_s=Chicago&planName=23ddd436-4a67-4222-946d-adacec252a94&planType=OD

Required Elements:

Element

Definition

component

Component name. To access a Employee Map component, set this parameter to employeemap.

type

Specifies the index type of the employee map's component.

effectiveDate

Specifies the effective date in milliseconds.

Scenario Component

Element

Definition

planName

Internal Scenario ID

planType

Type of the Scenario OD (OrgDesign), MD (OrgMerger), PC (eamDesign)

.

Analytic Values

Position

View

Options

Employee analytics view

  • averageSpanOfControlPosition
  • spanOfControlPosition
  • depthPosition
  • levelPosition
  • headCountPosition
  • headCountPercentage
  • headCountPercentagePosition
  • tenureSUMPosition
  • tenureAVGPosition
  • ageAvgPosition
  • budgetPosition
  • budgetPercentagePosition
  • budgetRelativePercentagePosition
  • salaryAvgPosition

Position analytics view

  • countPositionsPosition
  • countOccupiedPositionsPosition
  • countUnoccupiedPositionsPosition

Orgunit

View

Options

Employee analytics view

  • averageSpanOfControl
  • spanOfControl
  • depth
  • level
  • headCount
  • headCountPercentage
  • headCountRelativePercentage
  • tenureSUM
  • tenureAVG
  • ageAvg
  • budget
  • budgetPercentage
  • budgetRelativePercentage
  • salaryAvg

Position analytics view

  • countPositions
  • countOccupiedPositions
  • countUnoccupiedPositions

Filters

Employee Filters

Filter Name

Options

filter_salaryScale_amountLowNormalized

  • 0-50000
  • 50000-75000
  • 75000-100000
  • 100000-150000
  • 150000-200000
  • 200000-*

filter_salaryScale_amountHighNormalized

0-50000

50000-75000

75000-100000

100000-150000

150000-200000

200000-*

filter_dateOfBirth_dateOfBirth
  • 0-20
  • 20-30
  • 30-40
  • 40-50
  • 50-60
  • 60-70
  • 70-*

filter_s_city_city_s

 

filter_s_country_text_s

 

filter_talentInfo_criticalResource
  • true
  • false

filter_disability_disability
  • true
  • false

filter_employeePool_name_s

 

filter_ethnicity_text_s

 

filter_functionalArea_name_s

 

filter_gender_text_s
  • Male
  • Female
  • Other

filter_job_name_s

 

filter_jobFamily_name_s

 

filter_nationality_text_s

 

filter_statusDeleted
  • Yes
  • No

filter_orgunit_objectId

 

filter_orgunit_name_s

 

filter_ouLevel

 

filter_payGrade_name_s

 

filter_performance_performance
  • 1
  • 2
  • 3
  • 4
  • 5

filter_posLayer

 

filter_positionPool_name_s

 

filter_potential_potential
  • 1
  • 2
  • 3
  • 4
  • 5

filter_talentInfo_riskOfLoss
  • 1
  • 2
  • 3

filter_salary_value
  • 0-50000
  • 50000-75000
  • 75000-100000
  • 100000-150000
  • 150000-200000
  • 200000-*

filter_type

 

filter_pos_objectId

 

filter_talentInfo_scarceSkill
  • true
  • false

filter_dateOfHire_startDate
  • 1_0-2
  • 2_2-4
  • 3_4-6
  • 4_6-10
  • 5_10-15
  • 7_15-20
  • 7_20+

filter_vscan

0-1

1-2

2-3

3-4

4-5

 

 

Position Filters

Filter Name

Options

filter_location_city_s

 

filter_controllingArea_name_s

 

filter_costCenter_name_s

 

filter_country_text_s

 

filter_employeeGroup_name_s

 

filter_employeePool_name_s

 

filter_employeeSubGroup_name_s

 

filter_functionalArea_name_s

 

filter_job_name_s

 

filter_jobFamily_name_s

 

filter_keyIndication_keyPosition
  • true
  • false

filter_statusDeleted
  • Yes
  • No

filter_hasEmployeeChildren
  • true
  • false

filter_payGrade_name_s

 

filter_personnelArea_name_s

 

filter_personnelSubArea_name_s

 

filter_posLayer

 

filter_positionPool_name_s

 

filter_vacancy_vacant
  • true
  • false

Orgunit Filters

Filter Name

Options

filter_location_city_s

 

filter_companyCode_companyName_s

 

filter_controllingArea_name_s

 

filter_costCenter_name_s

 

filter_ouLevel

 

filter_location_text_s

 

filter_departmentIndicator_department
  • true
  • false

filter_statusDeleted
  • Yes
  • No

filter_personnelArea_name_s

 

filter_personnelSubArea_name_s

 

Dashboard Charts

Chart Name

Chart ID

Chart

Age Distribution

chart2

Gender Distribution

chart8

Nationality/Location

chart14

Potential/Performance

chart35

Risk of Loss/Performance

chart43

Risk of Loss/Potential

chart59

Job ID

chart69

Job Family

chart77

Ethnicity ID

chart8_1_2

Layer/Pay Grade

chart27

Trends Charts

Chart Name

Chart ID

Chart

Employee Headcount Trends

trendchart4

Employee Salary Trends

trendschart16

Position Trends

trendchart4

Orgunit Trends

trendchart4

Nakisa HR Suite 2022.R2-SP1 © 2023

 

 

 Nakisa Inc. All rights reserved worldwide.