NSDocumentTemplateEntity

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.

Constructors

NSDocumentTemplateEntity()

NSDocumentTemplateEntity

Initializes a new instance of the NSDocumentTemplateEntity class.

Methods

GetAutoeventId()

Which document plugin is responsible for the documents generated from this template

Integer GetAutoeventId()

Returns: CRMScript.Global.Integer Example:

NSDocumentTemplateEntity thing;
Integer autoeventId = thing.GetAutoeventId();

GetDefaultOref()

Processed via tag substitution to give document reference

String GetDefaultOref()

Returns: CRMScript.Global.String Example:

NSDocumentTemplateEntity thing;
String defaultOref = thing.GetDefaultOref();

GetDeleted()

True if deleted

Bool GetDeleted()

Returns: CRMScript.Global.Bool Example:

NSDocumentTemplateEntity thing;
Bool deleted = thing.GetDeleted();

GetDirection()

Integer GetDirection()

Returns: CRMScript.Global.Integer - 1 = incoming, 2 = outgoing. See <xref href=“CRMScript.NetServer.TaskDirection” data-throw-if-not-resolved=“false”></xref> Example:

NSDocumentTemplateEntity thing;
Integer direction = thing.GetDirection();

GetDocumentTemplateId()

Primary key

Integer GetDocumentTemplateId()

Returns: CRMScript.Global.Integer Example:

NSDocumentTemplateEntity thing;
Integer documentTemplateId = thing.GetDocumentTemplateId();

GetDocumentTypeKey()

The document type to use when creating a blank document. Plugin-specific. Used when not creating template from a local file.

Integer GetDocumentTypeKey()

Returns: CRMScript.Global.Integer Example:

NSDocumentTemplateEntity thing;
Integer documentTypeKey = thing.GetDocumentTypeKey();

GetEmailSubject()

Subject to use if document template is an email.

String GetEmailSubject()

Returns: CRMScript.Global.String Example:

NSDocumentTemplateEntity thing;
String emailSubject = thing.GetEmailSubject();

GetFilename()

Relative to TemplatePath, or extref for other document plugins. i.e URL or full path.

String GetFilename()

Returns: CRMScript.Global.String Example:

NSDocumentTemplateEntity thing;
String filename = thing.GetFilename();

GetIncludeSignature()

True if the email signature should be added in bottom of mail if this an email template

Bool GetIncludeSignature()

Returns: CRMScript.Global.Bool Example:

NSDocumentTemplateEntity thing;
Bool includeSignature = thing.GetIncludeSignature();

GetIntentId()

What is the intention of this document (used by SAINT)

Integer GetIntentId()

Returns: CRMScript.Global.Integer Example:

NSDocumentTemplateEntity thing;
Integer intentId = thing.GetIntentId();

GetInvitationDocType()

Integer GetInvitationDocType()

Returns: CRMScript.Global.Integer - Type for sending email meeting invitation. See <xref href=“CRMScript.NetServer.DocTmplInvitationType” data-throw-if-not-resolved=“false”></xref> Example:

NSDocumentTemplateEntity thing;
Integer invitationDocType = thing.GetInvitationDocType();

GetIsDefaultPublished()

Bool GetIsDefaultPublished()

Returns: CRMScript.Global.Bool - Published to external persons. Example:

NSDocumentTemplateEntity thing;
Bool isDefaultPublished = thing.GetIsDefaultPublished();

GetIsInUseInGuides()

True if the template is in use in a project or sales guide

Bool GetIsInUseInGuides()

Returns: CRMScript.Global.Bool Example:

NSDocumentTemplateEntity thing;
Bool isInUseInGuides = thing.GetIsInUseInGuides();

GetLoadTemplateFromPlugin()

Which document plugin is responsible for this template’s contents

Integer GetLoadTemplateFromPlugin()

Returns: CRMScript.Global.Integer Example:

NSDocumentTemplateEntity thing;
Integer loadTemplateFromPlugin = thing.GetLoadTemplateFromPlugin();

GetMimeType()

The mime type

String GetMimeType()

Returns: CRMScript.Global.String Example:

NSDocumentTemplateEntity thing;
String mimeType = thing.GetMimeType();

GetName()

The template list item

String GetName()

Returns: CRMScript.Global.String Example:

NSDocumentTemplateEntity thing;
String name = thing.GetName();

GetPrivacyDocType()

Integer GetPrivacyDocType()

Returns: CRMScript.Global.Integer - Indicator that this document template has a functional role, related to privacy/GDPR. See <xref href=“CRMScript.NetServer.DocTmplPrivacyType” data-throw-if-not-resolved=“false”></xref> Example:

NSDocumentTemplateEntity thing;
Integer privacyDocType = thing.GetPrivacyDocType();

GetQuoteDocType()

Integer GetQuoteDocType()

Returns: CRMScript.Global.Integer - The role this document plays in the Quote system, if any. See <xref href=“CRMScript.NetServer.DocTmplQuoteType” data-throw-if-not-resolved=“false”></xref> Example:

NSDocumentTemplateEntity thing;
Integer quoteDocType = thing.GetQuoteDocType();

GetRank()

