Home  ›  Intersystems Cache Database How to Read It

Intersystems Cache Database How to Read It

Written By Sunday, March 6, 2022 Add Comment Edit

Cheers for your feedback!
Need to tell usa more than? Click hither or apply the Feedback button.

Is this folio helpful?

Contents

  • Maintaining Local Databases
  • Controlling Caché Processes
  • Using the Task Director
  • Using the Groundwork Tasks Folio

Managing Caché

This chapter explains common Caché operations tasks including displaying procedure details, broadcasting messages, and monitoring processes. This chapter discusses the following topics:

  • Maintaining Local Databases

  • Decision-making Caché Processes

  • Using the Task Manager

  • Using the Background Tasks Page.

Maintaining Local Databases

You can review and maintain local databases on the Databases folio of the Direction Portal (Organisation Operations > Databases). From this page, you tin view the post-obit data:

  • Databases General Information — Overview data for all databases.

  • Database Details Page — Specific data for individual databases.

  • Databases Free Infinite Data — Complimentary space information for all databases. Yous can besides perform maintenance operations to increment free space from this page.

You also have the option to perform an integrity check using the buttons at the pinnacle of the page. For more information, come across the Verifying Structural Integrity section of the "Introduction to Data Integrity" chapter of Data Integrity Guide.

Databases General Data

The Databases page (System Operation > Databases) contains a listing of all local databases. For each local database, you come across the following data:

Local Databases List Information

Column Heading Definition
Proper noun The database name; click this name to display more details. See Database Details Folio.
Directory The organisation directory in which the database resides.
Max Size (GB) The maximum size allocated to which the database can abound, in gigabytes.
Size (MB) The current allocated size of the database, in megabytes.
Condition

The condition of the database: mounted (including which permissions it has), unmounted, or dismounted.

  • A mounted database is one for which Mount Required at Startup is selected, every bit described in Edit Database Properties in the "Configuring Caché" chapter of this guide, and which therefore must be mounted for Caché to kickoff or become master in a mirror; in this example, it is always mounted and accessible when Caché starts. Alternatively, information technology is a previously unmounted database that has been mounted dynamically when y'all accessed it or explicitly mounted it; in this case, information technology remains mounted until you explicitly dismount it or restart/stop Caché.

  • An unmounted database is 1 for which Mountain Required at Startup is not selected and which therefore does non demand to be mounted for Caché to start or go mirror main, and has been neither accessed nor explicitly mounted; information technology is mounted dynamically when you access it or explicitly mountain information technology, and remains mounted until you explicitly dismount it or restart/stop Caché.

  • A dismounted database is one that has been explicitly dismounted; it is inaccessible until you explicitly mount information technology or restart/terminate Caché (that is, a dismounted database is not mounted dynamically if you attempt to admission it). To permanently dismount a database you lot must remove information technology from the configuration, as described in Local Databases in the "Configuring Caché" chapter of this guide.

Annotation:

For data nearly explicitly mounting or dismounting a database, meet the Dismount / Mount activeness buttons in this table.
Encrypted Indicates whether or not the database is encrypted.
Journal Indicates whether globals in the database are journaled with a Y or an Due north.
Dismount / Mount

Buttons that let yous explicitly dismount or mount a database. The new status remains in effect until you lot explicitly change it or restart/finish Caché; to permanently dismount a database, you must remove it from the configuration.

In add-on, the folio contains a filter bar that you can utilise to control the number of databases displayed. For example, to list only the system databases, you lot might enter cac* in the Filter: text box; and/or to list but five databases per page, enter 5 in the Page size: text box; and/or to limit the number of rows displayed to iii, enter 3 in the Max rows: text box (a + sign displayed with the number in the Results field indicates there are additional databases that run into the specified criteria, but they are not displayed).

Database Details Page

The Database Details folio displays detailed information about whatever database. To admission this information from the Management Portal:

  1. Display the Databases page (Organization Functioning > Databases).

  2. Click the name of the database for which yous would like to see more than details.

The page includes data specific to the selected database, which is organized into a General Information table and a Database Size tabular array:

General Information

Field Definition
Directory Name of directory where this database resides.
Resource Proper name Resource proper noun assigned to this database.
Mounted Indicates whether this database is mounted.
Read Only Indicates whether this database is mounted as read-only.
Cluster Mounted Indicates whether this database is mounted within a cluster.
Encrypted Indicates whether this database is encrypted.
Encryption Cardinal ID Indicates encryption key ID.

Database Size

Field Definition
Cake Size Block size (bytes) for this database.
Blocks Current number of blocks inside this database.
Max Size Maximum size (MB) allowed for this database.
Size Maximum size (MB) allowed for this database.
Expansion Size: Amount (MB) this database will expand by.
Final Expansion Time Terminal time this database expanded.
Full Indicates that this database is full.

Displaying Free Infinite Data

To get free infinite information, you can display the Database Freespace folio of the Direction Portal or apply the ^%FREECNT utility.

Call back that the size and free infinite attributes of a database in normal operation change continuously, and that numbers reported by the portal or the utility at a given indicate in time are approximations only.

Display Free Space Data Using the Management Portal

