Version

    KillGraph

    Jobflow Component

    Short Description
    Ports
    Metadata
    KillGraph Attributes
    Details
    See also

    Short Description

    KillGraph aborts specified graphs and passes their final status to the output port.

    [Note]Note

    To be able to use this component, you need a separate jobflow license. Also, the component requires your project is executed on CloverDX Server.

    ComponentSame input metadataSorted inputsInputsOutputsEach to all outputsJavaCTLAuto-propagated metadata
    KillGraph0-10-1

    Ports

    Port typeNumberRequiredDescriptionMetadata
    Input0Input tokens with identifications of interrupted graphs.Any
    Output0Final graph execution status.Any

    Metadata

    KillGraph does not propagate metadata from left to right or from right to left.

    This component has metadata templates. The templates are described in Details. General details on metadata templates are available in metadata templates.

    KillGraph Attributes

    AttributeReqDescriptionPossible values
    Basic
    Run IDno

    Specifies the run ID of an interrupted graph. Has higher priority than the Execution group attribute. This attribute can be overridden in input mapping.

    long
    Execution groupno

    All graphs belonging to the specified execution group are interrupted. The Run ID attribute has higher priority. This attribute can be overridden in input mapping.

    string
    Kill daemon childrenno

    Specifies whether even daemon children are interrupted. Non-daemon children are aborted in any case. This attribute can be overridden in input mapping.

    false (default) | true
    Input mappingno

    Input mapping defines how to extract Run ID or Execution group to be interrupted from incoming token. See Input mapping.

    CTL transformation
    Output mappingno

    Output mapping defines how to populate the output token by final graph status of interrupted graph. See Output mapping.

    CTL transformation

    Details

    The KillGraph component aborts graphs specified by Run ID or by Execution group (all graphs belonging to the Execution group are aborted). Final execution status of interrupted graphs is passed to the output port or just printed out to a log. Moreover, you can choose if even daemon children of interrupted graphs are aborted (non-daemon children are interrupted in any case) - see the Execute graph as daemon attribute of ExecuteGraph.

    The component reads an input token, extracts Run ID or Execution group from incoming data (see the Input mapping attribute), interrupts the requested graphs and writes final status of the interrupted graph to the output port (see the Output mapping attribute).

    In case the input port is not attached, just the graphs specified in the Run ID attribute or in Execution group attribute are interrupted.

    Input mapping

    Input mapping is regular CTL transformation which is executed for each input token to extract Run ID or Execution group to be interrupted. Output record has following structure:

    Field NameTypeDescription
    runIdlongOverrides component attribute Run ID
    executionGroupstringOverrides component attribute Execution group
    killDaemonChildrenbooleanOverrides component attribute Kill daemon children

    Output mapping

    Output mapping is regular CTL transformation which is executed for interrupted graph to populate the output token. Available input data has following structure:

    Field NameTypeDescription
    runIdlongrun ID of interrupted graph
    originalJobURLstringpath to interrupted graph
    versionstringversion of interrupted graph
    submitTimelongtime when the graph execution was requested. The graph can be enqueued and started later, see startTime below. See Job Queue for more details about job queue.
    startTimedatetime of graph startup. If the graph was enqueued, this is the time when the graph was taken from the queue and started. See Job Queue for more details about job queue.
    endTimedatetime of graph finish
    durationlonggraph run execution time in milliseconds (endTime - startTime)
    statusstringfinal graph execution status (FINISHED_OK | ERROR | ABORTED | TIMEOUT)
    errExceptionstringcause exception for failed graphs
    errMessagestringerror message for failed graphs
    errComponentstringcomponent ID which caused the graph to fail
    errComponentTypestringtype of component which caused the graph to fail