Aptem

Extractor

Aptem is an end-to-end apprenticeship and vocational training management platform, used by training providers and employers to manage learner enrolment, programme delivery, progress tracking, compliance and end-point assessment. Training providers connect Aptem to bring that data into their own reporting, alongside other systems.

At a glance

Property	Value
Authentication	API key / token
Sync type	Mixed: automatic for streams with a known replication key; full table for the rest
Streams	Discovered dynamically from your tenant
Custom queries	Not supported

What you can sync

• Learner enrolment, programme and qualification records
• Progress tracking: reviews, milestones, tasks and evidence
• Compliance documents and end-point assessment data
• Organisation, group and user administration data

Prerequisites

• API token: for the Aptem OData API. The only credential needed.
• Tenant name: your Aptem tenant name, used to build the API base URL.

Setup

In Meltano Cloud:

1. Enter your Aptem API token.
2. Enter your Aptem tenant name.
3. Optionally choose a start date for extraction.

Available streams

This tap discovers streams dynamically from the Aptem OData service's $metadata document, so the exact set of streams reflects the entities and related collections exposed by your tenant. The following are recognised by the tap:

AimWorkPlacements, ApprenticeshipFinancialRecords, AptemCognitiveAssessments, AwardingBodyQualifications, AwardingBodyQualificationsAssessmentHistory, ComplianceDocuments, ComponentDueDateChanges, CrmActivities, DestinationProgressions, EmployerGroups, EPAErrors, Episodes, Groups, HoursRecords, IlrAims, IlrLearner, Jobs, LearnerEmployment, LearningPlanComponents, LearningPlanEvidences, LearningPlanEvidenceWithActivityData, MaximumProgrammeDataFields, Messages, Milestones, Notes, OnboardingResponses, OrganizationContacts, Organizations, ReviewResponses, Reviews, Tasks, Trackers, Users, UserGroups, WithdrawalReasons

Additional collections embedded within these entities are also discovered and extracted as their own streams, so the full list can be larger than what's above depending on your tenant.

Streams with a known replication key replicate incrementally; the rest replicate in full on every run.

Settings

Setting	Type	Description
api_token	string	API token for the Aptem OData API.
tenant_name	string	Aptem tenant name used to build the base URL.
start_date	date	The earliest record date to sync.

Advanced configuration

• Replication key overrides: if a stream isn't replicating incrementally despite exposing a suitable date column, set replication-method: INCREMENTAL and a replication-key for that stream in your project's metadata configuration:

  plugins:
    extractors:
    - name: tap-aptem
      variant: matatika
      pip_url: git+https://github.com/Matatika/tap-aptem.git@v0.1.0
      config:
      metadata:
        <stream_name>: # Aptem stream name
          replication-method: INCREMENTAL
          replication-key: <field_name> # a date column exposed by the stream

If you register a replication key override for a stream, consider opening an issue on the tap-aptem repo so it can be added upstream for everyone. Future version updates that include related changes would no longer require corresponding metadata entries, as above.

Need help?

If a stream or field you need isn't listed here or the connector doesn't work as expected, file it through the usual Meltano support channel.