To display the Database Freespace page, which shows data about the amount of free infinite on each local database and lets you compact and/or truncate databases, navigate to the Databases page and click Freespace. The following table describes the data displayed on the Database Freespace page:

Local Databases Freespace Data

Column Heading Definition
Proper noun The database proper name.
Directory The system directory in which the main volume of the database resides.
Max Size The maximum allocated size to which the database tin can grow, in gigabytes. The default is unlimited when you create a database.
Size The current allocated size of the database, in megabytes.
Expansion Size Size (in MB) past which to expand the database. The default and recommended setting is zero (0) when y'all create a database, which indicates the use of organization defaults (12% of the current size or 10 MB, whichever is larger). Nether this setting, the expansion size will not be greater than 1GB.
Available The amount of complimentary space (in MB) available in the database.
% Free The percentage of gratuitous space available in the database.
Disk Free Infinite The corporeality of space free on the book.
Condition The status of the directory, which indicates if the database is mounted and with what permissions.

Managing the free space (empty blocks) in a database is an important aspect of database maintenance. You tin perform the post-obit free space management operations on the Database Freespace folio

  • Compact a database — Move free space distributed throughout a database to its terminate

  • Truncate a database — Return gratuitous space at the end of a database to the underlying file arrangement

In addition, yous tin can use the ^DATABASE utility for the following database management operations involving global blocks (blocks containing global data):

  • Compact globals in a database — Reduce unused space within global blocks and the overall number of global blocks, increasing gratis space

  • Defragment globals in a database — Relocate global blocks so that the blocks representing a given global are in continuous sequence

The ^DATABASE utility can too be used to display free infinite data and to compact and truncate databases, forth with performing other database tasks such every bit recreating a database, which lets yous clear the data in an existing database without changing the database'southward name or size. See ^DATABASE in the "Using Character-based Security Management Routines" chapter of the Caché Security Administration Guide for data nigh the utility.

Annotation:

The data structures used by Caché are self-balancing and suffer no performance degradation over fourth dimension. Information technology is never necessary to take a database down to rebuild it nor to compress data or indices to regain performance.

Display Free Space Information Using ^%FREECNT

Caché also provides the ^%FREECNT utility, which yous run past entering do ^%FREECNT in the Terminal, to brandish the free space bachelor in a database.

When using ^%FREECNT in the %SYS namespace, you tin can choose to display the gratis infinite of all databases past entering an asterisk (*) at the prompt, or enter one database directory name. For example:

%SYS>do ^%FREECNT   Database directory to show costless space for (*=All)? *   Databases Selected ------------------ c:\MyCache\mgr\ c:\MyCache\mgr\cacheaudit\ c:\MyCache\mgr\cachelib\ c:\MyCache\mgr\cache\ c:\MyCache\mgr\cachetemp\ c:\MyCache\mgr\docbook\ c:\MyCache\mgr\samples\ c:\MyCache\mgr\user\ Device: Right margin: lxxx =>                                Cache Database Free Space                               Feb 15 2012  7:25 PM Database                           Max Size  Size    Available %Free   Disk Free c:\MyCache\mgr\                    Unlimited 191MB   19MB      9.94    sixty.79GB c:\MyCache\mgr\cacheaudit\         Unlimited 1MB     0.43MB    43      60.79GB c:\MyCache\mgr\cachelib\           Unlimited 319MB   27MB      8.46    sixty.79GB c:\MyCache\mgr\enshroud\              Unlimited 1MB     0.55MB    55      sixty.79GB c:\MyCache\mgr\cachetemp\          Unlimited 4MB     ane.5MB     37.5    sixty.79GB c:\MyCache\mgr\docbook\            Unlimited 144MB   11MB      7.63    60.79GB c:\MyCache\mgr\samples\            Unlimited 114MB   52MB      45.61   60.79GB c:\MyCache\mgr\user\               Unlimited 1MB     0.43MB    43      sixty.79GB

In a namespace other than %SYS, the utility shows the costless space of the databases in that namespace. For instance:

USER>Do ^%FREECNT     Databases Selected ------------------ c:\MyCache\mgr\user\ Device: Right margin: lxxx =>                                Cache Database Free Space                               Feb xv 2012  7:28 PM Database                           Max Size  Size    Bachelor %Free   Disk Complimentary c:\MyCache\mgr\user\               Unlimited 1MB     0.52MB    52      42.72GB

Note:

A <- flag (in the %Free column) indicates that the percentage of free space in the specified database has dropped below 5%. Ensure that at that place is enough infinite on the filesystem to handle database expansion.

You lot may choose the device to which to transport the information and choose the line length of the display.

Compacting a Database

Compacting a database moves gratis space distributed throughout the database to its end past relocating global blocks. You can then return the free infinite to the underlying file system by truncating the database. (You can likewise compact globals; see Meaty Globals in a Database.)

When y'all compact a database, y'all specify the amount of the bachelor gratis space to be positioned at its end, and the operation moves enough global blocks from the end to the offset to ensure that at to the lowest degree that amount of free space is located at the terminate. (The performance cannot create more complimentary space, so it can never identify more at the terminate than the total available amount.)

