Code Review / policy / parent.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Update APEX documentation with the usage of eventName
[policy/parent.git] / docs / apex / APEX-User-Manual.rst
diff --git a/docs/apex/APEX-User-Manual.rst b/docs/apex/APEX-User-Manual.rst
index b10dcf8..d32b1de 100644 (file)
--- a/docs/apex/APEX-User-Manual.rst
+++ b/docs/apex/APEX-User-Manual.rst
@@ -223,67 +223,67 @@ Build APEX
    installation. The following example show how to change to the target
    directory and how it should look like.
 
    installation. The following example show how to change to the target
    directory and how it should look like.
 
-+----------------------------------------------------------------------------------------------------------------------------+
-| Unix, Cygwin                                                                                                               |
-+============================================================================================================================+
-| .. container::                                                                                                             |
-|                                                                                                                            |
-|    .. container:: listingblock                                                                                             |
-|                                                                                                                            |
-|       .. container:: content                                                                                               |
-|                                                                                                                            |
-|          .. code::                                                                                                         |
-|             :number-lines:                                                                                                 |
-|                                                                                                                            |
-|             -rwxrwx---+ 1 esvevan Domain Users       772 Sep  3 11:55 apex-pdp-package-full_2.0.0~SNAPSHOT_all.changes*    |
-|             -rwxrwx---+ 1 esvevan Domain Users 146328082 Sep  3 11:55 apex-pdp-package-full-2.0.0-SNAPSHOT.deb*            |
-|             -rwxrwx---+ 1 esvevan Domain Users     15633 Sep  3 11:54 apex-pdp-package-full-2.0.0-SNAPSHOT.jar*            |
-|             -rwxrwx---+ 1 esvevan Domain Users 146296819 Sep  3 11:55 apex-pdp-package-full-2.0.0-SNAPSHOT-tarball.tar.gz* |
-|             drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 archive-tmp/                                         |
-|             -rwxrwx---+ 1 esvevan Domain Users        89 Sep  3 11:54 checkstyle-cachefile*                                |
-|             -rwxrwx---+ 1 esvevan Domain Users     10621 Sep  3 11:54 checkstyle-checker.xml*                              |
-|             -rwxrwx---+ 1 esvevan Domain Users       584 Sep  3 11:54 checkstyle-header.txt*                               |
-|             -rwxrwx---+ 1 esvevan Domain Users        86 Sep  3 11:54 checkstyle-result.xml*                               |
-|             drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 classes/                                             |
-|             drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 dependency-maven-plugin-markers/                     |
-|             drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 etc/                                                 |
-|             drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 examples/                                            |
-|             drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:55 install_hierarchy/                                   |
-|             drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 maven-archiver/                                      |
-+----------------------------------------------------------------------------------------------------------------------------+
-
-+--------------------------------------------------------------------------------------------------------+
-| Windows                                                                                                |
-+========================================================================================================+
-| .. container::                                                                                         |
-|                                                                                                        |
-|    .. container:: listingblock                                                                         |
-|                                                                                                        |
-|       .. container:: content                                                                           |
-|                                                                                                        |
-|          .. code::                                                                                     |
-|             :number-lines:                                                                             |
-|                                                                                                        |
-|                03/09/2018  11:55    <DIR>          .                                                   |
-|                03/09/2018  11:55    <DIR>          ..                                                  |
-|                03/09/2018  11:55       146,296,819 apex-pdp-package-full-2.0.0-SNAPSHOT-tarball.tar.gz |
-|                03/09/2018  11:55       146,328,082 apex-pdp-package-full-2.0.0-SNAPSHOT.deb            |
-|                03/09/2018  11:54            15,633 apex-pdp-package-full-2.0.0-SNAPSHOT.jar            |
-|                03/09/2018  11:55               772 apex-pdp-package-full_2.0.0~SNAPSHOT_all.changes    |
-|                03/09/2018  11:54    <DIR>          archive-tmp                                         |
-|                03/09/2018  11:54                89 checkstyle-cachefile                                |
-|                03/09/2018  11:54            10,621 checkstyle-checker.xml                              |
-|                03/09/2018  11:54               584 checkstyle-header.txt                               |
-|                03/09/2018  11:54                86 checkstyle-result.xml                               |
-|                03/09/2018  11:54    <DIR>          classes                                             |
-|                03/09/2018  11:54    <DIR>          dependency-maven-plugin-markers                     |
-|                03/09/2018  11:54    <DIR>          etc                                                 |
-|                03/09/2018  11:54    <DIR>          examples                                            |
-|                03/09/2018  11:55    <DIR>          install_hierarchy                                   |
-|                03/09/2018  11:54    <DIR>          maven-archiver                                      |
-|                               8 File(s)    292,652,686 bytes                                           |
-|                               9 Dir(s)  14,138,720,256 bytes free                                      |
-+--------------------------------------------------------------------------------------------------------+
++----------------------------------------------------------------------------------------------------------------+
+| Unix, Cygwin                                                                                                   |
++================================================================================================================+
+| .. container::                                                                                                 |
+|                                                                                                                |
+| .. container:: listingblock                                                                                    |
+|                                                                                                                |
+| .. container:: content                                                                                         |
+|                                                                                                                |
+| .. code::                                                                                                      |
+| :number-lines:                                                                                                 |
+|                                                                                                                |
+| -rwxrwx---+ 1 esvevan Domain Users       772 Sep  3 11:55 apex-pdp-package-full_2.0.0~SNAPSHOT_all.changes*    |
+| -rwxrwx---+ 1 esvevan Domain Users 146328082 Sep  3 11:55 apex-pdp-package-full-2.0.0-SNAPSHOT.deb*            |
+| -rwxrwx---+ 1 esvevan Domain Users     15633 Sep  3 11:54 apex-pdp-package-full-2.0.0-SNAPSHOT.jar*            |
+| -rwxrwx---+ 1 esvevan Domain Users 146296819 Sep  3 11:55 apex-pdp-package-full-2.0.0-SNAPSHOT-tarball.tar.gz* |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 archive-tmp/                                         |
+| -rwxrwx---+ 1 esvevan Domain Users        89 Sep  3 11:54 checkstyle-cachefile*                                |
+| -rwxrwx---+ 1 esvevan Domain Users     10621 Sep  3 11:54 checkstyle-checker.xml*                              |
+| -rwxrwx---+ 1 esvevan Domain Users       584 Sep  3 11:54 checkstyle-header.txt*                               |
+| -rwxrwx---+ 1 esvevan Domain Users        86 Sep  3 11:54 checkstyle-result.xml*                               |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 classes/                                             |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 dependency-maven-plugin-markers/                     |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 etc/                                                 |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 examples/                                            |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:55 install_hierarchy/                                   |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 maven-archiver/                                      |
++----------------------------------------------------------------------------------------------------------------+
+
++-----------------------------------------------------------------------------------------+
+| Windows                                                                                 |
++=========================================================================================+
+| .. container::                                                                          |
+|                                                                                         |
+| .. container:: listingblock                                                             |
+|                                                                                         |
+| .. container:: content                                                                  |
+|                                                                                         |
+| .. code::                                                                               |
+| :number-lines:                                                                          |
+|                                                                                         |
+| 03/09/2018  11:55    <DIR>          .                                                   |
+| 03/09/2018  11:55    <DIR>          ..                                                  |
+| 03/09/2018  11:55       146,296,819 apex-pdp-package-full-2.0.0-SNAPSHOT-tarball.tar.gz |
+| 03/09/2018  11:55       146,328,082 apex-pdp-package-full-2.0.0-SNAPSHOT.deb            |
+| 03/09/2018  11:54            15,633 apex-pdp-package-full-2.0.0-SNAPSHOT.jar            |
+| 03/09/2018  11:55               772 apex-pdp-package-full_2.0.0~SNAPSHOT_all.changes    |
+| 03/09/2018  11:54    <DIR>          archive-tmp                                         |
+| 03/09/2018  11:54                89 checkstyle-cachefile                                |
+| 03/09/2018  11:54            10,621 checkstyle-checker.xml                              |
+| 03/09/2018  11:54               584 checkstyle-header.txt                               |
+| 03/09/2018  11:54                86 checkstyle-result.xml                               |
+| 03/09/2018  11:54    <DIR>          classes                                             |
+| 03/09/2018  11:54    <DIR>          dependency-maven-plugin-markers                     |
+| 03/09/2018  11:54    <DIR>          etc                                                 |
+| 03/09/2018  11:54    <DIR>          examples                                            |
+| 03/09/2018  11:55    <DIR>          install_hierarchy                                   |
+| 03/09/2018  11:54    <DIR>          maven-archiver                                      |
+| 8 File(s)    292,652,686 bytes                                                          |
+| 9 Dir(s)  14,138,720,256 bytes free                                                     |
++-----------------------------------------------------------------------------------------+
 
 Install APEX
 ------------
 
 Install APEX
 ------------
