diff --git a/README.md b/README.md index 0a3b2ca6..e05c567b 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,19 @@ # FIX Orchestra Resources -This project contains resources and sample code for FIX Orchestra and FIX Repository 2016 Edition. Technical specifications for FIX Orchestra are in project [fix-orchestra-spec](https://github.com/FIXTradingCommunity/fix-orchestra-spec). +This project contains resources and sample code for FIX Orchestra version 1.0. Technical specifications for FIX Orchestra are in project [fix-orchestra-spec](https://github.com/FIXTradingCommunity/fix-orchestra-spec). FIX Orchestra is intended to provide a standard and some reference implementation for *machine readable rules of engagement* between counterparties. The goal is to reduce the time to get counterparties trading, and improve accuracy of implementations. ### News +* Version 1.5 of this project conforms to Orchestra version 1.0 Draft Standard. * The repositoryDiffMerge module was promoted to its own [xml-diff-merge project](https://github.com/FIXTradingCommunity/xml-diff-merge) since it has uses aside from Orchestra. * See new [Orchestra tutorials](https://github.com/FIXTradingCommunity/fix-orchestra/wiki) and FAQ. ### Planned Lifecycle -The planned lifecycle of this project is to roll out new features in a series of release candidates. After each release candidate is approved, it will be exposed to public review. When version 1 is considered complete, the last release candidate will be promoted to Draft Standard. +The planned lifecycle of this project is to roll out new features in a series of release candidates. After each release candidate is approved, it will be exposed to public review. When a version is considered complete, the last release candidate will be promoted to Draft Standard. ### Participation @@ -33,9 +34,15 @@ All FIX standards specifications [FIX Standards](https://www.fixtrading.org/standards/) -## Versions +## Standards Versions -### Current version: Version 1.0 Release Candidate 5 +### Version 1.0 Draft Standard + +Release candidate 5 was promoted to Draft Standard with minor enhancements and corrections on February 20, 2020. A draft standard must have at least two interoperable implementations in order to be promoted to a final Technical Standard. + +Version 1.5 of this project conforms to Orchestra version 1.0 Draft Standard. The XML schemas in the `repository` and `interfaces` modules are considered normative for the Orchestra standard. However, demonstration code in this project may be maintained and enhanced between versions of the standard. + +### Version 1.0 Release Candidate 5 Release Candidate 5 was approved by the Global Technical Committee on Sept. 19, 2019 for 90 day public review. The key enhancements in Release Candidate 5 were: * Security keys for sessions @@ -62,27 +69,26 @@ Release Candidate 2 was approved by the Global Technical Committee on May 18, 20 * Session configuration ### Version 1.0 Release Candidate 1 -Version 1.0 RC1 standardized the XML schema for FIX Orchestra and FIX Repository 2016 Edition. Release Candidate 1 was approved by the Global Technical Committee on Dec. 15, 2016 for 90 day public review. - +Version 1.0 RC1 standardized the XML schema for FIX Orchestra. Release Candidate 1 was approved by the Global Technical Committee on Dec. 15, 2016 for 90 day public review. ## Normative Modules The following modules are **normative**. -### repository2016 -This module contains an XML schema for Orchestra, also known as FIX Repository 2016 Edition. It is used to convey message structures and their components, as well as FIX application behaviors. Users may express workflow as responses to messages under different scenarios, as well as external state information that may influence behaviors. +### repository +This module contains an XML schema for Orchestra. It is used to convey message structures and their components, as well as FIX application behaviors. Users may express workflow as responses to messages under different scenarios, as well as external state information that may influence behaviors. -In addition to providing the XML schema as a resource, the module builds Java bindings for the schema. An XSLT is provided to translate existing Repository 2010 Edition files to the 2016 Edition schema +In addition to providing the XML schema as a resource, the module builds Java bindings for the schema. An XSLT is provided to translate existing Repository 2010 Edition files to the Orchestra schema. -### interfaces2016 +### interfaces -This module provides an XML schema for service offerings, protocols and session provisioning. In addition to providing the XML schema as a resource, the module builds Java bindings for the schema. Service elements may link to Orchestra files composed in the `repository2016` schema. +This module provides an XML schema for service offerings, protocols and session provisioning. In addition to providing the XML schema as a resource, the module builds Java bindings for the schema. Service elements may link to Orchestra files composed in the `repository` schema. ### dsl-antlr - Score Domain Specific Language (DSL) An orchestra file may contain conditional expressions to describe conditionally required fields and tell when a certain response to a message applies. Also, the DSL may be used for assignment expressions to set message fields and external state variables. -The Score grammar is provided in the notation of ANTLR4, and the project builds a lexer/parser for the grammar. +The Score grammar is provided in the notation of ANTLR4, and the project builds a lexer/parser for the grammar. This project generates Java code, but ANTLR4 is capable of generating several other programming languages from the same grammar. ## Informational Modules @@ -113,7 +119,7 @@ Google Protocol Buffers schemas from an Orchestra file. #### repository-quickfix -This module generates a QuickFIX data dictionary from a FIX Repository 2016 or Orchestra file. The format can be consumed by the C++, Java and .NET versions. Additionally, the module generates message classes for QuickFIX/J directly from an Orchestra file. Although the QuickFIX data dictionary format is not as richly featured as Orchestra, it is hoped that this utility will help with Orchestra adoption. In future, message validation will be able to take advantage of conditional expressions in Orchestra. +This module generates a QuickFIX data dictionary from an Orchestra file. The format can be consumed by the C++, Java and .NET versions. Additionally, the module generates message classes for QuickFIX/J directly from an Orchestra file. Although the QuickFIX data dictionary format is not as richly featured as Orchestra, it is hoped that this utility will help with Orchestra adoption. In future, message validation will be able to take advantage of conditional expressions in Orchestra. #### message-model Generic interfaces for message validators and populators not specific to a FIX engine implementation. @@ -122,7 +128,7 @@ Generic interfaces for message validators and populators not specific to a FIX e This module generates code that is conformant to the QuickFIX/J API for validating and populating messages. It is dependent on `repository-quickfix`. #### session-quickfix -A demonstration of session configuration for QuickFIX open-source FIX engine. It consumes an XML file in the `interfaces2016` schema. +A demonstration of session configuration for QuickFIX open-source FIX engine. It consumes an XML file in the `interfaces` schema. A module like this needs to be developed to support each FIX engine that uses a proprietary configuration format. The demonstration provides an example to follow for that work. @@ -132,10 +138,10 @@ A demonstration of state machine code generation from an Orchestra file. ### Data Files Data files in this project under `test/resources` are strictly for testing and to serve as examples for format. They are non-normative for FIX standards and may not be up to date. -See [FIX Standards](https://www.fixtrading.org/standards/) for normative standards documents and [FIX Repository](https://www.fixtrading.org/standards/fix-repository/) for latest Repository extension packs. +See [FIX Standards](https://www.fixtrading.org/standards/) for normative standards documents and [FIX Repository](https://www.fixtrading.org/standards/fix-repository/) for latest Repository extension packs. The plan is to start publishing extension packs in the Orchestra schema in 2020. ## License -© Copyright 2016-2019 FIX Protocol Limited +© Copyright 2016-2020 FIX Protocol Limited Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -154,7 +160,7 @@ limitations under the License. Note that the related Technical Specifications project has a different license than these resources. See [fix-orchestra-spec](https://github.com/FIXTradingCommunity/fix-orchestra-spec/blob/master/LICENSE) ## Prerequisites -This project requires Java 8 or later. It should run on any platform for which the JVM is supported. +This project requires Java 8 or later. It should run on any platform for which the JVM is supported. The plan is update this project to a minimum of Java 11, a long-term support version, soon. ## Build The project is built with Maven version 3.0 or later. diff --git a/docgen/pom.xml b/docgen/pom.xml index 904dd819..c3a0c09c 100644 --- a/docgen/pom.xml +++ b/docgen/pom.xml @@ -4,7 +4,7 @@ io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 docgen Generates humanly readable documentation diff --git a/dsl-antlr/README.md b/dsl-antlr/README.md index 779e0b78..2d151c73 100644 --- a/dsl-antlr/README.md +++ b/dsl-antlr/README.md @@ -19,6 +19,6 @@ The module may be included as a dependency in a Maven project as follows: io.fixprotocol.orchestra dsl-antlr - 1.4.0-RC5 + 1.5.0 ``` diff --git a/dsl-antlr/pom.xml b/dsl-antlr/pom.xml index 64de4e6f..ae869263 100644 --- a/dsl-antlr/pom.xml +++ b/dsl-antlr/pom.xml @@ -4,7 +4,7 @@ parent io.fixprotocol.orchestra - 1.5.0-SNAPSHOT + 1.5.0 4.0.0 dsl-antlr diff --git a/interfaces/README.md b/interfaces/README.md index 8e78e1c1..01b0c654 100644 --- a/interfaces/README.md +++ b/interfaces/README.md @@ -14,6 +14,6 @@ In addition to providing the XML schema as a resource, this module builds Java b io.fixprotocol.orchestra interfaces - 1.4.0-RC5 + 1.5.0 ``` diff --git a/interfaces/pom.xml b/interfaces/pom.xml index fe22a6ba..64a5fe84 100644 --- a/interfaces/pom.xml +++ b/interfaces/pom.xml @@ -4,7 +4,7 @@ io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 interfaces ${project.groupId}:${project.artifactId} diff --git a/interfaces/src/main/resources/xsd/interfaces.xsd b/interfaces/src/main/resources/xsd/interfaces.xsd index a24c75cb..c45cfc52 100644 --- a/interfaces/src/main/resources/xsd/interfaces.xsd +++ b/interfaces/src/main/resources/xsd/interfaces.xsd @@ -1,6 +1,5 @@ - + FIX interface configuration diff --git a/message-model/pom.xml b/message-model/pom.xml index 070c6b25..3b7662e7 100644 --- a/message-model/pom.xml +++ b/message-model/pom.xml @@ -5,7 +5,7 @@ io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 message-model ${project.groupId}:${project.artifactId} diff --git a/model-quickfix/pom.xml b/model-quickfix/pom.xml index f19353b4..d3c29f4c 100644 --- a/model-quickfix/pom.xml +++ b/model-quickfix/pom.xml @@ -5,7 +5,7 @@ io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 model-quickfix Message validation diff --git a/pom.xml b/pom.xml index 4a4c6a34..242ada63 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ 4.0.0 io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 pom ${project.groupId}:${project.artifactId} Parent project for FIX Orchestra diff --git a/repository-quickfix/pom.xml b/repository-quickfix/pom.xml index 311559d8..dffd68c8 100644 --- a/repository-quickfix/pom.xml +++ b/repository-quickfix/pom.xml @@ -3,7 +3,7 @@ io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 repository-quickfix ${project.groupId}:${project.artifactId} diff --git a/repository/README.md b/repository/README.md index 37e3e189..ff1f1126 100644 --- a/repository/README.md +++ b/repository/README.md @@ -21,6 +21,6 @@ The module may be included as a dependency in a Maven project as follows: io.fixprotocol.orchestra repository - 1.4.0-RC5 + 1.5.0 ``` diff --git a/repository/pom.xml b/repository/pom.xml index a0252f09..c08dbe99 100644 --- a/repository/pom.xml +++ b/repository/pom.xml @@ -6,7 +6,7 @@ io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 repository ${project.groupId}:${project.artifactId} diff --git a/repository/src/main/resources/xsd/repository.xsd b/repository/src/main/resources/xsd/repository.xsd index 586c8906..e869f463 100644 --- a/repository/src/main/resources/xsd/repository.xsd +++ b/repository/src/main/resources/xsd/repository.xsd @@ -1,7 +1,5 @@ - + FIX Repository standard structure of messages with workflow diff --git a/repository/src/main/resources/xsd/repositorytypes.xsd b/repository/src/main/resources/xsd/repositorytypes.xsd index a8ecd937..d30b3c80 100644 --- a/repository/src/main/resources/xsd/repositorytypes.xsd +++ b/repository/src/main/resources/xsd/repositorytypes.xsd @@ -1,6 +1,5 @@ - + © Copyright 2016-2020 FIX Protocol Limited Creative diff --git a/repository2010/pom.xml b/repository2010/pom.xml index 277eba15..d1918b28 100644 --- a/repository2010/pom.xml +++ b/repository2010/pom.xml @@ -6,7 +6,7 @@ io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 repository2010 ${project.groupId}:${project.artifactId} diff --git a/session-quickfix/pom.xml b/session-quickfix/pom.xml index c6bf8703..c59862b2 100644 --- a/session-quickfix/pom.xml +++ b/session-quickfix/pom.xml @@ -4,7 +4,7 @@ io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 session-quickfix ${project.groupId}:${project.artifactId} diff --git a/state-machine/README.md b/state-machine/README.md index f411562a..ff02c075 100644 --- a/state-machine/README.md +++ b/state-machine/README.md @@ -25,6 +25,6 @@ The module may be included as a dependency in a Maven project as follows: io.fixprotocol.orchestra state-machine - 1.4.0-RC5 + 1.5.0 ``` \ No newline at end of file diff --git a/state-machine/pom.xml b/state-machine/pom.xml index 63db3b70..5347fce9 100644 --- a/state-machine/pom.xml +++ b/state-machine/pom.xml @@ -5,7 +5,7 @@ io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 state-machine ${project.groupId}:${project.artifactId} diff --git a/testgen/pom.xml b/testgen/pom.xml index 49b4c894..156c2c64 100644 --- a/testgen/pom.xml +++ b/testgen/pom.xml @@ -4,7 +4,7 @@ io.fixprotocol.orchestra parent - 1.5.0-SNAPSHOT + 1.5.0 testgen ${project.groupId}:${project.artifactId}