For instance, suppose the size of a database is 50 MB, with 15 MB of that being gratuitous space, and v MB of that costless space already positioned at the end of the database. If you lot compact the database and specify more than than five MB simply less than 15MB, global blocks are moved from the end of the database to the beginning until the complimentary space at the end equals the amount y'all specified; if you specify 15 MB, all possible global blocks are moved to the beginning.

To meaty a database:

  1. Navigate to the Databases page (System Operations > Databases) and click Freespace to display the Database Freespace page.

  2. Click Meaty in the row of the database you want to compact. This displays the Compact Database page, which shows the name and location of the database, its electric current size, the full available complimentary space, and the amount of complimentary space currently at the end of the file.

    Notation:

    If a database is mounted read only and the Caché instance is not a fill-in or async mirror member (see the "Mirroring" chapter of the Caché High Availability Guide), the Compact link does non appear in its row on the Database Freespace page.

  3. The Target freespace (in MB) at finish of file prompt allows you to specify the amount of free space you want at the end of the file following the performance. Your entry must be within the stated range. In one case you have entered an corporeality, click OK. (If all of the free space is already at the end, or in that location is no gratis infinite, the prompt does not announced and the OK button is disabled.)

    Note:

    For a number of reasons, the operation may motion more free space than the amount you specify. Conversely, considering the numbers reported are approximations, it is possible that not all of the free infinite displayed tin actually be moved.

  4. When the Compact dialog box displays a message that the background job has started, click the Click here to view the background tasks page link almost the top of the folio to view the condition of Compact Database Space background tasks on the Background Tasks page (Arrangement Operation > Background Tasks).

  5. In the Compact dialog box, click Washed to redisplay the Database Freespace page. If >> is displayed in the beginning column of the database row, refresh the folio to see the new size displayed in the Size column.

Note:

The compact database operation is designed to run concurrently with normal database activity. The operation does consume some system resource, all the same, and may not complete if the system is under extremely high load. For these reasons, InterSystems recommends running this and other database reorganization operations (including compacting and defragmenting globals) during off-peak hours, and running but ane such performance on a system at a time.

Truncating a Database

Truncating a database returns free space from the end of the database to the underlying file organization. A database is often truncated after being compacted, which moves complimentary infinite to the end of the database.

When you truncate a database, you specify a target size for the database. If there is sufficient free space at the cease of database, the functioning removes enough to reduce the database to the target size; if non, it removes all that can be removed. (To notice out how much of a database's complimentary space is positioned at the end, compact the database; you practise not demand to consummate the operation to brandish current total available free infinite and the amount at the end.)

Note:

This characteristic is non applicative to databases with raw volumes or cluster-mounted volumes.

To truncate a database:

  1. Navigate to the Databases page (System Operation > Databases) and click Freespace to display the Database Freespace folio.

    Note:

    Gratuitous infinite for truncation purposes is different than free infinite for storing information. Sure control structures can be deleted during truncation if they are not being used for data storage. This can lead to a departure in reported free infinite.

  2. Click Truncate in the row of the database y'all desire to truncate. This displays the Truncate Database page (System Operation > Databases > Freespace > Truncate), which shows the proper noun, location, and current size in megabytes (MB) of the selected database.

    Notation:

    If a database is mounted read only and the Caché case is non a backup or async mirror member (see the "Mirroring" affiliate of the Caché High Availability Guide), the Truncate link does not appear in its row on the Database Freespace page.

  3. Enter the Target File Size (MB), which must be less than the electric current size, and click OK. Enter 0 to remove all possible free infinite from the end of the file.

  4. When the page displays a message that the groundwork job has started, click the Click here to view the background tasks page link almost the top of the folio to view the status of groundwork tasks on the Groundwork Tasks page (System Operation > Groundwork Tasks).

  5. In the Truncate dialog box, click Done to redisplay the Database Freespace page. If >> is displayed in the first column of the database row, refresh the page to encounter the new size displayed in the Size column.

Compacting Globals in a Database

The Compact globals in a database option of the ^DATABASE routine consolidates global information into fewer blocks, increasing the amount of free space in a database.

When globals are created and updated, Caché typically allocates data in a fashion that fills global blocks to about 70% of capacity. (Globals that take grown entirely in collation order may exist allocated at closer to 90%.) In general, allowing Caché to manage global block density automatically is sufficient. Yet, some nonsequential patterns of data deletion may reduce average global block density considerably.

Note:

To run into the current density of the global blocks in a database on a global by global basis, you tin run an integrity check (as described in Verifying Structural Integrity in the chapter "Introduction to Information Integrity" in the Caché Data Integrity Guide) and examine the Data Level output for each global.

When yous compact globals, you specify a desired global block density (90% by default) and the operation attempts to come equally close to this as possible by consolidating data—for example, rearranging global data that is spread across three blocks into two. Typically (simply not e'er), compacting globals yields a meaningful increase in available free space within a database. (If you specify a target density that is lower than the current global cake density of the database, the size of the database does non increase.)

To compact the globals in a database, use the following procedure:

  1. Open up the Terminal and change to the %SYS namespace.

  2. Enter practise ^DATABASE and select seven) Compact globals in a database from the menu.

  3. Specify the directory of the database on which you want to run the functioning. You tin can specify multiple databases by inbound ? at the Database directories to compact? prompt for a numbered list, then a listing of numbers, for example 1,4,7-10.

  4. Indicate that y'all want to compact all globals, or instead enter a listing of private globals to be compacted.

  5. Specify the target average global block density, betoken whether yous want to brandish the results of the compacting operation for each global, specify the output device, and confirm.

Note:

The compact globals operation is designed to run concurrently with normal database activity. The operation does consume some arrangement resources, yet, and may not complete if the organization is under extremely high load. For these reasons, InterSystems recommends running this and other database reorganization operations (including compacting a database and defragmenting globals) during off-peak hours, and running just one such operation on a system at a time.

Global compaction can involve a temporary increase in the size of the database being compacted. If this causes the database to reach its configured maximum size (come across Local Databases in the "Configuring Caché" affiliate of this guide), or if expansion is not possible because there is insufficient space bachelor on the storage volume, the performance is canceled.

Defragmenting Globals in a Database

The Defragment globals in a database option of the ^DATABASE routine rearranges global blocks inside the database and then that all of the blocks containing data for a given global are in consecutive sequence. The performance does not place large cord blocks or arrow blocks from a global in sequence, but information technology does locate them in a contiguous expanse. As part of the process, the Defragment globals in a database option compacts all globals in the same manner as the Compact globals in a database option, but with a target density of 70%. (If this is lower than the electric current global block density of the database, the size of the database does not increase.)

Note:

The CACHETEMP database cannot be defragmented.

In full general, it is not necessary to run defragmentation on any regular basis. Some workloads, yet, particularly those that read large portions of a database sequentially, can benefit from having global blocks organized sequentially.

The defragmentation process requires a certain amount of free space at the end of the database. For this reason, the post-obit possibilities exist:

  • If there is enough free infinite at the end to perform the operation, information technology completes without any changes to the database beyond global defragmentation.

  • If there is not enough free space in the database, the database is expanded as necessary. When defragmentation is complete, y'all can truncate the database to remove the added free space.

    If there is not enough free infinite in the database just at that place is significant free space that could exist moved to the end, you are informed of this then you can first compact the database and and so choose the Defragment globals in a database option again, reducing the amount of expansion required to complete the defragmentation operation.

To defragment the globals in a database, use the post-obit procedure:

  1. Open up the Terminal and change to the %SYS% namespace.

  2. Enter do ^DATABASE and select xiv) Defragment globals in a database from the menu.

  3. Specify the directory of the database on which you want to run the operation.

  4. Bespeak that desire to permit expansion, if required, and complete.

Note:

The defragment globals operation is designed to run concurrently with normal database activity. The operation does eat some system resource, yet, and may not complete if the system is under extremely loftier load. For these reasons, InterSystems recommends running this and other database reorganization operations (including compacting a database and compacting globals) during off-tiptop hours, and running simply one such functioning on a system at a fourth dimension.

Global defragmentation tin involve a temporary increase in the size of the database beingness compacted. If this causes the database to attain its configured maximum size (meet Local Databases in the "Configuring Caché" chapter of this guide), or if expansion is not possible because at that place is insufficient space available on the storage volume, the operation is canceled.

Important:

The defragment globals performance temporarily relocates all of the data in the database, regardless of the caste of global fragmentation in the database before the operation is run. Subsequent runs of the functioning consume similar amounts of resources but do not provide any additional benefit.

Decision-making Caché Processes

A Caché system runs a number of processes. Application lawmaking besides as Caché system code executes within these processes. In that location are three categories of Caché processes:

  • User processes, created when a user connects to Caché.

  • Background processes, created when a user bug an ObjectScript Chore command, or by the Management Portal or a utility (see Using the Background Tasks Page).

  • Caché system processes.

In this chapter, the word "procedure" by itself refers to both user and background processes.

You lot can manage and command processes using the Direction Portal:

Procedure Management Functions

Function How to admission function from the portal
Display procedure information

Brandish the Processes page (Organization Performance > Processes).
Display process details

Display the Processes page, then click Details in the right hand column of the selected process to display the Process Details page.
Suspend/resume a process

Display the Processes page, so click Details in the correct hand cavalcade of the selected process to display Procedure Details page. Then click Suspend or Resume on the operations bar, as desired.
Terminate a process

Display the Processes page, and then click Details in the correct hand column of the selected process to display the Procedure Details page. So click Terminate or End with <RESJOB> Mistake on the operations bar, as desired.
Display process variables

Display the Processes page, and so click Details in the right hand cavalcade of the selected procedure to display the Process Details page. So click the Variables tab to display the procedure variables.
Broadcast messages to terminals

Brandish the Processes folio and click the Broadcast button to open the Broadcast dialog.

Manage process refresh interval

Display the Processes page; optionally, click Details in the right hand column to display the Process Details page. In either example, edit the Refresh options (on the operations bar), as desired.

Display Procedure Information

To display all the active processes on the organization and basic information nearly each, navigate to the Processes folio (Organization Performance > Processes), which displays a tabular array of the processes with statistics about each in columns.

The following table describes the process data bachelor for brandish:

Process Column Information

Cavalcade Heading Definition
Job # Alphabetize of the Processes tabular array.
Process ID Operating system process identification number (PID).*
User Proper name of the user who owns the process.
Device Electric current device the process is using.
Namespace Namespace in which the process is running.
Routine Name of the routine that the process is currently executing.
Commands Number of commands executed.
Globals Number of global references, including updates, executed (database reads and writes) since the process entered Caché.
Country Procedure state. See the Land property of the %SYS.ProcessQuery grade documentation in the InterSystems Class Reference for an explanation of each state.
Client Name Name of the client organisation that continued to, or initiated the connectedness to, the process.
Client EXE Name of the executable that chosen the process.
Client IP IP Address of the system that initiated the process.
O/S Username Username assigned to the process by the operating organisation.
Details Push appears if you lot have authority to maintain this procedure. See Display Process Details.

* An asterisk (*) appears next to the process id if the user entered Caché in developer fashion. A plus or minus sign appears next to Callin processes:

  • + Process is in Caché

  • – Process is not in Caché

The Callin API is a Caché facility that lets you execute and evaluate ObjectScript commands and expressions from inside C programs.

Display Process Details

The Process Details page displays detailed information about any process. To admission this information from the Management Portal:

  1. Display the Processes page (System Operation > Processes).

  2. Click Details in the row of the appropriate process. (This option exists only on processes that you take authority to maintain.)

  3. The portal displays the Process Details page for the procedure yous selected.

Each category is described in one of the tables that follow:

  • Full general information

  • Customer awarding details

  • Execution details

In most cases, you can click whatsoever of the indicators to display a description of the item in the bottom detail box at the lower left corner of the page of the Process Details folio.

General Information

Indicator Definition
Process ID Process ID (PID) number of this procedure.
User Name Name of the user currently logged in for this process.
OS User Name Username assigned to the procedure past the operating organisation.
Namespace Namespace in which the process is executing.
Process Priority Priority level of this process.
Global References Number of global references made by this process.
Commands Executed Number of commands executed by this procedure.
Retentivity Limit Amount of memory (Kbytes) allocated for apply past this process.
Memory Summit Peak amount of memory (Kbytes) used past this process.
Individual Global Blocks Number of private global data blocks used past this process.
Current Device Name of the I/O device currently in use by this process.
Retention Used Amount of memory (Kbytes) currently in use past this process.
Open Devices List of devices currently opened by this procedure.
Lock Lock information for this process. Click the link at superlative of the item box for additional details (style, counts, and full reference).

Client Application Details

Indicator Definition
Client Name Node proper name of the client that is connected, or initiated the connection, to this procedure (if any).
EXE Proper name Name of the executable customer awarding customer connected to this process (if any).
Client IP Address IP address of the executable client awarding customer connected to this process (if whatsoever).
Info User-defined information (if any).

Execution Details

Indicator Definition
Process State Current execution state of this process.
In Tranaction Indicates whether or not this process is currently within a transaction.
Concluding Global Reference Last global referenced past this process.
Routine Name of the routine this process is currently executing.
Source Location Terminal reported source location (routine name plus offset) of this process.
Source Line Last reported line of source code executed past this process, if available.

Stopping a Process

From this page you tin can also finish or resume a procedure. You tin can stop a procedure in one of the post-obit ways:

  • Append a process with the intention of resuming the process later.

  • Terminate a process, which entirely cancels the process.

Append or Resume a Process

You may want to suspend a process if you are not sure what it is doing and want to investigate, or if a more than important process is trying to run and needs the CPU cycles. To access this option from the Management Portal:

  1. Display the Processes page (System Operation > Processes).

  2. Click Details in the row of the advisable procedure. This option only exists on processes that y'all take dominance to maintain.

  3. Click Suspend on the options bar.

You may resume a suspended process at any time past clicking Resume from the same page.

Finish a Procedure

Y'all may desire to end a process if information technology becomes unresponsive or is affecting other processes or users. To access this option from the Management Portal:

  1. Display the Processes page (System Operation > Processes).

  2. Click Details in the row of the appropriate process. (This option exists only on processes that you take authority to maintain. The portal displays the Procedure Details page for the process y'all selected.

  3. Click Finish on the options bar.

    Optionally, to log the status of the procedure when it terminates, select the Terminate with RESJOB Error check box.

    Annotation:

    This selection is enabled by default.

  4. Click Yes to ostend that yous desire to stop the process. At that place is no mode to resume a terminated process.

Display Process Variables

The Process Variables page displays all the variables used in the selected process giving the global name and the value of the global. To access this information from the Management Portal:

  1. Display the Processes page (Organisation Operation > Processes) page.

  2. Click Details in the row of the appropriate procedure. (This option exists only on processes that you have authority to maintain.) The portal displays the Procedure Details folio for the process you selected.

  3. Click Variables on the options bar.

Broadcast Messages to the Terminals

Y'all tin can broadcast messages to the terminals associated with a selected process or all processes; this utility is useful, for example, to inquire people to sign off the arrangement. However, you lot must apply it carefully or you may cause messages to appear in the middle of reports that may be printing at the time.

The utility temporarily takes command of each final as information technology sends the message. In one case the last receives the message, the previous procedure continues. The message appears on the final screen; information technology may disrupt the screen brandish, but it does non affect user input. The message does non appear in windows running Caché utilities.

To broadcast a message to the terminals associated with a selected process, do the following in the Management Portal:

  1. Brandish the Processes page (System Operation > Processes).

  2. Click Broadcast (on the options bar) to open up the Broadcast window.

  3. Enter the message to broadcast in the text box.

    (The dialog box notifies y'all if there are no active processes that tin accept a message; you do not see a bulletin text box or list of processes. Click Close.)

  4. Select the appropriate cheque boxes for the appropriate processes (PIDs) to receive the broadcast message. Utilise the Select All and Clear All buttons accordingly to aid with the selection.

  5. Click Broadcast.

  6. Afterwards the completed message displays, click Close.

Manage Refresh Interval

You tin can command whether or not to automobile-refresh the process information and, if you want to refresh the data, you can specify how frequently it is refreshed. The minimum interval for machine-refreshing the data is 5 seconds; the default interval is 10 seconds.

Note:

Auto-refresh is turned off by default; to refresh processes manually, click the refresh icon.

To turn on auto-refresh for all active processes, do the following in the Management Portal:

  1. Display the Processes folio (System Performance > Processes).

  2. Click the on (on the options bar) and enter the interval (minimum: 5 seconds) in the text box.

  3. To turn on car-refresh for process details, exercise the post-obit in the Management Portal:

    1. Brandish the Processes page (System Operation > Processes).

    2. Click Details in the row of the appropriate procedure. (This option exists but on processes that you have say-so to maintain. The portal displays the Process Details folio for the process you selected.

    3. Click the on (on the options bar) and enter the interval (minimum: v seconds) in the text box.

Using the Task Manager

To employ the Job Director, select System Operation > Task Director) to brandish the following menu options:

  • New Chore (schedule a new task)

  • On-need Chore (execute a chore on demand)

  • Upcoming Tasks (view tasks scheduled to run in the side by side 24 hours)

  • Task Schedule (view all scheduled tasks)

  • Task History (view completed tasks)

  • Import Tasks (import tasks previously exported to files, possibly by another Caché instance)

You can also interact with the Task Managing director using the InterSystems Final, equally described in the Using ^TASKMGR section.

Notation:

The Task Manager polls every 60 seconds to come across if at that place are any Tasks to be run. When you click Perform Action Now to schedule a Task, there may be a delay of upwardly to 60 seconds before the newly scheduled Job actually runs.

New Job

The New Job option starts the Chore Scheduler Sorcerer.

  1. On the showtime folio of the Task Scheduler Wizard, provide the following details about the new chore:

    • Task name

    • Description

    • Namespace to run task in — Choose from the list of divers namespaces in which to run the task

    • Task type — Choose from amidst the listed tasks. For details about the available tasks, come across Task Types below.

      Note:

      Depending on the task type selected, y'all may be presented with a form in which to specify additional information; for example, if you are scheduling an IntegrityCheck, the grade prompts y'all for Directory, Filename, and KeepDays (number of days to keep the file).

    • Task priority — Choose from Priority Normal, Priority Low, or Priority Loftier. For more information almost priority, read the Priority section of the "Process Management" chapter in Specialized System Tools and Utilities.

    • Run chore as this user — Choose from the list of defined users. To choose a different user than the i y'all are logged in as, you must take the %Admin_Secure:Use privilege.

      Note:

      If the chosen user is disabled, the task is suspended until the user is enabled and the task is resumed manually. This does not employ to built-in System tasks, which run fifty-fifty when the called user is disabled.

      Each task consumes a license unit, with the license user ID based on the Caché username yous select; see License Login Special Considerations in the "Managing Caché Licensing" chapter of this guide for more data.

    • Open output file when task is running and Output file — If the task creates output, the log file is written to the directory specified.

    • Suspend task on error? — Specify whether the task will be rescheduled and proceed to run after an error, or suspended. The default is No, to reschedule and run the task subsequently an error.

    • Reschedule task after system restart? — Specify whether yous desire to reschedule the task when the system restarts (that is, if the system is downwards when the task is scheduled to run):

      • No specifies that the chore should run when the organisation restarts.

      • Yes specifies that the task should exist rescheduled for the next logical time afterward the organisation restarts.

    • Send completion email notification to — If you have configured email settings for the Job Director (see Configuring Task Manager Email Settings in the "Configuring Caché" chapter of this guide), enter a comma-separated list of electronic mail addresses to which a notification should be sent when the task ends successfully.

    • Send error email notification to — If you have configured email settings for the Job Manager, enter a comma-separated listing of email addresses to which a notification should be sent when the task ends in error.

    • How should task run for Mirror — If this example is a mirror fellow member, specify the blazon of member the task can be run on:

      • run on primary failover fellow member only

      • run on backup failover member and async members but (all except principal)

      • run on all mirror members (primary, fill-in, and asyncs)

      Important:

      This setting must exist set for all tasks on the mirror member, the task volition non run on a mirror member if not. Adding an instance to a mirror fellow member does not automatically update this setting in user-defined tasks. As such, you must either:

      • Define this setting when you create a task even if the instance is not a mirror, and so information technology can run if the instance is added to a mirror.

      • Brand sure y'all review all user-defined tasks when an instance is added to a mirror and set How should job run for mirror.

      Note:

      When the status of a failover member is in transition, for instance when the backup is in the process of taking over as chief, the Chore Director does not run any tasks on that member until its status as primary or backup is established.

    Later on you lot have filled in all the necessary fields, click Next.

  2. On the second page of the Chore Scheduler Magician, specify when the new task should run. The options are:

    • Daily — A daily interval (for example, every other twenty-four hour period, or every tertiary solar day).

    • Weekly — A weekly interval on specific days of the week.

    • Monthly — A monthly interval on a specific day of the calendar month.

    • Monthly (by day) — A monthly interval on a specified day of the week (for example, first Monday, or third Midweek).

    • Afterward another job completes — Later on a specified task runs.

    • On demand — Only when manually executed.

    The Daily, Weekly, Monthly, and Monthly (past mean solar day) fields allow you to specify what fourth dimension during the twenty-four hours the job should run:

    • Starting time Date — The first solar day the scheduled task should run.

    • Finish Date — The last day the scheduled task should run.

    • Task execution details, which specify what happens when a task executes as follows:

      • Run once at this time — At the specified time, the task executes in one case.

      • Run every ____ — During the specified time range, the task executes repeatedly at the specified interval.

      Note:

      Past default, all new tasks expire if they miss their scheduled time for whatever reason. If you wish to change this behavior, see Changing Chore Expiration Beliefs below.

    Afterward you accept filled in all the necessary fields, click End to schedule the chore.

Task Types

This section describes the predefined job types yous tin can choose when creating or editing a task. Some tasks are merely available from sure namespaces.

Note:

You can define your own task types using the %SYS.Task.Definition API; see the grade documentation in the InterSystems Class Reference.

  • CheckLogging — creates an alarm or turns off ^%ISCLOG or ^ISCSOAP logging if it has been running also long (by default, 2 days)

  • CleanSQLIndex— cleans up stale SQL Argument Index entries

  • CumuIncrDBList — a cumulative backup of databases in the defined list

  • DiagnosticReport — collects and delivers diagnostic reports to the WRC

  • FullAllDatabases — a full fill-in of all databases

  • FullDBList — a total fill-in of databases in the defined list

  • IncrementalDBList — an incremental backup of databases in the defined list

  • IntegrityCheck — an integrity bank check of databases in the namespace. The Integrity Check job only appears when the %SYS namespace is selected.

  • InventoryScan — compiles an inventory browse of the instance

  • PurgeAudit — purge the inspect database later on a specified time following a journal switch

  • PurgeBackupLog — purge the backup log after a specified time following a database backup

  • PurgeErrorsAndLogs — purge error globals and cconsole.log based on settings in the cache.cpf file (encounter ErrorPurge and MaxConsoleLogSize parameters in the Startup section of the "Introduction to the Caché Parameter File" chapter of the Caché Parameter File Reference)

    Note:

    When System Monitor is running, it monitors and limits the size of the console log.

  • PurgeJournal — purge journal files that meet the purging criteria

  • PurgeTaskHistory — purge chore director history files

  • RunLegacyTask — run a legacy task, that is, your ain programmatic task; the line you enter in the text box, for example exercise ^MyCode, must be executable in the Terminal

    Note:

    Do not use the local variable Status in RunLegacyTask lawmaking. Caché uses this variable, and if it is modified past RunLegacyTask lawmaking, the task is probable to end with an error status.

    A legacy job that fails to complete due to an error is marked Suspended due to error and is not scheduled to run until the error is corrected and you resume the task.

  • SecurityScan — disables expired user accounts, and expires user passwords and CSP session tokens

  • ShadowPurge — purge shadow files

  • SuspendOnError — determines what happens if the Task returns an error %Status from the OnTask() method. Errors encountered by the Task Manager trying to execute the task (login error or no such Task found) practise not check this flag.

  • SwitchJournal — switch to a new journal file

  • UpdateSQLStats — updates the information on SQL query statistics

On-demand Task

The On-need Task page (System Operation > Task Manager > On-demand Task) lists the tasks you take scheduled as on-need. The list includes the job name, a description, and an option to Run the chore from this page. Yous can sort the information in the table by clicking whatsoever column heading. When you click Run, the Run Job Wizard page displays the job proper name and ID, and the date and fourth dimension the task will run; click Perform Action Now to ostend the information and schedule the task.

Upcoming Tasks

The Upcoming Tasks page (System Operation > Task Manager > Upcoming Tasks)lists the tasks scheduled to run within a certain interval. To select an interval, click an pick in the Scheduled to run: search pane to the left of the job listing. If yous select the To a date choice, you can either enter a date in yyyy-mm-dd format or click the calendar icon to select a date from the calendar.

You can sort the information in the task list by clicking whatsoever column heading. Y'all can Append or Resume the scheduling of each chore by clicking the advisable option:

  • Suspend — Lets you suspend the task; a do you want to reschedule task when task is supposed to run? drop-down list lets you specify:

    • No. Upon resuming the task, the task manager attempts to run missed instances of the job earlier returning to the normal schedule.

    • Yes. Upon resuming the job, the task manager returns to the normal schedule without attempting to run missed instances.

  • Resume — Lets you lot resume a suspended task.

Task Schedule

The Job Schedule page (Organization Operation > Task Manager > Task Schedule) lists all scheduled tasks. You can sort the information in the table by clicking any column heading. Yous can view Details or History, as well as Run, a scheduled job by clicking the appropriate choice:

  • taskname — Lets you view details about the task and perform operations on information technology.

  • History — Displays the task'south history.

  • Run — Lets y'all run the task. A Run Chore magician displays the job name and ID, and the date and time the task volition run; click Perform Action Now to confirm the data and schedule the task.

Job Details

To display detailed information about a scheduled job and perform one of several operations on information technology, click the task'due south proper noun in the Task Proper name column. The Job Details folio displays information and execution details about the selected task. You can perform i of the following operations on the chore past clicking the appropriate button:

  • Edit — Lets you alter the task definition and schedule using the Task Scheduler Wizard.

  • History — Lets you lot view the job'due south history.

  • Resume > Suspend— Let you suspend a task or resume a suspended task, as on the Upcoming Tasks page.

  • Delete — Lets you permanently delete the chore.

  • Export — Lets you export a chore to a file that can after exist imported, including by another Caché case.

  • Run — Lets you schedule the job. When you lot click Run, the Run Task Magician page displays the task name and ID, and the date and time the task will run; click Perform Activity Now to ostend the information and schedule the task.

Annotation:

Some of the actions options described are unavailable while a chore is running.

Scheduled Task History

To display history information about an individual scheduled chore, click the History link in the row of the particular. The Chore History page displays detailed history for the selected task. The Result column indicates the outcome the terminal time the task was run, showing either Success or an error bulletin. You tin sort the information in the table by clicking any column heading.

The Details link at the meridian of the page displays the Task Details page for the selected chore.

Chore History

The Task History page (Arrangement Operation > Task Manager > Task History) lists the history of all tasks executed past the Task Manager. You can sort the data in the table past clicking any column heading.

Import Tasks

The Import Tasks page (System Functioning > Task Manager > Import Tasks) lets you import and run a chore past browsing to a previously-exported task file, so clicking Perform Action At present. For information almost exporting tasks to a file, see Task Details in this section.

Using ^TASKMGR

The ^TASKMGR routine allows y'all to configure the Task Manager using the Terminal. Except when noted otherwise, ^TASKMGR and the Management Portal incorporate the aforementioned options for configuring tasks; the ane you utilize is a affair of preference.

To use ^TASKMGR:

  1. Open the Terminal.

  2. Enter ready $namespace = "%SYS" to change to the %SYS namespace.

  3. Enter do ^TASKMGR.

For more details about how to schedule or edit a chore programmatically, see the %SYS.Chore class documentation in the InterSystems Class Reference.

Changing Task Expiration Behavior

Past default, all tasks are configured to expire if they miss their scheduled time. This could happen for a number of reasons; for case, when Caché is down during the scheduled fourth dimension, or if the previous run of the task extends beyond the side by side scheduled fourth dimension. When a task expires, it does not run until the adjacent scheduled time.

The ^TASKMGR routine (only not the Direction Portal) contains the option to change this behavior, such that a scheduled run is never skipped. To practice and then:

  1. Open the Last.

  2. Enter set $namespace = "%SYS" to change to the %SYS namespace.

  3. Enter do ^TASKMGR.

  4. Select option 2.

  5. Enter the task number y'all want to edit.

  6. Press Enter to save the defaults of each option until you reach Task Expires?

  7. Enter No.

Alternatively, you can specify a grace menses, such that the task does not expire immediately after it is missed. Instead, the Job Manager runs the missed job equally soon equally it is able. To adjust this grace period of when a specific task expires:

  1. Open the Terminal.

  2. Enter set $namespace = "%SYS" to modify to the %SYS namespace.

  3. Enter practise ^TASKMGR.

  4. Select option two.

  5. Enter the job number y'all want to edit.

  6. Press Enter to salve the defaults of each pick until yous reach Chore Expires?

  7. Enter Aye.

  8. At the Expires in how many days? prompt, enter the number of days earlier the task should expire.

  9. At the Expires in how many hours? prompt, enter the number of hours earlier the task should expire.

  10. At the Expires in how many minutes? prompt, enter the number of minutes before the task should expire.

Using the Background Tasks Page

A groundwork task is an asynchronous job procedure that runs in the background, independently of the procedure that created it. A background job is created when a user issues an ObjectScript JOB control, or by the Management Portal or a utility to execute a job without requiring the user to look for completion. For example, when you use the portal to truncate a database, every bit described in Truncating a Database earlier in this affiliate, a groundwork task is started.

The Background Tasks folio (System Functioning > Background Tasks) lists by and active background tasks. You can purge the log of past groundwork tasks at any fourth dimension.

When a background job is agile, the process can also exist seen on the Processes page (Arrangement Operation > Processes), equally described in Decision-making Caché Processes.

DocReleaseID: Core2018.1.6

bernierfaccorelfain1981.blogspot.com

Source: https://docs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=GSA_MANAGE

0 Response to "Intersystems Cache Database How to Read It"

Post a Comment

Subscribe to: Post Comments (Atom)

Iklan Atas Artikel

Iklan Tengah Artikel 1

Iklan Tengah Artikel 2

Iklan Bawah Artikel