@@ -324,33 +324,33 @@ Install with DPKG
          the standard APEX start scripts to run APEX with this user’s
          permissions.
 
          the standard APEX start scripts to run APEX with this user’s
          permissions.
 
-+--------------------------------------------------------------------------------------+
-| DPKG Installation                                                                    |
-+======================================================================================+
-| .. container::                                                                       |
-|                                                                                      |
-|    .. container:: listingblock                                                       |
-|                                                                                      |
-|       .. container:: content                                                         |
-|                                                                                      |
-|          .. code::                                                                   |
-|             :number-lines:                                                           |
-|                                                                                      |
-|             # sudo dpkg -i apex-pdp-package-full-2.0.0-SNAPSHOT.deb                  |
-|             Selecting previously unselected package apex-uservice.                   |
-|             (Reading database ... 288458 files and directories currently installed.) |
-|             Preparing to unpack apex-pdp-package-full-2.0.0-SNAPSHOT.deb ...         |
-|             ********************preinst*******************                           |
-|             arguments install                                                        |
-|             **********************************************                           |
-|             creating group apexuser . . .                                            |
-|             creating user apexuser . . .                                             |
-|             Unpacking apex-uservice (2.0.0-SNAPSHOT) ...                             |
-|             Setting up apex-uservice (2.0.0-SNAPSHOT) ...                            |
-|             ********************postinst****************                             |
-|             arguments configure                                                      |
-|             ***********************************************                          |
-+--------------------------------------------------------------------------------------+
++--------------------------------------------------------------------------+
+| DPKG Installation                                                        |
++==========================================================================+
+| .. container::                                                           |
+|                                                                          |
+| .. container:: listingblock                                              |
+|                                                                          |
+| .. container:: content                                                   |
+|                                                                          |
+| .. code::                                                                |
+| :number-lines:                                                           |
+|                                                                          |
+| # sudo dpkg -i apex-pdp-package-full-2.0.0-SNAPSHOT.deb                  |
+| Selecting previously unselected package apex-uservice.                   |
+| (Reading database ... 288458 files and directories currently installed.) |
+| Preparing to unpack apex-pdp-package-full-2.0.0-SNAPSHOT.deb ...         |
+| ********************preinst*******************                           |
+| arguments install                                                        |
+| **********************************************                           |
+| creating group apexuser . . .                                            |
+| creating user apexuser . . .                                             |
+| Unpacking apex-uservice (2.0.0-SNAPSHOT) ...                             |
+| Setting up apex-uservice (2.0.0-SNAPSHOT) ...                            |
+| ********************postinst****************                             |
+| arguments configure                                                      |
+| ***********************************************                          |
++--------------------------------------------------------------------------+
 
 .. container:: paragraph
 
 
 .. container:: paragraph
 
@@ -538,67 +538,67 @@ Build and Install Manually (Unix, Windows, Cygwin)
    installation. The following example show how to change to the target
    directory and how it should look like.
 
    installation. The following example show how to change to the target
    directory and how it should look like.
 
-+-----------------------------------------------------------------------------------------------------------------------------+
-| Unix, Cygwin                                                                                                                |
-+=============================================================================================================================+
-| .. container::                                                                                                              |
-|                                                                                                                             |
-|    .. container:: listingblock                                                                                              |
-|                                                                                                                             |
-|          .. code::                                                                                                          |
-|            :number-lines:                                                                                                   |
-|                                                                                                                             |
-|            # cd packages/apex-pdp-package-full/target                                                                       |
-|            # ls -l                                                                                                          |
-|            -rwxrwx---+ 1 esvevan Domain Users       772 Sep  3 11:55 apex-pdp-package-full_2.0.0~SNAPSHOT_all.changes*      |
-|            -rwxrwx---+ 1 esvevan Domain Users 146328082 Sep  3 11:55 apex-pdp-package-full-2.0.0-SNAPSHOT.deb*              |
-|            -rwxrwx---+ 1 esvevan Domain Users     15633 Sep  3 11:54 apex-pdp-package-full-2.0.0-SNAPSHOT.jar*              |
-|            -rwxrwx---+ 1 esvevan Domain Users 146296819 Sep  3 11:55 apex-pdp-package-full-2.0.0-SNAPSHOT-tarball.tar.gz*   |
-|            drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 archive-tmp/                                           |
-|            -rwxrwx---+ 1 esvevan Domain Users        89 Sep  3 11:54 checkstyle-cachefile*                                  |
-|            -rwxrwx---+ 1 esvevan Domain Users     10621 Sep  3 11:54 checkstyle-checker.xml*                                |
-|            -rwxrwx---+ 1 esvevan Domain Users       584 Sep  3 11:54 checkstyle-header.txt*                                 |
-|            -rwxrwx---+ 1 esvevan Domain Users        86 Sep  3 11:54 checkstyle-result.xml*                                 |
-|            drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 classes/                                               |
-|            drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 dependency-maven-plugin-markers/                       |
-|            drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 etc/                                                   |
-|            drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 examples/                                              |
-|            drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:55 install_hierarchy/                                     |
-|            drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 maven-archiver/                                        |
-+-----------------------------------------------------------------------------------------------------------------------------+
-
-+-----------------------------------------------------------------------------------------------------------------------------+
-| Windows                                                                                                                     |
-+=============================================================================================================================+
-| .. container::                                                                                                              |
-|                                                                                                                             |
-|    .. container:: listingblock                                                                                              |
-|                                                                                                                             |
-|          .. code::                                                                                                          |
-|            :number-lines:                                                                                                   |
-|                                                                                                                             |
-|            >cd packages\apex-pdp-package-full\target                                                                        |
-|            >dir                                                                                                             |
-|            03/09/2018  11:55    <DIR>          .                                                                            |
-|            03/09/2018  11:55    <DIR>          ..                                                                           |
-|            03/09/2018  11:55       146,296,819 apex-pdp-package-full-2.0.0-SNAPSHOT-tarball.tar.gz                          |
-|            03/09/2018  11:55       146,328,082 apex-pdp-package-full-2.0.0-SNAPSHOT.deb                                     |
-|            03/09/2018  11:54            15,633 apex-pdp-package-full-2.0.0-SNAPSHOT.jar                                     |
-|            03/09/2018  11:55               772 apex-pdp-package-full_2.0.0~SNAPSHOT_all.changes                             |
-|            03/09/2018  11:54    <DIR>          archive-tmp                                                                  |
-|            03/09/2018  11:54                89 checkstyle-cachefile                                                         |
-|            03/09/2018  11:54            10,621 checkstyle-checker.xml                                                       |
-|            03/09/2018  11:54               584 checkstyle-header.txt                                                        |
-|            03/09/2018  11:54                86 checkstyle-result.xml                                                        |
-|            03/09/2018  11:54    <DIR>          classes                                                                      |
-|            03/09/2018  11:54    <DIR>          dependency-maven-plugin-markers                                              |
-|            03/09/2018  11:54    <DIR>          etc                                                                          |
-|            03/09/2018  11:54    <DIR>          examples                                                                     |
-|            03/09/2018  11:55    <DIR>          install_hierarchy                                                            |
-|            03/09/2018  11:54    <DIR>          maven-archiver                                                               |
-|                           8 File(s)    292,652,686 bytes                                                                    |
-|                           9 Dir(s)  14,138,720,256 bytes free                                                               |
-+-----------------------------------------------------------------------------------------------------------------------------+
++----------------------------------------------------------------------------------------------------------------+
+| Unix, Cygwin                                                                                                   |
++================================================================================================================+
+| .. container::                                                                                                 |
+|                                                                                                                |
+| .. container:: listingblock                                                                                    |
+|                                                                                                                |
+| .. code::                                                                                                      |
+| :number-lines:                                                                                                 |
+|                                                                                                                |
+| # cd packages/apex-pdp-package-full/target                                                                     |
+| # ls -l                                                                                                        |
+| -rwxrwx---+ 1 esvevan Domain Users       772 Sep  3 11:55 apex-pdp-package-full_2.0.0~SNAPSHOT_all.changes*    |
+| -rwxrwx---+ 1 esvevan Domain Users 146328082 Sep  3 11:55 apex-pdp-package-full-2.0.0-SNAPSHOT.deb*            |
+| -rwxrwx---+ 1 esvevan Domain Users     15633 Sep  3 11:54 apex-pdp-package-full-2.0.0-SNAPSHOT.jar*            |
+| -rwxrwx---+ 1 esvevan Domain Users 146296819 Sep  3 11:55 apex-pdp-package-full-2.0.0-SNAPSHOT-tarball.tar.gz* |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 archive-tmp/                                         |
+| -rwxrwx---+ 1 esvevan Domain Users        89 Sep  3 11:54 checkstyle-cachefile*                                |
+| -rwxrwx---+ 1 esvevan Domain Users     10621 Sep  3 11:54 checkstyle-checker.xml*                              |
+| -rwxrwx---+ 1 esvevan Domain Users       584 Sep  3 11:54 checkstyle-header.txt*                               |
+| -rwxrwx---+ 1 esvevan Domain Users        86 Sep  3 11:54 checkstyle-result.xml*                               |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 classes/                                             |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 dependency-maven-plugin-markers/                     |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 etc/                                                 |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 examples/                                            |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:55 install_hierarchy/                                   |
+| drwxrwx---+ 1 esvevan Domain Users         0 Sep  3 11:54 maven-archiver/                                      |
++----------------------------------------------------------------------------------------------------------------+
+
++-----------------------------------------------------------------------------------------+
+| Windows                                                                                 |
++=========================================================================================+
+| .. container::                                                                          |
+|                                                                                         |
+| .. container:: listingblock                                                             |
+|                                                                                         |
+| .. code::                                                                               |
+| :number-lines:                                                                          |
+|                                                                                         |
+| >cd packages\apex-pdp-package-full\target                                               |
+| >dir                                                                                    |
+| 03/09/2018  11:55    <DIR>          .                                                   |
+| 03/09/2018  11:55    <DIR>          ..                                                  |
+| 03/09/2018  11:55       146,296,819 apex-pdp-package-full-2.0.0-SNAPSHOT-tarball.tar.gz |
+| 03/09/2018  11:55       146,328,082 apex-pdp-package-full-2.0.0-SNAPSHOT.deb            |
+| 03/09/2018  11:54            15,633 apex-pdp-package-full-2.0.0-SNAPSHOT.jar            |
+| 03/09/2018  11:55               772 apex-pdp-package-full_2.0.0~SNAPSHOT_all.changes    |
+| 03/09/2018  11:54    <DIR>          archive-tmp                                         |
+| 03/09/2018  11:54                89 checkstyle-cachefile                                |
+| 03/09/2018  11:54            10,621 checkstyle-checker.xml                              |
+| 03/09/2018  11:54               584 checkstyle-header.txt                               |
+| 03/09/2018  11:54                86 checkstyle-result.xml                               |
+| 03/09/2018  11:54    <DIR>          classes                                             |
+| 03/09/2018  11:54    <DIR>          dependency-maven-plugin-markers                     |
+| 03/09/2018  11:54    <DIR>          etc                                                 |
+| 03/09/2018  11:54    <DIR>          examples                                            |
+| 03/09/2018  11:55    <DIR>          install_hierarchy                                   |
+| 03/09/2018  11:54    <DIR>          maven-archiver                                      |
+| 8 File(s)    292,652,686 bytes                                                          |
+| 9 Dir(s)  14,138,720,256 bytes free                                                     |
++-----------------------------------------------------------------------------------------+
 
 .. container:: paragraph
 
 
 .. container:: paragraph
 
