docs/cps-scheduled-processes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2022 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. cpsScheduledProcesses:
   7
   8
   9 CPS Scheduled Processes
  10 #######################
  11
  12 .. toctree::
  13    :maxdepth: 1
  14
  15 Introduction
  16 ============
  17
  18 The following section is a list of the current scheduled processes running within the CPS system.
  19
  20 Module Sync
  21 -----------
  22 The module sync is a user :ref:`configurable timed process<additional-cps-ncmp-customizations>`,
  23 which is set to search for CM-Handles within CPS with an *'ADVISED'* state.
  24 Once the CM-Handle(s) is processed by the module sync, the CM-Handle state is then set to *'READY'*, if the process completes successfully.
  25 If for any reason the module sync fails, the CM-Handle state will then be set to *'LOCKED'*,
  26 and the reason for the lock will also be stored within CPS.
  27
  28 Data Sync
  29 ---------
  30 The data sync is a user :ref:`configurable timed process<additional-cps-ncmp-customizations>`,
  31 which is set to search for CM-Handles with a sync state of *'UNSYNCHRONIZED'*.
  32 Once the CM-Handle(s) with a sync state of *'UNSYNCHRONIZED'* is processed by the data sync,
  33 the CM-Handle sync state is then set to *'SYNCHRONIZED'*, if the process completes successfully.
  34 If the data sync fails, the CM-Handle sync state will remain as *'UNSYNCHRONIZED'*, and will be re-attempted.
  35
  36 Retry Mechanism
  37 ---------------
  38 The retry mechanism is a user :ref:`configurable timed process<additional-cps-ncmp-customizations>`,
  39 which is used to search for CM-Handles which are currently in a *'LOCKED'* state.
  40 If the CM-Handle is ready to be retried then, the CM-Handle(s) in a *'LOCKED'* state is processed by the retry mechanism,
  41 the CM-Handle state is then set to *'ADVISED'*.
  42 Whether the CM-Handle is ready to be retried is dependent on both the number of attempts to sync the CM-Handle,
  43 and the last update time of the CM-Handle state.
  44 With each new attempt to unlock the CM-Handle, the time until the CM-Handle can next be retried is doubled.