Skip to main content

Set up Talend

Configure access to your Talend project repository stored in GitHub or Atlassian Stash (Bitbucket Server). The Talend connector reads project metadata directly from your version-controlled repository.

Prerequisites​

Before you begin, make sure you have:

  • A GitHub repository URL (or Atlassian Stash/Bitbucket Server URL) where your Talend projects are stored
  • Network access to GitHub or your Stash server
  • Atlan connector permissions to create and configure connectors

Verify repository structure​

  1. Confirm your repository contains Talend project files exported from Talend Studio.

    The connector requires .item and .properties files to extract metadata.

Expected repository structure
repository/
├── process/
│   ├── folder1/
│   │   ├── job1_0.1.item
│   │   ├── job1_0.1.properties
│   │   └── job2_0.1.item
│   └── folder2/
│       └── job3_0.1.item
├── code/
│   └── routines/
├── metadata/
└── talend.project

Create personal access token​

Create a personal access token with read permissions to your Talend project repository.

  1. Log in to GitHub.
  2. Navigate to Settings > Developer settings > Personal access tokens > Tokens (classic).
  3. Click Generate new token > Generate new token (classic).
  4. Configure the token:
    • Note: Enter a descriptive name, for example Atlan Talend Connector
    • Expiration: Select an appropriate expiration period
    • Scopes: Select repo for private repositories or public_repo for public repositories
  5. Click Generate token.
  6. Copy the generated token immediately—you can't view it again after leaving the page.

Prepare context files​

If your Talend jobs use context-based parameter resolution, prepare a .zip file to upload using the Zip File field in the connector UI. Consistent folder naming is required for correct parameter resolution, lineage extraction, and job parsing.

  1. Place context files under the appropriate environment folder (for example, test).
  2. Make sure job-specific and project-level properties files follow the defined hierarchy.
  3. Organize joblets within their respective project or context management folders.
  4. Store SQL files in accessible local paths as referenced in your Talend jobs.
Expected zip file structure

The example below uses concrete names from a sample project. The comments show the corresponding placeholders so you can map the layout to your own environment, projects, jobs, and joblets.

<archive>.zip
│
├── CONTEXTMANAGEMENT/
│   └── joblets/
│       ├── LoadContextFromFile_0.1.item             # LoadContextFromFile_<version>.item
│       ├── LoadContextFromFile_0.1.properties       # LoadContextFromFile_<version>.properties
│       ├── LoadContext_0.1.item                     # LoadContext_<version>.item
│       └── LoadContext_0.1.properties               # LoadContext_<version>.properties
│
├── SHARED_JOBLETS/                                  # <JOBLET_PROJECT>
│   └── joblets/
│       ├── LookupCustomer_0.1.item                  # <SharedJoblet>_<version>.item
│       └── LookupCustomer_0.1.properties            # <SharedJoblet>_<version>.properties
│
├── app/
│   └── talend/
│       └── contextfiles/
│           └── test/                                # <ENV>
│               ├── global.properties
│               └── projects/
│                   └── ATLAS/                       # <PROJECT_NAME>
│                       ├── project.properties
│                       └── jobs/
│                           ├── AdobeTargetFeed.properties              # <JOB_NAME>.properties
│                           └── AdobeTargetFeed_USFullFeed.properties   # <JOB_NAME>_<variant>.properties
│
├── localpath2/                                      # <localpath_folder>
│   ├── availability_vsd_ecomm.sql
│   ├── primary_color.sql
│   └── product_margin.sql
│
└── localpath3/                                      # <localpath_folder>
    └── NewColorV2.sql

Important notes​

  1. Context management requirement: If your setup includes a global project for parameterization, include the entire folder structure (for example, CONTEXTMANAGEMENT with all joblets) in the archive.
  2. .properties files: These contain key-value pairs for parameters and their values. Include them exactly as stored on the server and preserve the folder hierarchy without modification.
  3. .sql files: Some setups store SQL queries externally and reference them from jobs at runtime. Include these files with the same directory structure as on the server.
Key guideline

Don't alter the folder structure or file paths. The archive must mirror the server layout exactly to guarantee proper execution.

Next steps​

Crawl Talend assets: Create the workflow and run the crawl to extract Talend metadata