NSDocumentEntity - SuperOffice

Constructors

NSDocumentEntity()

NSDocumentEntity

Initializes a new instance of the NSDocumentEntity class.

Methods

GetActiveLinks()

Integer GetActiveLinks()

Returns: CRMScript.Global.Integer - Number of active links to sale, document, appointment. Example:

NSDocumentEntity thing;
Integer activeLinks = thing.GetActiveLinks();

GetAssociate()

NSAssociate GetAssociate()

Returns: CRMScript.NetServer.NSAssociate - The owner of the document* the associate whose checklist the document is in. Example:

NSDocumentEntity thing;
NSAssociate associate = thing.GetAssociate();

GetAttention()

String GetAttention()

Returns: CRMScript.Global.String - Attention/salutation. Example:

NSDocumentEntity thing;
String attention = thing.GetAttention();

GetCompleted()

Integer GetCompleted()

Returns: CRMScript.Global.Integer - Document Completed state. This is the part of the Status property. Example:

NSDocumentEntity thing;
Integer completed = thing.GetCompleted();

GetContact()

NSContact GetContact()

Returns: CRMScript.NetServer.NSContact - The contact associated with the document. It may also be null if no contact is associated with the document. Example:

NSDocumentEntity thing;
NSContact contact = thing.GetContact();

GetCreatedBy()

NSAssociate GetCreatedBy()

Returns: CRMScript.NetServer.NSAssociate - The person that first created the document. The property is read-only. Example:

NSDocumentEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();

GetCreatedDate()

DateTime GetCreatedDate()

Returns: CRMScript.Global.DateTime - Registered when. Example:

NSDocumentEntity thing;
DateTime createdDate = thing.GetCreatedDate();

GetCustomFields()

Gets the user-defined + extra fields on an NSDocumentEntity as a map.

Map GetCustomFields()

Returns: CRMScript.Native.Map Example:

NSDocumentEntity thing;
Map fields = thing.GetCustomFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

GetDate()

DateTime GetDate()

Returns: CRMScript.Global.DateTime - date + start time planned. Example:

NSDocumentEntity thing;
DateTime date = thing.GetDate();

GetDescription()

String GetDescription()

Returns: CRMScript.Global.String - The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases. Example:

NSDocumentEntity thing;
String description = thing.GetDescription();

GetDocumentId()

Integer GetDocumentId()

Returns: CRMScript.Global.Integer - Primary key. Example:

NSDocumentEntity thing;
Integer documentId = thing.GetDocumentId();

GetDocumentTemplate()

NSDocumentTemplate GetDocumentTemplate()

Returns: CRMScript.NetServer.NSDocumentTemplate - The template type of the document. Example:

NSDocumentEntity thing;
NSDocumentTemplate documentTemplate = thing.GetDocumentTemplate();

GetExternalRef()

String GetExternalRef()

Returns: CRMScript.Global.String - External reference for document plugin to resolve document identity (Notes ID, e-mail message ID, whatever). Example:

NSDocumentEntity thing;
String externalRef = thing.GetExternalRef();

GetExtraFields()

Gets the extra fields on NSDocumentEntity as a map.

Map GetExtraFields()

Returns: CRMScript.Native.Map Example:

