Cascade Update function

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Cascade Update function

    The Cascade Update function in the Telecommunications Network Inventory application allows you to update a configuration item (CI) attribute and automatically apply that change to all related CIs within the inventory hierarchy. This function is designed to ensure consistency of CI attributes across interconnected network components. It is primarily used as an action within Workflow Studio to streamline inventory data operations.

    Show full answer Show less

    Note that this function does not support updates to Life Cycle Stage and Life Cycle Status fields. If there are conflicts or discrepancies between related CIs during the cascade, the function returns an error with detailed conflict information.

    Key Features

    • Automatic Cascading: Updates to a CI attribute cascade down through all related CIs in the hierarchy, ensuring consistent attribute values across connected inventory items.
    • Flexible Field Updates: You can update any field except Life Cycle Stage and Life Cycle Status in a CI record and propagate those changes.
    • Error Handling: The function detects conflicts during the cascade process, returning errors when inconsistencies are found.
    • Workflow Integration: Available as a Workflow Studio action for admin users, enabling easy inclusion in automated workflows within the Telecommunications Network Inventory application.
    • Input Parameters: Requires a related change request, the target CI for update, and optionally the specific CI attribute to cascade.

    Cascade Rules

    The cascade update behavior varies depending on the CI type, with attribute updates propagating to specific related CIs as follows:

    • Telco Equipment: Updates cascade to related equipment holders (slots, subslots), interface cards, and network interfaces.
    • Telco Equipment Holder: Updates cascade to interface cards, subslots, and network interfaces.
    • Interface Card: Updates cascade to subslots and network interfaces.
    • Network Interface: Updates cascade to related network interface records.
    • Physical Connection: Updates cascade to related physical connection records.
    • Logical Connection: Updates cascade to all next element CIs defined in the connection elements referencing the logical connection.

    For example, updating the "Type" field in a Telco Equipment CI will cascade that update throughout its related hierarchy as defined above.

    Roles and Availability

    Only users with the admin role can add and configure this action within Workflow Studio flows. The function is accessible exclusively within the Telecommunications Network Inventory application, supporting inventory-related updates and workflows.

    The Cascade Update function enables you to update a configuration item (CI) attribute in the Telecommunications Network Inventory application and cascade the change in all related CIs. You can use this function to automatically cascade the field values in related CIs when you use Workflow Studio.

    You can use the Cascade Update function to update any field in the inventory record and cascade the changes all the way down to the hierarchy mentioned in the inventory record.

    If there’s a conflict, such as any discrepancies found in the related CIs, this function returns an error. For example, let's say that you pass the change request and CI but the CI isn’t added to the affected CI list of the change request. Instead, it returns a sort error with the conflict information in execution.

    Note:
    This function doesn’t work on Life Cycle Stage and Life Cycle Status fields.

    You can use this function as a Workflow Studio action in the Telecommunications Network Inventory workflow.

    Roles and availability

    Users with the admin role can add an action to a flow and define the configuration details of the flow. This function is available as a Workflow Studio action in the Telecommunications Network Inventory application so that you can perform inventory-related data operations.

    Input fields

    The following table lists the input fields in the Cascade Update function and their descriptions.

    Table 1. Input fields of Cascade Update function
    Field Name Description Data Type Mandatory?
    Change Request Change request that is related to the affected CI list. Reference.Change Request No
    CI CI where you want to update the field. Reference.Configuration Item No
    Field Attribute in the CI that you want to cascade. String No

    To learn more about the variable data types, see Flow Designer input and output data variables.

    Output

    Use this function to update the CI attribute in all related CIs.

    Cascade rule for all common attributes of CI

    The following table lists the information about the cascade rules for the different types of CIs.

    Table 2. Cascade rules
    CI Cascade Rule Example
    Telco Equipment Attributes that are updated for the related equipment holder (slot), interface card, telco equipment holder (subslot), and network interface records. The Type field that is updated in the equipment record cascades all the way down to the hierarchy mentioned in the inventory record.
    Telco Equipment Holder Attributes that are updated for the related interface card, telco equipment holder (subslot), and network interface records. The Type field that is updated in the equipment record cascades all the way down to the hierarchy mentioned.
    Interface Card Attributes that are updated for the related telco equipment holder (subslot) and network interface records. The Type field that is updated in the equipment record cascades all the way down to the hierarchy mentioned.
    Network Interface Attributes that are updated for the related network interface record. The Port Bandwidth field that is updated in the equipment record cascades all the way down to the hierarchy mentioned in the inventory record.
    Physical Connection Attributes are updated for the related physical connection record. The Bandwidth field that is updated in the equipment record cascades all the way down to the hierarchy mentioned in the inventory record.
    Logical Connection Attributes that are updated for all the next element CI records, which are defined in the connection element that reference the logical connection record. The Bandwidth field that is updated in the equipment record cascades all the way down to the hierarchy mentioned in the inventory record.