You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: customising-quickfixj.md
+26-22Lines changed: 26 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,11 +11,11 @@ The standard distribution of ```quickfixj-core``` can be used with custom artefa
11
11
12
12
To build custom artefacts it's helpful to understand how QuickFIX/J builds the Field, Component and Message classes from the QuickFIX/J dictionaries and from [FIX Orchestra](https://www.fixtrading.org/standards/fix-orchestra/).
13
13
14
-
QuickFIX/J reference implementations for FIX versions FIX4.0 to FIX5.0sp2 and for FIXT1.1 are generated from the QuickFIX dictionaries for the specific version. The dictionaries are located in the ```src/main/resources``` directory of the respective modules of the ```quickfixj-messages``` module.
15
-
This intentionally provides consistency with the prior QuickFIX/J 2 release to ease migration to QuickFIX/J 3.
14
+
The QuickFIX/J reference implementations for FIX versions FIX4.0 to FIX5.0sp2 and for FIXT1.1 are generated from the QuickFIX dictionaries for the specific version. The dictionaries are located in the ```src/main/resources``` directory of the respective modules of the ```quickfixj-messages``` module.
15
+
Maintaining the FIX4.0 to FIX5.0sp2 builds intentionally provides consistency with the prior QuickFIX/J 2 release in order to ease migration to QuickFIX/J 3.
16
16
17
-
The QuickFIX/J reference implementation for FIX Latest is generated from a [FIX Orchestra](https://www.fixtrading.org/standards/fix-orchestra/) repository file.
18
-
An implementation derived from the standard FIX Orchestra repository is known as an "_orchestration_".
17
+
The most recent standard is defined as [FIX Latest](https://www.fixtrading.org/online-specification/). The QuickFIX/J reference implementation for FIX Latest is generated from a [FIX Orchestra](https://www.fixtrading.org/standards/fix-orchestra/) repository file.
18
+
An implementation or customisation of the FIX Standars derived from the FIX Orchestra repository is known as an "_orchestration_".
19
19
The standard FIX Orchestra repository requires some modification to work well with QuickFIX/J.
20
20
This is done by the ```quickfixj-orchestration``` module.
21
21
The ```quickfixj-orchestration``` module publishes a modified Orchestra artefact which can then be the basis of a custom FIX Latest build using QuickFIX/J .
@@ -28,7 +28,7 @@ Please see [QuickFIX/J Orchestration](./quickfixj-orchestration/readme.md) for d
28
28
29
29
### **Enable the use of ```BigDecimal``` for FIX Decimal Data Types**
30
30
31
-
This behaviour is controlled by the ```${generator.decimal}``` build property. It is "false" by default to avoid surprising side effects of Incompatible Data Types.
31
+
This behaviour is controlled by the ```${generator.decimal}``` build property. It is "false" by default to avoid surprising side effects of incompatible data types.
32
32
33
33
To enable the use of ```BigDecimal``` in code generation, set the ```${generator.decimal}``` property to "true" in [quickfixj-messages](./quickfixj-messages/readme.md) and build the message artefacts.
34
34
@@ -55,7 +55,26 @@ Code generation using ```BigDecimal``` is incompatible at runtime with ```int```
55
55
Runtime incompatibilities can be resolved by:
56
56
* Amending the QuickFIX Dictionary to coerce the code generation and/or validation
57
57
* Changing the ordering of code generation and/or overwrite behaviour of code generation
58
-
* Building independent artefacts for conflicting versions and not using them in the same runtime
58
+
* Omitting incompatible versions from your customised build
59
+
* Building artefacts independently for the conflicting versions and ensuring they are not used them in the same runtime
60
+
61
+
See [QuickFIX/J Messages](./quickfixj-messages/readme.md) for details of the build and recommendation for **how to implement custom builds.**
62
+
63
+
### **Customising the FIX Protocol for specialised Rules of Engagement**
64
+
65
+
A Rules of Engagement can include customisation Messages, Components and Fields, including User Defined elements.
66
+
67
+
It is not necessary to maintain a fork of the entire QuickFIX/J project to provide customised QuickFIX Dictionaries and to
68
+
generate type-safe libraries that are interoperable with QuickFIX/J.
69
+
70
+
[FIX Orchestra](https://www.fixtrading.org/standards/fix-orchestra/) is intended for customisation to produce machine-readable Rules of Engagement.
71
+
72
+
Consider creating a new project (or projects) to build the Messages, Components and Fields as needed for your specific Rules of Engagement.
73
+
74
+
Edit the QuickFIX Dictionary or FIX Orchestra Repository (Orchestration) as required and
75
+
build the Messages, Components and Fields packages using the tools provided by the QuickFIX/J projects.
76
+
77
+
QuickFIX/J Dictionaries, FIX Orchestra Orchestrations and/or documents can also be generated.
59
78
60
79
See [QuickFIX/J Messages](./quickfixj-messages/readme.md) for details of the build and recommendation for **how to implement custom builds.**
61
80
@@ -70,21 +89,6 @@ The following describes how to use ```quickfixj-core``` from QuickFIX/J 3 witho
70
89
* build the required Message artefacts without the FIX Latest code generation. The Fields will then be generated only from legacy FIX Protocol Versions as they were prior to QuickFIX/J 3.0.0 - **or**
71
90
* if you want to use Messages, Components and/or Fields from FIX Latest while preferring legacy constants,
72
91
manipulate the order of code generation and/or the over-write behaviour of code behaviour to prefer earlier versions of FIX.
73
-
* For example, prevent FIX Latest code generation from over-writing existing generated sources (Fields).
74
-
75
-
See [QuickFIX/J Messages](./quickfixj-messages/readme.md) for details of the build and recommendation for **how to implement custom builds.**
76
-
77
-
### **Customising the FIX Protocol for specialised Rules of Engagement**
78
-
79
-
A Rules of Engagement can include customisation Messages, Components and Fields, including User Defined elements.
80
-
81
-
This can be accomplished by creating a new project to build the Messages, Components and Fields as needed for your specific Rules of Engagement.
82
-
Edit the QuickFIX Dictionary or FIX Orchestra Repository (Orchestration) as required and
83
-
build the Messages, Components and Fields packages using the tools provided by the QuickFIX/J projects.
84
-
It is not necessary to maintain a fork of the entire QuickFIX/J project to provide customised QuickFIX Dictionaries and to
85
-
generate type-safe libraries that are interoperable with QuickFIX/J.
86
-
QuickFIX/J Dictionaries, FIX Orchestra Orchestrations and/or documents can also be generated.
87
-
88
-
[FIX Orchestra](https://www.fixtrading.org/standards/fix-orchestra/) is intended for customisation to produce machine-readable Rules of Engagement.
92
+
For example, generate FIX Latest first and overwrite the generated Field classes by subsequently running code generation for an earlier version.
89
93
90
94
See [QuickFIX/J Messages](./quickfixj-messages/readme.md) for details of the build and recommendation for **how to implement custom builds.**
Copy file name to clipboardExpand all lines: quickfixj-core/readme.md
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,12 @@
2
2
3
3
This module builds the QuickFIX/J FIX "engine" including supporting capabilities.
4
4
5
-
The core engine depends on ```quickfixj-base``` and does not have compile time dependency on the Field, Component and Messages classes derived from base classes in ```quickfixj-base```. A small number of derived Fields are provided by ```quickfixj-base``.
5
+
The core engine depends on ```quickfixj-base```. A small number of derived Fields are provided by ```quickfixj-base``.
6
6
7
-
This module does have <u>**test**</u> dependency on generated message classes. The distinction of <u>*test*</u> dependency is significant as it allows easier [customisation](../customising-quickfixj.md) of QuickFIX/J deployments.
7
+
This module has <u>**test**</u> dependency on generated message classes. The distinction of <u>*test*</u> dependency is significant as it allows easier [customisation](../customising-quickfixj.md) of QuickFIX/J deployments.
8
8
9
9
## Developing quickfixj-core
10
10
11
11
To develop this module build ```quickfixj-base``` and ```quickfixj-messages``` first, or build the whole project.
12
12
13
13
Full ```quickfixj-messages``` build times can be long. See [the ```quickfixj-messages``` readme](../quickfixj-messages/readme.md) for how to do a minimal development build of the messages. Once these dependencies are built then ```quickfixj-core``` can be built and tested independently for higher productivity.
14
-
15
-
If and when you import the project into an IDE it can be better to exclude or close the ```quickfixj-messages``` module(s) to reduce the memory and computation overheads of importing these large packages.
0 commit comments