Integer GetRank()

Returns: CRMScript.Global.Integer - Rank order. Example:

NSDocumentTemplateEntity thing;
Integer rank = thing.GetRank();

GetRecordType()

NSDocTmplType GetRecordType()

Returns: CRMScript.NetServer.NSDocTmplType - 1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo See <xref href=“CRMScript.NetServer.TaskType” data-throw-if-not-resolved=“false”></xref> Example:

NSDocumentTemplateEntity thing;
NSDocTmplType recordType = thing.GetRecordType();

GetSaveInDb()

1 = save document records in DB; otherwise not.

Integer GetSaveInDb()

Returns: CRMScript.Global.Integer Example:

NSDocumentTemplateEntity thing;
Integer saveInDb = thing.GetSaveInDb();

GetSenderEmailAddress()

If email template, default sender address when template is of type quote email or privacy email.

String GetSenderEmailAddress()

Returns: CRMScript.Global.String Example:

NSDocumentTemplateEntity thing;
String senderEmailAddress = thing.GetSenderEmailAddress();

GetSenderEmailMode()

Integer GetSenderEmailMode()

Returns: CRMScript.Global.Integer - If email template, when DocType is Privacy or quote email, it is possible to make sender address like our contact, or our support contact, or always one address. See <xref href=“CRMScript.NetServer.SenderMailMode” data-throw-if-not-resolved=“false”></xref> Example:

NSDocumentTemplateEntity thing;
Integer senderEmailMode = thing.GetSenderEmailMode();

GetShowCurrents()

True if when using this template there should be shown a place for editing current choices of person, compant, sale, project etc

Bool GetShowCurrents()

Returns: CRMScript.Global.Bool Example:

NSDocumentTemplateEntity thing;
Bool showCurrents = thing.GetShowCurrents();

GetTooltip()

Tooltip or other description

String GetTooltip()

Returns: CRMScript.Global.String Example:

NSDocumentTemplateEntity thing;
String tooltip = thing.GetTooltip();

SetAutoeventId(Integer)

Which document plugin is responsible for the documents generated from this template

Void SetAutoeventId(Integer autoeventId)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer autoeventId;
thing.SetAutoeventId(autoeventId);

SetDefaultOref(String)

Processed via tag substitution to give document reference

Void SetDefaultOref(String defaultOref)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
String defaultOref;
thing.SetDefaultOref(defaultOref);

SetDeleted(Bool)

True if deleted

Void SetDeleted(Bool deleted)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Bool deleted;
thing.SetDeleted(deleted);

SetDirection(Integer)

Sets the direction of a document template.

Void SetDirection(Integer direction)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer direction;
thing.SetDirection(direction);

SetDocumentTemplateId(Integer)

Primary key

Void SetDocumentTemplateId(Integer documentTemplateId)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer documentTemplateId;
thing.SetDocumentTemplateId(documentTemplateId);

SetDocumentTypeKey(Integer)

The document type to use when creating a blank document. Plugin-specific. Used when not creating template from a local file.

Void SetDocumentTypeKey(Integer documentTypeKey)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer documentTypeKey;
thing.SetDocumentTypeKey(documentTypeKey);

SetEmailSubject(String)

Subject to use if document template is an email.

Void SetEmailSubject(String emailSubject)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
String emailSubject;
thing.SetEmailSubject(emailSubject);

SetFilename(String)

Relative to TemplatePath, or extref for other document plugins. i.e URL or full path.

Void SetFilename(String filename)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
String filename;
thing.SetFilename(filename);

SetIncludeSignature(Bool)

True if the email signature should be added in bottom of mail if this an email template

Void SetIncludeSignature(Bool includeSignature)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Bool includeSignature;
thing.SetIncludeSignature(includeSignature);

SetIntentId(Integer)

What is the intention of this document (used by SAINT)

Void SetIntentId(Integer intentId)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer intentId;
thing.SetIntentId(intentId);

SetInvitationDocType(Integer)

Void SetInvitationDocType(Integer invitationDocType)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer invitationDocType;
thing.SetInvitationDocType(invitationDocType);

SetIsDefaultPublished(Bool)

Published to external persons

Void SetIsDefaultPublished(Bool isDefaultPublished)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Bool isDefaultPublished;
thing.SetIsDefaultPublished(isDefaultPublished);

SetIsInUseInGuides(Bool)

True if the template is in use in a project or sales guide

Void SetIsInUseInGuides(Bool isInUseInGuides)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Bool isInUseInGuides;
thing.SetIsInUseInGuides(isInUseInGuides);

SetLoadTemplateFromPlugin(Integer)

Which document plugin is responsible for this template’s contents

Void SetLoadTemplateFromPlugin(Integer loadTemplateFromPlugin)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer loadTemplateFromPlugin;
thing.SetLoadTemplateFromPlugin(loadTemplateFromPlugin);

SetMimeType(String)

The mime type

Void SetMimeType(String mimeType)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
String mimeType;
thing.SetMimeType(mimeType);

SetName(String)

The template list item

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
String name;
thing.SetName(name);

SetPrivacyDocType(Integer)

