Skip to main content

Utils.Tasks.BuildInventory

class Utils.Tasks.BuildInventory extends %SYS.Task.Definition

Method Inventory

Parameters

parameter ALERTSFILENAMES = ,alerts.log;
parameter ALERTSSUBDIR = alerts;
parameter BADULINKSFILENAMES = ,errors-bad-links-external.xml;
we treat this one errors*.xml file differently...
parameter CODELOADLOGFILENAMES = ,reload-helper-code-irisdocs1.log,reload-helper-code-irisdocs2.log,reload-helper-code-irisdocs3.log,reload-helper-code-iscdocs.log,reload-helper-code-isc8docs.log;
parameter CODELOADLOGSUBDIR = code-reload-logs;
parameter COMBINEDFEEDBACKDATAFILENAMES = ,feedback-combined-backup-with-email.xml,helpful-combined-backup.xml;
parameter FEEDBACKDATAFILENAMES = ,feedback.xml,feedback_pagehelpful.xml;
parameter FEEDBACKSUBDIR = feedback;
parameter INSTANCEDATAFILENAMES = ,Temp.ContentStats.xml,Temp.Settings.xml,Temp.Updates.xml,Temp.Versions.xml,HIERARCHYFILEEXISTS.txt,HOMEPAGEEXISTS.txt,JSONDOCUMATICINPROGRESS.TXT,JSONNOTDOCUMATICINPROGRESS.TXT,LOADINPROGRESS.TXT;
Removed ,JSONDOCUMATICEXISTS.TXT,JSONNOTDOCUMATICEXISTS.TXT from this list
parameter INSTANCESUBDIR = instances;
parameter LOADLOGFILENAMES = ,reload-irisboth.log,reload-isc.log;
parameter LOADLOGSUBDIR = loadlogs;
parameter QCERRORFILENAMES = ,errors-bad-links-internal.xml,errors-bad-olinks.xml,errors-bad-syntax.xml,errors-brand-check.xml,errors-graphics-alttexttoolong.xml,errors-graphics-invalidwidth.xml,errors-graphics-nullalttext.xml,errors-graphics-filemissing.xml,errors-hasatab.xml,errors-help-links.xml,errors-hierarchy.xml,errors-longline.xml,errors-missingids-lowersect.xml,errors-missingids-page.xml,errors-missingids-sect1.xml,errors-pages-long-metadesc.xml,errors-tables-multipletgroups.xml,errors-tables-noheads.xml,errors-tables-with-spans.xml;
all QC error files (errors*.xml) except errors-bad-links-external.xml, which is treated differently
parameter QCSUBDIR = QC;
parameter USAGEDATAFILENAMES = ,Temp.SessionCounts.xml,Temp2.BadKeyCounts.xml,Temp2.BadSearchCounts.xml,Temp2.CRCounts.xml,Temp2.HelpKeyCounts.xml,Temp2.KeyCounts.xml,Temp2.OldHelpKeyCounts.xml,Temp2.SearchCounts.xml;
parameter USAGESUBDIR = usage;

Methods

classmethod AddCombinedFeedbackFilenames()
Runs only if ^Settings("MONITOR","combinedfeedback","server") and ^Settings("MONITOR","combinedfeedback","directory") are set.
classmethod BuildServerDirInventory(verbose As %Boolean = 1)
classmethod GetFilesAsLB(directory) as %List
Helper method
classmethod GetNewRecord(server, instance, category, shortfilename) as DBMTables.Central.ReportFiles
Helper method
classmethod GetRemoteFilesAsLB(sftp, directory) as %List
Helper method
classmethod GetSubdirsAsLB(directory) as %List
Helper method
classmethod InitializeFileInventory(verbose As %Boolean)
This generates filenames that will be looked for on UNIX systems, so case is very important Creates a set of *possible* records based on what we know about our server directories as well as what files we are looking for. Initialization does not require access to the servers. It does assume the ServerDirectories table has already been built.
method OnTask() as %Status
Scans the file system on the servers (assumes the standard install locations for our instances) and builds the DBMTables.Central.ServerDirectories table, and the DBMTables.Central.ReportFiles table. Other methods use these tables to know where to pick up files. This method runs once a day at 3 AM.
classmethod QueryDirectoryAsLB(directory, type="F") as %List
Helper method. Type can be either F or D, to get either files or directories
classmethod QueryRemoteDirectoryAsLB(sftp="", directory="") as %List
Helper method.
classmethod SaveRecord(record As DBMTables.Central.ReportFiles, skipExistenceTest=0)
Helper method

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab