Get started

​

Overview

​

Learn how the platform fits together

1. Read Architecture for the provisioning and runtime planes.
2. Read GitHub organization and repository structure to learn which repositories you own.
3. Complete the Backbase Academy courses Grand Central WoW and Backend Grand Central.

​

Quick links

• Java JDK 21: Connectors run on Java 21. For more information, see Java 21 API documentation.
• Maven 3.6 or later: Builds your project and pulls Banking OS artifacts from Artifactory and your organization’s GitHub Packages.
• Apache Camel: The integration framework your routes use. For more information, see Apache Camel components.
• Git: Clone repositories, create branches, and open pull requests.

​

Before you start checklist

• You have access to your self-service repository (gc-devhub-{installation}-self-service). Backbase creates it when your installation is set up. It’s the source of truth for your users, roles, and repositories.
• Your GitHub account is connected to the organization
• You’ve installed Java JDK 21, Maven 3.6 or later, and Git
• You understand basic Git workflows (clone, branch, commit, PR)
• You have a clear understanding of the integration you want to build
• You know which external APIs/services you’ll be integrating with
• (Optional) You have Azure access if you need to deploy to runtimes
• (Optional) You have DataDog/Grafana access if you need to monitor

​

Prerequisites

• Access to the self-service repository - You need to be added as a team member with appropriate permissions
  • If you don’t have access, contact your Backbase Onboarding team or project manager to request access
  • Manage access through the team_members section in self-service.tfvars
  • For additional user seats, create a support ticket in the Support Portal
• GitHub account - Connected to the organization
  • Your GitHub account must be part of the organization
  • Learn more about GitHub workflows and pull requests
• Azure access (optional) - For runtime access to dev, staging, test, or UAT environments
  • Required if you need to deploy or monitor connectors in runtime environments
  • Banking OS roles in self-service.tfvars grant this access
• Basic understanding of:
  • Git and GitHub workflows - Git documentation | GitHub Guides
  • Integration patterns - Familiarity with common integration patterns (request/response, pub/sub, etc.)
  • REST APIs - Understanding of REST principles and HTTP methods
  • Apache Camel (recommended) - Basic knowledge of Apache Camel and route definitions

​

Learning resources

• Git and GitHub: GitHub Learning Lab | Atlassian Git Tutorial
• REST APIs: REST API Tutorial | HTTP Methods Guide
• Apache Camel: Camel Examples
• Integration Patterns: Enterprise Integration Patterns
• README.md inside the self-service repository

​

Your first connector

​

Request repository creation

1. Navigate to the self-service repository and create a new branch.
2. Edit self-service.tfvars to add your connector repository definition.
3. Create a pull request targeting the main branch.

​

Define your connector repository

repositories = {
  "my-custom-connector" = {
    repository_topics = [
      "grandcentral",
      "connector",
      "integration",
      "camel-k"
    ]
    enable_branch_protection = true
    enforce_admins = true
    default_branch = "develop"
    require_branch_up_to_date = true
    protected_branches = ["main", "develop"]
    required_status_checks = ["Validate pull request / Verify Maven project"]
    repository_init_from_zip = {
      name    = "grandcentral-connector-template"
      version = "2.0.14"
    }
    repository_visibility = "private"
  }
}

• repository_init_from_zip: Automatically initializes your repository from the connector template
  • name: Use "grandcentral-connector-template" for connector projects
  • version: A published release of the template. Connector template release 2.0.14 is one published release.
• repository_topics: Add relevant tags for discoverability
• protected_branches: Branches that require pull request reviews before merging
• required_status_checks: CI/CD checks that must pass before merging

​

Wait for repository provisioning

1. The pipeline automatically provisions your repository.
2. The pipeline initializes the repository from the connector template.
3. You receive access to the repository based on your team permissions.

​

Clone and explore

git clone <your-organization>/my-custom-connector.git
cd my-custom-connector

• Maven project structure - Standard Java/Maven setup
• Camel K integration routes - Pre-configured integration patterns
• CI/CD pipelines - Automated build and validation
• Documentation templates - README and configuration guides

​

Understanding the template structure

my-custom-connector/
├── src/
│   └── main/
│       └── resources/
│           └── application.properties  # Configuration
│           └── routes/                # Camel routes
├── pom.xml                            # Maven dependencies
├── README.md                          # Project documentation
└── .github/
    └── workflows/                     # CI/CD pipelines

​

About the connector template

• Pre-configured Apache Maven project structure
• Sample Apache Camel routes and integration patterns
• CI/CD pipeline configuration
• Health check endpoints
• Logging configuration

• Check the version used by existing connector repositories in your installation, and align with your team’s choice.
• The repository is initialized from the template automatically when it is created.

​

Next steps

1. Review the template code - Understand the structure and patterns
2. Read the Build guide - Learn how to develop and build your connector
3. Configure your integration - Define your API endpoints and data mappings
4. Test locally - Use the development tools to test your connector

​

Get help

• Documentation: See Overview in the Build guide, Run, and Monitor.
• Your onboarding team or project manager: Access setup, first users, and questions during onboarding.
• Repository issue tracker: Technical questions about a connector repository.
• Support Portal: Extra user seats or Datadog-only users, access problems, namespace requests, and platform incidents such as failed deployments or unavailable runtimes. In the ticket, include your installation, runtime, and the affected connector or repository.

​

Common first steps

​

Adding team members

team_members = {
  "developer@example.com" = {
    github = {
      github_teams = ["development", "applications-live"]
    }
    grandcentral = {
      roles = ["dev-rw", "dev-ro"]
    }
  }
}

​

Understanding access levels

• GitHub teams: Control repository access
  • development: Write access to development repositories
  • applications-live: Write access to applications-live repository
  • self-service: Can approve PRs in self-service repository
• Banking OS roles: Control runtime access
  • dev-rw: Full access to dev runtime
  • dev-ro: Read-only access to dev runtime
  • Similar roles available for stg, test, and uat environments