Void SetPrivacyDocType(Integer privacyDocType)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer privacyDocType;
thing.SetPrivacyDocType(privacyDocType);

SetQuoteDocType(Integer)

Void SetQuoteDocType(Integer quoteDocType)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer quoteDocType;
thing.SetQuoteDocType(quoteDocType);

SetRank(Integer)

Rank order

Void SetRank(Integer rank)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer rank;
thing.SetRank(rank);

SetRecordType(NSDocTmplType)

1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo

Void SetRecordType(NSDocTmplType recordType)

Returns: CRMScript.Global.Void

See <xref href=“CRMScript.NetServer.TaskType” data-throw-if-not-resolved=“false”></xref>

Example:

NSDocumentTemplateEntity thing;
NSDocTmplType recordType;
thing.SetRecordType(recordType);

SetSaveInDb(Integer)

1 = save document records in DB; otherwise not.

Void SetSaveInDb(Integer saveInDb)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer saveInDb;
thing.SetSaveInDb(saveInDb);

SetSenderEmailAddress(String)

If email template, default senderaddress when template is of type quote email or privacy email.

Void SetSenderEmailAddress(String senderEmailAddress)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
String senderEmailAddress;
thing.SetSenderEmailAddress(senderEmailAddress);

SetSenderEmailMode(Integer)

Void SetSenderEmailMode(Integer senderEmailMode)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Integer senderEmailMode;
thing.SetSenderEmailMode(senderEmailMode);

SetShowCurrents(Bool)

True if when using this template there should be shown a place for editing current choices of person, compant, sale, project etc

Void SetShowCurrents(Bool showCurrents)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
Bool showCurrents;
thing.SetShowCurrents(showCurrents);

SetTooltip(String)

Tooltip or other description

Void SetTooltip(String tooltip)

Returns: CRMScript.Global.Void Example:

NSDocumentTemplateEntity thing;
String tooltip;
thing.SetTooltip(tooltip);

​Constructors

​NSDocumentTemplateEntity()

​Methods

​GetAutoeventId()

​GetDefaultOref()

​GetDeleted()

​GetDirection()

​GetDocumentTemplateId()

​GetDocumentTypeKey()

​GetEmailSubject()

​GetFilename()

​GetIncludeSignature()

​GetIntentId()

​GetInvitationDocType()

​GetIsDefaultPublished()

​GetIsInUseInGuides()

​GetLoadTemplateFromPlugin()

​GetMimeType()

​GetName()

​GetPrivacyDocType()

​GetQuoteDocType()

​GetRank()

​GetRecordType()

​GetSaveInDb()

​GetSenderEmailAddress()

​GetSenderEmailMode()

​GetShowCurrents()

​GetTooltip()

​SetAutoeventId(Integer)

​SetDefaultOref(String)

​SetDeleted(Bool)

​SetDirection(Integer)

​SetDocumentTemplateId(Integer)

​SetDocumentTypeKey(Integer)

​SetEmailSubject(String)

​SetFilename(String)

​SetIncludeSignature(Bool)

​SetIntentId(Integer)

​SetInvitationDocType(Integer)

​SetIsDefaultPublished(Bool)

​SetIsInUseInGuides(Bool)

​SetLoadTemplateFromPlugin(Integer)

​SetMimeType(String)

​SetName(String)

​SetPrivacyDocType(Integer)

​SetQuoteDocType(Integer)

​SetRank(Integer)

​SetRecordType(NSDocTmplType)

​SetSaveInDb(Integer)

​SetSenderEmailAddress(String)

​SetSenderEmailMode(Integer)

​SetShowCurrents(Bool)

​SetTooltip(String)

Constructors

NSDocumentTemplateEntity()

Methods

GetAutoeventId()

GetDefaultOref()

GetDeleted()

GetDirection()

GetDocumentTemplateId()

GetDocumentTypeKey()

GetEmailSubject()

GetFilename()

GetIncludeSignature()

GetIntentId()

GetInvitationDocType()

GetIsDefaultPublished()

GetIsInUseInGuides()

GetLoadTemplateFromPlugin()

GetMimeType()

GetName()

GetPrivacyDocType()

GetQuoteDocType()

GetRank()

GetRecordType()

GetSaveInDb()

GetSenderEmailAddress()

GetSenderEmailMode()

GetShowCurrents()

GetTooltip()

SetAutoeventId(Integer)

SetDefaultOref(String)

SetDeleted(Bool)

SetDirection(Integer)

SetDocumentTemplateId(Integer)

SetDocumentTypeKey(Integer)

SetEmailSubject(String)

SetFilename(String)

SetIncludeSignature(Bool)

SetIntentId(Integer)

SetInvitationDocType(Integer)

SetIsDefaultPublished(Bool)

SetIsInUseInGuides(Bool)

SetLoadTemplateFromPlugin(Integer)

SetMimeType(String)

SetName(String)

SetPrivacyDocType(Integer)

SetQuoteDocType(Integer)

SetRank(Integer)

SetRecordType(NSDocTmplType)

SetSaveInDb(Integer)

SetSenderEmailAddress(String)

SetSenderEmailMode(Integer)

SetShowCurrents(Bool)

SetTooltip(String)