
Aptem
tap-aptem (matatika variant)
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.
Prerequisites
To connect to Aptem, you will need:
- An API token for the Aptem OData API.
- Your Aptem tenant name, which is used to build the API base URL.
Setup
In Meltano Cloud:
- Enter your Aptem API token
- Enter your Aptem tenant name
- Optionally choose a start date for extraction
Available Streams
This tap discovers streams dynamically from the Aptem OData service $metadata document, so
the exact set of streams reflects the entities and related collections exposed by your tenant.
The following streams are recognised by the tap:
AimWorkPlacementsApprenticeshipFinancialRecordsAptemCognitiveAssessmentsAwardingBodyQualificationsAwardingBodyQualificationsAssessmentHistoryComplianceDocumentsComponentDueDateChangesCrmActivitiesDestinationProgressionsEmployerGroupsEPAErrorsEpisodesGroupsHoursRecordsIlrAimsIlrLearnerJobsLearnerEmploymentLearningPlanComponentsLearningPlanEvidencesLearningPlanEvidenceWithActivityDataMaximumProgrammeDataFieldsMessagesMilestonesNotesOnboardingResponsesOrganizationContactsOrganizationsReviewResponsesReviewsTasksTrackersUsersUserGroupsWithdrawalReasons
Additional related collections embedded within these entities are also discovered and extracted as their own streams.
Streams with a known replication key are replicated incrementally; the rest are replicated
in full on each run. If you find a stream is not behaving incrementally when it exposes a
suitable date column, you can set a replication key configuration for the plugin under
metadata in your meltano.yml:
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
Please also open an issue here
to register any missing configurations in the tap. Future version updates that include related
changes would no longer require corresponding metadata entries, as above.
Settings
API Token
API token for the Aptem OData API
Tenant Name
Aptem tenant name used to build the base URL.
Start Date
The earliest record date to sync
Aptem connector is available on Meltano. It is built, maintained, supported, and tested by Meltano.