# Class CIM_JobSettingData
extends CIM_SettingData

JobSettingData represents job characteristics and scheduling information for a CIM_Job. The settings may be applied to a job handling Service, a JobQueue or other destination to which jobs are submitted, and/or to individual CIM_Jobs. The applicability of the settings are defined using the ElementSettingData relationship. Since the Settings may be defined in several contexts and applied to many types of elements, this class is defined as a subclass of SettingData, versus ScopedSettingData.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_SettingData
|
+--CIM_JobSettingData

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | JobSettingData represents job characteristics and scheduling information for a CIM_Job. The settings may be applied to a job handling Service, a JobQueue or other destination to which jobs are submitted, and/or to individual CIM_Jobs. The applicability of the settings are defined using the ElementSettingData relationship. Since the Settings may be defined in several contexts and applied to many types of elements, this class is defined as a subclass of SettingData, versus ScopedSettingData.
UMLPackagePath | string | CIM::System::Processing
Version | string | 2.45.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
ApplicableMethod | string |
Description | string | This property identifies the method in CIM_Service associated to this SettingData to which the SettingData applies.
ClientRetries | uint32 |
Description | string | A numeric value indicating the number of retries a client may make on ResumeWithInput (or ResumeWithAction) after a failed attempt at ResumeWithInput (or ResumeWithAction). Zero means that the client has no retries. For example, this would be set this to zero if the test will use default inputs if an initial attempt at ResumeWithInput fails.
ModelCorrespondence | string | CIM_DiagnosticServiceJobCapabilities.ClientRetriesMax
DeleteOnCompletion | boolean |
Description | string | Indicates whether or not the Job should be automatically deleted upon completion. Note that the 'completion' of a recurring job is defined by its JobRunTimes or UntilTime properties, OR when the Job is terminated by manual intervention.
ModelCorrespondence | string | CIM_Job.DeleteOnCompletion
Write | boolean | true
InteractiveTimeout | datetime | 00000000001500.000000:000
Description | string | A datetime specification of a time interval to wait for input from a client before it leaves the QueryPending CIM_ConcreteJob.JobState (in favor or either terminating or continuing with defaults). The default is 15 minutes (00000000001500.000000:000).
ModelCorrespondence | string | CIM_DiagnosticServiceJobCapabilities.InteractiveTimeoutMax
OtherRecoveryAction | string |
Description | string | A string describing the recovery action when the instance's RecoveryAction property is 1 ("Other").
ModelCorrespondence | string | CIM_JobSettingData.RecoveryAction, CIM_Job.OtherRecoveryAction
RecoveryAction | uint16 |
Description | string | Describes the recovery setting if the Job does not successfully complete. The possible values are: 0 = "Unknown", meaning it is unknown as to what recovery action to take 1 = "Other", indicating that the recovery action will be specified in the property, OtherRecoveryAction 2 = "Do Not Continue", meaning stop the execution of the job and appropriately update its status 3 = "Continue With Next Job", meaning continue with the next job in the queue 4 = "Re-run Job", indicating that the job should be re-run 5 = "Run Recovery Job", meaning run the Job associated using the RecoveryJob relationship. Note that the recovery Job MUST already be on the queue from which it will run.
ModelCorrespondence | string | CIM_JobSettingData.OtherRecoveryAction, CIM_Job.RecoveryAction
ValueMap | string | 0, 1, 2, 3, 4, 5
Values | string | Unknown, Other, Do Not Continue, Continue With Next Job, Re-run Job, Run Recovery Job
RunInSilentMode | boolean |
Description | string | If CIM_DiagnosticServiceJobCapabilities.SilentModeSupported is TRUE, then this property identifies whether the DiagnosticService runs without interaction with the client. It does if the value is set to TRUE. It does not if the value is set to FALSE. This shall be set to FALSE if CIM_DiagnosticServiceJobCapabilities.SilentModeSupported is FALSE. If this is set to TRUE, then CIM_JobSettingData.DefaultInputValues and CIM_JobSettingData.DefaultInputNames shall be non-empty arrays.
ModelCorrespondence | string | CIM_DiagnosticServiceJobCapabilities.SilentModeSupported, CIM_JobSettingData.DefaultInputValues, CIM_JobSettingData.DefaultInputNames
TerminateOnTimeout | boolean |
Description | string | TerminateOnTimeout is a boolean that defines the behavior when the InteractiveTimeout is exceeded. If this value is TRUE the job will terminate when the InteractiveTimeout is exceeded. If FALSE the job will use DefaultInputs.
ModelCorrespondence | string | CIM_DiagnosticServiceJobCapabilities.DefaultValuesSupported, CIM_JobSettingData.DefaultInputValues, CIM_JobSettingData.DefaultInputNames
TimeBeforeRemoval | datetime |
Description | string | This is the TimeBeforeRemoval value to be applied to a ConcreteJob generated from the method identified in the ApplicableMethod property.
ModelCorrespondence | string | CIM_ConcreteJob.TimeBeforeRemoval
DefaultInputNames | string[] |
ArrayType | string | Indexed
Description | string | DefaultInputNames is an array of strings that define the names for the default inputs that will be requested from clients. The values in this array are the names of the values in the corresponding entry in the DefaultInputValues array. When a job requests input (such as with the DIAG34 standard message), the inputs being requested should be named using the names in the DefaultInputNames property. If this property is non-NULL then CIM_JobSettingData.InteractiveTimeout, CIM_JobSettingData.ClientRetries, CIM_DiagnosticServiceJobCapabilities.ClientRetriesMax should have a values and CIM_DiagnosticServiceJobCapabilities.DefaultValuesSupported should be TRUE. Since the property would only apply to interactive jobs, CIM_DiagnosticTest.Characteristics should contain 3 (Is Interactive). If this property has values, then CIM_JobSettingData.RunInSilentMode and CIM_DiagnosticServiceJobCapabilities.SilentModeSupported may be TRUE. This property may be used when there is an interactive timeout on a CIM_ConcreteJob.ResumeWithInput method call.
ModelCorrespondence | string | CIM_DiagnosticServiceJobCapabilities.DefaultValuesSupported, CIM_JobSettingData.DefaultInputValues, CIM_JobSettingData.InteractiveTimeout, CIM_JobSettingData.ClientRetries, CIM_DiagnosticServiceJobCapabilities.ClientRetriesMax, CIM_DiagnosticTest.Characteristics, CIM_JobSettingData.RunInSilentMode, CIM_DiagnosticServiceJobCapabilities.SilentModeSupported
DefaultInputValues | string[] |
ArrayType | string | Indexed
Description | string | DefaultInputValues is an array of strings that define default values for inputs that will be requested from clients. Each array has a name as defined in the corresponding entry in the DefaultInputNames array. If this property is non-NULL then CIM_JobSettingData.InteractiveTimeout, CIM_JobSettingData.ClientRetries, CIM_DiagnosticServiceJobCapabilities.ClientRetriesMax should have a values and CIM_DiagnosticServiceJobCapabilities.DefaultValuesSupported should be TRUE. Since the property would only apply to interactive jobs, CIM_DiagnosticTest.Characteristics should contain 3 (Is Interactive). If this property has values, then CIM_JobSettingData.RunInSilentMode and CIM_DiagnosticServiceJobCapabilities.SilentModeSupported may be TRUE. This property may be used when there is an interactive timeout on a CIM_ConcreteJob.ResumeWithInput method call.
ModelCorrespondence | string | CIM_DiagnosticServiceJobCapabilities.DefaultValuesSupported, CIM_JobSettingData.DefaultInputNames, CIM_JobSettingData.InteractiveTimeout, CIM_JobSettingData.ClientRetries, CIM_DiagnosticServiceJobCapabilities.ClientRetriesMax, CIM_DiagnosticTest.Characteristics, CIM_JobSettingData.RunInSilentMode, CIM_DiagnosticServiceJobCapabilities.SilentModeSupported

### Inherited Properties

Name | Data Type
--- | ---
Caption | string
ChangeableType | uint16
ConfigurationName | string
Description | string
ElementName | string
Generation | uint64
InstanceID | string
SoID | string
SoOrgID | string
ComponentSetting | string[]

## Class Methods