@@ -617,7 +617,7 @@ Installation Layout
 
       .. container:: content
 
 
       .. container:: content
 
-         ::
+::
 
             $APEX_HOME
                 ├───bin             (1)
 
             $APEX_HOME
                 ├───bin             (1)
@@ -943,10 +943,10 @@ Verify Installation - run Engine
       .. container:: paragraph
 
          A simple verification of an APEX installation can be done by
       .. container:: paragraph
 
          A simple verification of an APEX installation can be done by
-         simply starting the APEX engine without any configuration. On
+         simply starting the APEX engine without specifying a tosca policy. On
          Unix (or Cygwin) start the engine using
          Unix (or Cygwin) start the engine using
-         ``$APEX_HOME/bin/apexEngine.sh``. On Windows start the engine
-         using ``%APEX_HOME%\bin\apexEngine.bat``. The engine will fail
+         ``$APEX_HOME/bin/apexApps.sh engine``. On Windows start the engine
+         using ``%APEX_HOME%\bin\apexApps.bat engine``. The engine will fail
          to fully start. However, if the output looks similar to the
          following line, the APEX installation is realized.
 
          to fully start. However, if the output looks similar to the
          following line, the APEX installation is realized.
 
@@ -958,21 +958,16 @@ Verify Installation - run Engine
                :number-lines:
 
                Starting Apex service with parameters [] . . .
                :number-lines:
 
                Starting Apex service with parameters [] . . .
-               start of Apex service failed: Apex configuration file was not specified as an argument
-               2018-09-03 13:11:33,914 Apex [main] ERROR o.o.p.a.service.engine.main.ApexMain - start of Apex service failed
-               org.onap.policy.apex.model.basicmodel.concepts.ApexException: Apex configuration file was not specified as an argument
-                       at org.onap.policy.apex.service.engine.main.ApexCommandLineArguments.validateReadableFile(ApexCommandLineArguments.java:267)
-                       at org.onap.policy.apex.service.engine.main.ApexCommandLineArguments.validate(ApexCommandLineArguments.java:161)
-                       at org.onap.policy.apex.service.engine.main.ApexMain.<init>(ApexMain.java:68)
-                       at org.onap.policy.apex.service.engine.main.ApexMain.main(ApexMain.java:165)
-               usage: org.onap.policy.apex.service.engine.main.ApexMain [options...]
-               options
-               -c,--config-file <CONFIG_FILE>the full path to the configuration file to use, the configuration file must be a Json file
-                                             containing the Apex configuration parameters
-               -h,--help                     outputs the usage of this command
-               -m,--model-file <MODEL_FILE>  the full path to the model file to use, if set it overrides the model file set in the
-                                             configuration file
-               -v,--version                  outputs the version of Apex
+               start of Apex service failed.
+               org.onap.policy.apex.model.basicmodel.concepts.ApexException: Arguments validation failed.
+                at org.onap.policy.apex.service.engine.main.ApexMain.populateApexParameters(ApexMain.java:238)
+                at org.onap.policy.apex.service.engine.main.ApexMain.<init>(ApexMain.java:86)
+                at org.onap.policy.apex.service.engine.main.ApexMain.main(ApexMain.java:351)
+               Caused by: org.onap.policy.apex.model.basicmodel.concepts.ApexException: Tosca Policy file was not specified as an argument
+                at org.onap.policy.apex.service.engine.main.ApexCommandLineArguments.validateReadableFile(ApexCommandLineArguments.java:242)
+                at org.onap.policy.apex.service.engine.main.ApexCommandLineArguments.validate(ApexCommandLineArguments.java:172)
+                at org.onap.policy.apex.service.engine.main.ApexMain.populateApexParameters(ApexMain.java:235)
+                ... 2 common frames omitted
 
 Verify Installation - run an Example
 ####################################
 
 Verify Installation - run an Example
 ####################################