NSDocumentEntity thing;
Map fields = thing.GetExtraFields();
String oldValue = fields.get("x_foobar");
fields.insert("x_foobar", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

GetHeader()

String GetHeader()

Returns: CRMScript.Global.String - Visible document name. Example:

NSDocumentEntity thing;
String header = thing.GetHeader();

GetIsPublished()

Bool GetIsPublished()

Returns: CRMScript.Global.Bool - Should this NSDocumentEntity be published and visible to strangers?

GetLinks()

NSLink[] GetLinks()

Returns: CRMScript.NetServer.NSLink[] - List of all elements linked to the document. Example:

NSDocumentEntity thing;
NSLink[] links = thing.GetLinks();

GetLockSemantics()

Integer GetLockSemantics()

Returns: CRMScript.Global.Integer - See <xref href=“CRMScript.NetServer.DocumentLockSemantics” data-throw-if-not-resolved=“false”></xref> Example:

NSDocumentEntity thing;
Integer lockSemantics = thing.GetLockSemantics();

GetName()

String GetName()

Returns: CRMScript.Global.String - File name. Example:

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

GetOurRef()

String GetOurRef()

Returns: CRMScript.Global.String - Our reference, searchable field from free-text search. Example:

NSDocumentEntity thing;
String ourRef = thing.GetOurRef();

GetPerson()

NSPerson GetPerson()

Returns: CRMScript.NetServer.NSPerson - A document may also be connected to a person; this must be a contact person registered on the current company. This does not mean however that a person is required. Example:

NSDocumentEntity thing;
NSPerson person = thing.GetPerson();

GetProject()

NSProject GetProject()

Returns: CRMScript.NetServer.NSProject - 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 however that a project is required. Example:

NSDocumentEntity thing;
NSProject project = thing.GetProject();

GetPublishEventDate()

DateTime GetPublishEventDate()

Returns: CRMScript.Global.DateTime - Publish event date on NSDocumentEntity.

GetPublishFrom()

DateTime GetPublishFrom()

Returns: CRMScript.Global.DateTime - Publish from date on NSDocumentEntity.

GetPublishTo()

DateTime GetPublishTo()

Returns: CRMScript.Global.DateTime - Publish to date on NSDocumentEntity. After this date the event is no longer visible.

GetSale()

NSSale GetSale()

Returns: CRMScript.NetServer.NSSale - A document may also be connected to a sale, so you see the document on the company card, on the project card and on the sale card. This does not mean however that a sale is required. May be null. Example:

NSDocumentEntity thing;
NSSale sale = thing.GetSale();

GetSnum()

Integer GetSnum()

Returns: CRMScript.Global.Integer - The sequence number allocated from refcount on used template when creating the document. Example:

NSDocumentEntity thing;
Integer snum = thing.GetSnum();

GetSuggestedDocumentId()

Integer GetSuggestedDocumentId()

Returns: CRMScript.Global.Integer - Suggested guide item that this document is an instance of.

NOT valid for appointments, they have their own link

Example:

NSDocumentEntity thing;
Integer suggestedDocumentId = thing.GetSuggestedDocumentId();

GetType()

Integer GetType()

Returns: CRMScript.Global.Integer - Is this a normal document or a mail-merge or report? Example:

NSDocumentEntity thing;
Integer type = thing.GetType();

GetUpdatedBy()

NSAssociate GetUpdatedBy()

Returns: CRMScript.NetServer.NSAssociate - The person that last updated the appointment. Example:

NSDocumentEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();

GetUpdatedDate()

DateTime GetUpdatedDate()

Returns: CRMScript.Global.DateTime - Last updated when. Example:

NSDocumentEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();

GetUserDefinedFields()

Gets the user-defined fields on the NSDocumentEntity as a map.

Map GetUserDefinedFields()

Returns: CRMScript.Native.Map Example:

NSDocumentEntity thing;
Map fields = thing.GetUserDefinedFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

GetVisibleFor()

NSVisibleFor[] GetVisibleFor()

Returns: CRMScript.NetServer.NSVisibleFor[] - Return the user groups and/or users the NSDocumentEntity item is visible for. Example:

NSDocumentEntity thing;
NSVisibleFor[] visibleFor = thing.GetVisibleFor();

GetYourRef()

String GetYourRef()

Returns: CRMScript.Global.String - Your reference. Example:

NSDocumentEntity thing;
String yourRef = thing.GetYourRef();

SetActiveLinks(Integer)

Void SetActiveLinks(Integer activeLinks)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
Integer activeLinks;
thing.SetActiveLinks(activeLinks);

SetAssociate(NSAssociate)

Void SetAssociate(NSAssociate associate)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
NSAssociate associate;
thing.SetAssociate(associate);

SetAttention(String)

Void SetAttention(String attention)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
String attention;
thing.SetAttention(attention);

SetCompleted(Integer)

Void SetCompleted(Integer completed)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
Integer completed;
thing.SetCompleted(completed);

SetContact(NSContact)

Void SetContact(NSContact contact)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
NSContact contact;
thing.SetContact(contact);

SetCreatedBy(NSAssociate)

Void SetCreatedBy(NSAssociate createdBy)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);

SetCreatedDate(DateTime)

Void SetCreatedDate(DateTime createdDate)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);

SetCustomFields(Map)

Sets the user-defined and extra fields on an NSDocumentEntity with a map.

Void SetCustomFields(Map udefs)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
udefs["x_foo"] = "foobar";
udefs["x_bar"] = "456"; // List item id
thing.SetCustomFields(udefs);

SetDate(DateTime)

Void SetDate(DateTime date)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
DateTime date;
thing.SetDate(date);

SetDescription(String)

Void SetDescription(String description)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
String description;
thing.SetDescription(description);

SetDocumentId(Integer)

