Using Caché Studio - InterSystems Documentation

Using Studio Source Control Hooks• Ensure that you can perform source control activities from within Studio.• Ensure that Studio always has the same information that the source control system has as to whethera document has been checked out, and, if checked out, by whom.A.2 Caché DocumentsA Caché document is a class definition, a routine, or a CSP file. Caché records information about eachCaché document, such as whether it has changed since the last compilation. Your source control systemwill treat each Caché document as a separate unit.In Caché, you work within one namespace at a time. The same will be true for your source controlsystem.A.2.1 Tools for Managing Documents and FilesCaché provides the following tools for managing Caché documents and external files:• The %Studio.Extension.Base and %Studio.SourceControl.Base classes provide methods for basicdocument management. You can extend one of these classes to add menu items that act on Cachédocuments. These classes are discussed in a later section.• The $system.OBJ.Export function exports a Caché document to an XML file in the externaldocument system. This XML file contains all the information needed to reconstruct the Cachédocument. For example, for a class document, the corresponding XML file is a text representationof the entire class definition, which includes all code, properties, comments, and so on.• The $system.OBJ.Load function loads an external XML file and overwrites the correspondingCaché document, if one exists.• The %RoutineMgr.TS class method returns the timestamp for a Caché document. This methodalso returns, by reference, the compile time for the Caché document, as the second argument.A.2.2 Deciding How to Map Internal and External NamesEach document has two names:• An internal name, the name you use in the Open dialog box in Studio.• An external name, which should be the complete external file name, including path. Because ofdifferences between supported Caché platforms, it is not possible to provide a meaningful default.136 Using Caché Studio