summaryrefslogtreecommitdiffstats
path: root/src/site-docs/adoc/fragments/howto-apex/app-model-2-cli.adoc
blob: 973564df3543ed7f8a5939e76772020c19cd8d69 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
//
// ============LICENSE_START=======================================================
//  Copyright (C) 2016-2018 Ericsson. All rights reserved.
// ================================================================================
// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
// 
// SPDX-License-Identifier: CC-BY-4.0
// ============LICENSE_END=========================================================
//
// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
//

== Application: Convert a Policy Model to CLI Editor Commands

**Status: Experimental**

This application takes a policy model (JSON or XML encoded) and generates commands for the APEX CLI Editor.
This effectively reverses a policy specification realized with the CLI Editor.

[width="100%",options="header",cols="5a,5a"]
|====================
| Unix, Cygwin | Windows
|
[source%nowrap,sh]
----
# $APEX_HOME/bin/apexApps.sh model-2-cli [args]
----
|
[source%nowrap,bat]
----
> %APEX_HOME%\bin\apexApps.bat model-2-cli [args]
----
|====================

The option `-h` provides a help screen.

[source%nowrap,sh]
----
usage: gen-model2cli
 -h,--help                 prints this help and usage screen
 -m,--model <MODEL-FILE>   set the input policy model file
 -sv,--skip-validation     switch of validation of the input file
 -v,--version              prints the application version
----

For instance, running the tool with the __Sample Domain__ policy model as:
[source%nowrap,sh]
----
apexApps.sh tpl-event-json -m $APEX_HOME/examples/models/SampleDomain/SamplePolicyModelJAVA.json -t stimuli
----

will produce the following status messages:

[source%nowrap,sh]
----
gen-model2cli: starting CLI generator
 --> model file: examples/models/SampleDomain/SamplePolicyModelJAVA.json
----

and then run the generator application producing all CLI Editor commands and printing them to standard out.