Document files - SuperOffice

The physical document is tied to the NSDocumentEntity and stored in the document archive.

Create physical document from template

Which template to use is set in the document properties. Required IDs:

company (contact ID)
person
appointment
document
sale
selection
project
uiCulture (used to select a template of the appropriate language, for example, “en-US” or “nb-NO”)

If set to 0, the company, person, appointment, sale, and project IDs will default to the values set in the document properties.

NSDocumentAgent agent;
NSDocumentEntity doc = agent.GetDocumentEntity(2);

agent.CreateNewPhysicalDocumentFromTemplate(doc.GetContact().GetId(), 0, 0, doc.GetDocumentId(),0,0,0,"");

Filenames

The initial filename is taken from the document properties.

NSDocumentEntity doc;
String filename = doc.GetName();

Rename physical document

When renaming, you can suggest a new filename. The document archive may amend this if your suggestion is already used by another file, contains restricted characters, or similar.

String newFilename = "Trebbles.doc";
Integer docId = 3;

NSDocumentAgent agent;
NSDocumentEntity doc = agent.GetDocumentEntity(docId);

String actualName = agent.RenameDocument(docId, newFilename);

doc.SetName(actualName);
agent.SaveDocumentEntity(doc);

Don’t forget to save the NSDocumentEntity!

Change file extension

String changeFileExtension(Integer documentId, String extension) {

  NSDocumentAgent agent;
  NSDocumentEntity doc = agent.GetDocumentEntity(documentId);

  String newName = agent.RenameDocument(documentId, doc.GetName().beforeLast(".") + extension);
  doc.SetName(newName);
  agent.SaveDocumentEntity(doc);
  return(newName);
}

printLine(changeFileExtension(3, ".pdf"));

Locked for editing

In SuperOffice CRM, many people are creating, editing, and reading documents at any given time. If multiple users are editing the same document at the same time, they risk overwriting each other’s data. To prevent this from happening, SuperOffice CRM will lock a document when it is being edited by a user. Other users can still open the document, but only in read-only mode.

Is the document checked out

NSDocumentAgent agent;
NSCheckoutInfo info = agent.GetCheckoutState(2);
printLine(info.GetState().toString() + "\t" + info.GetName());

Check out

String[] returnTypes;
NSDocumentAgent agent;
agent.CheckoutDocument(2, returnTypes);

Undo (abandon) a checkout

String[] returnTypes;
NSDocumentAgent agent;
agent.UndoCheckoutDocument(2, returnTypes);

Check in

If the document or plug-in supports versioning, you can provide a description and metadata for a specific version when you check it in.

String[] returnTypes;
String[] meta;

NSDocumentAgent agent;
agent.CheckinDocument(2, returnTypes, "updated copyright", meta);

Edit physical document - online

File operations are unavailable in CRM Online. All updates happen through document plug-ins using a URL referring to the actual document.

To update only the document properties, update the NSDocumentEntity.

Get URL

NSDocumentAgent agent;
Integer docId = 2;
String url = agent.GetDocumentUrl(docId, "", true);
printLine(url);

This example gets a writable URL for the latest version of document 2.

Delete physical document

String[] returnType;

NSDocumentAgent agent;
agent.DeletePhysicalDocument(5, returnType);

Reference

Return types (NSReturnInfo)

The document plugin might need to request additional processing. When deleting, you should pass a list of return types that the client is prepared to handle. If there are no restrictions, pass an empty array.

CustomGui
Message
None
Other
SoProtocol

​Create physical document from template

​Filenames

​Rename physical document

​Change file extension

​Locked for editing

​Is the document checked out

​Check out

​Undo (abandon) a checkout

​Check in

​Edit physical document - online

​Get URL

​Delete physical document

​Reference

​Return types (NSReturnInfo)

Create physical document from template

Filenames

Rename physical document

Change file extension

Locked for editing

Is the document checked out

Check out

Undo (abandon) a checkout

Check in

Edit physical document - online

Get URL

Delete physical document

Reference

Return types (NSReturnInfo)