Class NSDiagnosticsAgent

NSDiagnosticsAgent()

Diagnostics, usage data collection, caches, and flushing

Declaration

NSDiagnosticsAgent

NSDiagnosticsAgent agent;
agent.callMethod(arg1, arg2);

AddWebAppUsage(NSWebAppUsage[])

Adds WebApp usage to existing log.

Declaration

Void AddWebAppUsage(NSWebAppUsage[] webAppUsages)

Parameters

Returns

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

Changes NetServer log settings.

Declaration

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

Parameters

Returns

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.

Declaration

Void CollectDataAdditions()

NSDiagnosticsAgent agent;
agent.CollectDataAdditions();

Returns

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.

NSDiagnosticsAgent agent;
agent.CollectTableSizes();

Declaration

Void CollectTableSizes()

NSDiagnosticsAgent agent;
agent.CollectTableSizes();

Returns

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.

Declaration

Void CollectWebUsage()

NSDiagnosticsAgent agent;
agent.CollectWebUsage();

Returns

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.

NSDiagnosticsAgent agent;
agent.CollectWinUsage();

Declaration

Void CollectWinUsage()

NSDiagnosticsAgent agent;
agent.CollectWinUsage();

Returns

FlushCaches()

Flushes all NetServer caches

Declaration

Void FlushCaches()

Returns

FlushCachesByName(String[])

Flushes all NetServer caches named

Declaration

Void FlushCachesByName(String[] cacheNames)

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

Parameters

Returns

GetCacheNames()

Gets the name of the caches that can be flushed

Declaration

String[] GetCacheNames()

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

Returns

GetWebAppUsagesForPeriod(DateTime,DateTime,String)

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

Declaration

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

Parameters

Returns

LogViewState(String)

Logs a change in view state.

Declaration

Void LogViewState(String viewState)

Parameters

Returns

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.

Declaration

String PerformTasksAfterUpgrade()

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

Returns

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.

Declaration

Void ResyncUsers()

NSDiagnosticsAgent agent;
agent.ResyncUsers();

Returns

WebAppUsageExistsInPeriod(Integer,String,DateTime)

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

Declaration

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

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

Parameters

Returns