%SYS.Task.DiagnosticReport

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	18	2

Properties
%RunDate	%RunTime	AdvancedReport	ArchiveDirectory
EmailCC	EmailFrom	EmailReplyTo	SMTPPass
SMTPPort	SMTPServer	SMTPUser	WRCHealthCheckEnabled
WRCIssueNumber	zInfoAdhocNotListedInZV	zInfoBackupType	zInfoCPUDetails
zInfoHardwareType	zInfoPrimaryPurpose	zInfoTotalPhysicalMemory	zzInfoNotesFromCustomer

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OriginalNamespace	%PackageName
%RemoveFromSaveSet	%SerializeObject	%SetModified	%ValidateObject
ArchiveDirectoryIsValid	GetCollectionType	GetPropertyName	GetSettings
GetTaskName	OnSubmit	OnTask	SetSettings
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType

• parameter TaskName = "DiagnosticReport";

This defines the user-visible name of this task. It is defined in the subclasses.

• parameter XMLNAME = "ProfilerData";

This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

• property AdvancedReport as %Boolean [ InitialExpression = 0 ];

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

• property ArchiveDirectory as %String(XMLPROJECTION="NONE");

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

• property EmailCC as %String(XMLPROJECTION="NONE");

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

• 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

• property EmailReplyTo as %String(XMLPROJECTION="NONE");

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

• property SMTPPass as %SYS.Task.Password(XMLPROJECTION="NONE");

password of SMTP Authenitcated User

• property SMTPPort as %String(XMLPROJECTION="NONE") [ InitialExpression = 25 ];

port for SNMTP server

• 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

• property SMTPUser as %String(XMLPROJECTION="NONE");

name of SMTP Authenticated User

• 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#

• 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

• 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

• property zInfoBackupType as %String(XMLNAME="BackupType");

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

• property zInfoCPUDetails as %String(XMLNAME="CPUDetails");

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

• property zInfoHardwareType as %String(MAXLEN=500,XMLNAME="HardwareType");

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

• 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

• property zInfoTotalPhysicalMemory as %String(XMLNAME="TotalPhysicalMemory");

total physical memory on the machine

• property zzInfoNotesFromCustomer as %String(MAXLEN=500,XMLNAME="NotesFromCustomer");

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

• classmethod ArchiveDirectoryIsValid(ArchiveDirectory As %String) as %Status

• 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.