IDocument Properties |
The IDocument type exposes the following members.
Name | Description | |
---|---|---|
![]() | ActiveLinks | ActiveLinks - Number of active links to documents, projects, Urls, appointments, sales, contacts, persons, selections |
![]() ![]() | ActivityLinks | The ActivityLinks attached to this document |
![]() ![]() | application | Application used for editing this document. Not used.
You may start other applications from CRM 5, and create documents with these other applications. For a document created in an external application, this property returns a reference to the application needed to open the document |
![]() ![]() | ArchiveProvider | Archive system where the document content is stored.
You may start other applications from CRM 5, and create “documents” with these other applications. For a document created in an external application, this property returns a reference to the application needed to open the document, 0 is the SO_arc document plugin. Used with the new document plugin |
![]() ![]() | ArchiveProviderName | Archive provider name. Which system the document content is stored in.
You may start other applications from CRM 5, and create “documents” with these other applications. For a document created in an external application, this property returns a reference to the application needed to open the document, 0 is the SO_arc document plugin. Used with the new document plugin |
![]() ![]() | Associate | Author/owner of document
The document owner - in most cases this is the associate who created the document. The associate.loginname is used in the path to open the document (SO_arc\LoginName<Timeperiod><FileName> |
![]() ![]() | Attention | Attention
Attention is shown in the Document dialog as the person the document is written to. This must be a contact person registered for the current contact, but it does not mean however that a contact person is required in order to write a document |
![]() | AutoSaveOnChangeIdentity | Should the model save on IdentityChanged? |
![]() | AutoSaveOnFlush | Should the model save on flush cache? |
![]() ![]() | Changed | has record been changed since read?
If the document has modified, this will return false |
![]() ![]() | Completed | Is Completed
A document that has not yet been completed will always be displayed in the owning associate’s diary. If the “do by” date has passed, it will appear in the Checklist even if it had a time stamp. See the database manual for more information regarding appointments shown in the Checklist or the Diary |
![]() ![]() | Contact | Contact this document refers to.
The contact the document is written to. The document record is saved under this company in the CRM 5 client |
![]() ![]() | CreatedAssociate | The user that created the object
The owner of the document, the associate whose checklist the document is in shown in if the document is not set to completed |
![]() ![]() | CreatedDate | The date the object was saved to the database.
The date and time the appointment was first created |
![]() ![]() | Description | Description - keywords
Displayed in the Document dialog as keywords, just below subject. Used for giving a more complete description of the content of the document. This field is FreeText word indexed, so you find it using the FreeText search |
![]() ![]() | Done | Done date
The date + start time this document was set as completed. By default, this will be the same as the CreatedDate, but in CRM5 you have the possibility to set a document as not completed. In those cases, the done date would differ from the CreatedDate |
![]() | ExternalFieldChanged | Have external fields been changed? If set then the model will save even if no internal fields have been modified. |
![]() | ExtRef | External Reference - identity in document archive system. |
![]() ![]() | filename | Filename - does not include path
The documents filename - as it is saved in the document archive. The filename is used in the path to open the document (SO_arc<SOAssociate.LoginName><Timeperiod><FileName> |
![]() ![]() | ForeignKey | ForeignKey
Get the foreign key values for this document. |
![]() ![]() | FullPath | FullPath - path and filename
FullPath - path and filename for the document object |
![]() ![]() | Group | Primary usergroup of the owning associate - set implicitly when Associate is set |
![]() ![]() | Header | Title of document. Changing this does not change the document after the document has been created.
The subject line of the document, as shown in the Document dialog |
![]() ![]() | Identity | The primary key on the primary table. Is zero for new objects. Is set when an object is saved.
The document’s identity is its unique internal identity. Note that all document records will have a corresponding appointment_id, See the database manual for more information regarding appointments and documents |
![]() ![]() | IsAvailable | is record available in db?
Checks if the record is available in the database. It’s useful to check if a document actually exists before adding new properties to it |
![]() | IsFavourite | Add/Remove this document from my favourites |
![]() ![]() | IsRequiredFilled | Are all the required fields filled out? Can we save the record?
Checks if all properties that are required in this model is filled |
![]() ![]() | IsValid | does the record exist?
To save time, we don’t load a record into buffer before one of its properties is asked for. This checks if the requested record is available in buffer |
![]() ![]() | OurRef | Our Reference - this is usually set auto-generated.
Our reference as shown in the Document dialog. The field is searchable using Freetext search |
![]() ![]() | Person | Person this document refers to.
The same person as returned as a string in the Attention property, but here it’s returned as a SOPerson object. This must be a contact person registered for the current contact, but this does not mean that a contact person is required in order to write a document |
![]() ![]() | Private | Visible for who? 0=public,1=private,2=group
The private flag specifies who is allowed to see this document |
![]() ![]() | PrivateToGroup | The group this document is visible for when Private=Group
The private flag specifies who is allowed to see this document |
![]() ![]() | Project | Project this document refers to
A document may also be connected to a project, so you see the document both on the company card, and on the project card. This does not mean that a project is required |
![]() ![]() | PublishType | Publish type for this document |
![]() ![]() | Reference | External Reference - can be used for an external identifier like an e-mail Message-id
Reference will be used for implementing an external document archive. Then the Notes ID, email ID or other archive provider IDs will be stored here |
![]() | Sale | Sale this document refers to |
![]() | Salutation | Salutation - this is a dynamically calculated field! |
![]() ![]() | SearchName | SearchName
This is not implemented in CRM SIX, for later use |
![]() ![]() | Sentry | Sentry settings for this object. Lets you find out your read/write access to the object. |
![]() ![]() | Status | Status indicates whether the document has been completed or not.
Status returns the value from the appointment table relating to the document objects status, e.g. completed, started& All documents have a record in the appointment table with a document_id > 0. See the database manual for more information |
![]() | SuggestedDocumentId | Gets the suggested document id |
![]() ![]() | Template | Document Template
The template a document is based on is stored in the SO_arc\template folder on the server. This will return the name as displayed in the GUI, and not the physical document name, of the template the document object is based on |
![]() ![]() | Type | Type distinguishes different kinds of documents: 4 = document, 8=draft, 9=mergedoc
All documents have a record in the appointment table with a document_id > 0. This property returns the type value as recorded in the appointment table. All documents have type = 4 |
![]() ![]() | UDef | The user-defined fields on the document |
![]() ![]() | UpdatedAssociate | The last user to modify the object
The last associate that updated this document. If the document has never been updated, this will return 0 |
![]() ![]() | UpdatedDate | The date of the most recent update.
The date and time the appointment was last edited. If the appointment has never been updated; this will return 0, formatted as a SuperOffice date (see the database manual), this will return 01.01.1970 |
![]() | ValidationMessage | Get validation message, if empty model will think it is ok to save |
![]() ![]() | YourRef | Your Reference
The text entered in the Your ref field in the Document dialog |