Trade Reconstruction
Trade Reconstruction is used to automatically link trade and orders from Order Management Systems (OMS) or Trade Capture systems to their related communications.
- Overview
- Creating A Trade Reconstruction Configuration
- Integration with Order Management Systems (OMS) or Trade Capture Systems
- Trade Reconstruction Limitations
Overview
Each Trade object has a connected Trade Reconstruction Configuration, which is used to add the criteria necessary to connect Trades to their related Communications. Trade Reconstruction Configurations have two components: the Search Criteria field, which defines the parameters of the saved search created for the Trade, and the Trade Keywords Field, which defines the Trade Keywords created for the Trade. Below is information on how to create a Trade Reconstruction Configuration, details on the Search Criteria field for Trade Reconstruction Configurations, details about Trade Keywords, and the limitations of Trade Reconstruction.
Creating A Trade Reconstruction Configuration
The Trade Reconstruction Configuration attached to your Trade is a key component to Trade Reconstruction, as it determines how Trades will be connected to their related communications. This must be created before you can create your Trade. To create a Trade Reconstruction Configuration, follow the steps below:
-
Navigate to the
Trade Reconstruction Configurations
tab and clickNew Trade Reconstruction Configuration
. -
The Trade Reconstruction Configuration creation form has the following fields:
-
Name: the name of the Trade Reconstruction Configuration
- Search Criteria: required JSON field to create the search parameters for the Saved Search created and linked to the Trade during Reconstruction. The details of the proper search criteria can be accessed via Contextual Help button on the Configuration secontion.
- See the below section titled
Search Criteria for Trade Reconstruction Configuration
for more information
- See the below section titled
-
Trade Keywords Field: optional field, allows you to choose fields on the Trade object which will be used to create
Trade Keywords
that are linked to the TradeYou can choose Trade fields of any field type. If you choose a Yes/No field, the
Yes Display Value
orNo Display Value
for that field will be used to create theTrade Keyword
.
-
Search Criteria for Trade Reconstruction Configuration
Trade Reconstruction Configuration Search Criteria field is inputted as JSON with each {}
representing a single logic group within a Saved Search. Each logic group should contain a list of conditions and boolean operator AND|OR
which joins it with the next logic group.
Parameters of logic group:
SearchConditions
- [Required] a list of search conditions which will be included in the logic groupBooleanOperator
- [Required] a boolean operator which joins specified logic group with the next logic groupAND/OR
Parameters of search condition:
DocumentFieldName
- [Required] name of the target document field you wish to search acrossObjectFieldName
- name of the Trade field used to populate theDocumentFieldName
when searchingOptional
- when set totrue
, it makes this search condition optional, meaning that if theObjectFieldName
field doesn’t have a value, it will skip over this search condition in the created Saved Search and continue to make a Rule for that particular object. If this value is not set (defaults tofalse
) or set tofalse
, this search condition is not optional, and if theObjectFieldName
field doesn’t have a value, it will fail to create a Rule for that particular Object (true
,false
)Value
- value used to populateDocumentFieldName
when searching (eitherObjectFieldName
orValue
should be provided, not both). IfDocumentFieldName
is multiple/single object/choice type field, then static value should be object/choice nameCondition
- [Required] the logical condition between theDocumentFieldName
andObjectFieldName
(see conditions below)
Field Type | Conditions |
---|---|
Date | Between , Is ,IsAfter , IsAfterOrOn , IsBefore , IsBeforeOrOn , IsSet |
Multiple Object | AllOfThese , AnyOfThese , IsSet |
Multiple Choice | AllOfThese , AnyOfThese , IsSet |
Single Object | AnyOfThese , IsSet |
Single Choice | AnyOfThese , IsSet |
Whole Number | GreaterThan , LessThan , Is , IsSet |
Decimal | GreaterThan , LessThan , Is , IsSet |
Currency | GreaterThan , LessThan , Is , IsSet |
Fixed Length | GreaterThan , GreaterThanOrEqualTo , Is , IsLike , IsSet , LessThan , LessThanOrEqualTo , StartsWith , EndsWith |
Long Text | GreaterThan , GreaterThanOrEqualTo , Is , IsLike , IsSet , LessThan , LessThanOrEqualTo , StartsWith , EndsWith |
Yes/No | Is , IsSet |
We do not use the time on Date fields when creating a condition using the Between
operator. For all Date fields (whether you provide a time or not), we create the condition to include the full day on both ends of the condition. For example, if you want a condition that finds communications with the Sent Date/Time
between 10/1 8AM and 10/2 10AM, we will create a condition that is Send Date/Time
> 10/1 at midnight and Sent Date/Time
< 10/2 at the end of the day.
NotOperator
- specifies if condition should be negative (defaultsfalse
if not added)DayRange
- specifies a number of days which will be added or subtracted from ObjectField date specified in condition (this works only for DATE fields whenBETWEEN
condition in specified, but it won’t break when added to other conditions)DayRangeDirection
- connected with theDayRange
parameter and specifies if the days should be added, subtracted, or added and subtracted from ObjectField date. Values for this parameter:ForwardAndBackwards
,Backwards
,Forward
, the default value isForwardAndBackwards
BooleanOperator
- the operator which joins the specified condition with the next condition (AND/OR
)
Search Criteria Validation Rules:
- Search criteria must contain at least one logic group
- Each logic group must include a
SearchConditions
list (with at least one condition in it) and aBooleanOperator
DocumentFieldName
,ObjectFieldName
orValue
,Condition
andBooleanOperator
are mandatory fields in a search conditionDocumentFieldName
field must be a field which exists on Document or a reflected field, e.g. Trace Monitored Individuals::First NameObjectFieldName
field must be a field which exists on the Trade ObjectDocumentFieldName
andObjectFieldName
fields must have the same field type, with one exception:
DocumentFieldName
fields with the field type single choice, multiple choice, single object, or multiple object can be mapped toObjectFieldName
fields with the fixed-length text field type- if
DocumentFieldName
andObjectFieldName
fields are single/multiple object fields, then both fields must be associated with the same object type- Saved Searches created by Trade Reconstruction MUST have at least one condition, so if the
Optional
flag results in no search conditions being added, it will not create the Saved Search for that object, thus Trade Reconstruction will failValue
value must be convertible toDocumentFieldName
field type, i.e. ifDocumentFieldName
is date field, then valid values are15 Apr 2021
or04/15/2021
- if
DocumentFieldName
is multiple/single object/choice field type, thenValue
should be a name of object/choice we want to searchCondition
must be valid for field type
Example Search Criteria:
[
{
"SearchConditions":[
{
"DocumentFieldName":"Trace Monitored Individuals",
"ObjectFieldName":"Trade Monitored Individuals",
"Condition":"AnyOfThese",
"BooleanOperator":"Or",
},
{
"DocumentFieldName":"Trace Monitored Individuals",
"ObjectFieldName":"Trade Related Individuals",
"Condition":"AnyOfThese",
"BooleanOperator":"And",
"NotOperator":true,
}
],
"BooleanOperator":"And"
},
{
"SearchConditions":[
{
"DocumentFieldName":"Trace Document Status Updated On",
"ObjectFieldName":"System Created On",
"Condition":"Between",
"BooleanOperator":"And",
"DayRange":14,
"DayRangeDirection":"Backwards",
"BooleanOperator":"Or"
},
{
"DocumentFieldName":"Trace Document Status Updated On",
"Value":"1 Jan 2021",
"Condition":"Is",
"BooleanOperator":"And",
}
],
"BooleanOperator":"And"
}
]
Trade Keywords
The Trade Keywords Field
field on the Trade Reconstruction Configuration
holds the names of the field on Trade which hold critical keywords that will be searched in the created saved search.
For example, there is a field on Trade called Important Names
which is a Multiple Choice field. On a particular Trade, the names John Smith
and Jane Doe
are selected as choices on Important Names
that are important for this Trade. To search for these names, you will select Important Names
in the Trade Keywords Field
on the Trade Reconstruction Configuration
attached to the Trade. During Reconstruction, John Smith
and Jane Doe
will be created as Trade Keywords, which can be found on the Trade Keywords
tab and will be attached to that Trade. If another Trade shares the same keyword, they will both be attached to that single keyword.
Integration with Order Management Systems (OMS) or Trade Capture Systems
Please contact support@relativity.com for more information on Trade system integrations.
Trade Reconstruction Limitations
You must create a Trade Reconstruction Configuration before you can create a Trade.
If you decide to Reconstruct a Trade which has already been Reconstructed in the past, everything is removed from the previous Reconstruction and replaced with the new information from the most recent Reconstruction. Trade Keywords
are not deleted, but the connection between the Trade Keyword
and the Trade is gone and will not be searched for (unless the same keyword is still on the Trade, in which it will re-establish the connection and search for this keyword). All of the Trade’s Related Documents from the previous Reconstruction will be removed. However, an Audit will be created for each Reconstruction with the following information: the Artifact ID of the Reconstructed Trade, the User that kicked off the Reconstruction, the date and time the Reconstruction began, and the Artifact ID of every Related Document that was connected to the Trade.
You must run each Trade indiviudally - mass editing Perform Reconstruction
field on the Trade will not start Trade Reconstruction.