NSSaintAgent - SuperOffice

Administration and maintenance of SAINT counters and statuses.

Constructors

NSSaintAgent()

NSSaintAgent

Administration and maintenance of SAINT counters and statuses.

Methods

CreateDefaultSaintConfiguration()

Sets default values into a new NSSaintConfiguration.

NSSaintConfiguration CreateDefaultSaintConfiguration()

Returns: CRMScript.NetServer.NSSaintConfiguration

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

Example:

NSSaintAgent agent;
NSSaintConfiguration thing = agent.CreateDefaultSaintConfiguration();
thing = agent.SaveSaintConfiguration(thing);

CreateDefaultStatusMonitor()

Sets default values into a new NSStatusMonitor.

NSStatusMonitor CreateDefaultStatusMonitor()

Returns: CRMScript.NetServer.NSStatusMonitor

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

Example:

NSSaintAgent agent;
NSStatusMonitor thing = agent.CreateDefaultStatusMonitor();
thing = agent.SaveStatusMonitor(thing);

CreateDefaultStatusMonitorPeriods()

Sets default values into a new NSStatusMonitorPeriods.

NSStatusMonitorPeriods CreateDefaultStatusMonitorPeriods()

Returns: CRMScript.NetServer.NSStatusMonitorPeriods

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

Example:

NSSaintAgent agent;
NSStatusMonitorPeriods thing = agent.CreateDefaultStatusMonitorPeriods();
thing = agent.SaveStatusMonitorPeriods(thing);

GetSaintConfigurations()

Returns the NSStatusMonitorPeriods entity.

NSSaintConfiguration[] GetSaintConfigurations()

Returns: CRMScript.NetServer.NSSaintConfiguration[] Example:

NSSaintAgent agent;
NSSaintConfiguration[] res = agent.GetSaintConfigurations();

GetStatusMonitor(Integer)

Gets a single status monitor based on its identity

NSStatusMonitor GetStatusMonitor(Integer id)

Returns: CRMScript.NetServer.NSStatusMonitor Example:

NSSaintAgent agent;
Integer id;
NSStatusMonitor res = agent.GetStatusMonitor(id);

GetStatusMonitorPeriods()

Returns the NSStatusMonitorPeriods entity.

NSStatusMonitorPeriods GetStatusMonitorPeriods()

Returns: CRMScript.NetServer.NSStatusMonitorPeriods Example:

NSSaintAgent agent;
NSStatusMonitorPeriods res = agent.GetStatusMonitorPeriods();

GetStatusMonitors(Integer,String)

Gets all active status monitors for a specified target

NSStatusMonitor[] GetStatusMonitors(Integer id, String type)

Returns: CRMScript.NetServer.NSStatusMonitor[] Example:

NSSaintAgent agent;
Integer id;
String type;
NSStatusMonitor[] res = agent.GetStatusMonitors(id, type);

RegenerateCounters(Bool)

Regenerates the Saint counters* this can take several minutes

NSBatchTaskInfo RegenerateCounters(Bool runAsBatch)

Returns: CRMScript.NetServer.NSBatchTaskInfo Example:

NSSaintAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateCounters(runAsBatch);

RegenerateStatusMonitor(Integer)

Regenerates the given status monitor

Void RegenerateStatusMonitor(Integer statusMonitorId)

Returns: CRMScript.Global.Void Example:

NSSaintAgent agent;
Integer statusMonitorId;
agent.RegenerateStatusMonitor(statusMonitorId);

RegenerateStatusMonitors(Bool)

Regenerates status monitors

NSBatchTaskInfo RegenerateStatusMonitors(Bool runAsBatch)

Returns: CRMScript.NetServer.NSBatchTaskInfo Example:

NSSaintAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateStatusMonitors(runAsBatch);

SaveSaintConfiguration(NSSaintConfiguration)

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

NSSaintConfiguration SaveSaintConfiguration(NSSaintConfiguration saintConfiguration)

Returns: CRMScript.NetServer.NSSaintConfiguration Example:

NSSaint  agent;
NSSaintConfiguration thing = agent.CreateDefaultSaintConfiguration();
thing = agent.SaveSaintConfiguration(thing);

SaveStatusMonitor(NSStatusMonitor)

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

NSStatusMonitor SaveStatusMonitor(NSStatusMonitor statusMonitor)

Returns: CRMScript.NetServer.NSStatusMonitor Example:

NSSaint  agent;
NSStatusMonitor thing = agent.CreateDefaultStatusMonitor();
thing = agent.SaveStatusMonitor(thing);

SaveStatusMonitorPeriods(NSStatusMonitorPeriods)

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

NSStatusMonitorPeriods SaveStatusMonitorPeriods(NSStatusMonitorPeriods statusMonitorPeriods)

Returns: CRMScript.NetServer.NSStatusMonitorPeriods Example:

NSSaint  agent;
NSStatusMonitorPeriods thing = agent.CreateDefaultStatusMonitorPeriods();
thing = agent.SaveStatusMonitorPeriods(thing);

SetRankOnStatusMonitors(String,Integer[])

Sets rank order on status monitors

Void SetRankOnStatusMonitors(String type, Integer[] itemsIds)

Returns: CRMScript.Global.Void Example:

NSSaintAgent agent;
String type;
Integer[] itemsIds;
agent.SetRankOnStatusMonitors(type, itemsIds);

​Constructors

​NSSaintAgent()

​Methods

​CreateDefaultSaintConfiguration()

​CreateDefaultStatusMonitor()

​CreateDefaultStatusMonitorPeriods()

​GetSaintConfigurations()

​GetStatusMonitor(Integer)

​GetStatusMonitorPeriods()

​GetStatusMonitors(Integer,String)

​RegenerateCounters(Bool)

​RegenerateStatusMonitor(Integer)

​RegenerateStatusMonitors(Bool)

​SaveSaintConfiguration(NSSaintConfiguration)

​SaveStatusMonitor(NSStatusMonitor)

​SaveStatusMonitorPeriods(NSStatusMonitorPeriods)

​SetRankOnStatusMonitors(String,Integer[])

Constructors

NSSaintAgent()

Methods

CreateDefaultSaintConfiguration()

CreateDefaultStatusMonitor()

CreateDefaultStatusMonitorPeriods()

GetSaintConfigurations()

GetStatusMonitor(Integer)

GetStatusMonitorPeriods()

GetStatusMonitors(Integer,String)

RegenerateCounters(Bool)

RegenerateStatusMonitor(Integer)

RegenerateStatusMonitors(Bool)

SaveSaintConfiguration(NSSaintConfiguration)

SaveStatusMonitor(NSStatusMonitor)

SaveStatusMonitorPeriods(NSStatusMonitorPeriods)

SetRankOnStatusMonitors(String,Integer[])