summaryrefslogtreecommitdiffstats
path: root/examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/01-introduction.adoc
diff options
context:
space:
mode:
authorDinh Danh Le <dinh.danh.le@ericsson.com>2018-08-23 00:41:47 +0100
committerDinh Danh Le <dinh.danh.le@ericsson.com>2018-08-23 16:56:04 +0100
commit6a2abc8402af63dd8941b4652278a6df404d781a (patch)
treed806687cf4621527e471730192f2f26c256ac311 /examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/01-introduction.adoc
parenta4a992216c40138cda8501ee9bed971038b530a9 (diff)
Add docs for the examples package
This review is big because it contains examples for the whole project. The big size is mainly due to the site.xml, logos and css files which are repeatedly created, and more aciidoc files are needed. The pom.xml files are changed properly. Change-Id: I42a94e4d898529f9249ef03de908c8b1a0142c7f Signed-off-by: Dinh Danh Le <dinh.danh.le@ericsson.com> Issue-ID: POLICY-867
Diffstat (limited to 'examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/01-introduction.adoc')
-rw-r--r--examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/01-introduction.adoc25
1 files changed, 25 insertions, 0 deletions
diff --git a/examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/01-introduction.adoc b/examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/01-introduction.adoc
new file mode 100644
index 000000000..02a7a0e76
--- /dev/null
+++ b/examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/01-introduction.adoc
@@ -0,0 +1,25 @@
+//
+// ============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
+
+Consider a scenario where a supermarket chain called _HyperM_ controls how it sells items in a policy-based manner.
+Each time an item is processed by _HyperM_'s point-of-sale (PoS) system an event is generated and published about that item of stock being sold.
+This event can then be used to update stock levels, etc..
+
+__HyperM__ want to extend this approach to allow some checks to be performed before the sale can be completed.
+This can be achieved by requesting a policy-controlled decision as each item is processed by for sale by each PoS system.
+The decision process is integrated with __HyperM__'s other IT systems that manage stock control, sourcing and purchasing, personnel systems, etc.
+
+In this document we will show how APEX and APEX Policies can be used to achieve this, starting with a simple policy, building up to more complicated policy that demonstrates the features of APEX.
+