ecl-logo Documentation

Object[Notebook, Script]

A sequence of code that generates an experimental workflow that is executed in the laboratory.

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[Notebook, Script, _String]
    Pattern Description: The object reference of this object.

    Type

    Type of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Notebook, Script]
    Pattern Description: Object[Notebook, Script]

    Notebook

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

    Author

    The investigator who created this notebook.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Relation: Object[User]

    DisplayName

    A short title which is displayed for this asset in the user interface.
    Format: Single
    Class: String
    Programmatic Pattern: _String

    AssetFile

    The cloud file storing the asset.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    AssetFileLog

    The history of files for this asset, oldest to newest.
    Format: Multiple

    [[1]] Date Changed

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

    [[2]] New Asset Cloud File

    [[3]] Updating User

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

    Protocols

    All parent protocols in this notebook.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    Status

    The current status of this script.
    Format: Single
    Class: Expression
    Programmatic Pattern: ScriptStatusP

    ExceptionType

    The reason for the exception. None if there is no exception.
    Format: Single
    Class: Expression
    Programmatic Pattern: ScriptExceptionTypeP

    DateCompleted

    The date on which the last step of this script's execution was finished.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    Script

    The script that created this script.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    History

    The series of code cells that have been run as part of this script.
    Format: Multiple

    [Expression]

      Header: Expression
      Class: Compressed

    [Kernel]

      Header: Kernel
      Class: Compressed

    [Messages]

      Header: Messages
      Class: Compressed

    [Exception]

      Header: Exception
      Class: Boolean

    [Output]

      Header: Output
      Class: Compressed

    [ObjectsGenerated]

      Header: ObjectsGenerated
      Class: Compressed

    CurrentProtocols

    The protocol objects that must be completed before this script should resume.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    ParallelizeProtocols

    Indicates if the CurrentProtocols should be run in parallel or in series, if there are multiple.
    Format: Single
    Class: Boolean
    Programmatic Pattern: BooleanP

    TimeConstraint

    The maximum amount of time that each cell in this script is allowed to run for before timing out.
    Format: Single
    Class: Real
    Unit: 1 minute
    Programmatic Pattern: GreaterP[0 Second]

    IgnoreWarnings

    Indicates if the script should stop if a Warning message is thrown.
    Format: Single
    Class: Boolean
    Programmatic Pattern: BooleanP

    TemplateNotebookFile

    The cloud file storing the original notebook used to create this script.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    TemplateNotebookFileLog

    The history of files for the template notebooks, oldest to newest.
    Format: Multiple

    [[1]] Date Changed

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

    [[2]] Notebook

    [[3]] Updating User

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

    CompletedNotebookFile

    The cloud file storing the completed notebook over this script's history.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    CompletedNotebookFileLog

    The history of files for the completed notebooks, oldest to newest.
    Format: Multiple

    [[1]] Date Changed

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

    [[2]] Notebook

    [[3]] Updating User

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

    PendingNotebookFile

    The cloud file storing the pending notebook of this script's future commands.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    PendingNotebookFileLog

    The history of files for the notebook with the pending commands, oldest to newest.
    Format: Multiple

    [[1]] Date Changed

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

    [[2]] Notebook

    [[3]] Updating User

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

    Kernel

    Indicates whether this script should be run locally or in the cloud via Manifold.
    Format: Single
    Class: Expression
    Programmatic Pattern: Objects`Private`Local | Cloud

    DesignOfExperiment

    The design of experiment that the script is based on.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

Troubleshooting

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