DocTmpl Table (130)
• 7 minutes to read
• 7 minutes to read
DocTmpl MDO list item table. DocTmpl list table. Describes templates available for writing new documents.
Fields
| Name | Description | Type | Null |
|---|---|---|---|
| DocTmpl_id | Primary key | PK | |
| name | The list item | String(239) | |
| rank | Rank order | UShort | ● |
| tooltip | Tooltip or other description | String(254) | ● |
| deleted | 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists | UShort | ● |
| filename | Relative to TemplatePath in SOARC. Plugin specific extref in other doc archives. i.e. Google document URL or Notes id. | String(239) | |
| autoevent_id | Document plugin id - where the documents generated from this template are to be stored. Copied to the document.archiveProvider when document is created. | Id | ● |
| record_type | 1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes | Enum DocTmplType | |
| direction | 1 = incoming, 2 = outgoing, see EAppntDirection | Enum DocTmplDirection | ● |
| saveInDb | 1 = save document records in DB; otherwise not. | UShort | ● |
| default_oref | Processed via tag substitution to give document reference | String(239) | ● |
| regkey_open | Registry key to use for Open, if blank, we simply ask Windows to do the operation for us | String(239) | ● |
| regkey_edit | Registry key to use for Edit; if blank, we simply ask Windows to do the operation for us | String(239) | ● |
| regkey_print | Registry key to use for Print; if blank, we simply ask Windows to do the operation for us | String(239) | ● |
| accelerator | Accelerator key code for this template | UShort | ● |
| registered | Registered when | UtcDateTime | |
| registered_associate_id | Registered by whom | FK associate | |
| updated | Last updated when | UtcDateTime | |
| updated_associate_id | Last updated by whom | FK associate | |
| updatedCount | Number of updates made to this record | UShort | |
| defaultPublishType | Should documents based on this template be published=true? Default state of publish flag on documents. | Enum PublishType | ● |
| intentId | What is the intention of this document (used by SAINT) | FK Intent | ● |
| mimeType | The MIME type, for Web/Browser use of documents of this type | String(254) | ● |
| loadTemplateFromPlugin | If nonzero, then this is the ID of the document plugin that should supply the template document file, instead of the default so_arc/template | Int | ● |
| quoteDocType | The role this document plays in the Quote system, if any | Enum DocTmplQuoteType | ● |
| privacyDocType | Indicator that this document template has a functional role, related to privacy/GDPR | Enum DocTmplPrivacyType | ● |
| emailSubject | Subject line for document templates that represent an email; template tags are accepted in this item | String(4000) | ● |
| includeSignature | If True, signature (mail.htm) should be added at bottom of template when used | Bool | ● |
| showCurrents | If True, A dialog or sidebar will be shown for changing current values on Contact, Person | Bool | ● |
| senderEmailMode | Type of sender email setting. Always use senderEmailAddress = 0, Use Our contact = 1, Use Support Associate = 2 | Enum SenderMailMode | ● |
| senderEmailAddress | The email address to use in from field | String(256) | ● |
| invitationDocType | Type for sending email meeting invitation. Not an invitation type template = 0, New = 1, Changed = 2, Cancelled = 3 | Enum DocTmplInvitationType | ● |
Values needed to access the DocTmpl tables
This table must contain special values that would be difficult to guess correctly. These are listed below with a description of how to use them.
| Record Type | ID | Comment |
|---|---|---|
| Unknown | 0 | The document type is unknown/undecided |
| Appointment | 1 | (not used for document templates) |
| Document | 2 | Generic text document (for instance, a letter) |
| 3 | Email message | |
| Fax | 4 | Facsimile |
| Phone | 5 | (not used for document templates) |
| To Do | 6 | (not used for document templates) |
| Mail merge draft document | 7 | Template for mail merge operations |
| Mail merge final document | 8 | Result of a mail merge operation |
| Saved report | 9 | Saved result of running a report (output from Reporter) |
| Direction Type | ID | Comment |
|---|---|---|
| Unknown | 0 | The direction of documents from this template is unknown/undecided |
| Incoming | 1 | Document template for incoming documents |
| Outgoing | 2 | Document template is used for outgoing documents |
| SaintAll | 3 | 'All' choice for Saint. This is NOT an acceptable value for a task definition, but is used by the Saint system for indexing all directions |
Is this document template some kind of quote document, and if so what
| QuoteDocType | ID | Comment |
|---|---|---|
| None | 0 | This document template is in no way related to Quote Management |
| MailBody | 1 | This is a template for the offer mail body |
| MainDocument | 2 | This is a template for the main offer document, document instances will be referred through Quote.DocumentId |
| QuoteLines | 3 | This is a template for the AsposeWords merge process, generating the offer line details |
| ConfirmationMailBody | 4 | This is a template for the mail body of the order confirmation |
| ConfirmationLines | 5 | This is a template for the lines document that is an attachment to the confirmation mail |
Indexes
| Fields | Types | Description |
|---|---|---|
| DocTmpl_id | PK | Clustered, Unique |
| name | String(239) | Unique |
Relationships
| Table | Description |
|---|---|
| associate | Employees, resources and other users - except for External persons |
| ConsentSource | Consent source for GDPR |
| DocTmplGroupLink | User group link table for DocTmpl, for MDO item hiding |
| DocTmplHeadingLink | Heading link table for DocTmpl, for MDO headers |
| Intent | Intent list for SAINT. More information regarding SuperOffice Sales Intelligence on http://techdoc.superoffice.com |
| SaleType | Type of sale - large solution, incremental, whatever fits the organization |
| SuggestedDocument | Unique owner of a set of licensed modules |
Replication Flags
- Replicate changes DOWN from central to satellites and travellers.
- Replicate changes UP from satellites and travellers back to central.
- Copy to satellite and travel prototypes.
Security Flags
- No access control via user's Role.