Skip to content

Commit c82b0d2

Browse files
authored
Update README.md
1 parent 23d159b commit c82b0d2

File tree

1 file changed

+44
-9
lines changed

1 file changed

+44
-9
lines changed

README.md

Lines changed: 44 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,50 @@
11
# IDP DV
2-
Class data verifier. Utility validates Caché classes properties data according to the properties' types.
2+
Class data verifier. Utility validates IRIS classes properties data according to the properties' types.
33

4+
## Instalation
45

5-
### Use Import classes and call one of the entry points:
6+
To install IDP.DV, you just need to dowload and import the package [IDP.DV](https://github.com/intersystems-ru/CDV/releases) file.
7+
Some ways to import IDP package:
8+
- Go to Management Portal -> System Explorer -> Classes -> Import and select the XML file.
9+
- Drag the file over Studio
10+
- Terminal command:
11+
12+
```
13+
Do $system.OBJ.Load("yourpath/IDP.DV.xml","ck")
14+
```
15+
16+
### Docker ###
17+
18+
To install using Docker. Follow this instructions:
19+
20+
Open terminal and clone the repo into any local directory
21+
22+
```
23+
$ git https://github.com/intersystems-ru/CDV.git
24+
```
25+
26+
Open the terminal in this directory and run:
27+
28+
```
29+
$ docker-compose build
30+
```
31+
32+
Run the IRIS container with your project:
33+
```
34+
$ docker-compose up -d
35+
```
36+
37+
### How to Run the Application
38+
Open InterSystems IRIS terminal:
39+
40+
```
41+
$ docker-compose exec iris iris session iris
42+
USER>zn "IRISAPP"
43+
IRISAPP>set st = ##class(IDP.DV).ScanAllClasses(.Oid)
44+
IRISAPP>zw Oid
45+
```
46+
47+
## Usage
648

749
s st = ##class(IDP.DV).ScanAllClasses(.Oid) - for all user classes
850
s st = ##class(IDP.DV).ScanSubclassesOf(Class, .Oid) - for subclasses
@@ -16,12 +58,5 @@ Arguments:
1658
- `Class` - Scan all subclasses Of a class (and class itself).
1759
- `Mask` - Passed into the SQL query `SELECT ID FROM %Dictionary.ClassDefinition Where ID LIKE ?`
1860

19-
### Example
20-
21-
1. Import IDP.DV into desired namespace
22-
2. Run in terminal:
23-
24-
s st = ##class(IDP.DV).ScanAllClasses(.Oid)
25-
zw Oid
2661

2762

0 commit comments

Comments
 (0)