How to run the example

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

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

1. Import the sic_rtgs.zip project into the Design Server.
2. Open the sic_rtgs_validation_flow project in Design Server and view the sic_rtgs_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=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3501_acmt_010_001_03
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3502_acmt_011_001_03
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3503_acmt_015_001_03
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3504_camt_003_001_07
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3505_camt_004_001_08
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3506_camt_005_001_08
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3507_camt_006_001_08
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3508_camt_007_001_08
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3509_camt_008_001_08
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3510_camt_011_001_07
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3511_camt_019_001_07
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3512_camt_025_001_05
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3513_camt_027_001_07
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3514_camt_029_001_09
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3515_camt_048_001_05
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3516_camt_050_001_05
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3517_camt_052_001_08
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3518_camt_054_001_08
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3519_camt_056_001_08
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3520_camt_087_001_06
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3521_pacs_002_001_10
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3522_pacs_004_001_09
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3523_pacs_008_001_08
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3524_pacs_009_001_08
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3525_pacs_028_001_03
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3526_reda_015_001_01
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3527_reda_017_001_01
      • @packagemap=sic_rtgs/validation/schema_only/maps/sic_rtgs_mx_schema_validation_xsd/sirt3599_head_001_001_01
   2. It utilizes the following nodes:
      1. Source Nodes:
         • mx_input

           This node identifies the input data to be validated in the flow. It uses the INPUT_FILE variable to set the location of the data.

      2. Map Nodes:
         • MX pre-check

           Runs map mxut1010_bizsvc_sirt which sets flow variables, checks pre-validation conditions and creates infoset.json for validation.

         • XSD_VAL

           Runs map sirt3500_val which calls the appropriate map to perform schema validation of a SIC RTGS message.

         Note: The map sirt3500_val internally calls all the other maps identified in the above Flow Description step.
      3. Decision Nodes:
         • pre-valid chk

           This node checks the flow variable stopValidation to decide if further validation/processing is not required.

         • XSD_RESULT_FORMAT

           This node checks the value of the flow variable REPORT_FORMAT to determine if the resulting report for schema-only validation should be generated in XML (default) or JSON.

      4. Log Nodes:
         • FAILURE

           In case of no validation due to precondition check failures, this node creates a log file specified by the flow variable FAILURE_LOG.

      5. Fail Node:
         • STOP

           It generates error message setup in the node in case of no validation performed.

      6. Passthrough Nodes:
         • XSD_XML_CONVERT

           This node receives a schema-only validation report in XML format and does not modify the content, thus passing it as is to the appropriate target node.

      7. Format Converter Nodes:
         • XSD_JSON_CONVERT

           This node receives a schema-only validation report in XML format and converts it to JSON before passing it to the appropriate target node.

      8. Target Nodes:
         • xsd_xml

           This node contains the resulting schema-only validation report in XML format and creates the output as defined by variable OUTPUT_RESULT_XML.

         • xsd_json

           This node contains the resulting schema-only validation report in JSON format and creates the output as defined by variable OUTPUT_RESULT_JSON.

   3. It utilizes the following variables:
      Flow variables:

      • VALIDATION_TYPE

        The default value is schema.

        The value extended is not supported at this time. This variable is currently not being used in any node.

      • REPORT_FORMAT

        The default value is xml.

        It can be changed to json. This is used in Decision node XSD_RESULT_FORMAT.

      • INPUT_FILE

        The default value is ../tools/mxservice/data/sirt_pacs_009.xml.

        This is the data file to be used for validation and can be customized. This is used in Source node mx_input.

      • OUTPUT_RESULT_XML

        The default value is validation_result.xml.

        This is the location of the validation report file in xml format. It is used in Target node xsd_xml. It can be customized.

      • OUTPUT_RESULT_JSON

        The default value is validation_result.json.

        This is the location of the validation report file in json format. It is used in Target node xsd_json. It can be customized.

      • FAILURE_LOG

        The default value is stopMXValidation.json.

        This is the location of the failure log. It is used in Log node FAILURE. It can be customized.

      • bizSvc

        For internal use in the Map node MX pre-check to determine the type of data being read in the input file.

      • stopValidation

        For internal use in the Map node MX pre-check and is checked in Decision node pre-valid chk to cause a Failure log in case a data file was not recognized as a valid SIC message.

3. Open the main flow sic_rtgs_validation_flow in the Design Server. It utilizes above one source node, two map nodes, two decision nodes, one log node, one fail node, one passthrough node, one format converter node and two target nodes
4. In Design Server, create a package that contains the input files and one flow sic_rtgs_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.