README

Members of the Universal Business Language (UBL) TC create and manage technical content in this TC GitHub repository as part of the TC's chartered work (the program of work and deliverables described in its charter.

OASIS TC GitHub repositories, as described in GitHub Repositories for OASIS TC Members' Chartered Work, are governed by the OASIS TC Process, IPR Policy, and other policies. While they make use of public GitHub repositories, these repositories are distinct from OASIS Open Repositories, which are used for development of open source licensed content.

Description

Various build processes in this repository create the NDR subcommittee documentation and other deliverables.

Contributions

As stated in this repository's CONTRIBUTING file, contributors to this repository must be Members of the OASIS UBL TC for any substantive contributions or change requests. Anyone wishing to contribute to this GitHub project and participate in the TC's technical activity is invited to join as an OASIS TC Member. Public feedback is also accepted, subject to the terms of the OASIS Feedback License.

Licensing

Please see the LICENSE file for description of the license terms and OASIS policies applicable to the TC's work in this GitHub project. Content in this repository is intended to be part of the UBL TC's permanent record of activity, visible and freely available for all to use, subject to applicable OASIS policies, as presented in the repository LICENSE.

Further Description of this Repository

This repository is for GitHub publishing of the artefacts:

OASIS Business Document Naming and Design Rules (BDNDR) v1.1
- Business-Document-NDR-v1.1-{stage}.xml
  - this XML requires an entity file:
    - Business-Document-NDR-v1.1-{stage}-summary.ent
    - this entity file can be empty when it is made inconsistent with new edits to the base XML
    - this entity file should be replaced by the version created on GitHub
    - this entity file is created on GitHub using the stylesheet fragments:
      - massage-NDR.xsl
      - check-UBL-NDR-3.0.xsl
  - the publishing process leverages an assembly step using:
    - assembleEntities.xsl
UBL Naming and Design Rules v3.1
- UBL-NDR-v3.1-{stage}.xml
UBL 2.1 JSON Serialization v2.0
- UBL-2.1-JSON-v2.0-{stage}.xml
UBL 2.2 JSON Serialization v1.0
- UBL-2.2-JSON-v1.0-{stage}.xml
UBL 2.3 JSON Serialization v1.0
- UBL-2.3-JSON-v1.0-{stage}.xml
UBL Governance v1.1
- UBL-Governance-v1.1-{stage}.xml

Opening the authored XML documents in an XSLT-aware browser (e.g. Safari) allows one to peruse the final document as if it had been published in HTML.

Included in the BDNDR results are the following schema fragments:

XML Schema XSD:
- BDNDR-CCTS_CCT_SchemaModule-1.1.xsd
- BDNDR-UnqualifiedDataTypes-1.1.xsd
JSON Schema:
- BDNDR-CCTS_CCT_SchemaModule-1.1.json
- BDNDR-UnqualifiedDataTypes-1.1.json

When the JSON Schemas and serializations have changed, the following directories must be updated with the results of recreating the JSON artefacts:

UBL-2.1-JSON-results - /val, /json-schema
UBL-2.2-JSON-results - /val, /json-schema
UBL-2.3-JSON-results - /val, /json-schema

The /json subdirectory in each of the above is a transliteration of that UBL release's suite of XML sample instances individually converted to JSON using:

CCTSXML2JSON.xsl (see readme-CCTSXML2JSON.html for the documentation)

Support subdirectories:

art - high-res artwork for PDF publishing
db - HTML runtime event for DocBook from OASIS DocBook templates
htmlart - low-res artwork for HTML publishing
utilities - tools used to generate outputs

Every git push triggers GitHub to publish the results of all of the inputs. This is done by the doall-github.sh bash invocation of the doall.sh script:

#!/bin/bash
#
# This is the invocation that happens in the GitHub action ... it must be bash
#
bash doall.sh "$1" "$2" "$3" "$4" "$5" "$6" "$7"

The invocation doall.sh that has all of the required current invocations that must be edited accordingly when new revisions are being published:

bash doall.sh targetDirectory platform label dateTime serverUsername serverPassword

The GitHub invocations by doall.sh are as follows:

UBL Governance
- bash packageGovernance.sh targetDirectory stage label dateTime serverUsername serverPassword
Business Document Naming and Design rules
- bash packageBDNDR11.sh targetDirectory stage label dateTime serverUsername serverPassword
UBL Naming and Design rules
- bash packageUBLNDR.sh targetDirectory stage label dateTime serverUsername serverPassword
JSON Serialization
- bash packageUBLJSON.sh targetDirectory ublVersion stage label dateTime serverUsername serverPassword
where:
- pre-existing target directory (without trailing "/", e.g. ../results or ..\results)
- ublVersion (e.g. "2.1", "2.2", "2.3")
- stage (e.g. "csd02wd03", "csprd01", "os", etc.)
- label (e.g. "CCYYMMDD-hhmmz" UTC time as in "20200406-0250z", or any string for testing purposes)
- dateTime (e.g. "now" for current time, or "CCYYMMDD-hhmm" in local time as in "20200405-2250z" for EDT -0400)
- serverUsername (automatically supplied on GitHub as a secret value)
- serverPassword (automatically supplied on GitHub as a secret value)

The build results ZIP file contains:

UBL-Governance-v1.1-{stage}-{label}.zip
Business-Document-NDR-v1.1-{stage}-{label}.zip
UBL-NDR-v3.1-{stage}-{label}.zip
UBL-2.1-JSON-v2.0-{stage}-{label}.zip
UBL-2.2-JSON-v1.0-{stage}-{label}.zip
UBL-2.3-JSON-v1.0-{stage}-{label}.zip
archive-only-not-in-final-distribution/ndr.exitcodes.test.txt
- a summary of the exit codes for each of the publishing tasks
archive-only-not-in-final-distribution/ndr.console.test.txt
- the console record of the execution of each of the publishing tasks

Contact

Please send questions or comments about OASIS TC GitHub repositories to the OASIS TC Administrator. For questions about content in this repository, please contact the TC Chair or Co-Chairs as listed on the the UBL TC's home page.

oasis-tcs / ubl-ndrsc