QaManagedDocument

In this topic: Hide

 

The QaManagedDocument object represents a Managed Document entry in the CM4D Site database. A Managed Document represents a CM4D Document that exists somewhere in the network file system. Managed Documents are created by managing a new or existing CM4D Document via methods in the QaDoc API object or via the CM4D application interface.

The CM4D API will maintain a list of Managed Documents as loaded by various QaDoc.LoadManagedDocument methods. Managed Documents can be loaded with or without their associated subordinate objects (Event Choices, Report Choices, and Managed Routines). If loaded, this object has methods, as listed below, to obtain their representative objects. Document Manager Privilege is required to modify Managed Documents.

QaManagedDocument - Methods

Methods Description Return Type Input Parameters Remarks
GetEventChoiceByPos(LONG position_); Get report Choice by list position IQaEventChoice*        
GetManagedRoutineByPos(LONG position_); Get Managed Routine by list position IQaManagedRoutine*     
GetReportChoiceByPos(LONG position_); Get Event Choice by list position IQaReportChoice*       
GetEventChoiceCount(void); Count of subordinate Event Choices   LONG     
GetManagedRoutineCount(void); Count of subordinate Managed Routines LONG     
GetReportChoiceCount(void); Count of subordinate Report Choices LONG     

QaManagedDocument - Properties

Property Description Return Type Input Parameters Remarks
CreateTime; Managed Document Create Date/Time  DATE    Get-only
Filename; Document Path and Filename BSTR    Get-only; fully qualified path
ID; Managed Document Unique Identifier BSTR    Get-only
Name; Managed Document Name              BSTR     
SiteID; Site Unique Identifier           BSTR    Get-only
Status; Document Status            eManagedStatus     
Type; Document Type              eManagedAsType     

Managed Document Enumerators

QaManagedDocument Managed Document Status - eManagedStatus

Enumerator Description Help String Input Parameters Remarks
eManagedDisabled = 0,   Managed Document Disabled 0  
eManagedEnabled  = 1   Managed Document Enabled 1  

QaManagedDocument Managed Document Type - eManagedAsType

Enumerator Description Help String Input Parameters Remarks
eManagedAsStaticCM4D = 1,   Static CM4D   1  
eManagedAsCM4Di      = 3,   CM4Di         3  
eManagedAsDynamicCM4D = 4,   Dynamic CM4D  4  
eManagedAsWorkcellCM4D = 5   Workcell CM4D 5  

 

See also, QaManagedDocumentsXML.