ecl-logo Documentation

Object[Troubleshooting]

A record of an issue encountered while using the ECL and the steps taken to resolve the issue.

Organizational Information

    Name

    Name of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: A string.

    ID

    ID of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: The ID of this object.

    Object

    Object of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Troubleshooting, _String]
    Pattern Description: The object reference of this object.

    Type

    Type of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Troubleshooting]
    Pattern Description: Object[Troubleshooting]

    Notebook

    Notebook this object belongs to.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Pattern Description: An object of that matches ObjectP[Object[LaboratoryNotebook]].

    DateResolved

    Date when this issue was most recently marked resolved.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    ReportedBy

    The person who reported this issue.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Relation: Object[User]

    Assignee

    The ECL team member responsible for resolving this issue.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Relation: Object[User]

    Followers

    The relevant persons to be kept apprised of any updates to this issue, so that they may follow its progress.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link
    Relation: Object[User]

Troubleshooting

    AssigneeLog

    A log of the ECL team member responsible for resolving this troubleshooting.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Date
      Programmatic Pattern: _?DateObjectQ

    [[2]] Person Assigning

      Header: Person Assigning
      Class: Link
      Programmatic Pattern: _Link
      Relation: Object[User]

    [[3]] Assignee

      Header: Assignee
      Class: Link
      Programmatic Pattern: _Link
      Relation: Object[User]

    Resolved

    Indicates if the immediate problem presented by this troubleshooting has been resolved or is still under investigation.
    Format: Single
    Class: Expression
    Programmatic Pattern: BooleanP

    ResolvedLog

    A log of whether the troubleshooting has been resolved or not.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Date
      Programmatic Pattern: _?DateObjectQ

    [[2]] Person Deciding

      Header: Person Deciding
      Class: Link
      Programmatic Pattern: _Link
      Relation: Object[User]

    [[3]] Resolved

      Header: Resolved
      Class: Expression
      Programmatic Pattern: BooleanP

    Headline

    One sentence description of the issue being reported.
    Format: Single
    Class: String
    Programmatic Pattern: _String

    Description

    A long form description of the issue being reported.
    Format: Single
    Class: String
    Programmatic Pattern: _String

    Attachments

    Additional supporting material describing this troubleshooting issue.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    AttachmentLog

    A log of the additional supporting material describing this troubleshooting.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Date
      Programmatic Pattern: _?DateObjectQ

    [[2]] Person Attaching

      Header: Person Attaching
      Class: Link
      Programmatic Pattern: _Link
      Relation: Object[User]

    [[3]] Attachment

    CommentLog

    A log of all the comments about the troubleshooting.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Date
      Programmatic Pattern: _?DateObjectQ

    [[2]] Person Commenting

      Header: Person Commenting
      Class: Link
      Programmatic Pattern: _Link
      Relation: Object[User]

    [[3]] Comment

      Header: Comment
      Class: String
      Programmatic Pattern: _String

    ActionLog

    A log of the actions executed on this troubleshooting.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Date
      Programmatic Pattern: _?DateObjectQ

    [[2]] Person Responsible

      Header: Person Responsible
      Class: Link
      Programmatic Pattern: _Link
      Relation: Object[User]

    [[3]] Action

      Header: Action
      Class: Expression
      Programmatic Pattern: TroubleshootingActionP

    AffectedApplication

    Indicates the ECL Application that is affected.
    Format: Single
    Class: Expression
    Programmatic Pattern: ECLApplicationP

    AffectedFunction

    The Emerald library function call that this software bug presents itself in.
    Format: Single
    Class: Expression
    Programmatic Pattern: _Symbol

    IncidenceReduction

    Description of action taken to reduce the probability of this troubleshooting from repeating.
    Format: Single
    Class: String
    Programmatic Pattern: _String

    ErrorSource

    The classification of the core issue that was responsible for this troubleshooting.
    Format: Single
    Class: String
    Programmatic Pattern: _String

    RootCauseCategory

    The classification of the core issue that was responsible for this troubleshooting.
    Format: Single
    Class: Expression
    Programmatic Pattern: RootCauseCategoryP

    SolutionWarrantedLog

    A log of whether the troubleshooting was deemeed to warrant a solution or not.
    Format: Multiple

    [[1]] Date

      Header: Date
      Class: Date
      Programmatic Pattern: _?DateObjectQ

    [[2]] Person Deciding

      Header: Person Deciding
      Class: Link
      Programmatic Pattern: _Link
      Relation: Object[User]

    [[3]] Solution Warranted

      Header: Solution Warranted
      Class: Boolean
      Programmatic Pattern: BooleanP

Data Integrations

    AsanaSyncedAttachments

    Asana attachment GID / cloud file pairs that have been synced to this troubleshooting.
    Format: Multiple

    [[1]] Asana Attachment GID

      Header: Asana Attachment GID
      Class: String
      Programmatic Pattern: _String

    [[2]] EmeraldCloudFile

Versioning

    SoftwareVersion

    Indicates the version of the application (CommandCenter, Engine, or Nexus) from which the ticket was submitted, as well as the version information of Mathematica, Constellation, and SLL that were in use when this troubleshooting ticket was filed.
    Format: Multiple

    [Application]

      Header: Application
      Class: Expression
      Relation: ['Null', 'Null']

    [Mathematica]

      Header: Mathematica
      Class: String

    [Constellation]

      Header: Constellation
      Class: String

    [SLL]

      Header: SLL
      Class: String

    [Distro]

Last modified on Mon 26 Sep 2022 15:43:53