Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

Utils.Tasks.GetAndBuild

class Utils.Tasks.GetAndBuild

Wrapper code for use in retrieving files from the doc servers and building tables for use in the DAD and in the Usage Dashboards. Requires login credentials for all the doc servers.

Method Inventory

Methods

classmethod Alerts(verbose As %Boolean = 1)
Scans all the instances on the servers (public and internal), gets their alerts.log files, and then rebuilds the DBMTables.Central.AlertsLog table.

For determining the locations of files to get, this method assumes up-to-date DBMTables.Central.ServerDirectories table; see ServerDirectoryInventory().

Run this via Utils.Tasks.CheckAlertsLogs.

classmethod CodeReloadLogs(verbose As %Boolean = 1)
DOCS-12140 -- Gets the code-reload logs from /nethome/docuser/code-reload-logs/ and stashes them in the central directory

Run this via Utils.Tasks.CheckAlertsLogs.

classmethod DBMReports(verbose As %Boolean = 1)
Retrieves the DBM error report files (error-*.xml) from the docupdatelogs and docupdatelogsj from all the instances. These files are exported soon after a content load; they contain information about the errors like broken links and too-long lines in program listings. Then it rebuilds the DBMTables.Central.DBMErrors table as well as the DBMTables.Central.BadURLs table (which maybe we don't need).

Creates or updates records in DBMTables.Central.ReportFiles.

For determining the locations of files to get, this method assumes up-to-date DBMTables.Central.ServerDirectories table; see ServerDirectoryInventory().

Run this via Utils.Tasks.BuildDBMReport.

classmethod LoadLogs(verbose As %Boolean = 1)
Scans the content load logs (at their network location) and rebuilds the DBMTables.Central.LoadLog table.

Does NOT use the DBMTables.Central.ServerDirectories table.

Run this via Utils.Tasks.BuildLoadLog.

classmethod OtherData(verbose As %Boolean = 1)
Retrieves the smaller files from the docupdatelogs and docupdatelogsj directories of the instances (that is, not the large Temp2.Count*.xml and the large error-*.xml files). Also gets files from the DocBookMgr/algolia directories of the instances. Then rebuilds these tables:

It also *updates* the Feedback.Combined and Feedback.Combined.PageUseful tables (but does not clear them first). Note that the UsageData() method also does this step.

Creates or updates records in DBMTables.Central.ReportFiles.

For determining the locations of files to get, this method assumes up-to-date DBMTables.Central.ServerDirectories table; see ServerDirectoryInventory().

Run this via Utils.Tasks.BuildOtherData.

classmethod PDFBuildInfo(verbose As %Boolean = 1)
Scans the PDF build logs (at their network location) and then rebuilds the DBMTables.Central.PDFLog and DBMTables.Central.PDFErrorLogItem tables.

Does NOT use the DBMTables.Central.ServerDirectories table.

Run this via Utils.Tasks.CheckPDFLogs.

classmethod ServerDirectoryInventory(verbose As %Boolean = 1)
Scans the file system on the servers (assumes the standard install locations for our instances) and builds the DBMTables.Central.ServerDirectories table. Other methods use that table to know where to pick up files.

Run this via Utils.Tasks.BuildServerDirInventory.

classmethod URLTable()
Does the once-daily build of URL table.
classmethod UsageData(verbose As %Boolean = 1)
Retrieves the usage files (Temp2.Count*.xml and feedback*.xml) from the docupdatelogs and docupdatelogsj directories of the instances. These files which tell us things like "how many times viewed." Then it rebuilds the DBMTables.Usage tables.

It also *updates* the Feedback.Combined and Feedback.Combined.PageUseful tables (but does not clear them first). Note that the OtherData() method also does this step.

Creates or updates records in DBMTables.Central.ReportFiles.

For determining the locations of files to get, this method assumes up-to-date DBMTables.Central.ServerDirectories table; see ServerDirectoryInventory().

Run this via Utils.Tasks.BuildUsageData.

FeedbackOpens in a new tab