DAM developer guide
This guide covers system integration, enterprise workflows, service extensions, Parser plugins, and governance reporting. REST APIs support cross-system calls. The SDK extends controllers, services, persistence, and frontend capabilities within product services. Parser plugins convert new job formats into standard lineage. These approaches can be combined with explicit delivery boundaries.
Choose an approach
| Requirement | Approach | Guide |
|---|---|---|
| Query metadata, standards, quality, assets, and lineage | REST API | API overview |
| Integrate enterprise approvals | REST API and adapter | Workflow integration |
| Extend service responses, properties, or interfaces | Microservice SDK | SDK architecture |
| Add menus, forms, or views | Frontend extension | Frontend development |
| Parse a new job format | SQLink Parser | Parser plugins |
| Build governance dashboards | Reporting models and SQL | Governance reporting |
SDK development requires vendor authorization, matching SDK, and training support. REST integration can use any suitable language but still requires deployment-specific permissions and contract acceptance.
Service base URLs
Use environment configuration rather than hard-coded hosts or sessions.
| Variable | Example base URL | Objects |
|---|---|---|
BASE_BASE_URL | https://<host>/base | Systems, tags, base jobs |
METADATA_BASE_URL | https://<host>/metadata | Sources, tables, fields, reports, metamodels |
DOMAIN_BASE_URL | https://<host>/domain | Standards, reference codes, metrics |
QUALITY_BASE_URL | https://<host>/quality | Rules, issues, execution |
ASSETS_BASE_URL | https://<host>/assets | Catalogs and assets |
DATASECURITY_BASE_URL | https://<host>/datasecurity | Classification and security assets |
SQLINK_BASE_URL | https://<host>/sqlink | Parsing, lineage, impact |
GRAPH_BASE_URL | https://<host>/graph | Relationships and context |
JOB_BASE_URL | https://<host>/job | Instances and runs |
USER_BASE_URL | https://<host>/user | Users, tokens, organizations |
See request conventions. The following example applies only if your gateway confirms Bearer authentication:
curl --fail-with-body --request POST \
--header "Authorization: Bearer $DAM_TOKEN" \
--header 'Content-Type: application/json' \
--data '{"currentPage":1,"pageSize":20,"keyword":"customer"}' \
"$METADATA_BASE_URL/entities/searchMetadata"Inject tokens through secrets management and exclude them from repositories, logs, and screenshots.
Delivery principles
- Confirm release, services, authorization, and upgrade windows before extension design.
- Keep enterprise logic in adapters, plugins, or extension modules. Replace product Beans only through supported mechanisms.
- Design audit, idempotency, and rollback for writes, approvals, job starts, and parsing.
- Regress APIs, Beans, plugins, and SQL with business samples before every upgrade.
- Keep product tables and Repositories under product ownership; store custom properties in separate keyed tables.
| Stage | Deliverables |
|---|---|
| Design | Target release, services, permissions, key mappings, idempotency |
| Development | Modules, configuration templates, migrations, API/Parser tests |
| Integration | Normal, unauthorized, repeated, timeout, and upgrade cases |
| Release | Build, dependencies, deployment order, rollback, operating guide |
