%Studio.General


class %Studio.General

Collection of ClassMethods used by Studio

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
15 1


Summary


Methods
CheckDeveloperRole ConstructCSPSession DecomposeStatus DumpObjectClose
DumpObjectExecute DumpObjectFetch DumpObjectSlot Execute
FeatureBits GetFileDateModified GetStudioInfo GetWebServerPort
ReturnCSPSessionId


Methods


• classmethod CheckDeveloperRole() as %Status
• classmethod ConstructCSPSession(page As %String = "") as %String
Internal method to construct a CSP session with current security permissions and return the session id
• classmethod DecomposeStatus(status As %String) as %Status
• classmethod DumpObjectClose(ByRef qHandle As %Binary) as %Status
• classmethod DumpObjectExecute(ByRef qHandle As %Binary, oref As %String) as %Status
• classmethod DumpObjectFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod DumpObjectSlot(ByRef qHandle As %String, oref As %String, ivar As %String, slot As %Integer)
• classmethod Execute(%cmd As %String)
• classmethod FeatureBits(bit As %Integer = "") as %Binary
• classmethod GetFileDateModified(filename As %String, utc As %Boolean = 0) as %String
Return the date last modified of file filename in %Timestamp format. By default this is local time, if you pass utc as true it returns it in UTC time
• classmethod GetStudioInfo() as %String
return $c(1) delimetered string p1 - %SYSTEM.Version.GetNumber() p2 - Is MVB installed p3 - Is Ensamble installed p4 - Is Activate available p5 - Is Other Enabled p6 - Feetback URL p7 - _$SYSTEM.Version.Format(4) p8 - ^%SYS("Studio","NoXecute") p9 - U2 Enabled. Bit 30
• classmethod GetWebServerPort(ByRef port As %Integer, ByRef server As %String, ByRef urlprefix As %String, ByRef url As %String) as %Status
Return the port the Cache web server is running on or 0 if the web server is not active. Also returns the server name which is useful if the web server is running on a different machine (needed for VMS configurations for example). It can also return a urlprefix which is added to the url to goto at the start and is required if one web server is serving multiple Cache installations to differential between these versions which again is needed by VMS installs. It also returns url which is the constructed url as a string, you just need to append the page you are going to request to this.
• classmethod ReturnCSPSessionId(id As %String) as %String
Deprecated internal method to return the CSP session id of the session constructed with ConstructCSPSession. This is no longer needed as ConstructCSPSession returns the CSP sessionId directly now.

Queries


• query DumpObject(oref As %String)
Selects Name As %String, Value As %String
Copyright © 1997-2020 InterSystems Corporation, Cambridge, MA