Skip to content

Commit

Permalink
ODE-1264 updated README.md with description of `skipSequentialValidat…
Browse files Browse the repository at this point in the history
…ion` conditional flag.
  • Loading branch information
hmusavi committed May 16, 2019
1 parent 8bfdeb9 commit db15284
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,11 @@ definitions:
type: array
items:
type: string
skipSequentialValidation:
description: This boolean property specifies if this sequential or chronological field should take part in sequential validation or not.
set the value of this property to True if you would like to skip sequential validation of this field.
type: boolean
```

The following conditional field validation states that the value of `metadata.payloadType` must be equal `us.dot.its.jpo.ode.model.OdeBsmPayload` if
Expand Down Expand Up @@ -488,6 +493,30 @@ EqualsValue = {"startsWithField": "metadata.recordType"}
- Value: ISO timestamp: `LatestTime = 2018-12-03T00:00:00.000Z`
- Note: For more information on how to write parsable timestamps, see [dateutil.parser.parse()](https://dateutil.readthedocs.io/en/stable/parser.html#dateutil.parser.parse).

The following field validation specifies that sequential validation should NOT be enacted on `metadata.recordGeneratedAt` when the record is generated
by TMC (`"metadata.recordGeneratedBy":"TMC"`).

```
[metadata.recordGeneratedAt]
Type = timestamp
LatestTime = NOW
EqualsValue = {"conditions":[{"ifPart":{"fieldName":"metadata.recordGeneratedBy","fieldValues":["TMC"]},"thenPart":{"skipSequentialValidation":"true"}}]}
```

The following field validation specifies that sequential validation should NOT be enacted on `metadata.serialId.recordId` when the records is from
and `rxMsg` OR the records is _santiized_ (`"metadata.sanitized": "True"`.
fields when

```
[metadata.serialId.recordId]
Type = decimal
UpperLimit = 2147483647
LowerLimit = 0
EqualsValue = {"conditions":[
{"ifPart":{"fieldName":"metadata.recordType","fieldValues":["rxMsg"]},"thenPart":{"skipSequentialValidation":"true"}},
{"ifPart":{"fieldName":"metadata.sanitized","fieldValues":["True"]},"thenPart":{"skipSequentialValidation":"true"}}]}
```

**Files**
- [Default Configuration File](odevalidator/config.ini)
- [Sample Data File](../../../data/bsmTx.json)
Expand Down

0 comments on commit db15284

Please sign in to comment.