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 3 values, and there is a header row present with the following values, indicating the contents of every column (in order):

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 3 values, and there is a header row present with the following values, indicating the contents of every column (in order):

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):

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 five columns, containing the following fields for every row (in order):

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):

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):

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):

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):

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.

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):

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.

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):

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