メインコンテンツまでスキップ

ALM Integration

The Application Lifecycle Management (ALM) integration connects ProBeya with Jira and Azure DevOps (ADO). It enables bidirectional synchronization of work items, allowing teams to manage operational transformation activities in ProBeya while keeping development teams aligned in their existing ALM tools.

Overview​

ProBeya supports two ALM providers:

ProviderAuthenticationSync Methods
Jira (Cloud & Server)Email + API TokenJQL-based pull, webhook push
Azure DevOpsPersonal Access Token (PAT)WIQL-based pull, service hook push

Each connection links a ProBeya organization to a specific project in the ALM system. Field mappings define how ALM fields translate to ProBeya columns.

Getting Started​

  1. Navigate to Settings > ALM.
  2. Click Create Connection.
  3. Select the provider (Jira or Azure DevOps).
  4. Enter a name, base URL, and credentials.
  5. Specify the project key (Jira) or project name (ADO).
  6. Configure field mappings to define how data flows between systems.
  7. Click Test Connection to verify credentials.
  8. Save and optionally click Sync Now for an initial data pull.

How It Works​

Field Mappings​

Each mapping links an ALM field to a ProBeya column with a sync direction:

DirectionBehaviour
InboundALM → ProBeya (pull only)
OutboundProBeya → ALM (push only)
BothBidirectional synchronization

Sync Operations​

  • Inbound Pull -- Triggered manually via Sync Now or on a schedule. Fetches work items from the ALM project using JQL (Jira) or WIQL (ADO) and creates or updates ProBeya items.
  • Outbound Push -- Triggered automatically when a mapped ProBeya field changes and the mapping direction is out or both.
  • Webhook Inbound -- An auto-generated webhook secret is provided during connection setup. Configure this in your ALM system to push real-time updates to ProBeya.

Sync Log​

Every sync operation is recorded in the sync log with:

FieldDescription
Directioninbound or outbound
Statussuccess or error
Items CreatedNumber of new items created
Items UpdatedNumber of existing items updated
Items FailedNumber of items that failed to sync
ErrorsError messages for failed items
Started / Completed AtTiming information

Configuration​

SettingDescription
Providerjira or azure_devops
NameHuman-readable connection name
Base URLALM instance URL (e.g., https://yourorg.atlassian.net)
CredentialsProvider-specific authentication (stored encrypted)
Project KeyJira project key or ADO project name
Field MappingsArray of source-target-direction mapping entries
Sync EnabledToggle automatic synchronization on or off

Permissions​

  • Any authenticated organization member can create and manage ALM connections.
  • Credentials are stored as encrypted JSONB and are never returned in API responses.
  • The webhook secret is returned once at connection creation for configuration in the ALM system.
  • All operations are scoped to the current organization.

Tips & Best Practices​

ヒント

Use the Test Connection button before saving to verify credentials. You can test both existing connections (by ID) and new credentials inline during the setup wizard.

  • Start with inbound-only mappings to populate ProBeya from your ALM. Add outbound later once you are confident in the field mappings.
  • Use the sync log to diagnose failed items -- the error messages often indicate mapping mismatches.
  • For Jira, use a service account with read-only access for inbound syncs to follow least-privilege.
  • Rotate API tokens and PATs periodically and update the connection credentials.
  • Keep field mappings minimal -- sync only the fields that are genuinely needed.
  • Connectors -- ERP/MES/Quality system connectors for pharma environments.
  • Webhooks -- Generic outbound webhooks for custom integrations.
  • Integrations -- Pre-built connectors for Slack, Teams, and other tools.