File-based output integrations
We provide a host of standard exports in our API to return useful information in bulk. These API exports have the following properties:
- The data contained in the API export is a reflection of the data at the time of the request (i.e., live data).
- The output will always be given in the default JSON format of the API.
- Most exports use pagination, returning the data piece by piece instead of in bulk.
- Especially when working with large amounts of data, the export API requests can often take some time to complete.
As an alternative to these API exports, we provide a similar host of file-based exports. These standard file-based output exports are triggered according to a configurable schedule (e.g. daily), transform the data to a desired format (e.g. CSV) and are uploaded to a desired, easily accessible location (e.g. S3). As such, these export integrations have the following advantages:
- No time-consuming live generation required: the last export is always readily available on the desired location (i.e. S3, SFTP server).
- No need to handle data tranformation.
- No need to handle pagination.
Prerequisites
To have access to the file-based output integrations, regardless of type, at least the following prerequisites must be met:
- You have the appropriate TechWolf API licenses.
- You have the appropriate SkillEngine API credentials, which include:
- Tenant ID
- Tenant secret
- Tenant name
- Region (Europe or United States)
- You have a TechWolf API tenant set up that contains the relevant information for the requested output integration.
- Both you and TechWolf have access to the agreed output location.
Supported export types
Employee Info
The Employee info export provides an overview of all Employees and their fields.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing one row for every employee.
Every row has 5 values, and there is a header row present with the following values, indicating the contents of every column (in order):
-
| Field name | Field description |
|---|---|
| employee_id | The id of the Employee in TechWolf. |
| low_data_availability | Flag indicating whether sufficient data is available for qualitative Skill inference for the given employee. |
| active | Flag indicating whether the Employee will be used in matching. This is useful if an Employee is being phased out. |
| last_updated | Timestamp of the last update to this entity. |
| organisational_unit_X | The Organisational Unit of the Employee. Column organisational_unit_0 is the top-level Organisational Unit, column organisational_unit_1 the second-level etc. |
Job Info
The Job info export provides an overview of all Jobs and their fields.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing one row for every Job.
Every row has 7 values, and there is a header row present with the following values, indicating the contents of every column (in order):
-
| Field name | Field description |
|---|---|
| job_id | The id of the Job in TechWolf. |
| job_name | The name of the Job in TechWolf. |
| job_family | The Job family to which this Job belongs. |
| job_family_group | The Job family group to which this Job belongs |
| low_data_availability | Flag indicating whether sufficient data is available for qualitative Skill inference for the given Job. |
| active | Flag indicating whether the Job will be used in matching. This is useful when a Job is being phased out. |
| last_updated | Timestamp of the last update to this entity. |
Course info
The Course info export provides an overview of all the available Courses.
Currently supported output formats are:
-
CSV:
-
The CSV contains one row for every Course.
Every row has three values, and there is a header row present with the following values, indicating the contents of every column (in order):
-
| Field name | Field description |
|---|---|
| course_id | The id of the Course with the Skill in TechWolf. |
| course_title | The title of the Skill in TechWolf. |
| source | The LMS from which the Course originates. |
Course Skill Profiles (Course to Skill)
The Course Skill Profile export provides an overview of all the Skills of every Course.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing one row for every Skill of every Course, with Courses without Skills not being represented.
Every row has three values, and there is a header row present with the following values, indicating the contents of every column (in order):
-
| Field name | Field description |
|---|---|
| course_id | The id of the Course with the Skill in TechWolf. |
| skill_id | The id of the Skill in TechWolf. |
| skill | The name of the Skill in TechWolf. |
Employee Skill Profiles (Employee to Skill)
The Employee Skill Profile export provides an overview of all the Skills of every Employee.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing - besides the header row - one or more rows for every Skill of every Employee (every Skill has one row for each of its sources if it has any, and one row otherwise), with Employees without Skills not being represented.
The matrix has six columns, containing the following fields for every row (in order):
-
| Field name | Field description |
|---|---|
| employee_id | The id of the Employee with the Skill in TechWolf. |
| skill_id | The id of the Skill in TechWolf. |
| skill | The name of the Skill in TechWolf. |
| validation_state | The validation state of the Skill; one of “validated”, “suggested”, “rejected”. |
| skill_source | The event type from which the Skill is inferred for this Employee (e.g. “working_history”). |
| skill_event_source | The source of the Skill event from which the Skill is inferred (e.g. “Workday” or “Degreed”). |
Job Skill Profiles (Job to Skill)
The Job Skill Profile export provides an overview of all the Skills of every job. Note that only the governed Skill Profiles are taken into account, not the suggested Skill Profiles.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing - besides the header row - one or more rows for every Skill of every Job (every Skill has one row for each of its Skill types), with Job without Skills not being represented.
The matrix has five columns, containing the following fields for every row (in order):
-
| Field name | Field description |
|---|---|
| job_id | The id of the Job with the Skill in TechWolf. |
| skill_id | The id of the Skill in TechWolf. |
| skill | The name of the Skill in TechWolf. |
| skill_type | The type of the Skill; one of “Job-Specific”, “Family-Specific”. |
| validation_state | The validation state of the Skill; one of “validated”, “suggested”, “initially_validated”. |
| proficiency_level | The required Skill proficiency level for this Job as an integer. |
| critical | Indicates whether the Skill is critical for the Job. |
Note that initially validated Skills for Jobs and Job families are Skills which have been inferred after the first data load (i.e. the first iteration of the Job to Skill mapping). These Skills are used to initially populate the governed Skill profile of the Job or Job family, but which have not been manually verified like other (normal) validated skills. The initial validation process for Jobs and/or Job families is not a required step in creating a Job or Job family or managing its Skill profile(s). If initial validation was not used during data loading, the associated states can never appear in the data.
Skill Info
The Skill export provides an overview of all Skills and their description. For Skills that are part of the Taxonomy, the location in the Taxonomy is also provided.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing - besides the header row - a row for every Skill.
The matrix has ten columns, containing the following fields for every row (in order):
-
| Field name | Field description |
|---|---|
| skill_id | The id of the skill. |
| skill_name | The name of the skill. |
| skill_description | The description of the skill. |
| techwolf_domain | The default Domain provided by TechWolf. |
| taxonomy_skill_cluster_id | The id of the Cluster the Skill belongs to; empty for Skills that are not part of the Taxonomy. |
| taxonomy_skill_cluster_name | The name of the Cluster the Skill belongs to; empty for Skills that are not part of the Taxonomy |
| taxonomy_subdomain_id | The id of the Subdomain the Skill belongs to; empty for Skills that are not part of the Taxonomy; only relevant for four-level taxonomies, always empty for three-level Taxonomies. |
| taxonomy_subdomain_name | The name of the Subdomain the Skill belongs to; empty for Skills that are not part of the Taxonomy; only relevant for four-level taxonomies, always empty for three-level Taxonomies. |
| taxonomy_domain_id | The id of the top-level Domain the Skill belongs to; empty for Skills that are not part of the Taxonomy. |
| taxonomy_domain_name | The name of the top-level Domain the Skill belongs to; empty for Skills that are not part of the Taxonomy. |
Market Info
The Market info export provides an overview of the different peer groups that are configured, and which companies are in each peer group. A peer group consists of a list of companies used to create external market Skill Profiles for Jobs.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing one row for every company of every peer group.
Every row has two values, and there is a header row present with the following values, indicating the contents of every column (in order):
-
| Field name | Field description |
|---|---|
| peer_group | The name of the Peer Group in TechWolf. |
| company | The name of the company within the Peer Group. |
Market Skill Profiles (Market to Skill)
Provides an overview of all Skills required by the companies in the different peer groups, for every Job.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing one row for every Market Skill of every Job-Peer Group combination, with Job-Peer Group combinations without Market Skills not being represented.
The matrix has four columns, containing the following fields for every row (in order)
-
| Field name | Field description |
|---|---|
| job_id | The id of the Job with the Skill in TechWolf. |
| peer_group | The name of the Peer Group in TechWolf. |
| skill_id | The id of the Skill in TechWolf. |
| skill | The name of the Skill in TechWolf. |
Employee Skill Gap
The Employee Skill Gap export provides an overview of the match score between Employees and their assigned position.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing - besides the header row - a row for every Employee-Job match.
The matrix has 3 columns, containing the following fields for every row (in order):
-
| Field name | Field description |
|---|---|
| employee_id | The unique ID of the Employee. |
| job_id | The unique ID of the assigned position. |
| score | The match score between the Employee and the Job, expressed as a number between 0 and 1. |
Employee Skill Gap Explained
The Skill Gap Explained export provides a detailed information of the match score between Employees and their assigned positions, including adjacent Skills and how closely they align with the required Skills for their assigned position.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing - besides the header row - a row for every Skill for every Employee-Job match.
The matrix has six columns, containing the following fields for every row (in order):
-
| Field name | Field description |
|---|---|
| employee_id | The unique ID of the Employee. |
| job_id | The unique ID of the assigned position. |
| status | The current status of the match (e.g., “present”, “missing”). |
| skill_id | The unique ID of the required Skill. |
| adjacent_skill_id | The unique ID of the most similar adjacent Skill that the Employee has. |
| adjacency_score | The adjacency score between the required Skill and the adjacent Skill, expressed as a number between 0 and 1. |
Internal Mobility
The internal mobility export provides an overview of potential matches between Employees and Jobs within the organisation, with their match score and status.
We offer three export types within this category:
- Matching Employees for Job: Contains the best matching Employees for each Job.
- Matching Jobs for Employee: Contains the best matching Jobs for each Employee.
- Internal Mobility: Contains both the best matching Employees for each Job and the best matching Jobs for each Employee.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing - besides the header row - a row for every employee-Job match.
The matrix has 3 columns, containing the following fields for every row (in order):
-
| Field name | Field description |
|---|---|
| employee_id | The unique ID of the Employee. |
| job_id | The unique ID of the Job within the organisation. |
| score | The match score between the Employee and the Job, expressed as a number between 0 and 1. |
Internal Mobility Explained
The internal mobility export provides an overview of potential matches between Employees and Jobs within the organisation, including adjacent Skills and how closely they align with the required Skills for the job.
We offer three export types within this category:
- Matching Employees for Job: Contains the best matching Employees for each Job.
- Matching Jobs for Employee: Contains the best matching Jobs for each Employee.
- Internal Mobility: Contains both the best matching Employees for each Job and the best matching Jobs for each Employee.
Currently supported output formats are:
-
CSV:
-
The CSV represents a two-dimensional matrix, containing - besides the header row - a row for every Skill of every Employee-Job match.
The matrix has 6 columns, containing the following fields for every row (in order):
-
| Field name | Field description |
|---|---|
| employee_id | The unique ID of the Employee. |
| job_id | The unique ID of the Job within the organization. |
| status | The current status of the Internal Mobility match (e.g., “present”, “missing”). |
| skill_id | The unique ID of the required Skill. |
| adjacent_skill_id | The unique ID of the most similar adjacent Skill that the Employee has. |
| adjacency_score | The adjacency score between the required Skill and the adjacent Skill, expressed as a number between 0 and 1. |
Supported output locations
S3
We support the use of Amazon S3 buckets as the location the above-mentioned output integrations can be shared. These buckets are owned and managed by TechWolf, but will be made accessible to you to fetch the export files.
Export output files will be located on your bucket, named techwolf-X (with ‘X’
being your company name or abbreviation), under the output/exports directory.
The names of the files can be configured per file type, but the names must always contain the date at which they were created in one of the supported date formats. For compatibility reasons, names cannot contain semicolons (’:’) or periods (’.’).
Coming soon
- Private SFTP server
Standard export relation diagram
Was this page helpful?