%SYS
DiagnosticReport Class Reference

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

Inheritance diagram for DiagnosticReport:
Collaboration diagram for DiagnosticReport:

Public Member Functions

_.Library.Status OnTask ()
 This method is responsible for executing the task. More...
 
- Public Member Functions inherited from Definition
_.Library.List GetSettings ()
 Return a serialized list of user-defined Property values for an instance of this Task as a $List. More...
 
_.Library.Status OnSubmit (_.Library.String pID, _.Library.String pSubmit)
 This callback is called when this form is submitted. More...
 
_.Library.Status SetSettings (_.Library.List pState)
 Called by the Task Manager prior to running OnTask() to set all Property values. More...
 

Public Attributes

 AdvancedReport
 flag to indicate if this should be Advanced Report; default is to collect a Basic report More...
 
 ArchiveDirectory
 if this field is filled, then the files are left in the local Archive
More...
 
 EmailCC
 used to populate the "From:" field in the email generated to send the Diagnostic Report More...
 
 EmailFrom
 used to populate the "From:" field in the email generated to send the Diagnostic Report More...
 
 EmailReplyTo
 used to populate the "Reply-To:" field in the email generated to send the Diagnostic Report More...
 
 SMTPPass
 password of SMTP Authenitcated User More...
 
 SMTPPort
 port for SNMTP server More...
 
 SMTPServer
 name of SMTP server to use for sending Diagnostic Report; if this is blank, the Diagnostic Report will not be sent to InterSystems More...
 
 SMTPUser
 name of SMTP Authenticated User More...
 
 WRCHealthCheckEnabled
 flag to indicate if Diagnostic Report should be emailed to the WRC when collected and not associated with a WRC issue# More...
 
 WRCIssueNumber
 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. More...
 
 zInfoAdhocNotListedInZV
 if there are any Adhocs applies as changed files only, which didn't update the $ZV string, they should be listed here More...
 
 zInfoBackupType
 manual field indicating the types of backups used on this InterSystems IRIS instance More...
 
 zInfoCPUDetails
 manual field indicating the type and quantity of CPU(s) used on this system More...
 
 zInfoHardwareType
 manual field indicating the type of hardware that this system is running on More...
 
 zInfoPrimaryPurpose
 manual property indicates what the primary use is for this InterSystems IRIS instance: Development, Testing, QA or Production More...
 
 zInfoTotalPhysicalMemory
 total physical memory on the machine More...
 
 zzInfoNotesFromCustomer
 any special notes that the customer wants included with the Diagnostic Report More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Definition
_.Library.Boolean CheckPermission (_.Library.String taskClass, _.Library.String namespace, _.Library.Status sc)
 This method checks if the current process has the permission defined by the RESOURCE parameter for the given Task class. More...
 
_.Library.String GetCollectionType (_.Library.String propertyName, _.Library.String tCollection)
 Return a collection type for a property. More...
 
_.Library.String GetTaskName ()
 Returns the localized name of this task.
 
- Static Public Attributes inherited from Definition
 DOMAIN = None
 This class defines a task that can be executed by the Task Manager. More...
 
 RESOURCE = None
 This specifies a security resource and optional permission. More...
 
 TaskName = None
 This defines the user-visible name of this task. More...
 

Detailed Description

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.

Member Function Documentation

◆ OnTask()

_.Library.Status OnTask ( )

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.

Reimplemented from Definition.

Member Data Documentation

◆ AdvancedReport

AdvancedReport

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

 

◆ ArchiveDirectory

ArchiveDirectory

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

 

◆ EmailCC

EmailCC

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

 

◆ EmailFrom

EmailFrom

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

 

◆ EmailReplyTo

EmailReplyTo

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

 

◆ SMTPPass

SMTPPass

password of SMTP Authenitcated User

 

◆ SMTPPort

SMTPPort

port for SNMTP server

 

◆ SMTPServer

SMTPServer

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

 

◆ SMTPUser

SMTPUser

name of SMTP Authenticated User

 

◆ WRCHealthCheckEnabled

WRCHealthCheckEnabled

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

 

◆ WRCIssueNumber

WRCIssueNumber

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

zInfoAdhocNotListedInZV

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

 

◆ zInfoBackupType

zInfoBackupType

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

 

◆ zInfoCPUDetails

zInfoCPUDetails

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

 

◆ zInfoHardwareType

zInfoHardwareType

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

 

◆ zInfoPrimaryPurpose

zInfoPrimaryPurpose

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

 

◆ zInfoTotalPhysicalMemory

zInfoTotalPhysicalMemory

total physical memory on the machine

 

◆ zzInfoNotesFromCustomer

zzInfoNotesFromCustomer

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