Skip to main content

%SYS.Task.DiagnosticReport

Class %SYS.Task.DiagnosticReport Extends (%SYS.Task.Definition, %XML.Adaptor) [ Inheritance = right, System = 4 ]

Task provided by the WRC to automate the collection of reports, and to automate them being sent to the WRC for achival and configuration history

Parameters​

TaskName​

Parameter TaskName = "DiagnosticReport";

XMLNAME​

Parameter XMLNAME = "ProfilerData";

Properties​

ArchiveDirectory​

Property ArchiveDirectory As %String(XMLPROJECTION = "NONE");

if this field is filled, then the files are left in the local Archive

AdvancedReport​

Property AdvancedReport As %Boolean [ InitialExpression = 0 ];

flag to indicate if this should be Advanced Report; default is to collect a Basic report

EmailCC​

Property EmailCC As %String(XMLPROJECTION = "NONE");

used to populate the "From:" field in the email generated to send the Diagnostic Report

EmailFrom​

Property EmailFrom As %String(XMLPROJECTION = "NONE") [ InitialExpression = "DefaultDiagnosticReport@InterSystems.com" ];

used to populate the "From:" field in the email generated to send the Diagnostic Report

EmailReplyTo​

Property EmailReplyTo As %String(XMLPROJECTION = "NONE");

used to populate the "Reply-To:" field in the email generated to send the Diagnostic Report

SMTPServer​

Property SMTPServer As %String(XMLPROJECTION = "NONE");

name of SMTP server to use for sending Diagnostic Report; if this is blank, the Diagnostic Report will not be sent to InterSystems

SMTPUser​

Property SMTPUser As %String(XMLPROJECTION = "NONE");

name of SMTP Authenticated User

SMTPPass​

Property SMTPPass As %SYS.Task.Password(XMLPROJECTION = "NONE");

password of SMTP Authenitcated User

SMTPPort​

Property SMTPPort As %String(XMLPROJECTION = "NONE") [ InitialExpression = 25 ];

port for SNMTP server

WRCHealthCheckEnabled​

Property WRCHealthCheckEnabled As %Boolean(XMLPROJECTION = "NONE") [ InitialExpression = 0 ];

flag to indicate if Diagnostic Report should be emailed to the WRC when collected and not associated with a WRC issue#

WRCIssueNumber​

Property WRCIssueNumber As %Integer(XMLPROJECTION = "NONE");

WRC Issue Number to be included in subject; NOTE: This is cleared after a Diagnostic Report is sent with this in the Subject line, and needs to be reinitilized through the System Management Portal

zInfoAdhocNotListedInZV​

Property zInfoAdhocNotListedInZV As %String(XMLNAME = "AdhocNotListedInZV");

if there are any Adhocs applies as changed files only, which didn't update the $ZV string, they should be listed here

zInfoBackupType​

Property zInfoBackupType As %String(XMLNAME = "BackupType");

manual field indicating the types of backups used on this InterSystems IRIS instance

zInfoCPUDetails​

Property zInfoCPUDetails As %String(XMLNAME = "CPUDetails");

manual field indicating the type and quantity of CPU(s) used on this system

zInfoHardwareType​

Property zInfoHardwareType As %String(MAXLEN = 500, XMLNAME = "HardwareType");

manual field indicating the type of hardware that this system is running on

zInfoPrimaryPurpose​

Property zInfoPrimaryPurpose As %String(DISPLAYLIST = ",Development,Testing,Quality Assurance,Production,", VALUELIST = ",Dev,Test,QA,Prod,", XMLNAME = "PrimaryPurpose");

manual property indicates what the primary use is for this InterSystems IRIS instance: Development, Testing, QA or Production

zInfoTotalPhysicalMemory​

Property zInfoTotalPhysicalMemory As %String(XMLNAME = "TotalPhysicalMemory");

total physical memory on the machine

zzInfoNotesFromCustomer​

Property zzInfoNotesFromCustomer As %String(MAXLEN = 500, XMLNAME = "NotesFromCustomer");

any special notes that the customer wants included with the Diagnostic Report

Methods​

ArchiveDirectoryIsValid​

ClassMethod ArchiveDirectoryIsValid(ArchiveDirectory As %String) As %Status

OnTask​

Method OnTask() As %Status

This method is responsible for executing the task At the scheduled time, the Task Manager - creates an instance of this object, - Sets any property values using the stored "Settings" for the task, - and invokes this method to execute the task.