Object[Notebook, Job]
A job asset in a lab notebook, which generates one or more computations to run asynchronously on the ECL Manifold.
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, Job, _String]
Pattern Description: The object reference of this object.
Type
Type of this Object.
Format: Single
Class: Expression
Programmatic Pattern: Object[Notebook, Job]
Pattern Description: Object[Notebook, Job]
Notebook
Notebook this object belongs to.
Format: Single
Class: Link
Programmatic Pattern: _Link
Pattern Description: An object of that matches ObjectP[Object[LaboratoryNotebook]].
Relation: Object[LaboratoryNotebook][Objects]
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
Relation: Object[EmeraldCloudFile]
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
Header: New Asset Cloud File
Class: Link
Programmatic Pattern: _Link
Relation: Object[EmeraldCloudFile]
[[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
Archive
Indicates that this job has been archived, and should not appear in a list of recent computations.
Format: Single
Class: Expression
Programmatic Pattern: BooleanP
Status
Status
Current status of this job.
Format: Single
Class: Expression
Programmatic Pattern: Active | Inactive | Aborted
Computation Conditions
JobType
Type describes the conditions under which this job will enqueue new computations. OneTime jobs will enqueue a single computation, and automatically change Status to Inactive once a computation has been enqueued. Scheduled jobs will enqueue computations at one or more ScheduledStartDates, and enqueue additiona repeat computations from these start dates according to ComputationFrequency. Triggered jobs enqueue computations upon creation of objects of specified type(s), or upon changes to tracked type(s), object(s), or field(s).
Format: Multiple
Class: Expression
Programmatic Pattern: OneTime | Scheduled | Triggered
ScheduledStartDates
One or more dates at which this job should add a computation to the Manifold queue.
Format: Multiple
Class: Date
Programmatic Pattern: _?DateObjectQ
ComputationFrequency
For each member of ScheduledStartDates, the frequency at which repeated computations should be enqueued. The first enqueued computation is the date specified in ScheduledStartDates.
Format: Multiple
Class: Real
Unit: 1 hour
Programmatic Pattern: GreaterEqualP[1 Minute]
TrackedTypeChanges
Changes to objects of these type(s) will trigger this job. If TrackedTypeFieldChanges is specified, this job will only be triggered when one of the tracked field(s) is updated. Otherwise, computations will be queued if any fields in objects of the tracked type(s) are updated. The template notebook may refer to triggering objects with $TrackedObjects, which will contain a list of objects of the tracked type(s) which have been changed.
Format: Multiple
Class: Expression
Programmatic Pattern: TypeP[]
TrackedTypeFieldChanges
For each member of TrackedTypeChanges, a list of one or more field(s) to track. This job will enqueue new computations when any of the tracked field(s) in objects of the tracked type(s) are updated. The template notebook may refer to triggering objects with $TrackedObjects, which will contain a list of objects for which one of the tracked field(s) has been updated.
Format: Multiple
Class: Expression
Programmatic Pattern: {_Symbol..}
TrackedObjectChanges
Changes to one or more of these objects will trigger this job. If TrackedObjectFieldChanges is specified, this job will only be triggered when one of the tracked field(s) is updated. Otherwise, computations will be queued if any fields in the tracked object(s) are updated. The template notebook may refer to triggering objects with $TrackedObjects, which will contain a list of the tracked objects which have been updated.
Format: Multiple
Class: Link
Programmatic Pattern: _Link
Relation: Object[]
TrackedObjectFieldChanges
For each member of TrackedObjectChanges, a list of one or more field(s) to track. This job will enqueue new computations when any of the tracked field(s) in the tracked object(s) are updated. The template notebook may refer to triggering objects with $TrackedObjects, which will contain a list of the tracked objects for which one of the tracked field(s) has been updated.
Format: Multiple
Class: Expression
Programmatic Pattern: {_Symbol..}
ComputationSchedule
One or more dates at which this job will add a computation to the Manifold queue. If Type includes Scheduled, then each scheduled start date will appear in this list. If Type includes Repeating or Triggered, an entry will be appended to this list each time a new recurring computation is enqueued.
Format: Multiple
[[1]] Date
Header: Date
Class: Date
Programmatic Pattern: _?DateObjectQ
[[2]] Computation
Header: Computation
Class: Link
Programmatic Pattern: Null|ObjectP[Object[Notebook, Computation]]
Relation: Object[Notebook, Computation]
[[3]] Status
Header: Status
Class: Expression
Programmatic Pattern: Pending|Running|Completed|Error
Task Definition
TemplateNotebookFile
The Mathematica notebook file (.nb) containing the SLL commands to be run by Manifold. This template will be used to generate computations.
Format: Single
Class: Link
Programmatic Pattern: _Link
Relation: Object[EmeraldCloudFile]
HardwareConfiguration
Hardware specifications upon which this task should be run. Standard - Fargate cluster with 8GB RAM. HighRAM - Fargate cluster with 30GB RAM.
Format: Single
Class: Expression
Programmatic Pattern: Standard | HighRAM
EstimatedRunTime
Estimated time which computations created by this job are expected to take. Must be less than MaximumRunTime.
Format: Single
Class: Real
Unit: 1 second
Programmatic Pattern: GreaterP[1 Second]
MaximumRunTime
The maximum run time which computations created by this job are allowed to run for. If run time exceeds this value, the job will end with state TimedOut.
Format: Single
Class: Real
Unit: 1 second
Programmatic Pattern: GreaterP[1 Second]
MaximumThreads
The maximum number of computational threads that computations created by this job may use.
Format: Single
Class: Integer
Programmatic Pattern: GreaterP[0, 1]
Computations
ComputationFinancingTeam
The organization which should finance the computational costs of computations created by this job.
Format: Single
Class: Link
Programmatic Pattern: _Link
Relation: Object[Team, Financing][ManifoldJobs]
Computations
List of Manifold computations created by this job.
Format: Multiple
Class: Link
Programmatic Pattern: _Link
Relation: Object[Notebook, Computation][Job]
Last modified on Mon 26 Sep 2022 15:43:47