Void SetDocumentId(Integer documentId)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
Integer documentId;
thing.SetDocumentId(documentId);

SetDocumentTemplate(NSDocumentTemplate)

Void SetDocumentTemplate(NSDocumentTemplate documentTemplate)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
NSDocumentTemplate documentTemplate;
thing.SetDocumentTemplate(documentTemplate);

SetExternalRef(String)

Void SetExternalRef(String externalRef)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
String externalRef;
thing.SetExternalRef(externalRef);

SetExtraFields(Map)

Sets the extra field values on NSDocumentEntity with a map.

Void SetExtraFields(Map extras)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
Map extras;
extras["SuperOffice:1"] = "[I:123]";
extras["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
extras["custom.progid"] = "foobar";
thing.SetExtraFields(extras);

SetHeader(String)

Void SetHeader(String header)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
String header;
thing.SetHeader(header);

SetIsPublished(Bool)

Sets the IsPublished property

Void SetIsPublished(Bool isPublished)

Returns: CRMScript.Global.Void

SetLinks(NSLink[])

Void SetLinks(NSLink[] links)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
NSLink[] links;
thing.SetLinks(links);

SetLockSemantics(Integer)

Void SetLockSemantics(Integer lockSemantics)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
Integer lockSemantics;
thing.SetLockSemantics(lockSemantics);

SetName(String)

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

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

SetOurRef(String)

Void SetOurRef(String ourRef)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
String ourRef;
thing.SetOurRef(ourRef);

SetPerson(NSPerson)

Void SetPerson(NSPerson person)

Returns: CRMScript.Global.Void

A document may also be connected to a person; this must be a contact person registered on the current company. This does not mean however that a person is required.

Example:

NSDocumentEntity thing;
NSPerson person;
thing.SetPerson(person);

SetProject(NSProject)

Void SetProject(NSProject project)

Returns: CRMScript.Global.Void

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 however that a project is required.

Example:

NSDocumentEntity thing;
NSProject project;
thing.SetProject(project);

SetPublishEventDate(DateTime)

Void SetPublishEventDate(DateTime publishDate)

Returns: CRMScript.Global.Void

SetPublishFrom(DateTime)

Sets the publish from date on an NSDocumentEntity.

Void SetPublishFrom(DateTime publishFrom)

Returns: CRMScript.Global.Void

SetPublishTo(DateTime)

Sets the publish to date on NSDocumentEntity. After this date the event is no longer visible.

Void SetPublishTo(DateTime publishTo)

Returns: CRMScript.Global.Void

SetSale(NSSale)

Void SetSale(NSSale sale)

Returns: CRMScript.Global.Void

A document may also be connected to a sale, so you see the document on the company card, on the project card and on the sale card. This does not mean however that a sale is required. May be null.

Example:

NSDocumentEntity thing;
NSSale sale;
thing.SetSale(sale);

SetSnum(Integer)

Void SetSnum(Integer snum)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
Integer snum;
thing.SetSnum(snum);

SetSuggestedDocumentId(Integer)

Void SetSuggestedDocumentId(Integer suggestedDocumentId)

Returns: CRMScript.Global.Void

NOT valid for appointments, they have their own link

Example:

NSDocumentEntity thing;
Integer suggestedDocumentId;
thing.SetSuggestedDocumentId(suggestedDocumentId);

SetType(Integer)

Void SetType(Integer type)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
Integer type;
thing.SetType(type);

SetUpdatedBy(NSAssociate)

Void SetUpdatedBy(NSAssociate updatedBy)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);

SetUpdatedDate(DateTime)

Void SetUpdatedDate(DateTime updatedDate)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);

SetUserDefinedFields(Map)

Sets the user-defined fields on the NSDocumentEntity as a map.

Void SetUserDefinedFields(Map udefs)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
thing.SetUserDefinedFields(udefs);

SetVisibleFor(NSVisibleFor[])

Sets the user groups and/or users the NSDocumentEntity item is visible for.

Void SetVisibleFor(NSVisibleFor[] visibleFor)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
NSVisibleFor[] visibleFor = thing.GetVisibleFor();
visibleFor[0].SetVisiblity(1);  // usergroup
visibleFor[0].SetVisibleId(123); // usergroup id
thing.SetVisibleFor(visibleFor);

SetYourRef(String)

Void SetYourRef(String yourRef)

Returns: CRMScript.Global.Void Example:

NSDocumentEntity thing;
String yourRef;
thing.SetYourRef(yourRef);

​Constructors