Data Management Object Model Reference

Job_Old Members

Job_Old overview

Public Instance Constructors

Job_Old Constructor Constructor for Job object. Construction of DMOM objects and initialization of all member variables.

Public Instance Properties

CollectJobEndOutputVariables (inherited from JobBase) Indicate whether should generate script output variables or not, When script output variables was generated, the caller should response to release it
CurrentDirectory (inherited from JobBase) Set current directory
CurrentInputDataSource (inherited from JobBase) The current input data source
Description (inherited from JobBase) Gets/sets the Job description
DisableInteractiveDebug (inherited from JobBase) Used to disable interactive debug features like Debug.MsgBox. Interactive debug messages should be disabled when data management scripts are running unattended.
ErrorCount (inherited from JobBase) Gets/sets the Error counts for Validation
Errors (inherited from JobBase) A string a containing the validation errors seperated by CR/LF
EventHandlers Gets/Sets the collection of event handlers for the job
GlobalVariables (inherited from JobBase) Gets/Sets the collection of global variables for the job
GlobalVariablesSections (inherited from JobBase) Gets/Sets the collection of global variables sections
HasSourceFile (inherited from JobBase) Returns true if there is a source file for the script
IgnoreBadCases (inherited from JobBase) Setting this to true enables a transformation to continue despite writing of a record failed Setting this to false would make the transformation stop when a write fails Default value is true
InputCaseNumbers (inherited from JobBase) The current input case numbers
InputDataSources (inherited from JobBase) Gets/Sets the Datasource sources collection for a job
IsDebug (inherited from JobBase) IsDebug is True if the DMOM is running within the Professional debugger.
IsParsed (inherited from JobBase) Returns true if the script has been Parsed
JobEndOutputVariables (inherited from JobBase) JobEndScriptProgram reference
Log (inherited from JobBase) Gets/Sets the logging object for a job
MetaDataScript (inherited from JobBase) Gets/Sets the collection of Meta Data items for a job
Name (inherited from JobBase) Gets/sets the job name
OutputCaseNumber (inherited from JobBase) The current output case number
OutputDataSources (inherited from JobBase) Gets/Sets the Datasource target for a job
Parser (inherited from JobBase) This property returns a reference to the current parser
Questions (inherited from JobBase) Returns the Question collection for the Job
Source (inherited from JobBase) Returns the source for the Script
SourceFile (inherited from JobBase) Returns the filename of the script source. This property is only valid if "HasSourceFile" returns true.
SourceFileStartLine (inherited from JobBase) The starting line of the script in the Source file
TableDocument (inherited from JobBase) Default Table document i.e. the Table document assigned to the first output datasource
TableDocuments (inherited from JobBase) Table documents collection, containing one Table document per output datasource
TempDirectory (inherited from JobBase) Get or set the temporary directory for the job
TransformationContents Sets/gets the metadata contents of the transformation Also detect the provider type and provider sub type used. Possible values are enumerated in TransformationContents
TransformedInputMetaData (inherited from JobBase) input metadata source filenames
TransformedOutputMetaData (inherited from JobBase) Output metadata source filenames
WarningCount (inherited from JobBase) Gets/sets the Warning counts for Validation
Warnings (inherited from JobBase) A string a containing the validation warnings seperated by CR/LF
WeightEngine (inherited from JobBase) Returns a reference to the Weighting component
WeightEngines (inherited from JobBase) Return the WeightEngine collection

Public Instance Methods

AddEventScript (inherited from JobBase) Adds a new event script to the job
AddMetadataScript (inherited from JobBase) Add a new metadata script to the job
AddNewSQL (inherited from JobBase) Creates and insert SQL statement, and executes the statement
AttachDebugger (inherited from JobBase) Used for attaching a debugger to the script
CloneDocument (inherited from JobBase)
CreateMetaDataScript (inherited from JobBase) Uses MDM to create a mdd file from the metadata script section
CreateSourceMetadata (inherited from JobBase) Creates a dummy mdm document based on the raw DB schema info. This is used when no metadata is specified for the transformation
DropCurrentCase (inherited from JobBase) The case/respondent/database row is dropped and not written to designated outputs.
EnvironmentClose Close the data manager framework environment. mrOleDb connections are closed.
EnvironmentInitOverloaded. Initializes the data manager framework environment including the mrScript engine environment. Depending on the transformation content metadata transformations are done here. The input datasource is opened.
EnvironmentInit (inherited from JobBase)Overloaded. Sets the internal environment value
Equals (inherited from Object) 
GetHashCode (inherited from Object) 
GetIncludedFiles (inherited from JobBase) Gets a string collection of included files
GetInputCDSCSource (inherited from JobBase) returns the input CDSC Source inteface based on the index
GetInputDocument (inherited from JobBase) returns the Input MDM Document based on the index
GetOutputCDSCSource (inherited from JobBase) returns the output CDSC Source interface based on the index
GetOutputDocument (inherited from JobBase) returns the Input MDM Document based on the index
GetType (inherited from Object) 
InputCaseNumber (inherited from JobBase) Get the input case number for the specified input source
Load (inherited from JobBase) Loading a Job object from a DMScript file.
LoadString (inherited from JobBase)Loading a Job object from a DMScript string.
LoadXml (inherited from JobBase) Loading a Job object from a XML file.
Parse (inherited from JobBase) Parses the script
ReleaseScriptOutputVariables (inherited from JobBase) Caller need to call this method to manually ensure cloned variables will be rleased
Run Executes the currently loaded DMScript. FUTURE: The object model representing the loaded script is passed onto the runner components that host the process and executes the transformation within a thread pool.
Save (inherited from JobBase) Saving a Job object to a DMScript file.
SaveToString (inherited from JobBase) Saving a Job object to a string.
SaveXml (inherited from JobBase) Saving a Job object to a XML file.
Stop Stops the excution of the job
ToString (inherited from Object) 
Validate Validates the different Script sections of the currently open DMScript file. A test connection to every datasource(including those referenced in global variable definitions) with appropriate security and access mode will be made and errors reported. All errors encountered + the Validate summary are returned in the stringarray When Validate returns the client should query the properties WarningCount and ErrorCount The client should abandon the transformation if ErrorCount>0 The client may proceed with the transformation if ErrorCount=0 and WarningCount>0

Public Instance Events

AfterJobEnd After Job End Event handler, is fired at the very end of the transformation after the environment has been closed (all connections are closed and Direct SQL on outputs are executed)
BadCase Bad Case Event handler, is fired whenever a new case has been read and writing failed
BeforeJobStart Before Job Start Event handler, is fired at the very beginning of the transformation
JobEnd Job End Event handler, is fired at the end of the transformation but before the environment is closed
JobStart Job Start Event handler, is fired after the environment has been initialized
JobStatus JobStatus Event handler, is fired multiple times during the initial metadata transformation
NextCase Next Case Event handler, is fired whenever a new case has been read but before it's written to the output

See Also

Job_Old Class | SPSSMR.Data.Transformations Namespace