aboutsummaryrefslogtreecommitdiffstats
path: root/src/site-docs/adoc/fragments/apex-policy-model/introduction.adoc
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@est.tech>2020-10-16 13:09:11 +0100
committerliamfallon <liam.fallon@est.tech>2020-10-16 13:09:16 +0100
commit0cf967c0239a8ab9c8b8831b700b72d9a08f7b03 (patch)
treea4fbcd97008769d55ac443bc22abf517308bf6a7 /src/site-docs/adoc/fragments/apex-policy-model/introduction.adoc
parent9833876720ff14517ee78bda557e6021df723800 (diff)
Remove apex asciidoc documents
Apex documentation has now all been ported to use the ONAP recommended rst format. This review removes the old asciidoc documents. Issue-ID: POLICY-2824 Change-Id: I562bd344cb7d6ff36e7d54bdb8f95e3b656468f8 Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'src/site-docs/adoc/fragments/apex-policy-model/introduction.adoc')
-rw-r--r--src/site-docs/adoc/fragments/apex-policy-model/introduction.adoc43
1 files changed, 0 insertions, 43 deletions
diff --git a/src/site-docs/adoc/fragments/apex-policy-model/introduction.adoc b/src/site-docs/adoc/fragments/apex-policy-model/introduction.adoc
deleted file mode 100644
index 906f51cce..000000000
--- a/src/site-docs/adoc/fragments/apex-policy-model/introduction.adoc
+++ /dev/null
@@ -1,43 +0,0 @@
-//
-// ============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)
-//
-
-== Introduction
-
-The APEX policy model is shown in UML notation in the figure below.
-A policy model can be stored in JSON or XML format in a file or can be held in a database.
-The APEX editor creates and modifies APEX policy models.
-APEX deployment deploys policy models, and a policy model is loaded into APEX engines so that the engines can run the policies in the policy model.
-
-The figure shows four different views of the policy model:
-
-* The general model view shows the main parts of a policy: state, state output, event, and task.
- A task can also have parameters.
- Data types can be defined on a per-model basis using either standard atomic types (such as character, string, numbers) or complex types from a policy domain.
-* The logic model view emphasizes how decision-making logic is injected into a policy.
- There are essentially three different types of logic:
- task logic (for decision making in a task),
- task selection logic (to select a task if more than one is defined in a state), and
- state finalizer logic (to compute the final output event of a state and select an appropriate next state from the policy model).
-* The context model view shows how context is injected into a policy.
- States collect all context from their tasks.
- A task can define what context it requires for the decision making, i.e. what context the task logic will process.
- Context itself is a collection of items (individual context information) with data types.
- Context can be templated.
-* The event and field model view shows the events in the policy model.
- Tasks define what information they consume (input) and produce (output).
- This information is modeled as fields, essentially a key/type tuple in the model and a key/type/value triple at execution.
- Events then are collection of fields.
-
-.APEX Policy Model for Execution
-image::apex-policy-model/UmlPolicyModels.png[APEX Policy Model for Execution]
-