Logo
Introduction
Application Overview
Data Model
Mgmt User Interface
Components
Advanced
Reference
   
CLASSES, METHODS and PERMISSIONS

Doc   DocLinkType      DocType      PropertyDef      RestrictedPropertyDef
Group      GroupFilter      GroupPropertyDef      GroupType

Doc Class

Library: CCDocumentMgmt.Lib
Program ID: CCDocumentMgmtLib.Doc
Class ID: Doc

Method

Permissions
Parameters
Notes
.AssignToGroup AssignDocumentsToGroup AppID
SessionID
GroupID
DocumentID
For DocumentID see Doc.Create

For GroupID see Group.Create
.Browse ViewDocuments
or
ViewAllDocuments
AppID
SessionID
Filter
RetrieveLevels
SortField
StartRow
EndRow
ReturnPropDefXML
Each criterion in the GroupType is formatted in the following manner: {PropertyName} = `Value'.  Retrieve levels are defined as follows:

-1 returns all properties

0 returns header properties (only in DMDocument database table)

>0 returns some or all user defined properties

-1 entered in the StartRow or the EndRow field returns all rows.
.BrowseByGroupID View Documents AppID
SessionID
GroupID
For GroupID see Group.Create
.Create AddDocuments AppID
SessionID
DocType
For DocTypeID see DocType.Create
.Delete DeleteDocuments AppID
SessionID
DocumentID
For DocumentID see Doc.Create
.GetRelatedDocuments ViewDocuments
or
ViewAllDocuments
AppID
SessionID
DocumentID
For DocumentID see Doc.Create
.ImportCCFormat None AppID
SessionID
XMLDocumentMgmtAction
ApplyResults
AllowPartialUpdate

Determines if changes are made to the database.

If ApplyResults is true, the changes are made to the database.

If false, no changes are made to the database.

If AllowPartialUpdate is true, a fatal error does not abort the entire operation, but only the current document.

If false, any fatal error aborts the entire upload process and produces an exception report.

Use the list of errors in the return as the master list of errors and error codes.

.RelateDocument ViewDocuments
or
ViewAllDocuments
AppID
SessionID
DocumentID
LinktoDocumentID
LinkTypeID

Uses DocumentID of the document you are linking.

For DocumentID see Doc.Create

For LinkTypeID see DocLinkType.Create

<AssignResponse>True</AssignResponse>

.RemoveFromGroup EditGroups AppID
SessionID
GroupID
DocumentID
For DocumentID see Doc.Create

For GroupID see Group.Create

.RemoveRelateDocument

RelateDocuments AppID
SessionID
DocumentID
LinkToDocument
LinkTypeID
For DocumentID see Doc.Create

For LinkTypeID see DocLinkType.Create
.RetrieveRecordCount   AppID
SessionID
Filter

   
.Retrieve View Documents
or
ViewAllDocuments
AppID
SessionID
DocumentID
For DocumentID see Doc.Create

.Save

EditDocuments

AppID
SessionID
XML
For DocumentID see Doc.Create