How to fill the data importer file?
Importer API imports Organization Objectives, KPI and KPI data. Importer API requires data in CSV format. XLS, XLSX formats are not allowed. Following sections define and explain what kind of data to be filled in CSV before importing.
Please note that this feature is available for admin users only
# API 1. KPI Import:
KPI import API imports organization objectives, KPI and mapping (relationship) between them.
It requires two csv files, one listing all organization objectives and KPI; other listing the mapping (relationship) between them, to be uploaded at same time.
When all the entries in the csv file meet the criteria described below then only the entries are imported into the new system. Import will be rejected when at least one entry fails to meet the criteria described below. There is no partial import. You will be presented with the errors in application, if there are any. You are also required to give all files different names before uploading for import.
Sample CSVs:
Sample KPI Data.csv Sample Mapping.csv
Following is the list of columns to be filled in csv file to import KPI and organization objective:
The first file is about KPI definition where the users need to captured the basic attributes of the KPIs to be imported
Column | Properties |
|---|---|
Data Type | Possible values: OBJECTIVE, KPI This field is required. |
VCS Ref Number | VCS reference number of the objective or KPI. This field is optional. When it is not specified, the VCS reference number is calculated, except when importing KPI without any Parent KPI. |
KPI ID | ID of Objective or KPI used in your existing system. This field is required. KPI ID is unique only for a given financial year range. It is to be used for another objective or KPI for different financial years, if the same KPI or objective remains active another year. |
Financial Year Start | The start date of financial year to which this objective/KPI belongs to. This field is required. Format of date must be: YYYY-MM-DD. |
Financial Year End | The end date of financial year to which this objective/KPI belongs to. This field is required. Format of date must be: YYYY-MM-DD. |
KPI Title | Title of the objective/KPI. This field is required. |
Department | The name of the department to which the KPI belongs to. This field should be empty when entering details of organization objectives, but required when details are of KPI. Values in this column must be pre-populated in the new system before importing. New values are not accepted i.e. only existing values in the system are allowed. |
Category | Category of KPI. This field is required for KPI, and must be empty for organization objectives. Values in this column must be pre-populated in the new system before importing. New values are not accepted i.e. only existing values in the system are allowed. |
KPI Type | Possible values are:
|
Perspective | Perspective of organization objectives. This field is required for organization objectives and KPI. |
Direction Of Goodness | This field is required. Possible values are: Up (for Higher the better), Down (for Lower the better). |
Weightage | The weightage of the organization goal or KPI. This field is required. It needs to be a number between 1 and 100. Please note for a single user sum of Daily and Policy management should not be > 100 % |
Data Capture Frequency | The data capture frequency of the organization objective or KPI. This field is required. Frequency Supported - Weekly, Monthly, Quarterly, Half Yearly, Yearly. Frequency Not Supported - Hourly, Shift wise, Daily and Fortnightly |
Review Frequency | The review frequency of the organization objective or KPI. This field is required. Frequency Supported: Monthly, Quarterly, Half Yearly, Yearly. |
Unit Of Measurement | This field is required. Values in this column must be pre-populated in the new system before importing. New values are not accepted i.e. only existing values in the system are allowed. |
Description | The operational description of the organization goal or KPI. This field is optional. |
Remarks | Remarks for the organization goal or KPI. This field is optional. |
Primary Owner Employee Id | The employee ID of the person whom this organization goal or KPI is assigned to. This is typically stored in Active Directory for each person. This field is required. When the given ID does not exist in the new system, a new identity will be created for which following two fields will be required. For the latest/current financial year this ID must exist before importing the data. |
Primary Owner First Name | This field is optional but required when the ID of the person to whom the organization goal or KPI is assigned does not exist in the new system. In this case this field is used to create a new identity of the person. |
Primary Owner Last Name | This field is optional but required when the ID of the person to whom the organization goal or KPI is assigned does not exist in the new system. In this case this field is used to create a new identity of the person. |
Total Target | The individual target for each DCF of organization goal or KPI. This field is required. For example, if the target is 100 for a Monthly KPI, then target for each of the 12 months will be 100. |
Total Upper | The individual Upper control limit for each DCF of organization goal or KPI. This field is required. For example, if the Upper control limit is 110 for a Monthly KPI, then Upper control limit for each of the 12 months will be 110. |
Total Lower | The individual Lower control limit for each DCF of organization goal or KPI. This field is required. For example, if the Lower control limit is 90 for a Monthly KPI, then Lower control limit for each of the 12 months will be 90. |
Capture Data Indicator | This column indicates the week, the month etc. to which the organization object or KPI was applicable for. For example, if the data capture frequency of the organization goal or KPI was Monthly and was applicable for the first 3 months of the year, you must enter 1,2,3. The format of the values of this column is numbers separated by comma. Avoid spaces around numbers. If this field is blank, 4E will make the KPI applicable for all intervals of the complete financial year as per the mentioned DCF. |
Viewer Employee Id | This is an optional field |
Viewer First Name | This field is optional but required when the ID of the person to whom the organization goal or KPI’s view access is assigned, does not exist in the new system. In this case this field is used to create a new identity for the person. |
Viewer Last Name | This field is optional but required when the ID of the person to whom the organization goal or KPI’s view access is assigned, does not exist in the new system. In this case this field is used to create a new identity for the person. |
YTD Target | The YTD target calculation method, This should be entered in all CAPS - SUM, AVG(for Average) |
YTD Actual | The YTD actual calculation method, This should be entered in all CAPS - SUM, AVG(for Average). |
Following is the list of columns to be filled in csv file to import organization objective mapping (relationship):
The relationship between two KPIs or an organization goal and KPI is defined using the following two columns named as Parent KPI ID, Child KPI ID. For example, if KPI named A is a child of KPI named B, then A will come under Child KPI ID and similarly, B will come under Parent KPI ID.
Column | Properties |
|---|---|
Parent KPI ID | ID of Objective or KPI used in your existing system. This field is required. This is the same as the field called KPI ID mentioned in the previous section. NOTE: If you want to import a KPI without its Parent KPI, put ‘-’ (hyphen) in this column. |
Child KPI ID | ID of Objective or KPI used in your existing system. This field is required. This is the same as the field called KPI ID mentioned in the previous section. |
Financial Year Start | The start date of financial year to which this objective/KPI belongs to. This field is required. Format of date must be: YYYY-MM-DD. |
Financial Year End | The end date of financial year to which this objective/KPI belongs to. This field is required. Format of date must be: YYYY-MM-DD. |
Please note that while defining the root KPIs or Organization goals, keep the Parent KPI ID as '-'. Users must ensure that each and every KPI mentioned in the mapping sheet, should also be present with a proper definition in the KPI definition sheet.
# API 2. KPI Actual Data Import:
Following is the list of columns to be filled in the csv file to import KPI data. All the columns are required.
Column | Properties |
|---|---|
KPI ID | ID of Objective or KPI used in your existing system. This field is required. KPI ID is unique only for a given financial year range. It is to be used for another objective or KPI for different financial years, if the same KPI or objective remains active another year. |
Data Capture Frequency | The data capture frequency of the organization objective or KPI. This field is required. Values in this column must be pre-populated in the new system before importing. New values are not accepted i.e. only existing values in the system are allowed. Currently we are not supporting frequency values less than weekly - Hourly, Shift wise, Daily. Allowed values are Weekly, Monthly, Quarterly, Half Yearly, Yearly. |
Actual | This field is required. The actual target to be met for the given KPI or Objective. This must be numbers separated by comma. Numbers with decimal points are allowed. For example, 1,2,3.4,5,6,7.11. Only enter those numbers which are applicable for that particular month, week, etc. |
Financial Year Start | The start date of financial year to which this objective/KPI belongs to. This field is required. Format of date must be: YYYY-MM-DD. |
Financial Year End | The end date of financial year to which this objective/KPI belongs to. This field is required. Format of date must be: YYYY-MM-DD. |
LAST_UPDATED | 23 Aug 2021, Anil 18 Aug 2022, Mritunjoy |
|---|---|
LAST_REVIEWED | 19 Oct 2021, Ameya |