Alfresco Process Services connector icon

Load Alfresco Process Services data in Python using dltHub

Build a Alfresco Process Services-to-database or-dataframe pipeline in Python using dlt with automatic Cursor support.

In this guide, we'll set up a complete Alfresco Process Services data pipeline from API credentials to your first data load in just 10 minutes. You'll end up with a fully declarative Python pipeline based on dlt's REST API connector, like in the partial example code below:

Example code
@dlt.source
def alfresco_process_services_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "http://localhost:8080/alfresco/api/-default-/public/alfresco/versions/1/nodes/2b1111e5-c79e-445e-909a-46c989bc3531/versions/1.0/storage-info/cm%3Acontent",
            "auth": {
                "type": "bearer",
                "token": access_token,
            }
        },
        "resources": [
            "archive", "archive-restore"
        ],
    }
    [...]
    yield from rest_api_resources(config)


def get_data() -> None:
    # Connect to destination
    pipeline = dlt.pipeline(
        pipeline_name='alfresco_process_services_pipeline',
        destination='duckdb',
        dataset_name='alfresco_process_services_data', 
    )
    # Load the data
    load_info = pipeline.run(alfresco_process_services_source())
    print(load_info)

Why use dltHub Workspace with LLM Context to generate Python pipelines?

Accelerate pipeline development with AI-native context
Debug pipelines, validate schemas and data with the integrated Pipeline Dashboard
Build Python notebooks for end users of your data
Low maintenance thanks to Schema evolution with type inference, resilience and self documenting REST API connectors. A shallow learning curve makes the pipeline easy to extend by any team member
dlt is the tool of choice for Pythonic Iceberg Lakehouses, bringing mature data loading to pythonic Iceberg with or without catalogs

What you’ll do

We’ll show you how to generate a readable and easily maintainable Python script that fetches data from alfresco_process_services’s API and loads it into Iceberg, DataFrames, files, or a database of your choice. Here are some of the endpoints you can load:

Activiti App Endpoints: Endpoints related to the Activiti application, including API versions and documentation.
- /activiti-app/api/enterprise/app-version: Provides the version information of the Activiti app.
- /activiti-app/api-explorer.html: Documentation and exploration interface for the Activiti API.
Alfresco Document and Service Endpoints: Endpoints for accessing documents and various services in the Alfresco platform.
- /alfresco/aos/documents/doc1.docx: Access to a specific document (doc1.docx).
- /alfresco/service/bulkfsimport: A set of services for importing files in bulk, including initiation and status checks.
  - /alfresco/service/bulkfsimport/initiate: Initiates the bulk file import process.
  - /alfresco/service/bulkfsimport/status: Checks the status of the bulk file import process.
  - /alfresco/service/bulkfsimport/inplace: Service for inplace bulk file import operations.
Alfresco Share and Admin Endpoints: Interfaces for the Alfresco Share application and administrative tasks.
- /share: Main entry point for the Alfresco Share application.
- /alfresco/s/enterprise/admin: Admin interface for enterprise-level management.
- /admin: General administrative interface for Alfresco.
Workspaces and Other Endpoints: Various endpoints related to workspaces and other functionalities within Alfresco.
- /workspace: Endpoint for accessing the workspace functionalities.
- /alfresco: General root endpoint for Alfresco services.

You will then debug the Alfresco Process Services pipeline using our Pipeline Dashboard tool to ensure it is copying the data correctly, before building a Notebook to explore your data and build reports.

Setup & steps to follow

💡
Before getting started, let's make sure Cursor is set up correctly:

We suggest using a model like Claude 3.7 Sonnet or better
Index the REST API Source tutorial: https://dlthub.com/docs/dlt-ecosystem/verified-sources/rest_api/ and add it to context as @dlt rest api
Read our full steps on setting up Cursor

Now you're ready to get started!

⚙️ Set up dlt Workspace

Install dlt with duckdb support:
```
pip install "dlt[workspace]"
```
Initialize a dlt pipeline with Alfresco Process Services support.
```
dlt init dlthub:alfresco_process_services duckdb
```
The init command will setup the necessary files and folders for the next step.

🤠 Start LLM-assisted coding

Here’s a prompt to get you started:

Prompt
Please generate a REST API Source for Alfresco Process Services API, as specified in @alfresco_process_services-docs.yaml 
Start with endpoints archive and archive-restore and skip incremental loading for now. 
Place the code in alfresco_process_services_pipeline.py and name the pipeline alfresco_process_services_pipeline. 
If the file exists, use it as a starting point. 
Do not add or modify any other files. 
Use @dlt rest api as a tutorial. 
After adding the endpoints, allow the user to run the pipeline with python alfresco_process_services_pipeline.py and await further instructions.

🔒 Set up credentials

The REST API uses various methods for authentication including Basic authentication and OAuth 2 SSO, but specific details such as client id, client secret, token, refresh token, and their application are not provided in the snippets.

To get the appropriate API keys, please visit the original source at https://docs.alfresco.com/process-services/1.9/develop/rest-api/. If you want to protect your environment secrets in a production environment, look into setting up credentials with dlt.

🏃‍♀️ Run the pipeline in the Python terminal in Cursor


python alfresco_process_services_pipeline.py

If your pipeline runs correctly, you’ll see something like the following:


Pipeline alfresco_process_services load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset alfresco_process_services_data
The duckdb destination used duckdb:/alfresco_process_services.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

📈 Debug your pipeline and data with the Pipeline Dashboard

Now that you have a running pipeline, you need to make sure it’s correct, so you do not introduce silent failures like misconfigured pagination or incremental loading errors. By launching the dlt Workspace Pipeline Dashboard, you can see various information about the pipeline to enable you to test it. Here you can see:
- Pipeline overview: State, load metrics
- Data’s schema: tables, columns, types, hints
- You can query the data itself
```
dlt pipeline alfresco_process_services_pipeline show dashboard
```
🐍 Build a Notebook with data explorations and reports

With the pipeline and data partially validated, you can continue with custom data explorations and reports. To get started, paste the snippet below into a new marimo Notebook and ask your LLM to go from there. Jupyter Notebooks and regular Python scripts are supported as well.
```
import dlt

data = dlt.pipeline("alfresco_process_services_pipeline").dataset()
# get "archive" table as Pandas frame
data."archive".df().head()
```

Extra resources:

Learn more with our 1h LLM-assisted coding course!