BMC Atrium CMDB
Data Model

Class BMC.CORE:BMC_Document

BMC.CORE:BMC_BaseElement

  |
  +--BMC.CORE:BMC_Document
Direct Known Subclasses:
BMC.CORE:BMC_Contract, BMC.CORE:BMC_ContractLine

Class that stores all documents related to an IT infrastructure in the CMDB. It categorizes any type of documented information in your IT environment, and includes attributes that specify various properties of the documentation. It also includes an attachment field for storing documentation. This class is included in the Common Data Model because ITIL defines documentation as one of the six elements that compose a CMDB. Therefore, if you have documents that are critical to your configuration and you want to track them as CIs, this class enables you to do so. For example, you can use the BMC_Document class to include a disaster recovery plan in an impact model. As another example, IT or business managers might need planning reports that detail crucial steps involved in establishing change and configuration processes in their enterprise. The BMC_Document class can store these reports, as well as the author's name and the creation date. Additionally, the manager can attach the report using the DocumentAttachment attribute. This class has no corresponding DMTF CIM class.

Properties

Name Value Scope Options
namespaceName BMC.CORE None None
classId BMC_DOCUMENT None None
FormName BMC.CORE:BMC_Document None None
Exposure usedVisible TOSUBCLASS=false OVERRIDABLE=false

Attributes Summary

Data type Name and description
character Author
Attribute that specifies the name of the person who wrote the document.
enumeration ContractLifeCycle
This is intended to keep track of the life cycle state of class and subclasses such as BMC_Contract - ADD Description
attachment DocumentAttachment
Attribute the enables you to store a document in the BMC Atrium CMDB by typing the file name in the field.
dateTime DocumentDate
Attribute that specifies the date and time the document was created.
character DocumentPurpose
Specifies the purpose or the content of the document file, for example, DeploymentModel or FunctionalModel
character DocumentSize
Attribute that specifies the size of the document (in bytes).
enumeration DocumentStatus
Attribute that specifies the status of the current document. Values are Draft (10), Pre-Released (20), Released (30), and Obsolete (40). No default value.
character DocumentType
Attribute that specifies the format of the document file (for example, Microsoft Word, PDF, or text).
dateTime EndDate
Attribute that specifies the end date of a contract that establishes a specific agreement between a provider and a customer.
dateTime ExecutionDate
Specifies the date on which the contract is signed by the provider and consumer of the service.
character FileName
Attribute that specifies the name of the document file. If the document is not attached to the instance, you can include the full path to the file.
character Keywords
Attribute that specifies a set of words that convey the subject of the document and allow others to search for it.
character Locale
Attribute that specifies the geographical area where the document is localized. Value should be a locale code (for example, en_US
dateTime StartDate
Attribute that specifies the start date of a contract that establishes a specific agreement between a provider and a customer.
dateTime TerminationDate
Specifies the date on which the contract or contract line is to be terminated as per the conditions in the termination clause of the contract.


Attributes inherited from class BMC.CORE:BMC_BaseElement
AccountID, AssignedTo, AttributeDataSourceList, Availability, Category, CheckSumValue, CITag, ClassId, CMDBRowLevelSecurity, CMDBWriteSecurity, Confidentiality, CreateDate, DatasetId, Description, FailedAutomaticIdentification, History, ImpactComputationModel, InstanceId, Integrity, isCloud, Item, LastModifiedBy, LastScanDate, LicensingType, ManufacturerName, MarkAsDeleted, MarketVersion, Model, ModifiedDate, Name, NameFormat, Notes, OwnerContact, OwnerName, ParentCITag, Priority, ReconciliationIdentity, ReferenceInstance, RequestId, SerialNumber, ShortDescription, Submitter, Supported, SystemEnvironment, TokenFormat, TokenId, Type, VersionNumber

Attribute Detail

Author

character Author
Attribute that specifies the name of the person who wrote the document.

Name Value Scope Options
FieldId 530021100
None None
attributeId OS00C04FA081BAYn3hQw5aQ_GgMw0A
None None
namespaceName BMC.CORE
None None
MaxLen 254
None None

ContractLifeCycle

enumeration
ContractLifeCycle
This is intended to keep track of the life cycle state of class and subclasses such as BMC_Contract - ADD Description

Name Value Scope Options
FieldId 530059400
None None
attributeId OS005056B5170D_uYmSg2F72Wwi4UA
None None
namespaceName BMC.CORE
None None
ValueMap 0; 1; 10; 20; 30; 40; 50; 60; 70; 80
None None
Values Other; Unknown; Draft; InNegotiation; Canceled; Executed; Active; Expired; Hold; Terminated
None TRANSLATABLE= true

DocumentAttachment

attachment
DocumentAttachment
Attribute the enables you to store a document in the BMC Atrium CMDB by typing the file name in the field.

Name Value Scope Options
FieldId 530021600
None None
attributeId OS00C04FA081BAKYDhQwaX9KGgOQ0A
None None
namespaceName BMC.CORE
None None

DocumentDate

dateTime
DocumentDate
Attribute that specifies the date and time the document was created.

Name Value Scope Options
FieldId 530021200
None None
attributeId OS00C04FA081BA[33hQwQP5BGgNA0A
None None
namespaceName BMC.CORE
None None

DocumentPurpose

character
DocumentPurpose
Specifies the purpose or the content of the document file, for example, DeploymentModel or FunctionalModel

Name Value Scope Options
FieldId 530067420
None None
attributeId OS005056B5170D21guTADhClYAEp8A
None None
namespaceName BMC.CORE
None None
MaxLen 254
None None

DocumentSize

character
DocumentSize
Attribute that specifies the size of the document (in bytes).

Name Value Scope Options
FieldId 530034200
None None
attributeId OS00C04FA081BAckDKRQzojIggWFMG
None None
namespaceName BMC.CORE
None None
MaxLen 255
None None

DocumentStatus

enumeration
DocumentStatus
Attribute that specifies the status of the current document. Values are Draft (10), Pre-Released (20), Released (30), and Obsolete (40). No default value.

Name Value Scope Options
FieldId 530021000
None None
attributeId OS00C04FA081BAq3zhQw6Ns8GgMQ0A
None None
namespaceName BMC.CORE
None None
ValueMap 10; 20; 30; 40
None None
Values Draft; Pre-Released; Released; Obsolete
None TRANSLATABLE= true

DocumentType

character
DocumentType
Attribute that specifies the format of the document file (for example, Microsoft Word, PDF, or text).

Name Value Scope Options
FieldId 530020900
None None
attributeId OS00C04FA081BAonnhQwDQExGgMA0A
None None
namespaceName BMC.CORE
None None
MaxLen 254
None None

EndDate

dateTime
EndDate
Attribute that specifies the end date of a contract that establishes a specific agreement between a provider and a customer.

Name Value Scope Options
FieldId 530048700
None None
attributeId OS00C04FA081BAewZ0SAivlWRw5GAA
None None
namespaceName BMC.CORE
None None

ExecutionDate

dateTime
ExecutionDate
Specifies the date on which the contract is signed by the provider and consumer of the service.

Name Value Scope Options
FieldId 530065500
None None
attributeId OS005056B5170DH2khTAWJgcLgnFEA
None None
namespaceName BMC.CORE
None None

FileName

character
FileName
Attribute that specifies the name of the document file. If the document is not attached to the instance, you can include the full path to the file.

Name Value Scope Options
FieldId 530021400
None None
attributeId OS00C04FA081BA837hQw7cVFGgNw0A
None None
namespaceName BMC.CORE
None None
MaxLen 254
None None

Keywords

character
Keywords
Attribute that specifies a set of words that convey the subject of the document and allow others to search for it.

Name Value Scope Options
FieldId 530021300
None None
attributeId OS00C04FA081BAw37hQwrQpFGgNg0A
None None
namespaceName BMC.CORE
None None
MaxLen 254
None None

Locale

character
Locale
Attribute that specifies the geographical area where the document is localized. Value should be a locale code (for example, en_US

Name Value Scope Options
FieldId 160
None None
attributeId OS00C04FA081BAonFAQwDQExGgMA0A
None None
namespaceName BMC.CORE
None None
MaxLen 254
None None

StartDate

dateTime
StartDate
Attribute that specifies the start date of a contract that establishes a specific agreement between a provider and a customer.

Name Value Scope Options
FieldId 530048600
None None
attributeId OS00C04FA081BAWf1zSAXkszRwo2AA
None None
namespaceName BMC.CORE
None None

TerminationDate

dateTime
TerminationDate
Specifies the date on which the contract or contract line is to be terminated as per the conditions in the termination clause of the contract.

Name Value Scope Options
FieldId 530065600
None None
attributeId OS005056B5170DPmkhTA#g8dLgolEA
None None
namespaceName BMC.CORE
None None

Inherited Relationship Classes

Name Superclass Reference CI Class

BMC Atrium CMDB
Data Model

Copyright 2007 BMC Software, Inc. All rights reserved.