@@ -1007,7 +1002,9 @@ Verify Installation - run an Example
 
    .. container:: paragraph
 
 
    .. container:: paragraph
 
-         You can now try to run apex.
+         Create a Tosca Policy for the SampleDomain example using ApexCliToscaEditor
+         as explained in the section "The APEX CLI Tosca Editor". Assume the tosca policy name is SampleDomain_tosca.json.
+         You can then try to run apex using the ToscaPolicy.
 
    .. container:: listingblock
 
 
    .. container:: listingblock
 
@@ -1016,18 +1013,15 @@ Verify Installation - run an Example
         .. code::
          :number-lines:
 
         .. code::
          :number-lines:
 
-          # $APEX_HOME/bin/apexEngine.sh -c $APEX_HOME/examples/config/SampleDomain/Stdin2StdoutJsonEventJava.json (1)
-          # $APEX_HOME/bin/apexEngine.sh -c C:/apex/apex-full-2.0.0-SNAPSHOT/examples/config/SampleDomain/Stdin2StdoutJsonEventJava.json (2)
-          >%APEX_HOME%\bin\apexEngine.bat -c %APEX_HOME%\examples\config\SampleDomain\Stdin2StdoutJsonEventJava.json :: (3)
+          # $APEX_HOME/bin/apexApps.sh engine -p $APEX_HOME/examples/SampleDomain_tosca.json (1)
+          >%APEX_HOME%\bin\apexApps.bat engine -p %APEX_HOME%\examples\SampleDomain_tosca.json(2)
 
 .. container:: colist arabic
 
    +-------+---------+
    | **1** | UNIX    |
    +-------+---------+
 
 .. container:: colist arabic
 
    +-------+---------+
    | **1** | UNIX    |
    +-------+---------+
-   | **2** | Cygwin  |
-   +-------+---------+
-   | **3** | Windows |
+   | **2** | Windows |
    +-------+---------+
 
 .. container:: paragraph
    +-------+---------+
 
 .. container:: paragraph
@@ -1042,7 +1036,7 @@ Verify Installation - run an Example
       .. code::
          :number-lines:
 
       .. code::
          :number-lines:
 
-         Starting Apex service with parameters [-c, v:/dev/ericsson/apex/onap/apex-pdp/packages/apex-pdp-package-full/target/install_hierarchy/examples/config/SampleDomain/Stdin2StdoutJsonEventJava.json] . . .
+         Starting Apex service with parameters [-p, /home/ubuntu/apex/SampleDomain_tosca.json] . . .
          2018-09-05 15:16:42,800 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Created apex engine MyApexEngine-0:0.0.1 .
          2018-09-05 15:16:42,804 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Created apex engine MyApexEngine-1:0.0.1 .
          2018-09-05 15:16:42,804 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Created apex engine MyApexEngine-2:0.0.1 .
          2018-09-05 15:16:42,800 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Created apex engine MyApexEngine-0:0.0.1 .
          2018-09-05 15:16:42,804 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Created apex engine MyApexEngine-1:0.0.1 .
          2018-09-05 15:16:42,804 Apex [main] INFO o.o.p.a.s.e.r.impl.EngineServiceImpl - Created apex engine MyApexEngine-2:0.0.1 .
@@ -1076,36 +1070,36 @@ Verify Installation - run an Example
    the console. Pasting the input event multiple times will produce
    output events with different values.
 
    the console. Pasting the input event multiple times will produce
    output events with different values.
 
-+-------------------------------------------------------------+-------------------------------------------------------------+
-| Input Event                                                 | Example Output Event                                        |
-+=============================================================+=============================================================+
-| .. container::                                              | .. container::                                              |
-|                                                             |                                                             |
-|    .. container:: content                                   |    .. container:: content                                   |
-|                                                             |                                                             |
-|       .. code::                                             |       .. code::                                             |
-|         :number-lines:                                      |         :number-lines:                                      |
-|                                                             |                                                             |
-|         {                                                   |         {                                                   |
-|          "nameSpace": "org.onap.policy.apex.sample.events", |          "name": "Event0004",                               |
-|          "name": "Event0000",                               |          "version": "0.0.1",                                |
-|          "version": "0.0.1",                                |          "nameSpace": "org.onap.policy.apex.sample.events", |
-|          "source": "test",                                  |          "source": "Act",                                   |
-|          "target": "apex",                                  |          "target": "Outside",                               |
-|          "TestSlogan": "Test slogan for External Event0",   |          "TestActCaseSelected": 2,                          |
-|          "TestMatchCase": 0,                                |          "TestActStateTime": 1536157104627,                 |
-|          "TestTimestamp": 1469781869269,                    |          "TestDecideCaseSelected": 0,                       |
-|          "TestTemperature": 9080.866                        |          "TestDecideStateTime": 1536157104625,              |
-|         }                                                   |          "TestEstablishCaseSelected": 0,                    |
-|                                                             |          "TestEstablishStateTime": 1536157104623,           |
-|                                                             |          "TestMatchCase": 0,                                |
-|                                                             |          "TestMatchCaseSelected": 1,                        |
-|                                                             |          "TestMatchStateTime": 1536157104620,               |
-|                                                             |          "TestSlogan": "Test slogan for External Event0",   |
-|                                                             |          "TestTemperature": 9080.866,                       |
-|                                                             |          "TestTimestamp": 1469781869269                     |
-|                                                             |          }                                                  |
-+-------------------------------------------------------------+-------------------------------------------------------------+
++----------------------------------------------------+----------------------------------------------------+
+| Input Event                                        | Example Output Event                               |
++====================================================+====================================================+
+| .. container::                                     | .. container::                                     |
+|                                                    |                                                    |
+| .. container:: content                             | .. container:: content                             |
+|                                                    |                                                    |
+| .. code::                                          | .. code::                                          |
+| :number-lines:                                     | :number-lines:                                     |
+|                                                    |                                                    |
+| {                                                  | {                                                  |
+| "nameSpace": "org.onap.policy.apex.sample.events", | "name": "Event0004",                               |
+| "name": "Event0000",                               | "version": "0.0.1",                                |
+| "version": "0.0.1",                                | "nameSpace": "org.onap.policy.apex.sample.events", |
+| "source": "test",                                  | "source": "Act",                                   |
+| "target": "apex",                                  | "target": "Outside",                               |
+| "TestSlogan": "Test slogan for External Event0",   | "TestActCaseSelected": 2,                          |
+| "TestMatchCase": 0,                                | "TestActStateTime": 1536157104627,                 |
+| "TestTimestamp": 1469781869269,                    | "TestDecideCaseSelected": 0,                       |
+| "TestTemperature": 9080.866                        | "TestDecideStateTime": 1536157104625,              |
+| }                                                  | "TestEstablishCaseSelected": 0,                    |
+|                                                    | "TestEstablishStateTime": 1536157104623,           |
+|                                                    | "TestMatchCase": 0,                                |
+|                                                    | "TestMatchCaseSelected": 1,                        |
+|                                                    | "TestMatchStateTime": 1536157104620,               |
+|                                                    | "TestSlogan": "Test slogan for External Event0",   |
+|                                                    | "TestTemperature": 9080.866,                       |
+|                                                    | "TestTimestamp": 1469781869269                     |
+|                                                    | }                                                  |
++----------------------------------------------------+----------------------------------------------------+
 
 .. container:: paragraph
 
 
 .. container:: paragraph
 
@@ -1287,7 +1281,7 @@ Run in ONAP
 
          .. container:: content
 
 
          .. container:: content
 
-            ::
+::
 
                docker login -u docker -p docker nexus3.onap.org:10003
 
 
                docker login -u docker -p docker nexus3.onap.org:10003
 
@@ -1365,6 +1359,51 @@ Build a Docker Image
                ENV PATH /opt/app/policy/apex-pdp/bin:$PATH
                WORKDIR /home/apexuser
 
                ENV PATH /opt/app/policy/apex-pdp/bin:$PATH
                WORKDIR /home/apexuser
 
+Running APEX in Standalone mode
+-------------------------------
+
+   .. container:: paragraph
+
+      APEX Engine can run in standalone mode by taking in a ToscaPolicy
+      as an argument and executing it.
+      Assume there is a tosca policy named ToscaPolicy.json in APEX_HOME directory
+      This policy can be executed in standalone mode using any of the below methods.
+
+Run in an APEX installation
+###########################
+
+   .. container:: listingblock
+
+      .. container:: content
+
+        .. code::
+         :number-lines:
+
+          # $APEX_HOME/bin/apexApps.sh engine -p $APEX_HOME/ToscaPolicy.json(1)
+          >%APEX_HOME%\bin\apexApps.bat engine -p %APEX_HOME%\ToscaPolicy.json(2)
+
+.. container:: colist arabic
+
+   +-------+---------+
+   | **1** | UNIX    |
+   +-------+---------+
+   | **2** | Windows |
+   +-------+---------+
+
+Run in a docker container
+#########################
+
+   .. container:: listingblock
+
+      .. container:: content
+
+        .. code::
+         :number-lines:
+
+          # docker run -p 6969:6969 -v $APEX_HOME/ToscaPolicy.json:/tmp/policy/ToscaPolicy.json \
+            --name apex -it nexus3.onap.org:10001/onap/policy-apex-pdp:latest /bin/bash \
+            -c "/opt/app/policy/apex-pdp/bin/apexEngine.sh -p /tmp/policy/ToscaPolicy.json"
+
 APEX Configurations Explained
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 APEX Configurations Explained
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -1517,8 +1556,7 @@ Engine Service Parameters
                     "id"             :  45,  (3)
                     "instanceCount"  : 4,  (4)
                     "deploymentPort" : 12345,  (5)
                     "id"             :  45,  (3)
                     "instanceCount"  : 4,  (4)
                     "deploymentPort" : 12345,  (5)
-                    "policyModelFileName" : "examples/models/VPN/VPNPolicyModelJava.json", (6a)
-                    "policy_type_impl" : {...}, (6b)
+                    "policy_type_impl" : {...}, (6)
                     "periodicEventPeriod": 1000, (7)
                     "engineParameters":{ (8)
                       "executorParameters":{...}, (9)
                     "periodicEventPeriod": 1000, (7)
                     "engineParameters":{ (8)
                       "executorParameters":{...}, (9)
@@ -1560,13 +1598,7 @@ Engine Service Parameters
             |                                   | Websocket connection to the       |
             |                                   | engine                            |
             +-----------------------------------+-----------------------------------+
             |                                   | Websocket connection to the       |
             |                                   | engine                            |
             +-----------------------------------+-----------------------------------+
-            | **6a**                            | the APEX policy model file to     |
-            |                                   | load into the engine on startup   |
-            |                                   | when APEX is running native       |
-            |                                   | policies in standalone mode       |
-            |                                   | (optional)                        |
-            +-----------------------------------+-----------------------------------+
-            | **6b**                            | the APEX policy model as a JSON   |
+            | **6**                             | the APEX policy model as a JSON   |
             |                                   | or YAML block to load into the    |
             |                                   | engine on startup when            |
             |                                   | APEX is running a policy that has |
             |                                   | or YAML block to load into the    |
             |                                   | engine on startup when            |
             |                                   | APEX is running a policy that has |
@@ -1749,6 +1781,52 @@ Input and Output Interfaces
             | **18** | any other output configuration (e.g. event name filter, see below) |
             +--------+--------------------------------------------------------------------+
 
             | **18** | any other output configuration (e.g. event name filter, see below) |
             +--------+--------------------------------------------------------------------+
 
+Event Name
+##########
+
+            .. container:: paragraph
+
+               Any event defined in APEX has to be unique. The "name" of
+               of an event is used as an identifier for an ApexEvent. Every
+               event has to be tagged to an eventName. This can be done in different
+               ways. Either the actual event can have a field called "name". Or, the
+               event has some other field that can act as the identifier, which can be
+               specified using "nameAlias". But in other cases, where a "name" or "nameAlias"
+               cannot be specified, the incoming event coming over an endpoint can be
+               manually tagged to an "eventName" before consuming it.
+
+            .. container:: paragraph
+
+               The "eventName" can have a single event's name if the event coming
+               over the endpoint has to be always mapped to the specified eventName's
+               definition. Otherwise, if different events can come over the endpoint,
+               then "eventName" field can consist of multiple event names separated by
+               "|" symbol. In this case, based on the received event's structure, it is
+               mapped to any one of the event name specified in the "eventName" field.
+
+            .. container:: paragraph
+
+               The following code shows some examples on how to specify the eventName field:
+
+            .. container:: listingblock
+
+               .. container:: content
+
+                  .. code::
+
+                     "eventInputParameters": {
+                       "Input1": {
+                         "carrierTechnologyParameters" : {...},
+                         "eventProtocolParameters":{...},
+                         "eventName" : "VesEvent" (1)
+                       },
+                       "Input2": {
+                         "carrierTechnologyParameters" : {...},
+                         "eventProtocolParameters":{...},
+                         "eventName" : "AAISuccessResponseEvent|AAIFailureResponseEvent" (2)
+                       }
+                     }
+
 Event Filters
 #############
 
 Event Filters
 #############
 
@@ -2203,7 +2281,7 @@ Standard Input
 
                   .. container:: content
 
 
                   .. container:: content
 
-                     ::
+::
 
                         "carrierTechnologyParameters" : {
                           "carrierTechnology" : "FILE", (1)
 
                         "carrierTechnologyParameters" : {
                           "carrierTechnology" : "FILE", (1)
@@ -2587,7 +2665,7 @@ Kafka Output
                   +--------+---------------------------------+
 
 JMS IO
                   +--------+---------------------------------+
 
 JMS IO
-#######
+######
 
             .. container:: paragraph
 
 
             .. container:: paragraph
 
@@ -2731,7 +2809,7 @@ JMS Output with Object
                   parameter to ``true``.
 
 Websocket (WS) IO
                   parameter to ``true``.
 
 Websocket (WS) IO
-########################
+#################
 
             .. container:: paragraph
 
 
             .. container:: paragraph
 
@@ -3160,7 +3238,7 @@ REST Server Stand-alone in Servlet
                         </servlet>
 
 REST Requestor IO
                         </servlet>
 
 REST Requestor IO
-##################
+#################
 
             .. container:: paragraph
 
 
             .. container:: paragraph
 
@@ -3797,7 +3875,6 @@ A configuration example
                       "id"             :  45,
                       "instanceCount"  : 4,
                       "deploymentPort" : 12345,
                       "id"             :  45,
                       "instanceCount"  : 4,
                       "deploymentPort" : 12345,
-                      "policyModelFileName" : "examples/models/some-model.json",
                       "engineParameters"    : {
                         "executorParameters" : {
                           "JAVASCRIPT" : {
                       "engineParameters"    : {
                         "executorParameters" : {
                           "JAVASCRIPT" : {
@@ -4016,12 +4093,9 @@ The APEX Engine
 
          .. container:: paragraph
 
 
          .. container:: paragraph
 
-            The APEX engine comes with a few CLI arguments for setting
-            configuration and policy model. The configuration file is
-            always required. The policy model file is only required if
-            no model file is specified in the configuration, or if the
-            specified model file should be over written. The option
-            ``-h`` prints a help screen.
+            The APEX engine comes with a few CLI arguments, the main one is for setting
+            the tosca policy file for execution. The tosca policy file is
+            always required. The option ``-h`` prints a help screen.
 
          .. container:: listingblock
 
 
          .. container:: listingblock
 
@@ -4031,12 +4105,9 @@ The APEX Engine
 
                   usage: org.onap.policy.apex.service.engine.main.ApexMain [options...]
                   options
 
                   usage: org.onap.policy.apex.service.engine.main.ApexMain [options...]
                   options
-                  -c,--config-file <CONFIG_FILE>  the full path to the configuration file to use, the configuration file must be a Json file
-                                                  containing the Apex configuration parameters
-                  -h,--help                       outputs the usage of this command
-                  -m,--model-file <MODEL_FILE>    the full path to the model file to use, if set it overrides the model file set in the
-                                                  configuration file
-                  -v,--version                    outputs the version of Apex
+                  -p,--tosca-policy-file <TOSCA_POLICY_FILE>     the full path to the ToscaPolicy file to use.
+                  -h,--help                                      outputs the usage of this command
+                  -v,--version                                   outputs the version of Apex
 
 The APEX CLI Editor
 -------------------
 
 The APEX CLI Editor
 -------------------
@@ -4239,7 +4310,7 @@ The APEX CLI Tosca Editor
 
 
 The APEX Client
 
 
 The APEX Client
---------------------
+---------------
 
          .. container:: paragraph
 
 
          .. container:: paragraph
 
@@ -5164,11 +5235,21 @@ Example Configuration for a Production Server
                 </logger>
             </configuration>
 
                 </logger>
             </configuration>
 
+Unsupported Features
+^^^^^^^^^^^^^^^^^^^^
+
+         .. container:: paragraph
+
+            This section documents some legacy and unsupported features
+            in apex-pdp. The documentation here has not been updated for
+            recent versions of apex-pdp. For example, the apex-pdp models
+            specified in this example should now be in TOSCA format.
+
 Building a System with Websocket Backend
 Building a System with Websocket Backend
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+----------------------------------------
 
 Websockets
 
 Websockets
-----------
+##########
 
          .. container:: paragraph
 
 
          .. container:: paragraph
 
@@ -5190,7 +5271,7 @@ Websockets
             does not support WAMP at the moment.
 
 Websocket in Java
             does not support WAMP at the moment.
 
 Websocket in Java
------------------
+#################
 
          .. container:: paragraph
 
 
          .. container:: paragraph
 
@@ -5204,7 +5285,7 @@ Websocket in Java
             Netty, … there are also Kafka extensions for Websockets.
 
 Websocket Example Code for Websocket clients (FOSS)
             Netty, … there are also Kafka extensions for Websockets.
 
 Websocket Example Code for Websocket clients (FOSS)
----------------------------------------------------
+###################################################
 
          .. container:: paragraph
 
 
          .. container:: paragraph
 
@@ -5237,7 +5318,7 @@ Websocket Example Code for Websocket clients (FOSS)
                example <http://www.programmingforliving.com/2013/08/jsr-356-java-api-for-websocket-client-api.html>`__
 
 BCP: Websocket Configuration
                example <http://www.programmingforliving.com/2013/08/jsr-356-java-api-for-websocket-client-api.html>`__
 
 BCP: Websocket Configuration
-----------------------------
+############################
 
          .. container:: paragraph
 
 
          .. container:: paragraph
 
@@ -5270,7 +5351,7 @@ BCP: Websocket Configuration
             reconnected manually after an APEX boot.
 
 Demo with VPN Policy Model
             reconnected manually after an APEX boot.
 
 Demo with VPN Policy Model
---------------------------
+##########################
 
          .. container:: paragraph
 
 
          .. container:: paragraph
 
@@ -5297,7 +5378,7 @@ Demo with VPN Policy Model
                in an editor (we need to send those events to APEX)
 
 A Websocket Configuration for the VPN Domain
                in an editor (we need to send those events to APEX)
 
 A Websocket Configuration for the VPN Domain
-############################################
+********************************************
 
             .. container:: paragraph
 
 
             .. container:: paragraph
 
@@ -5364,7 +5445,7 @@ A Websocket Configuration for the VPN Domain
                     }
 
 Start APEX Engine
                     }
 
 Start APEX Engine
-#################
+*****************
 
    .. container:: paragraph
 
 
    .. container:: paragraph
 
@@ -5378,7 +5459,7 @@ Start APEX Engine
          .. code::
             :number-lines:
 
          .. code::
             :number-lines:
 
-            #: $APEX_HOME/bin/apexEngine.sh -c $APEX_HOME/examples/config/VPN/Ws2WsServerAvroContextJsonEvent.json
+            #: $APEX_HOME/bin/apexApps.sh engine -c $APEX_HOME/examples/config/VPN/Ws2WsServerAvroContextJsonEvent.json
 
 .. container:: listingblock
 
 
 .. container:: listingblock
 
@@ -5387,7 +5468,7 @@ Start APEX Engine
       .. code::
         :number-lines:
 
       .. code::
         :number-lines:
 
-        #: %APEX_HOME%\bin\apexEngine.bat -c %APEX_HOME%\examples\config\VPN\Ws2WsServerAvroContextJsonEvent.json
+        #: %APEX_HOME%\bin\apexApps.bat engine -c %APEX_HOME%\examples\config\VPN\Ws2WsServerAvroContextJsonEvent.json
 
 .. container:: paragraph
 
 
 .. container:: paragraph
 
@@ -5415,7 +5496,7 @@ Start APEX Engine
    policy is triggered/executed.
 
 Run the Websocket Echo Client
    policy is triggered/executed.
 
 Run the Websocket Echo Client
-#############################
+*****************************
 
    .. container:: paragraph
 
 
    .. container:: paragraph
 
@@ -5505,7 +5586,7 @@ Run the Websocket Echo Client
             ws-simple-echo: opened connection to APEX (Web Socket Protocol Handshake)
 
 Run the Websocket Console Client
             ws-simple-echo: opened connection to APEX (Web Socket Protocol Handshake)
 
 Run the Websocket Console Client
-################################
+********************************
 
    .. container:: paragraph
 
 
    .. container:: paragraph
 
@@ -5596,7 +5677,7 @@ Run the Websocket Console Client
             ws-simple-console: opened connection to APEX (Web Socket Protocol Handshake)
 
 Send Events
             ws-simple-console: opened connection to APEX (Web Socket Protocol Handshake)
 
 Send Events
-###########
+***********
 
    .. container:: paragraph
 
 
    .. container:: paragraph
 
@@ -5742,6 +5823,3 @@ Send Events
 
    .. container::
       :name: footer-text
 
    .. container::
       :name: footer-text
-
-
-
Parent code that holds the pom.xml to build all the repos (Casablanca)