ChangeCollisionHelper - Global

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read

    • Helper functions found in the Change Management Collision Detector Plugin.

    Use these methods in server side scripts, or when using AJAX calls on the client. You must have the Change Management Collision Detector Plugin installed to use these methods.

    ChangeCollisionHelper - addCiToChangeAffectedCis(String ci, String changeId)

    Adds the CI to the change's affected CI list.

    Table 1. Parameters
    Name Type Description
    ci String The sys_id of the configuration item
    changeId String The change record's sys_id
    Table 2. Returns
    Type Description
    void

    ChangeCollisionHelper - getAffectedCisByChangeId(String changeId)

    Returns the Affected CI sys_ids for the given change.

    Table 3. Parameters
    Name Type Description
    changeId String A change record's sys_id
    Table 4. Returns
    Type Description
    Array An array of sys_ids of affected CIs.

    ChangeCollisionHelper - getBlackoutsByDate(GlideDateTime startDate, GlideDateTime endDate)

    Returns any blackout that overlap the period defined by startDate and endDate.

    Table 5. Parameters
    Name Type Description
    startDate GlideDateTime The beginning date
    endDate GlideDateTime The ending date
    Table 6. Returns
    Type Description
    Array An array of blackouts (blackoutId:stringSpan).

    ChangeCollisionHelper - getChangesWithAffectedCi(String ci, GlideDateTime startDate, GlideDateTime endDate)

    Returns changes scheduled in the timespan (defined by startDate and endDate) that have the given CI in their Affected CIs list.

    Table 7. Parameters
    Name Type Description
    ci String The configuration item's sys_id
    startDate GlideDateTime The beginning date
    endDate GlideDateTime The ending date of the time span
    Table 8. Returns
    Type Description
    Array An array of change record's sys_ids

    ChangeCollisionHelper - getChangesWithCi(String ci, GlideDateTime startDate, GlideDateTime endDate)

    Returns the changes that are in the timespan (startDate, endDate) and that are linked to the given CI.

    Table 9. Parameters
    Name Type Description
    ci String The configuration item's sys_id
    startDate GlideDateTime The beginning date
    endDate GlideDateTime The ending date of the time span
    Table 10. Returns
    Type Description
    Array An array of sys_ids for change records

    ChangeCollisionHelper - getCiMaintenanceSchedule(String ci)

    Returns the Maintenance Schedule for a CI.

    Table 11. Parameters
    Name Type Description
    ci String The configuration item's sys_id
    Table 12. Returns
    Type Description
    void

    ChangeCollisionHelper - getDependants(String ci)

    Returns all the CIs that depend on the given CI.

    Table 13. Parameters
    Name Type Description
    ci String A configuration item's sys_id
    Table 14. Returns
    Type Description
    Array An array of CIs

    ChangeCollisionHelper - getDependencies(String ci)

    Returns all the CIs that the given CI depends on.

    Table 15. Parameters
    Name Type Description
    ci String The configuration item's sys_id
    Table 16. Returns
    Type Description
    Array An array of CIs

    ChangeCollisionHelper - isCiInAffectedCis(String ci, String changeId)

    Check if an CI is already in the change's affected CIs list.

    Table 17. Parameters
    Name Type Description
    ci String The sys_id of the configuration item
    changeId String The change record's sys_id
    Table 18. Returns
    Type Description
    Boolean True if the CI already is in the change's affected CI list.

    ChangeCollisionHelper - isDateInCiMaintenanceWindows( GlideDateTime startDate, GlideDateTime endDate, String maintenanceWindow)

    Checks if the time span defined by startDate and endDate falls in the CI's maintenance window.

    Table 19. Parameters
    Name Type Description
    startDate GlideDateTime The beginning date
    endDate GlideDateTime The ending date
    maintenanceWindow String The configuration item's sys_id
    Table 20. Returns
    Type Description
    Boolean True if the time span is in the CI's maintenance window