Skip to content

docs(0074): add business partner script variants#326

Draft
nicoprow wants to merge 1 commit into
catenax-eV:mainfrom
nicoprow:docs/standards/0074/multi-script
Draft

docs(0074): add business partner script variants#326
nicoprow wants to merge 1 commit into
catenax-eV:mainfrom
nicoprow:docs/standards/0074/multi-script

Conversation

@nicoprow

@nicoprow nicoprow commented May 22, 2026

Copy link
Copy Markdown

Summary

Applies the script variants contribution to the CX-0074 Business Partner Gate API standard, standardising the scriptVariants attribute already present in the reference implementation.

  • Adds Script Variants (List of Business Partner Script Variant) to the Business Partner entity in §1.5.2.1
  • Adds new sub-section §1.5.2.1.2 BUSINESS PARTNER SCRIPT VARIANT defining the full data model: BusinessPartnerScriptVariant with nested LegalEntityScriptVariant, SiteScriptVariant, and AddressScriptVariant (each with a physical and, where applicable, alternative address variant)
  • Specifies that available script codes are operator-defined and published via the Business Partner Data Pool (CX-0012), not validated at the Gate API level
  • Clarifies that script variants flow through the enrichment process like any other business partner attribute, and that deduplication of identical script codes is the enrichment process's responsibility

Fields standardised in physical address script variant: postal code, city, district, street name/prefix/suffix fields, building, floor, door, company postal code, industrial zone. Fields present in the reference implementation but not meaningful to vary by script (taxJurisdictionCode, house number, milestone, direction) are intentionally excluded from the standard.

Diagrams

  • Updated business-partner.puml / .svg: removes obsolete commented-out script variant draft and adds BusinessPartnerScriptVariant class with ScriptCode / NameParts and a composition relation from BusinessPartner
  • New business-partner-script-variant.puml / .svg: dedicated diagram for §1.5.2.1.2 showing the full script variant hierarchy

Change Request

https://github.com/catenax-eV/product-standardization-prod/issues/667

Comment on lines +270 to +274
1. A sharing member **MAY** supply script variants on input when source data is available in multiple scripts.
2. Script variants are passed to the enrichment process as part of the business partner data and are processed like any other attribute.
3. The enrichment process **MAY** add or normalise script variants on output, for example by adding a Latin transliteration for a record submitted in a non-Latin script.
4. The set of available script codes is operator-defined and published in the Business Partner Data Pool (see CX-0012 Business Partner Data Pool API). The Gate accepts any string value for the script code without validation; unknown codes are resolved by the enrichment process.
5. The Gate accepts a script variants list containing duplicate script code entries; deduplication is the responsibility of the enrichment process.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If these shall be CACs, they must be in the normative part of the document. As these are suggestions anyway, I'd rather remove the MAY.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants