.. _releasemid:

======================
ReleaseAllResources
======================


    1. The subarray Node provides API for **ReleaseAllResources workflow**.
    2. **Input JSON** is as per schema detailed at :    https://developer.skao.int/projects/ska-schemas/en/latest/schemas/tmc/ska-tmc-releaseresources.html
    3. The Sub-array node **accepts the command** if :-

        A. **Admin mode** reported by each of the system - CSP,SDP subarray are in **ONLINE/ENGINEERING/RESERVED**
        B. Operational **state** of the Sub-array node is **ON/OFF/INIT/STANDBY/ALARM**

    4. The Sub-array Node **rejects the command** if :-

        A. **Admin mode** reported by each of the system - CSP,SDP Sub-array are in **OFFLINE** or **NOT FITTED**.
        B. Operational **state** of central node is **FAULT/UNKNOWN/DISABLE** .

    5. The following **state requirements** are applied for the **command execution** :-

        A. TMC Subarray is in `'observation state'` **EMPTY** or **IDLE** .
        B. :term:`isSubarrayAvailable` is checked to ensure the subsystems (CSP and SDP) are :term:`available`

    6. The **command execution** involves below **key operations** :-

        A. For CSP and SDP , no JSON is sent to leaf nodes.
        B. Dish Leaf node and Dish master **events** are **unsubscribed** for assigned dishes
        C. When command is invoked on the relevant TMC CSP, SDP, leaf Nodes.

            - If leaf node **rejects** release resources command , command failure is reported as **'RESULT_CODE - FAILED'** on Long Running Command Result attribute of the TMC Subarray node.Command will not be sent to remaining subsystems in this case if multiple subsystems are involved .
            - If **all** leaf node **accept** command , the TMC Subarray node will wait for command completion.

    7. The Sub-array node **monitors the progress** of command via the Sub-array node **ObsState transitions** and the **long running command results**.

        A. Command is **successful** when the TMC Subarray Node transitions to **EMPTY** ObsState. This is reported as **'RESULT_CODE - OK'** on Long Running Command Result attribute of TMC Subarray node.
        B. Command failure is reported in any of the below cases as **'RESULT_CODE - FAILED'** on Long Running Command Result attribute of the Subarray node.

            - The CSP Leaf node/SDP Leaf node reports **'RESULT_CODE - FAILED'** on its Long Running Command Result attribute
            - The command **times out** if TMC SubarrayNode **does not transition** to **EMPTY** within the **timeout period** specified by `CommandTimeOutDefault` property specified in helm chart of the TMC Subarray node .

    8. On **success** the system is **ready for fresh observation**; on **failure** it may revert to **IDLE** or **FAULT** depending on severity.
    9. When **all** targeted subsystems report **successful** completion, **cleanup** on the TMC subarray node proceeds. Assigned resources attribute is reset.