NSReportAgent - SuperOffice

Run reports, set favorites, labels.

Constructors

NSReportAgent()

NSReportAgent

Run reports, set favorites, labels.

Methods

CreateDefaultReportEntity()

Sets default values into a new NSReportEntity.

NSReportEntity CreateDefaultReportEntity()

Returns: CRMScript.NetServer.NSReportEntity

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSReportAgent agent;
NSReportEntity thing = agent.CreateDefaultReportEntity();
thing = agent.SaveReportEntity(thing);

CreateDefaultReportLabelLayoutEntity()

Sets default values into a new NSReportLabelLayoutEntity.

NSReportLabelLayoutEntity CreateDefaultReportLabelLayoutEntity()

Returns: CRMScript.NetServer.NSReportLabelLayoutEntity

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSReportAgent agent;
NSReportLabelLayoutEntity thing = agent.CreateDefaultReportLabelLayoutEntity();
thing = agent.SaveReportLabelLayoutEntity(thing);

CreateFavorite(Integer,String,String)

Creates the report as favorite.

NSReportEntity CreateFavorite(Integer sourceId, String name, String description)

Returns: CRMScript.NetServer.NSReportEntity Example:

NSReportAgent agent;
Integer sourceId;
String name;
String description;
NSReportEntity res = agent.CreateFavorite(sourceId, name, description);

DeleteFavorite(Integer)

Deletes the report favorite.

Void DeleteFavorite(Integer reportEntityId)

Returns: CRMScript.Global.Void

DeleteReport(Integer)

Deletes the report with the given ID.

Bool DeleteReport(Integer reportId)

Returns: CRMScript.Global.Bool Example:

NSReportAgent agent;
Integer reportId;
Bool res = agent.DeleteReport(reportId);

DeleteReportLabelLayoutEntity(Integer)

Deletes the NSReportLabelLayoutEntity

DeleteReportLabelLayoutEntity(Integer reportLabelLayoutEntity)

Returns: CRMScript.Global.Void Example:

NSReportAgent agent;
agent.DeleteReportLabelLayoutEntity(123);

GenerateReport(Integer,Integer,String,String,String,NSArchiveRestrictionInfo[])

Generates the report in PDF format.

String GenerateReport(Integer reportId, Integer labelLayoutId, String filename, String language, String fileType, NSArchiveRestrictionInfo[] restrictions)

Returns: CRMScript.Global.String Example:

NSReportAgent agent;
Integer reportId;
Integer labelLayoutId;
String filename;
String language;
String fileType;
NSArchiveRestrictionInfo[] restrictions;
String res = agent.GenerateReport(reportId, labelLayoutId, filename, language, fileType, restrictions);

GetReportEntity(Integer)

Gets an NSReportEntity object.

NSReportEntity GetReportEntity(Integer reportEntityId)

Returns: CRMScript.NetServer.NSReportEntity Example:

NSReportAgent agent;
NSReportEntity thing = agent.GetReportEntity(123);

GetReportLabelLayoutEntity(Integer)

Gets an NSReportLabelLayoutEntity object.

NSReportLabelLayoutEntity GetReportLabelLayoutEntity(Integer reportLabelLayoutEntityId)

Returns: CRMScript.NetServer.NSReportLabelLayoutEntity Example:

NSReportAgent agent;
NSReportLabelLayoutEntity thing = agent.GetReportLabelLayoutEntity(123);

ImportReport(String)

Takes the input stream and create a report. This stream must be on a valid XML format.

Integer ImportReport(String report)

Returns: CRMScript.Global.Integer Example:

NSReportAgent agent;
String report;
Integer res = agent.ImportReport(report);

SaveReportEntity(NSReportEntity)

Updates the existing NSReportEntity or creates a new NSReportEntity if the id parameter is 0

NSReportEntity SaveReportEntity(NSReportEntity reportEntity)

Returns: CRMScript.NetServer.NSReportEntity Example:

NSReport  agent;
NSReportEntity thing = agent.CreateDefaultReportEntity();
thing = agent.SaveReportEntity(thing);

SaveReportLabelLayoutEntity(NSReportLabelLayoutEntity)

Updates the existing NSReportLabelLayoutEntity or creates a new NSReportLabelLayoutEntity if the ID parameter is 0.

NSReportLabelLayoutEntity SaveReportLabelLayoutEntity(NSReportLabelLayoutEntity reportLabelLayoutEntity)

Returns: CRMScript.NetServer.NSReportLabelLayoutEntity - The new or updated NSReportLabelLayoutEntity. Example:

NSReport  agent;
NSReportLabelLayoutEntity thing = agent.CreateDefaultReportLabelLayoutEntity();
thing = agent.SaveReportLabelLayoutEntity(thing);

UpdateFavorite(NSReportEntity)

Updates the favorite.

NSReportEntity UpdateFavorite(NSReportEntity reportEntity)

Returns: CRMScript.NetServer.NSReportEntity Example:

NSReportAgent agent;
NSReportEntity reportEntity;
NSReportEntity res = agent.UpdateFavorite(reportEntity);

​Constructors

​NSReportAgent()

​Methods

​CreateDefaultReportEntity()

​CreateDefaultReportLabelLayoutEntity()

​CreateFavorite(Integer,String,String)

​DeleteFavorite(Integer)

​DeleteReport(Integer)

​DeleteReportLabelLayoutEntity(Integer)

​GenerateReport(Integer,Integer,String,String,String,NSArchiveRestrictionInfo[])

​GetReportEntity(Integer)

​GetReportLabelLayoutEntity(Integer)

​ImportReport(String)

​SaveReportEntity(NSReportEntity)

​SaveReportLabelLayoutEntity(NSReportLabelLayoutEntity)

​UpdateFavorite(NSReportEntity)

Constructors

NSReportAgent()

Methods

CreateDefaultReportEntity()

CreateDefaultReportLabelLayoutEntity()

CreateFavorite(Integer,String,String)

DeleteFavorite(Integer)

DeleteReport(Integer)

DeleteReportLabelLayoutEntity(Integer)

GenerateReport(Integer,Integer,String,String,String,NSArchiveRestrictionInfo[])

GetReportEntity(Integer)

GetReportLabelLayoutEntity(Integer)

ImportReport(String)

SaveReportEntity(NSReportEntity)

SaveReportLabelLayoutEntity(NSReportLabelLayoutEntity)

UpdateFavorite(NSReportEntity)