.png)
Broadcom Clarity PPM Integration Guide
Integrate Broadcom Clarity PPM with enterprise applications through REST APIs, XOG/SOAP services, scheduled synchronization, and controlled data workflows.
Broadcom Clarity PPM integration options at a glance
Broadcom Clarity PPM provides REST APIs as the preferred mechanism for new application integrations, supporting queries and updates for Projects, Tasks, Resources, Investments, Timesheets, and related objects. XOG provides an established XML/SOAP option for enterprise estates, bulk-oriented exchanges, and operations not practical through REST. General-purpose webhooks for all object changes are not confirmed, so scheduled incremental synchronization is the safer default. Martini can authenticate through OAuth 2.0 where enabled, orchestrate paginated API or XOG calls, transform JSON and XML, apply validation and business rules, checkpoint successful processing, and expose APIs for downstream applications.
| Integration point | Supported by Broadcom Clarity PPM? | Common use cases | How Martini supports it |
|---|---|---|---|
| REST APIs | Yes | Query and update Projects, Tasks, Resources, Investments, Timesheets, relationships, and configured attributes. REST is the preferred option for new application integrations where the required resource is available. | Martini can consume Clarity REST endpoints from workflows, handle pagination, map JSON payloads, apply business rules, and expose APIs for other applications. |
| SOAP APIs / XOG | Yes | XOG provides XML-based imports and exports for established integrations, bulk-oriented exchanges, projects, resources, tasks, investments, and financial data. | Martini can invoke SOAP services, generate and parse XML, preserve namespaces, validate schemas, and isolate partial failures in XOG processing. |
| Bulk, asynchronous, or batch processing | Limited | XOG supports XML-oriented batch-style exchanges. Dedicated REST bulk or asynchronous coverage must be verified for the target Clarity release. | Martini can implement controlled batching, pagination, checkpointing, bounded concurrency, retries, and record-level error isolation around REST or XOG calls. |
| Webhooks and outbound callbacks | Not confirmed | A general-purpose webhook facility for all Clarity object changes is not confirmed. Event support must be checked for the specific release and object. | Martini can receive HTTP requests when an approved intermediary, event bus, or Clarity-side extension emits notifications; otherwise it can use scheduled incremental synchronization. |
| File and attachment APIs | Limited | Document and attachment capabilities exist in relevant Clarity areas, but upload, download, linking, and versioning coverage depends on the object and release. | Martini can route supported files through workflows, transform metadata, and send content to applications, object storage, or file-transfer endpoints after validating the relevant interface. |
| Database and analytics access | Limited | Clarity reporting and data-warehouse capabilities can support analytics extracts. Direct access to Broadcom-managed SaaS operational storage should not be assumed. | Martini can consume supported reporting APIs or files and load transformed data into a customer-managed database or analytics platform. |
| Authentication | Yes | OAuth 2.0 bearer tokens are relevant for REST integrations where enabled. Legacy or deployment-specific Basic, session-based, or XOG authentication must be verified per tenant. | Martini can store OAuth credentials, tokens, usernames, passwords, and endpoint configuration in secure environment settings rather than embedding secrets in workflows. |
How Broadcom Clarity PPM exposes data and business events
Clarity REST APIs
Clarity REST APIs are the preferred standards-based mechanism for new application integrations. They support querying and updating business objects, filtering collections, retrieving relationships, and processing configured attributes, although exact resources, verbs, filters, and pagination behavior vary by release.
Martini implementation pattern
Martini implementation pattern: a workflow authenticates to Clarity, retrieves paginated or incrementally changed objects, maps and validates JSON, applies business rules, writes to the target system, and advances a checkpoint only after successful processing.
Implementation sequence
Clarity XOG/SOAP
XOG is Clarity’s established XML Open Gateway for XML-based imports and exports. It remains relevant for existing enterprise integrations, bulk-style exchanges, financial data, and operations not practical through REST.
Martini implementation pattern
Martini implementation pattern: a workflow constructs version-compatible XML, invokes the XOG/SOAP service, parses the response, distinguishes record-level and submission-level errors, and records replayable failures without treating XOG as interchangeable with REST.
Implementation sequence
Scheduled incremental synchronization
A general-purpose webhook facility covering all Clarity object changes is not confirmed. Scheduled API polling based on modified timestamps is therefore the safer default for recurring synchronization.
Martini implementation pattern
Martini implementation pattern: a scheduler starts a workflow, the workflow reads the prior checkpoint, queries changed objects page by page, validates and writes each result, and advances the checkpoint only when the synchronization window has completed successfully.
Implementation sequence
Files and attachments
Clarity document and attachment capabilities are available in some functional areas, but exact upload, download, linking, and versioning support depends on the object and release.
Martini implementation pattern
Martini implementation pattern: a workflow calls the validated Clarity document interface, checks content type, size, access rights, and version metadata, then routes the file to a target application, object store, or file endpoint.
Implementation sequence
Common Broadcom Clarity PPM integration patterns
Pattern 1: Synchronize Projects and Tasks to Jira
When to use this pattern
Use this pattern when Clarity governs approved project scope while Jira teams manage delivery execution. The workflow should synchronize only eligible or changed Projects and Tasks, retain cross-system identifiers, and define which system owns status, dates, and completion percentages.
Integration direction
Example Mapping
| Broadcom Clarity PPM Field | Canonical Field | Target Field |
|---|---|---|
| Project.code | projectExternalId | Jira project key |
| Project.name | projectName | Jira project name |
| Task.name | workItemTitle | Jira issue summary |
| Task.percentComplete | completionPercentage | Jira progress or status |
Martini implementation pattern
A scheduled Martini workflow queries changed Projects and Tasks, validates parent-child relationships, maps Clarity identifiers to Jira issue keys, enriches records with configured ownership rules, and performs idempotent upserts. Failed tasks are isolated and retried without recreating successful issues.
Martini capabilities used
- workflows
- API consumption
- data mapping
- business rules
- checkpointing
- error handling
Pattern 2: Transfer Resources and Timesheets to Workday
When to use this pattern
Use this pattern to exchange approved time, worker identity, organizational data, or labor-cost inputs between Clarity and Workday. Approval state, accounting period, identity matching, and late corrections must be explicit.
Integration direction
Example Mapping
| Broadcom Clarity PPM Field | Canonical Field | Target Field |
|---|---|---|
| Resource.id | workerExternalId | Workday worker ID |
| Resource.department | organizationCode | Workday supervisory organization |
| Timesheet.period | payrollPeriod | Workday pay period |
| Timesheet.hours | approvedHours | Workday time quantity |
Martini implementation pattern
Martini retrieves approved Timesheets and related Resources, validates worker and Project or Task references, transforms organizational and accounting codes, and submits the target payload. A stable period and worker key prevents duplicate submissions, while corrections are handled as controlled updates.
Martini capabilities used
- scheduled workflows
- API consumption
- data transformation
- validation
- idempotency
- retry handling
Pattern 3: Convert ServiceNow Demand into Clarity Investments
When to use this pattern
Use this pattern when ServiceNow owns intake and approval while Clarity owns portfolio or project planning. The workflow should define the handoff point, required attributes, and return path for the new Clarity identifier and status.
Integration direction
Example Mapping
| Broadcom Clarity PPM Field | Canonical Field | Target Field |
|---|---|---|
| ServiceNow.request_number | sourceRequestId | Clarity external reference |
| ServiceNow.short_description | demandTitle | Idea or Investment name |
| ServiceNow.approval_state | approvalStatus | Clarity eligibility rule |
| ServiceNow.business_case | investmentDescription | Clarity description |
Martini implementation pattern
Martini receives a confirmed ServiceNow event when available or polls for approved requests, validates mandatory portfolio values, applies investment-type rules, creates an Idea, Investment, or Project through REST or XOG, and returns the Clarity identifier. An idempotency key prevents duplicate objects during retries.
Martini capabilities used
- API exposure
- workflow orchestration
- data mapping
- conditional routing
- business rules
- duplicate prevention
Pattern 4: Load Clarity Portfolio Data into Snowflake
When to use this pattern
Use this pattern for enterprise reporting that combines Clarity Projects, Investments, Resources, financial information, and Timesheets with data from other platforms. It is appropriate when direct access to Broadcom-managed operational storage is unavailable or unsuitable.
Integration direction
Example Mapping
| Broadcom Clarity PPM Field | Canonical Field | Target Field |
|---|---|---|
| Project.id | clarityProjectId | project_id |
| Investment.type | investmentType | investment_type |
| Resource.id | resourceExternalId | resource_id |
| Timesheet.hours | reportedHours | reported_hours |
Martini implementation pattern
A Martini scheduler extracts supported REST, reporting, warehouse, or file data, normalizes object relationships, preserves source identifiers, and loads incremental data into Snowflake. Checkpoints, reconciliation totals, deletion or inactive-record handling, and rejected-row quarantine support reliable analytics loads.
Martini capabilities used
- scheduler triggers
- API consumption
- file processing
- data mapping
- database integration
- monitoring
Applications commonly integrated with Broadcom Clarity PPM
Clarity PPM commonly participates in enterprise portfolio, project delivery, workforce, finance, and analytics architectures. The specific ownership of data and supported interfaces should be confirmed for each customer environment.
| Application | Scenario | Direction | Martini Pattern |
|---|---|---|---|
| ServiceNow | Transfer approved demand, project requests, or IT work into Clarity for portfolio and project planning, with status returned when required. | ServiceNow → Martini → Broadcom Clarity PPM | Martini receives an approved ServiceNow event or polls for eligible requests, validates project attributes, creates the appropriate Clarity Idea, Investment, or Project through REST or XOG, and returns the Clarity identifier and status. |
| Jira | Align Clarity governance with delivery tasks, assignments, and progress managed by Jira teams. | Broadcom Clarity PPM → Martini → Jira | A scheduled Martini workflow retrieves changed Projects and Tasks, maps stable Clarity identifiers to Jira issue keys, upserts issues, and applies explicit ownership rules for dates, status, and completion percentages. |
| Salesforce | Transfer customer opportunities or delivery commitments into Clarity Projects or Investments. | Salesforce → Martini → Broadcom Clarity PPM | Martini consumes approved Salesforce data, validates required portfolio attributes, transforms customer and opportunity values, creates or updates the relevant Clarity object, and stores cross-system identifiers. |
| Workday | Match Resources and organizational structures or exchange approved time and labor-related information. | Workday → Martini → Broadcom Clarity PPM | Martini retrieves or receives worker and organizational data, normalizes identity and accounting codes, validates approved Timesheets and periods, and submits controlled updates to Clarity or Workday. |
| SAP S/4HANA | Exchange project financials, cost centers, budgets, actuals, and accounting data. | SAP S/4HANA → Martini → Broadcom Clarity PPM | Martini orchestrates scheduled extracts and updates, maps financial dimensions and Clarity investment identifiers, validates totals, isolates rejected records, and retries transient failures. |
| Oracle E-Business Suite | Coordinate project accounting, financial plans, costs, and actuals between finance and portfolio management. | Oracle E-Business Suite → Martini → Broadcom Clarity PPM | A Martini workflow exchanges supported API, service, or file data, applies accounting and project-reference rules, performs idempotent upserts, and records reconciliation results. |
| Microsoft Project | Exchange project schedules and task information with Clarity where the customer’s supported version and process require it. | Microsoft Project → Martini → Broadcom Clarity PPM | Martini transforms schedule and task structures into Clarity-compatible REST or XOG payloads, validates parent Projects before Tasks, and handles conflicts and partial failures independently. |
| Snowflake | Centralize Clarity portfolio, project, resource, and financial data for enterprise analytics. | Broadcom Clarity PPM → Martini → Snowflake | Martini extracts supported REST, reporting, warehouse, or file data, normalizes relationships, preserves Clarity identifiers, loads incrementally into Snowflake, and advances checkpoints only after successful loads. |
How to build a Broadcom Clarity PPM integration in Martini
Objective
Establish a tenant-specific Clarity connection and confirm the release, enabled modules, endpoint paths, authentication method, and permissions required for the selected objects.
Instructions in Martini
- Configure the Clarity endpoint and release-specific settings in Martini environment configuration.
- Use OAuth 2.0 where enabled; verify any Basic, session-based, or XOG credentials before use.
- Store credentials, tokens, and secrets in secure Martini configuration.
- Test access with a least-privilege Clarity user.
Objective
Select an event, schedule, or API entry point based on the confirmed Clarity capabilities and the required synchronization latency.
Instructions in Martini
- Use a scheduler for recurring incremental synchronization when general webhooks are not confirmed.
- Use a Martini API when a Clarity-side extension, intermediary, or source application can call Martini.
- Use an external event mechanism only after confirming the relevant Clarity object notification.
Objective
Retrieve the required Clarity objects through REST, XOG/SOAP, reporting interfaces, or validated file mechanisms while accounting for pagination and checkpoints.
Instructions in Martini
- Query only the Projects, Tasks, Resources, Investments, Timesheets, or Ideas required by the use case.
- Process paginated REST collections deterministically.
- Use modified-date filters or an equivalent incremental query where supported.
- Construct release-compatible XML for XOG operations.
Objective
Coordinate calls, dependencies, batching, and target writes in a Martini workflow that can continue safely after transient or record-level failures.
Instructions in Martini
- Validate parent Projects before processing dependent Tasks.
- Separate transient service failures from authorization, validation, and conflict errors.
- Use bounded concurrency and controlled batches.
- Persist correlation identifiers and checkpoint state.
Objective
Transform Clarity JSON or XML into the target application’s canonical model while preserving identifiers, relationships, and configured attributes.
Instructions in Martini
- Map stable Clarity IDs to external identifiers.
- Normalize dates, statuses, organizational codes, and accounting values.
- Preserve XML namespaces and required elements for XOG.
- Handle required custom attributes separately from optional fields.
Objective
Enforce business ownership, approval, eligibility, duplicate prevention, and reconciliation rules before committing changes.
Instructions in Martini
- Filter Timesheets by approval state and accounting period.
- Define which system owns status, dates, completion, and financial values.
- Use lookup-before-create or stable external keys for idempotency.
- Validate configured Clarity permissions and custom-field values.
Common Broadcom Clarity PPM data objects used in integrations
| Object | Typical Use | Common target systems | Martini handling |
|---|---|---|---|
| Projects | Synchronize project definitions, schedules, status, financial information, and project-level attributes. | Jira, ServiceNow, SAP S/4HANA, Oracle E-Business Suite, Snowflake | Martini retrieves changed Projects, validates configured and required attributes, maps stable identifiers, and performs idempotent creates or updates. |
| Tasks | Exchange project work items, schedules, assignments, dependencies, and completion information. | Jira, Microsoft Project, Snowflake | Martini validates the parent Project, transforms task dates and ownership, upserts target tasks, and isolates dependency or validation failures. |
| Resources | Synchronize people, roles, teams, labor resources, organizational data, and resource attributes. | Workday, payroll platforms, Snowflake | Martini matches worker identities, maps organization and labor codes, enforces permissions and required fields, and handles inactive or changed Resources. |
| Investments | Exchange projects and other investment types in Clarity’s portfolio and investment hierarchy. | Salesforce, ServiceNow, SAP S/4HANA, Snowflake | Martini applies investment-type rules, maps financial and portfolio attributes, preserves Clarity IDs, and routes rejected records for replay. |
| Timesheets | Transfer approved time entries associated with Resources, Projects, Tasks, accounting periods, or chargeable work. | Workday, payroll platforms, finance systems, Snowflake | Martini filters approval states, validates worker and project references, prevents duplicate period submissions, and processes corrections explicitly. |
| Ideas | Represent proposed work or demand items that may be evaluated and converted into Investments or Projects. | ServiceNow, Salesforce, Snowflake | Martini validates intake data, applies approval and conversion rules, creates or updates Ideas, and returns the Clarity identifier to the source system. |
Authentication and security considerations
Tenant-specific authentication
Clarity authentication depends on the release and deployment model. OAuth 2.0 bearer tokens are relevant for REST integrations where enabled, while Basic, session-based, or XOG credentials may apply to older or deployment-specific configurations.
Least-privilege access
The authenticated user must have permission to access the required Projects, Tasks, Resources, Investments, Timesheets, custom attributes, and financial information. Successful authentication does not grant access to every Clarity object.
Martini secret management
Store OAuth client credentials, tokens, usernames, passwords, and endpoint settings in secure Martini configuration. Do not embed secrets in workflow definitions or mappings.
Operational considerations for Broadcom Clarity PPM integrations
Release and schema compatibility
REST resources, attributes, filters, pagination, custom fields, and XOG schemas can vary by Clarity release, tenant configuration, and enabled modules. Validate mappings against the target environment.
Pagination and checkpoints
Process collection responses page by page and persist the last successful checkpoint. Do not advance the checkpoint when only part of a synchronization succeeds.
Throttling and retries
Apply bounded concurrency and exponential backoff for temporary service failures or throttling. Retry transient errors, but isolate authorization, validation, conflict, and duplicate errors for remediation.
Idempotency and relationships
Use stable external identifiers or lookup-before-create logic. Validate parent Projects before Tasks and validate Resource, Project, Task, and accounting-period references before submitting Timesheets.
Testing and reconciliation
Test custom attributes, permissions, XOG XML namespaces, partial failures, late Timesheet corrections, inactive records, attachments, and reconciliation totals before production deployment.
Why use Martini instead of scripts or point-to-point integrations?
Centralized orchestration
Martini coordinates Clarity API calls, XOG/SOAP services, schedules, target applications, files, databases, and messaging in maintainable workflows rather than isolated scripts.
Reusable transformation and policy
Mappings, validation, identifier management, approval rules, and error policies can be reused across Clarity integrations while preserving the flexibility to add custom logic when required.
Operational control
Checkpointing, pagination, retries, bounded batching, error isolation, logging, and monitoring provide a controlled way to operate recurring synchronization and replay failed records.
Controlled API exposure
Martini can expose APIs that shield applications from Clarity release-specific details, apply security and business rules, and provide a consistent integration surface for downstream systems.
Frequently asked questions
Clarity can integrate through its REST APIs, established XOG/SOAP services, scheduled incremental queries, and selected reporting, warehouse, file, or attachment interfaces. REST is generally preferred for new application integrations, while XOG remains relevant for existing XML and bulk-oriented processes.
Yes. Martini can consume Clarity REST APIs, invoke XOG/SOAP services, orchestrate scheduled synchronization, transform JSON and XML, apply validation and business rules, and expose APIs for other systems. A native Martini Clarity connector is not documented in the supplied sources.
No. A dedicated Clarity connector is not required. Martini can use Clarity’s confirmed REST APIs, XOG/SOAP services, authentication methods, supported reporting or file interfaces, and externally generated notifications where available.
Lonti does not charge an additional per-connector or per-vendor fee for a Clarity integration. The integration is subject to the provisioned capacity of the Martini environment. Separate costs may apply from Broadcom, cloud infrastructure, or other third-party systems based on subscriptions, usage, and deployment model.
REST should generally be evaluated first for new integrations when the required resources and operations are available. XOG/SOAP remains appropriate for established integrations, XML batch exchanges, or operations that are unavailable or impractical through REST.
A general-purpose webhook mechanism covering all Clarity object changes is not confirmed. The specific release and object should be checked. When native notifications are unavailable, scheduled incremental synchronization, an enterprise event bus, or an intermediary application can provide the event-driven behavior.
A Martini scheduler can query Clarity using a supported modified-date or equivalent incremental filter, process paginated responses, map and validate relationships, upsert the target data, and advance a checkpoint only after successful processing. Stable identifiers and idempotent writes prevent duplicates.
Yes. Martini can expose a controlled REST API that applies authentication, validation, mapping, business rules, and workflow orchestration before calling Clarity REST or XOG/SOAP services. This can shield downstream applications from release-specific Clarity details and centralize error handling.
Related Martini documentation
APIs
Plan your Broadcom Clarity PPM integration
Use Martini to connect Clarity REST APIs and XOG/SOAP services with the applications, data platforms, and workflows that support your enterprise.