NSDiagnosticsAgent - SuperOffice

Diagnostics, usage data collection, caches, and flushing

Constructors

NSDiagnosticsAgent()

NSDiagnosticsAgent

Diagnostics, usage data collection, caches, and flushing

Methods

AddWebAppUsage(NSWebAppUsage[])

Adds WebApp usage to existing log.

Void AddWebAppUsage(NSWebAppUsage[] webAppUsages)

Returns: CRMScript.Global.Void

ChangeLogSettings(Bool,Bool,Bool,Bool,Bool,Bool,Bool,Bool)

Changes NetServer log settings.

Void ChangeLogSettings(Bool logWarning, Bool logInformation, Bool logSuccessAudit, Bool logFailureAudit, Bool logToEventLog, Bool logToSuperOffice, Bool logToFile, Bool logToTrace)

Returns: CRMScript.Global.Void

CollectDataAdditions()

Collects and transmits usage statistics: Database Additions. If opted-out then this call does nothing. The call returns immediately (starting a background thread), and updates CS scheduler table to set the next run time.

Void CollectDataAdditions()

Returns: CRMScript.Global.Void Example:

NSDiagnosticsAgent agent;
agent.CollectDataAdditions();

CollectTableSizes()

Collects and transmits usage statistics: Table Sizes. If opted-out then this call does nothing. The call returns immediately (starting a background thread), and updates CS scheduler table to set the next run time. <pre><code>NSDiagnosticsAgent agent; agent.CollectTableSizes();</code></pre>

Void CollectTableSizes()

Returns: CRMScript.Global.Void Example:

NSDiagnosticsAgent agent;
agent.CollectTableSizes();

CollectWebUsage()

Collects and transmits usage statistics: Web-based clients Usage. If opted-out then this call does nothing. The call returns immediately (starting a background thread), and updates CS scheduler table to set the next run time.

Void CollectWebUsage()

Returns: CRMScript.Global.Void Example:

NSDiagnosticsAgent agent;
agent.CollectWebUsage();

CollectWinUsage()

Collects and transmits usage statistics: Windows CRM Client Usage. If opted-out then this call does nothing. The call returns immediately (starting a background thread), and updates CS scheduler table to set the next run time. <pre><code>NSDiagnosticsAgent agent; agent.CollectWinUsage();</code></pre>

Void CollectWinUsage()

Returns: CRMScript.Global.Void Example:

NSDiagnosticsAgent agent;
agent.CollectWinUsage();

FlushCaches()

Flushes all NetServer caches

Void FlushCaches()

Returns: CRMScript.Global.Void

FlushCachesByName(String[])

Flushes all NetServer caches named

Void FlushCachesByName(String[] cacheNames)

Returns: CRMScript.Global.Void Example:

NSDiagnosticsAgent agent;
String[] cacheNames;
agent.FlushCachesByName(cacheNames);

GetCacheNames()

Gets the name of the caches that can be flushed

String[] GetCacheNames()

Returns: CRMScript.Global.String[] Example:

NSDiagnosticsAgent agent;
String[] res = agent.GetCacheNames();

GetWebAppUsagesForPeriod(DateTime,DateTime,String)

Gets all WebAppUsages for a given period, that match an optional search term

NSWebAppUsage[] GetWebAppUsagesForPeriod(DateTime fromDate, DateTime toDate, String searchTerm)

Returns: CRMScript.NetServer.NSWebAppUsage[]

LogViewState(String)

Logs a change in view state.

Void LogViewState(String viewState)

Returns: CRMScript.Global.Void

The granularity of the logging depends on the current configuration.This call returns asynchronously, leaving the server to finish processing later on.

PerformTasksAfterUpgrade()

After upgrading to a new file set, there may be tasks that need to be done. Fpr example, import new TypicalSearches, if present. Tasks performed here need to be idempotent and independent of the actual upgrade jump (what was the previous version). They should complete in a reasonable time, not more than a few minutes maximum.

String PerformTasksAfterUpgrade()

Returns: CRMScript.Global.String Example:

NSDiagnosticsAgent agent;
String res = agent.PerformTasksAfterUpgrade();

ResyncUsers()

Resynchronizes user information with SuperOffice Community, if opted-out then this call does nothing. The call returns immediately (starting a background thread), and updates CS scheduler table to set the next run time.

Void ResyncUsers()

Returns: CRMScript.Global.Void Example:

NSDiagnosticsAgent agent;
agent.ResyncUsers();

WebAppUsageExistsInPeriod(Integer,String,DateTime)

Checks if viewState has been clicked at least once since a date.

Bool WebAppUsageExistsInPeriod(Integer associateId, String viewState, DateTime fromDate)

Returns: CRMScript.Global.Bool - true if viewState has been clicked at least once since FromDate, if asscoiateId < 0 or FromDate is DateTime.MinValue no restriction given for those parameters. Example:

NSDiagnosticsAgent agent;
Integer associateId;
String viewState;
DateTime fromDate;
Bool res = agent.WebAppUsageExistsInPeriod(associateId, viewState, fromDate);

​Constructors

​NSDiagnosticsAgent()

​Methods

​AddWebAppUsage(NSWebAppUsage[])

​ChangeLogSettings(Bool,Bool,Bool,Bool,Bool,Bool,Bool,Bool)

​CollectDataAdditions()

​CollectTableSizes()

​CollectWebUsage()

​CollectWinUsage()

​FlushCaches()

​FlushCachesByName(String[])

​GetCacheNames()

​GetWebAppUsagesForPeriod(DateTime,DateTime,String)

​LogViewState(String)

​PerformTasksAfterUpgrade()

​ResyncUsers()

​WebAppUsageExistsInPeriod(Integer,String,DateTime)

Constructors

NSDiagnosticsAgent()

Methods

AddWebAppUsage(NSWebAppUsage[])

ChangeLogSettings(Bool,Bool,Bool,Bool,Bool,Bool,Bool,Bool)

CollectDataAdditions()

CollectTableSizes()

CollectWebUsage()

CollectWinUsage()

FlushCaches()

FlushCachesByName(String[])

GetCacheNames()

GetWebAppUsagesForPeriod(DateTime,DateTime,String)

LogViewState(String)

PerformTasksAfterUpgrade()

ResyncUsers()

WebAppUsageExistsInPeriod(Integer,String,DateTime)