HS.HC.SubTaskMgr.JobRecord
persistent class HS.HC.SubTaskMgr.JobRecord extends %Library.Persistent, HS.REST.Model.ISerializable
SQL Table Name: HS_HC_SubTaskMgr.JobRecord
Keeps track of jobs that have been requested to run async, along with metadataProperty Inventory
- ClassName
- EndTime
- Error
- ErrorAsString
- Ignore
- JobId
- JobKey
- LastErrorLogTime
- MethodName
- Namespace
- Restart
- StartTime
- State
- Status
- WrittenOutput
Method Inventory
Parameters
parameter %JSONDEFAULTMAPPING = 0;
%JSONDEFAULTMAPPING may be set to 0 (default is 1) to suppress creation of the default JSON mapping for the object.
parameter DEFAULTGLOBAL = ^|"HSSYS"|HS.HC.SubTaskMgr.JobRecord;
Override DEFAULTGLOBAL from %Library.Persistent
Properties
property ClassName as %Dictionary.Classname [ Required ];
Class name
Property methods: ClassNameGet(), ClassNameGetStored(), ClassNameIsValid(), ClassNameSet()
property EndTime as %TimeStamp;
End time of job - when job completeS or errors out
Property methods: EndTimeDisplayToLogical(), EndTimeGet(), EndTimeGetStored(), EndTimeIsValid(), EndTimeLogicalToDisplay(), EndTimeLogicalToXSD(), EndTimeNormalize(), EndTimeOdbcToLogical(), EndTimeSet(), EndTimeXSDToLogical()
property Error as %Status [ InitialExpression = $$$OK , Required ];
Error Status, logs any errors thrown
Property methods: ErrorGet(), ErrorGetStored(), ErrorIsValid(), ErrorLogicalToOdbc(), ErrorLogicalToXSD(), ErrorSet(), ErrorXSDToLogical()
property ErrorAsString as %String [ Calculated ];
Property methods: ErrorAsStringCompute(), ErrorAsStringDisplayToLogical(), ErrorAsStringGet(), ErrorAsStringIsValid(), ErrorAsStringLogicalToDisplay(), ErrorAsStringLogicalToOdbc(), ErrorAsStringNormalize(), ErrorAsStringSQLCompute()
property Ignore as %Boolean [ InitialExpression = 0 ];
Boolean flag to skip step
Property methods: IgnoreDisplayToLogical(), IgnoreGet(), IgnoreGetStored(), IgnoreIsValid(), IgnoreLogicalToDisplay(), IgnoreNormalize(), IgnoreSet()
property JobId as %Integer [ InitialExpression = $Job , Required , ReadOnly ];
Id of the job.
Property methods: JobIdDisplayToLogical(), JobIdGet(), JobIdGetStored(), JobIdIsValid(), JobIdLogicalToDisplay(), JobIdNormalize(), JobIdXSDToLogical()
property JobKey as %String [ Calculated ];
Unique identifier for a job.
Property methods: JobKeyDisplayToLogical(), JobKeyIsValid(), JobKeyLogicalToDisplay(), JobKeyLogicalToOdbc(), JobKeyNormalize()
property LastErrorLogTime as %TimeStamp;
Property methods: LastErrorLogTimeDisplayToLogical(), LastErrorLogTimeGet(), LastErrorLogTimeGetStored(), LastErrorLogTimeIsValid(), LastErrorLogTimeLogicalToDisplay(), LastErrorLogTimeLogicalToXSD(), LastErrorLogTimeNormalize(), LastErrorLogTimeOdbcToLogical(), LastErrorLogTimeSet(), LastErrorLogTimeXSDToLogical()
property MethodName as %Dictionary.Identifier [ Required ];
Method name
Property methods: MethodNameGet(), MethodNameGetStored(), MethodNameIsValid(), MethodNameSet()
property Namespace as HS.HC.DataType.NamespaceName [ InitialExpression = $Namespace , Required ];
Namespace
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceGetStored(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSet()
property Restart as %Boolean [ Transient ];
Transient property used to set the Status of a job to "pending" by UpdateItem in HS.HC.SubTaskMgr.API
Property methods: RestartDisplayToLogical(), RestartGet(), RestartIsValid(), RestartLogicalToDisplay(), RestartNormalize(), RestartSet()
property StartTime as %TimeStamp;
Start time of job - when it starts running
Property methods: StartTimeDisplayToLogical(), StartTimeGet(), StartTimeGetStored(), StartTimeIsValid(), StartTimeLogicalToDisplay(), StartTimeLogicalToXSD(), StartTimeNormalize(), StartTimeOdbcToLogical(), StartTimeSet(), StartTimeXSDToLogical()
property State as %Stream.GlobalCharacter;
State - current state of running jobs
Property methods: StateDelete(), StateGet(), StateGetObject(), StateGetObjectId(), StateGetStored(), StateGetSwizzled(), StateIsValid(), StateNewObject(), StateOid(), StateOpen(), StateSet(), StateSetObject(), StateSetObjectId(), StateUnSwizzle()
property Status as %String (VALUELIST = ",pending,running,complete,error") [ InitialExpression = "pending" , Required ];
Status - pending, running, complete, error
Property methods: StatusDisplayToLogical(), StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property WrittenOutput as %Stream.GlobalCharacter;
Stores output of any write commands during the execution of the background job - IO redirection to collect
Property methods: WrittenOutputDelete(), WrittenOutputGet(), WrittenOutputGetObject(), WrittenOutputGetObjectId(), WrittenOutputGetStored(), WrittenOutputGetSwizzled(), WrittenOutputIsValid(), WrittenOutputNewObject(), WrittenOutputOid(), WrittenOutputOpen(), WrittenOutputSet(), WrittenOutputSetObject(), WrittenOutputSetObjectId(), WrittenOutputUnSwizzle()
Methods
method JobKeyGet() as %String
Indexes
index ($JobRecord on ) [Extent, Type = bitmap];
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (JobIdIdx on JobId);
Unique Indexing on JobId
Index methods: JobIdIdxExists()
index (MethodCallIdx on Namespace,ClassName,MethodName) [Unique];
Unique Indexing on (Namespace, ClassName, MethodName)
Index methods: MethodCallIdxCheck(), MethodCallIdxCheckUnique(), MethodCallIdxDelete(), MethodCallIdxExists(), MethodCallIdxOpen(), MethodCallIdxSQLCheckUnique(), MethodCallIdxSQLExists(), MethodCallIdxSQLFindPKeyByConstraint(), MethodCallIdxSQLFindRowIDByConstraint()
index (StatusIdx on Status) [Type = bitmap];
Bitmap Indexing on Status
Triggers
trigger ValidateMethod (BEFORE event INSERT);
Check the following before inserting any step:
Method has no return type
Method has no arguments
Method exists in namespace
Inherited Members
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InitExtentData()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %JSONExport()
- %JSONExportToStream()
- %JSONExportToString()
- %JSONImport()
- %JSONMappingInfo()
- %JSONNew()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- JSONExport()
- JSONExportToStream()
- JSONExportToString()
- JSONImport()
Storage
Storage Model: Storage (HS.HC.SubTaskMgr.JobRecord)
^|"HSSYS"|HS.HC.SubTaskMgr.JobRecordD(ID) |
= | %%CLASSNAME
JobId
Namespace
ClassName
MethodName
Status
Ignore
WrittenOutput
State
StartTime
EndTime
Error
LastErrorLogTime
|