How to run the example

This NBOR REGIS schema Validation will use the sample files to demonstrate the generation of validation report as output from a NBOR REGIS XML message.

The stopValidation.json file will report the validation failure due to the pre-conversion checks:

If input file is other than any of the supported NBOR REGIS messages as per schema list indicated above.

Import the nbor_regis.zip project into the Design Server.
Open the nbor_regis project in Design Server and view the flow nbor_regis_validation_flow.
1. The Flow Description points to all the maps to be executed during the flow process, which will be called from within some of the map nodes in the flow. The following is a list of maps invoked using RUN built-in function during the flow process:
  - - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1501_admi_004_001_02
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1502_camt_005_001_08
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1503_camt_006_001_08
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1504_camt_007_001_08
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1505_camt_008_001_08
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1506_camt_025_001_05
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1507_camt_029_001_09
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1508_camt_046_001_05
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1509_camt_047_001_06
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1510_camt_052_001_08
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1511_camt_053_001_08
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1512_camt_054_001_08
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1513_camt_056_001_08
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1514_camt_060_001_05
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1515_pacs_002_001_10
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1516_pacs_004_001_09
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1517_pacs_008_001_08_trz
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1518_pacs_008_001_08
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1519_pacs_009_001_08_cov
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1520_pacs_009_001_08
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1521_pacs_029_001_01
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1551_head112_admi004
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1552_head112_camt005
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1553_head112_camt006
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1554_head112_camt007
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1555_head112_camt008
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1556_head112_camt025
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1557_head112_camt029
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1558_head112_camt046
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1559_head112_camt047
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1560_head112_camt052
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1561_head112_camt053
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1562_head112_camt054
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1563_head112_camt056
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1564_head112_camt060
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1565_head112_pacs002
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1566_head112_pacs004
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1567_head112_pacs008_trz
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1568_head112_pacs008
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1569_head112_pacs009_cov
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1570_head112_pacs009
    - @packagemap=nbor_regis/validation/schema_only/maps/nbor_regis_mx_schema_validation_xsd/rgis1571_head112_pacs029
2. It utilizes the following nodes:
  1. Map Nodes:
    - MX pre-check
      Runs map mxut1009_bizsvc_rgis which set flow variables, check pre-validation conditions and create infoset.json for validation.
    - MX De_envelope
      Runs map rgis1600_deenvelope which separates header and document portions for messages.
    - BAH XSD-VAL
      Runs map rgis1501_nbor_regis_bah_val which calls the appropriate map to performs schema validation on the header of a NBOR REGIS message.
    - DOC XSD-VAL
      Runs map rgis1502_nbor_regis_doc_val which calls the appropriate map to performs schema validation on the body of a NBOR REGIS message.
      
      Note: The maps rgis1501_nbor_regis_bah_val and rgis1502_nbor_regis_doc_val internally call all the other maps identified in the above Flow Description step.
  2. Decision Nodes:
    - pre-valid chk
      This node checks the flow variable stopTranslation to decide if further validation/processing is not required.
  3. Route Nodes:
    - BAH-VAL
      This routing node identifies the type of validation to be performed for the message envelope. The options are extended or schema. The default as per the flow settings is schema (extended is not supported).
    - DOC-VAL
      This routing node identifies the type of validation to be performed for the message body. The options are extended or schema. The default as per the flow settings is schema (extended is not supported).
  4. Log Nodes:
    - FAILURE
      It creates stopMXvalidation.json log file in case of no validation due to pre-condition check failures.
    - bah_xsd
      It creates bah_validation_results.xml output file for results of message header schema validation.
    - doc_xsd
      It creates doc_validation_results.xml output file for results of message body schema validation.
  5. Fail Node:
    - STOP
      It generates error message setup in the node in case of no validation performed.
In Design Server, create a package nbor_regis_mx_validation that contains the input files and one flow nbor_regis_validation_flow. The maps will automatically be included during deployment of the package onto the runtime server.

Note: Not required for running flows on Design Server user interface directly.