Skip to content

Commit 987d875

Browse files
author
Rob Tjalma
authored
Merge pull request #39 from com-pas/update-readme
Updated README.md with information about OCL Files
2 parents 0fdfb1d + 956467a commit 987d875

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,32 @@ described in the URL above that the URL can be overwritten locally with an HTTPS
3030
Check the [Development](DEVELOPMENT.md) page for more detail information how to work with this repository, because of
3131
the mixture with RiseClipse.
3232

33+
## Custom OCL Files
34+
35+
There is a way to add custom OCL Files to the validator, for instance to force company specific rules. In the Docker
36+
Image there is a volume `/data/ocl` which can be used to add these files, see our compas-deployment project for an
37+
example how to.
38+
39+
In this directory, you can use subdirectories like `SemanticConstraints` as RiseClipse is doing. And there is a special
40+
filter that when you create a directory `FileSpecifics`. In this directory you can create for instance a directory `CID`
41+
to put constraints specific for an SCL File Type. Known types are `SSD`, `IID`, `ICD`, `SCD`, `CID`, `SED`, `ISD`,
42+
`STD`.
43+
44+
For instance,
45+
46+
```
47+
data
48+
└── ocl
49+
├── FileSpecifics
50+
│ └── CID
51+
│ └── Busbar.ocl
52+
└── SemanticConstraints
53+
└── Busbar.ocl
54+
```
55+
56+
If you are using the validator are library (using JAR Files) there is a property to configure the directory, see
57+
[Common Environment variables](#common-environment-variables)
58+
3359
## Common Environment variables
3460

3561
Below environment variable(s) can be used to configure the validator.

0 commit comments

Comments
 (0)