diff options
| author |   aditya.puthuparambil <aditya.puthuparambil@est.tech> | 2020-03-19 10:52:46 +0000 |
|---|---|---|
| committer | Aditya Puthuparambil <aditya.puthuparambil@est.tech> | 2020-03-19 12:06:50 +0000 |
| commit | 8c69f0434102b0328ae4754783a01c36f7e35c97 (patch) | |
| tree | d11ea0e4d806ad03080cb28c2bed6bd6232bcebe /examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/02-data-models.adoc | |
| parent | 690495d32c6033741d7a7c2413476f7ba88e2825 (diff) | |
Apex-pdp tutorial documentation changes
Issue-ID: POLICY-2424
Signed-off-by: aditya.puthuparambil <aditya.puthuparambil@est.tech>
Change-Id: I92491c904b65a0db93c9e6eaba676c653c276175
Diffstat (limited to 'examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/02-data-models.adoc')
| -rw-r--r-- | examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/02-data-models.adoc | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/02-data-models.adoc b/examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/02-data-models.adoc index 1ed43cc37..b07c67226 100644 --- a/examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/02-data-models.adoc +++ b/examples/examples-myfirstpolicy/src/site-docs/adoc/fragments/02-data-models.adoc @@ -1,10 +1,11 @@ // // ============LICENSE_START======================================================= // Copyright (C) 2016-2018 Ericsson. All rights reserved. +// Modifications Copyright (C) 2020 Nordix Foundation. // ================================================================================ // 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========================================================= // @@ -14,7 +15,7 @@ == Data Models === Sales Input Event -Each time a PoS system processes a sales item an event with the following format is emitted: +Each time a PoS system processes a sales item an event with the following format is triggered: .Sale Input Event [width="100%",options="header"] @@ -34,14 +35,14 @@ The `notes` field contains arbitrary notes about the sale. === Sales Decision Event -After a `SALE_INPUT` event is emitted by the PoS system _HyperM_'s policy-based controlled sales checking system emits a Sale Authorization Event indicating whether the sale is authorized or denied. +After a `SALE_INPUT` event is triggered by the PoS system _HyperM_'s policy-based controlled sales checking system triggers a Sale Authorization Event indicating whether the sale is authorized or denied. The PoS system can then listen for this event before continuing with the sale. .Sale Authorisation Event [width="100%",options="header"] |==================== |Event| Fields | Description -| SALE_AUTH | sale_ID, time, authorized, amount, item_ID, quantity, assistant_ID, branch_ID, notes, message... | Event indicating a sale of an item is authorized or denied +| SALE_AUTH | sale_ID, time, authorized, amount, item_ID, quantity, assistant_ID, branch_ID, notes, message... | Event indicating if the sale of an item is authorized or denied |==================== In each `SALE_AUTH` event the `sale_ID` field is copied from the `SALE_INPUT` event that trigger the decision request. |