| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| ============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) |
| |
| --> |
| |
| <document> |
| <properties> |
| <title>The APEX Policy Guide</title> |
| <author email="sven.van.der.meer@ericsson.com">Sven van der Meer</author> |
| <author email="liam.fallon@ericsson.com">Liam Fallon</author> |
| <author email="john.keeney@ericsson.com">John Keeny</author> |
| </properties> |
| <body> |
| |
| <section name="The APEX Policy Guide"> |
| |
| <p> |
| The APEX policy guide combines a set of howto documents, all supporting APEX and policy, including how to write task and task selection logic. |
| The howto documents are provided as integrated documentation in the APEX site. |
| Furthermore, we provide stand-alone documents in HTML and PDF. |
| </p> |
| |
| <p> |
| Note: most of the documentation is written in AsciiDoc. |
| We are using the AsciiDoctor version. |
| Due to the different build tools used for the different documentation targets, the rendered documents differ in style. |
| The content however comes always from a single, normative source located in the APEX source repositories. |
| </p> |
| |
| <h3>APEX Policy Guide documentation</h3> |
| <table> |
| <tr> |
| <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="20%">Name</th> |
| <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="50%">Description</th> |
| <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="30%">Links</th> |
| </tr> |
| <tr> |
| <td>Policy Guide</td> |
| <td> |
| The complete APEX Policy Guide, including all HowTos and other documentation. |
| The stand-alone versions aggregate all other documents listed in this table. |
| </td> |
| <td> |
| <ul> |
| <li><a href="docs-apex/html/APEX-Policy-Guide.html">stand-alone HTML</a></li> |
| <li><a href="docs-apex/pdf/APEX-Policy-Guide.pdf">stand-alone PDF</a></li> |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <td>The APEX Policy Model</td> |
| <td> |
| A deep dive into the policy model defined and implemented in the APEX engine. |
| This model is the foundation for policy execution. |
| </td> |
| <td> |
| <ul> |
| <li><a href="docs-apex/html/Tech-APEX-PolicyModel.html">stand-alone HTML</a></li> |
| <li><a href="docs-apex/pdf/Tech-APEX-PolicyModel.pdf">stand-alone PDF</a></li> |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <td>HowTo: Policy Logic</td> |
| <td> |
| An APEX policy requires task logic being programmed. |
| When multiple tasks are combined into a single policy state, a so called task selection logic needs to be programmed as well. |
| This HowTo explains how to programme policy task logic and if required task selection logic. |
| </td> |
| <td> |
| <ul> |
| <li><a href="policy-guide/pg-task-logic.html">APEX Site, task logic</a></li> |
| <li><a href="policy-guide/pg-task-selection-logic.html">APEX Site, task selection logic</a></li> |
| <li><a href="policy-guide/pg-logic-cheatsheet.html">APEX Site, logic cheatsheet</a></li> |
| <li><a href="docs-apex/html/HowTo-PolicyLogic.html">stand-alone HTML</a></li> |
| <li><a href="docs-apex/pdf/HowTo-PolicyLogic.pdf">stand-alone PDF</a></li> |
| </ul> |
| </td> |
| </tr> |
| |
| </table> |
| </section> |
| </body> |
| </document> |