For information on converting to InterSystems IRIS, see the
InterSystems IRIS Adoption Guide
and the InterSystems IRIS In-Place Conversion Guide,
both available on the WRC Distributions page (login required).
This is the string used for naming the default proxy CSPApplication that is referenced for exporting/importing files
parameter MANAGEDEXTENT = 0;
The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager
to ignore this class. If set to 1 then the Extent Manager will register globals used by
the class and detect collisions. Unmanaged extents (MANAGEDEXTENT = 0) are not checked.
Currently, only classes using default storage (%Library.CacheStorage) can be managed.
This is required since each Namespace will have it's own Change extent
This Parameter should be updated when synced from Perforce
parameter Version = 122;
Revision number of this class when compiled as part of the //custom_ccrs/_common/config/... branch.
This version will not be updated (by design) when the class is integrated to other branches.
This allows the user to tell what version of the Studio client tools are in use.
method takes a file name, or an array of filenames, and changes the pReadonly state to the pReadOnly value
classmethod CheckWritableState(pList="", ByRef pReadOnly, ByRef pReadWrite, ByRef pAbsent, ByRef pLog As %Stream.Object = "") as %Status
Given a list of files on the OS, returns a list of those that are Readonly, and a list of those that are writable
method Create(pItems="", pJob="", pCreatedBy="", pLabel="", pTarget="Server", pCCR="", pEnv="") as %Status
Method to create a ItemSet and Payload file which can be passed to another system for import
pItems is an array subscripted by the item name (full file name on file system), with a value of add/edit/delete
Wrapper method for interactively downloading list of ItemSets from server via Web Service, and then selecting and saving one to disk
classmethod Export(pID="", ByRef pItemSetFile) as %Status
Export the ItemSet to the file system
method ExportToFile(ByRef pItemSetFile) as %Status
Export the ItemSet to the file system
classmethod FindReplaceInFile(pFind, pReplace, pFile, pExtensionRename="", pLog As %Stream.Object = "") as %Status
as cspapplication paths must be unique, if multiple namespaces on this instance need to send/receive
ItemSets, then we may be using a secondary cspApp naming convention which is '/..#CSPAppLink/'
When this is the case, this method exchanges the values in an XML file on disk to or from the standard (/..#CSPAppLink/)
or local csp application name.
classmethod GetPathTranslation(ByRef pRoot, ByRef pPath) as %Status
the Utility CSPApplication, called '/itemsetsourcelink*' acts as a mechanism to 'tar' and 'untar' ItemSets for transport to/from Server/Client
this makes sure that the CSP Application is defined for this namespace, and finds where it points on the file system
Returns value the Major.Minor version for this instance, so it can be used in comparison code which makes sure certain features are used in appropriate versions
classmethod IsValidOSProcessName(ByRef pCurrentProcess, ByRef pSServer) as %Boolean
Utility method to check the OS username of the current process make sure for UNIX it matches the username that the Super Server is running as
classmethod Load(pInteractive As %Boolean = 1, pItemSetFile="", pLoadToOS As %Boolean = "", pOverwrite As %Boolean = 0, pLoadToNS As %Boolean = "", pCompile As %Boolean = "", pQspec=$get(^SYS("SourceControl", "Misc", "ImportFlags"), "kvfbryu"), pP4user, pP4pass, ByRef pNewID As %String, pServerISID="", pToken="") as %Status
Wrapper method for importing, loading to file system (OS), loading to namespace and compiling ItemSet into this namespace
Can be either interactive or scripted
method LoadToNS(pQspec As %String = $get(^SYS("SourceControl", "Misc", "ImportFlags"), "kvfbryu"), pLoadedlist, pListonly As %Boolean = 0, pCompileProject As %Boolean = 0, ByRef pIncPercent As %String, ByRef pProjectName As %String) as %Status
Loads the files from the file system into the namespace; creates a project and (optionally) compiles the project
When pCompileProject=1, the project will be compiled after load is complete
When pCompileProject=2, the project will only be compiled after load if the ItemSet does not contain this class in it's payload (i.e. pIncPercent'=2)
method LoadToOS(pQspec As %String = $get(^SYS("SourceControl", "Misc", "ImportFlags"), "kvfbryu"), ByRef pErrorlog As %String, ByRef pLoadedlist As %String, ByRef pReadWrite As %String, pListonly As %Boolean = 0, pOverwrite As %Boolean = 0, pP4user="", pP4pass="") as %Status
Load the items in this ItemSet into the local file system
If the file already exists and is ReadOnly, then it will be changed to ReadWrite, loaded to the OS, and then marked as ReadOnly again
If the file exists and is ReadWrite, it will not be overwritten by the ItemSet load, unless pOverwrite is set to true
takes an item name (or an array of names), and converts it from the file system representation to the csp application representation, or vice versa
if pName includes a Perforce version identifier (e.g. <file>#<ver> ignore the version when validating the file's existance
When pValidate is '1', when the method will confirm that the file exists and that it is not empty (there is no usecase for passing empty
files in ItemSets, and it can mess up the import of the ItemSet in some versions of Caché).
method P4Revert(SCs="", changelist="", perforceBranch="", pP4user, pP4pass) as %Status
SQL Query: SELECT COUNT(ID) As Num FROM ItemSet WHERE CCR = :pRID AND Target='Server'
query ServerItemSetsByRID(pRID As %String, pCommitted As %String = "")
SQL Query: SELECT ID, Name, CreateTimestamp, CommittedTimestamp, ImportTimestamp
FROM ItemSet WHERE CCR = :pRID AND Target='Server' AND ''=:pCommitted UNION
SELECT ID, Name, CreateTimestamp, CommittedTimestamp, ImportTimestamp
FROM ItemSet WHERE CCR = :pRID AND Target='Server' AND Committed=:pCommitted
ORDER BY CommittedTimestamp DESC, CreateTimestamp DESC, ImportTimestamp DESC
index (CommittedMap on Committed) [Type = bitmap];
index (DeployedMap on Deployed) [Type = bitmap];
index (IDKEY on %PL97361) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (ItemMap on ItemList(KEYS));
Enables Fast lookup of all ItemSets containing a given Item
index (ItemSetMap on %PL97361,ItemList(KEYS));
Index to match items in the itemlist
This is called item map because it maps items to the individual itemset
When PL97361 is resolved for all supported client versions, the first subscript should be changed from %PL97361 to %%ID