# Class CIM_ApplicationSystem
extends CIM_System

The ApplicationSystem class represents an application or a software system that supports a particular business function and that can be managed as an independent unit. Such a system can be decomposed into its functional components using the CIM_SoftwareFeature class. The Features for a particular application or software system are located using the CIM_ApplicationSystemSoftwareFeature association. The features are part of the deployment-oriented aspects of the application system. With regard to the application runtime aspects, the ApplicationSystem class also represents the core class of the Application Systems' sub-model which of the application runtime model. Its role in the systems sub-model is a) the root node of the containment hierarchy of the application elements (at runtime) as services, components, sub-systems, etc., b) the place for runtime overview information such as response time or system status, c) runtime control of the entire application (e.g., start/stop), and d) the main entry point to the navigation through and drill-down into the runtime model. The lifetime of an instance of this class is not limited to the application instance it represents. Even if the application is not running, the ApplicationSystem object can report properties that have values (e.g., the name of the application or the current status). Note that it is also possible to define the lifetime of the objects through the lifetime of the application instances. Through ApplicationSystemDependency, non-containment relationships can be expressed.

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

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_System
|
+--CIM_ApplicationSystem

## Direct Known Subclasses

CIM_DatabaseSystem
CIM_J2eeApplication
CIM_J2eeServer

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | The ApplicationSystem class represents an application or a software system that supports a particular business function and that can be managed as an independent unit. Such a system can be decomposed into its functional components using the CIM_SoftwareFeature class. The Features for a particular application or software system are located using the CIM_ApplicationSystemSoftwareFeature association. The features are part of the deployment-oriented aspects of the application system. With regard to the application runtime aspects, the ApplicationSystem class also represents the core class of the Application Systems' sub-model which of the application runtime model. Its role in the systems sub-model is a) the root node of the containment hierarchy of the application elements (at runtime) as services, components, sub-systems, etc., b) the place for runtime overview information such as response time or system status, c) runtime control of the entire application (e.g., start/stop), and d) the main entry point to the navigation through and drill-down into the runtime model. The lifetime of an instance of this class is not limited to the application instance it represents. Even if the application is not running, the ApplicationSystem object can report properties that have values (e.g., the name of the application or the current status). Note that it is also possible to define the lifetime of the objects through the lifetime of the application instances. Through ApplicationSystemDependency, non-containment relationships can be expressed.
UMLPackagePath | string | CIM::Application::DeploymentModel
Version | string | 2.8.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
Distribution | uint16 |
Description | string | Distribution describes how the application system is distributed with respect to its underlying servers. In general, the application system is distributed or local. This property indicates whether the application system is running on one or multiple servers. This can be determined without having to query for associated servers represented by ComputerSystems. Distributed systems also introduce a virtual notion to themselves. Note that a distributed application system is not tangible but virtual. Only its contained local systems can be found as processes or threads, and can therefore be regarded as tangible. The distributed system remains a named, virtual entity, that scopes strongly bound constituents and allows the application to be managed in its entirety. The property is needed to help root cause analysis and operations, especially when these are automated, in order to clearly know that more than one executed application - most likely the local application systems - is affected by the management task. This is particularly true if the contained application systems provide uniform functionality like webserver or application server farms. To express constraints between distributed and local system, this class must be derived and appropriate associations must be defined. This property should not be confused with the Roles[] property defined in System. The latter is reserved for administrator assigned roles.
ValueMap | string | 0, 1, 2, 3..32767, 32768..65535
Values | string | Unknown, Distributed, Local, DMTF Reserved, Vendor Specific
EnabledState | uint16 | 0
Description | string | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down and starting are transient states between enabled and disabled. In contrast to the original version defined higher in the inheritance hierarchy (EnabledLogicalElement), EnabledState is simplified. It reflects the notion of an execution status tailored to applications and represents a summary of the original property. It allows simplified and efficient determination of whether the application is started, stopped or in transition between either of these states. The property does not show any errors. Errors MUST be described in MSE.OperationalStatus, and MAY also be described in logs or other data sources. The mapping to MSE.OperationalStatus is as follows: ExecutionStatus <- MSE.OperationalStatus Unknown <- Unknown, No Contact, Lost Communication, Either of the values <- Other Enabled (started) <- OK, Degraded, Stressed, Predictive Failure, In Service, Dormant, Supporting Entity in Error, Completed Enabled or Disabled (Started or Stopped) <- Error, Non-Recoverable Error Starting <- Starting Shutting Down (Stopping) <- Stopping Disabled (Stopped) <- Stopped, Aborted. The mapping to the original EnabledState property is as follows: Unknown <- Unknown, Not Applicable Either of the values <-Other Enabled <- Enabled, Enabled but Offline, In Test, Deferred, Quiesce Disabled <- Disabled ShuttingDown <- ShuttingDown Starting <- Starting.
ModelCorrespondence | string | CIM_EnabledLogicalElement.OtherEnabledState
Override | string | EnabledState
ValueMap | string | 0, 2, 3, 4, 10, 11..32767, 32768..65535
Values | string | Unknown, Enabled, Disabled, Shutting Down, Starting, DMTF Reserved, Vendor Reserved
LastServingStatusUpdate | datetime |
Description | string | The point in time at which the ServingStatus property was last updated.
ModelCorrespondence | string | CIM_ApplicationSystem.ServingStatus
ServingStatus | uint16 |
Description | string | ServingStatus is a summary of MSE.OperationalStatus. It allows simplified and efficient determination of whether the application is providing service or has stopped doing so for various reasons like errors, shutdown, abort, etc. Therefore, no transitional values are provided. The property does not show any errors. Errors MUST be described in MSE.OperationalStatus, and MAY also be described in logs or other data sources. Therefore, ServingStatus is suited to provide summary information for monitoring purposes and service level management. The mapping to MSE.OperationalStatus is as follows: ServingStatus <- MSE.OperationalStatus Unknown <- Unknown, No Contact, Lost Communication Either of the values <- Other Serving <- OK, Degraded, Stressed, Predictive Failure, Completed Not Serving <- Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, Aborted, Dormant, Supporting Entity in Error.
ModelCorrespondence | string | CIM_ManagedSystemElement.OperationalStatus
ValueMap | string | 0, 1, 2, 5..4096, 4097..65535
Values | string | Unknown, Serving, Not Serving, DMTF Reserved, Vendor Specific
StartupTime | datetime |
Description | string | The point in time (date and time) when the application system was last started. If the application system is in a state other the state Enabled (i.e., started and running) this value is not meaningful and the property value MUST be set to all zeros. StartupTime is preferably the point in time when the application is available to the user. Instead, if the provider and/or the instrumentation cannot determine the point in time the application becomes available, the point in time can be used at which the underlying operating system reports successful launch of the application. If no value can be provided the property value MUST be set to all zeros.

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_System
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_System
NameFormat | string | CIM_System
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_System
PrimaryOwnerName | string | CIM_System
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Status | string | CIM_ManagedSystemElement
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
IdentifyingDescriptions | string[] | CIM_System
OperationalStatus | uint16[] | CIM_ManagedSystemElement
OtherIdentifyingInfo | string[] | CIM_System
Roles | string[] | CIM_System
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### StartApplication (uint16)

#### Method Qualifiers (StartApplication)

Name | Data Type | Value
--- | --- | ---
Description | string | StartApplication() starts an application system. The ApplicationSystem object must have been created prior to the invocation of this method. It is up to the implementation of the method to define which of the contained or dependent sub-elements are to be started and in which order their startup may occur. Since a system startup can extend over long periods of time (several minutes is not unusual for complex distributed applications), the method can be implemented synchronously or asynchronously. In both cases EnabledState and RequestedState reflect the current state of the application and the desired state (Enabled) respectively. The exact nature of the errors during the startup cannot be determined in the asynchronous case. The method must return one of the following values: Unspecified Error: If no return code can be identified Completed with No Error: successful invocation Start Already in Progress: application still being started Failed:Indicates errors upon execution.
ModelCorrespondence | string | CIM_ApplicationSystem.EnabledState, CIM_ApplicationSystem.RequestedState
ValueMap | string | 0, 1, 2, 3, 4..4096, 4097..32767, 32768..65535
Values | string | Unspecified Error, Completed with No Error, Start Already in Progress, Failed, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (StartApplication)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value

#### StopApplication (uint16)

#### Method Qualifiers (StopApplication)

Name | Data Type | Value
--- | --- | ---
Description | string | StopApplication() allows for stopping/shutting down an application system. It is up to the implementation of the method to define which of the contained or dependent sub-elements are to be stopped and in which order their stop has to occur. Since a system shutdown can last considerable time (several minutes is not necessarily unusual for complex distributed applications), the method can be implemented synchronously or asynchronously. In both cases EnabledState and RequestedState reflect the current state of the application and the desired state (Disabled) respectively. The exact nature of the errors during the stop cannot be determined in the asynchronous case. The method must return one of the following: Unspecified Error: If no return code can be identified Completed with No Error: successful invocation Stop Already in Process: application is shutting down Failed: Indicates errors upon execution.
ModelCorrespondence | string | CIM_ApplicationSystem.EnabledState, CIM_ApplicationSystem.RequestedState
ValueMap | string | 0, 1, 2, 3, 4..4096, 4097..32767, 32768..65535
Values | string | Unspecified Error, Completed with No Error, Stop Already in Process, Failed, DMTF Reserved, Method Reserved, Vendor Specific

#### Method Parameters (StopApplication)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement