Data Management Object Model Reference

JobBase Members

JobBase overview

Public Instance Properties

CollectJobEndOutputVariables Indicate whether should generate script output variables or not, When script output variables was generated, the caller should response to release it
CurrentDirectory Set current directory
CurrentInputDataSource The current input data source
Description Gets/sets the Job description
DisableInteractiveDebug Used to disable interactive debug features like Debug.MsgBox. Interactive debug messages should be disabled when data management scripts are running unattended.
ErrorCount Gets/sets the Error counts for Validation
Errors A string a containing the validation errors seperated by CR/LF
EventHandlers This property returns a collection of output datasource objects
GlobalVariables Gets/Sets the collection of global variables for the job
GlobalVariablesSections Gets/Sets the collection of global variables sections
HasSourceFile Returns true if there is a source file for the script
IgnoreBadCases 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 The current input case numbers
InputDataSources Gets/Sets the Datasource sources collection for a job
IsDebug IsDebug is True if the DMOM is running within the Professional debugger.
IsParsed Returns true if the script has been Parsed
JobEndOutputVariables JobEndScriptProgram reference
Log Gets/Sets the logging object for a job
MetaDataScript Gets/Sets the collection of Meta Data items for a job
Name Gets/sets the job name
OutputCaseNumber The current output case number
OutputDataSources Gets/Sets the Datasource target for a job
Parser This property returns a reference to the current parser
Questions Returns the Question collection for the Job
Source Returns the source for the Script
SourceFile Returns the filename of the script source. This property is only valid if "HasSourceFile" returns true.
SourceFileStartLine The starting line of the script in the Source file
TableDocument Default Table document i.e. the Table document assigned to the first output datasource
TableDocuments Table documents collection, containing one Table document per output datasource
TempDirectory Get or set the temporary directory for the job
TransformedInputMetaData input metadata source filenames
TransformedOutputMetaData Output metadata source filenames
WarningCount Gets/sets the Warning counts for Validation
Warnings A string a containing the validation warnings seperated by CR/LF
WeightEngine Returns a reference to the Weighting component
WeightEngines Return the WeightEngine collection

Public Instance Methods

AddEventScript Adds a new event script to the job
AddMetadataScript Add a new metadata script to the job
AddNewSQL Creates and insert SQL statement, and executes the statement
AttachDebugger Used for attaching a debugger to the script
CloneDocument
CreateMetaDataScript Uses MDM to create a mdd file from the metadata script section
CreateSourceMetadata Creates a dummy mdm document based on the raw DB schema info. This is used when no metadata is specified for the transformation
DropCurrentCase The case/respondent/database row is dropped and not written to designated outputs.
EnvironmentInitOverloaded. Sets the internal environment value
Equals (inherited from Object) 
GetHashCode (inherited from Object) 
GetIncludedFiles Gets a string collection of included files
GetInputCDSCSource returns the input CDSC Source inteface based on the index
GetInputDocument returns the Input MDM Document based on the index
GetOutputCDSCSource returns the output CDSC Source interface based on the index
GetOutputDocument returns the Input MDM Document based on the index
GetType (inherited from Object) 
InputCaseNumber Get the input case number for the specified input source
Load Loading a Job object from a DMScript file.
LoadStringLoading a Job object from a DMScript string.
LoadXml Loading a Job object from a XML file.
Parse Parses the script
ReleaseScriptOutputVariables Caller need to call this method to manually ensure cloned variables will be rleased
Run Executes a DMS script
Save Saving a Job object to a DMScript file.
SaveToString Saving a Job object to a string.
SaveXml Saving a Job object to a XML file.
Stop Description: By calling this method, the transformation will stop imediately, events defined after this event will not be executed
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

See Also

JobBase Class | SPSSMR.Data.Transformations Namespace