%Installer.CSPApplication
class %Installer.CSPApplication extends %Installer.Activity
This is a "CSPApplication" activity within a Manifest documentProperty Inventory
- AuthenticationMethods
- AutoCompile
- CSPZENEnabled
- CSRFToken
- ChangePasswordPage
- CookiePath
- CustomErrorPage
- DeepSeeEnabled
- DefaultSuperclass
- DefaultTimeout
- Description
- Directory
- DispatchClass
- EventClass
- Grant
- GroupById
- InboundWebServicesEnabled
- IsNamespaceDefault
- JWTAccessTokenTimeout
- JWTAuthEnabled
- JWTRefreshTokenTimeout
- LockCSPName
- LoginClass
- MatchRoles
- PackageName
- PermittedClasses
- Recurse
- RedirectEmptyPath
- Resource
- ServeFiles
- ServeFilesTimeout
- SessionScope
- TwoFactorEnabled
- Url
- UseSessionCookie
- UserCookieScope
- WSGIAppLocation
- WSGIAppName
- WSGICallable
- WSGIDebug
- WSGIType
- iKnowEnabled
Properties
property AuthenticationMethods as %String;
Flags for enabled authentication methods.
Commonly used values are 4=Kerberos, 32=password, and 64=unauthenticated.
For supported authentication methods and the corresponding values to provide, see the AutheEnabled property in Security.Applications.
If not specified, the default value depends on the installation type
Commonly used values are 4=Kerberos, 32=password, and 64=unauthenticated.
For supported authentication methods and the corresponding values to provide, see the AutheEnabled property in Security.Applications.
If not specified, the default value depends on the installation type
Property methods: AuthenticationMethodsDisplayToLogical(), AuthenticationMethodsGet(), AuthenticationMethodsIsValid(), AuthenticationMethodsLogicalToDisplay(), AuthenticationMethodsLogicalToOdbc(), AuthenticationMethodsNormalize(), AuthenticationMethodsSet()
property AutoCompile as %Installer.Boolean [ InitialExpression = 1 ];
Autocompile flag
Property methods: AutoCompileDisplayToLogical(), AutoCompileGet(), AutoCompileIsValid(), AutoCompileLogicalToDisplay(), AutoCompileLogicalToXSD(), AutoCompileNormalize(), AutoCompileSet(), AutoCompileXSDToLogical()
property CSPZENEnabled as %Installer.Boolean [ InitialExpression = 1 ];
Flag for CSP ZEN Enabled
Property methods: CSPZENEnabledDisplayToLogical(), CSPZENEnabledGet(), CSPZENEnabledIsValid(), CSPZENEnabledLogicalToDisplay(), CSPZENEnabledLogicalToXSD(), CSPZENEnabledNormalize(), CSPZENEnabledSet(), CSPZENEnabledXSDToLogical()
property CSRFToken as %Installer.Boolean;
Prevent login CSRF attack.
For CSP Web Application only.
When enabled generate a token and cookie in the login page that is validated before accepting any username/password. Enabling this will prevent programatic access to pages in this application that just pass in the username/password on the initial request. It also prevents the use of the CSPSHARE=1 URL Parameter to pass the session token in the URL when cookies are required for the application.
For CSP Web Application only.
When enabled generate a token and cookie in the login page that is validated before accepting any username/password. Enabling this will prevent programatic access to pages in this application that just pass in the username/password on the initial request. It also prevents the use of the CSPSHARE=1 URL Parameter to pass the session token in the URL when cookies are required for the application.
Property methods: CSRFTokenDisplayToLogical(), CSRFTokenGet(), CSRFTokenIsValid(), CSRFTokenLogicalToDisplay(), CSRFTokenLogicalToXSD(), CSRFTokenNormalize(), CSRFTokenSet(), CSRFTokenXSDToLogical()
property ChangePasswordPage as %String (MAXLEN = 1024);
Change Password Page
Property methods: ChangePasswordPageDisplayToLogical(), ChangePasswordPageGet(), ChangePasswordPageIsValid(), ChangePasswordPageLogicalToDisplay(), ChangePasswordPageLogicalToOdbc(), ChangePasswordPageNormalize(), ChangePasswordPageSet()
property CookiePath as %String (MAXLEN = 256);
Session cookie path
Property methods: CookiePathDisplayToLogical(), CookiePathGet(), CookiePathIsValid(), CookiePathLogicalToDisplay(), CookiePathLogicalToOdbc(), CookiePathNormalize(), CookiePathSet()
property CustomErrorPage as %String (MAXLEN = 1024);
Custom Error Page
Property methods: CustomErrorPageDisplayToLogical(), CustomErrorPageGet(), CustomErrorPageIsValid(), CustomErrorPageLogicalToDisplay(), CustomErrorPageLogicalToOdbc(), CustomErrorPageNormalize(), CustomErrorPageSet()
property DeepSeeEnabled as %Installer.Boolean;
Indicates whether DeepSee access is enabled for this application.
For CSP Web Application only.
Corresponds with the Analytics option shown in Management Portal
For CSP Web Application only.
Corresponds with the Analytics option shown in Management Portal
Property methods: DeepSeeEnabledDisplayToLogical(), DeepSeeEnabledGet(), DeepSeeEnabledIsValid(), DeepSeeEnabledLogicalToDisplay(), DeepSeeEnabledLogicalToXSD(), DeepSeeEnabledNormalize(), DeepSeeEnabledSet(), DeepSeeEnabledXSDToLogical()
property DefaultSuperclass as %String (MAXLEN = 256);
Default Superclass
Property methods: DefaultSuperclassDisplayToLogical(), DefaultSuperclassGet(), DefaultSuperclassIsValid(), DefaultSuperclassLogicalToDisplay(), DefaultSuperclassLogicalToOdbc(), DefaultSuperclassNormalize(), DefaultSuperclassSet()
property DefaultTimeout as %Installer.Integer;
Session timeout
Property methods: DefaultTimeoutDisplayToLogical(), DefaultTimeoutGet(), DefaultTimeoutIsValid(), DefaultTimeoutLogicalToDisplay(), DefaultTimeoutNormalize(), DefaultTimeoutSet(), DefaultTimeoutXSDToLogical()
property Description as %String (MAXLEN = 1024);
Application Description
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Directory as %String (MAXLEN = 1024) [ Required ];
Path to CSP files.
Property methods: DirectoryDisplayToLogical(), DirectoryGet(), DirectoryIsValid(), DirectoryLogicalToDisplay(), DirectoryLogicalToOdbc(), DirectoryNormalize(), DirectorySet()
property DispatchClass as %String (MAXLEN = 256);
If defined, this will dispatch all requests in this CSP application to this one class.
Property methods: DispatchClassDisplayToLogical(), DispatchClassGet(), DispatchClassIsValid(), DispatchClassLogicalToDisplay(), DispatchClassLogicalToOdbc(), DispatchClassNormalize(), DispatchClassSet()
property EventClass as %String (MAXLEN = 256);
Event Class
Property methods: EventClassDisplayToLogical(), EventClassGet(), EventClassIsValid(), EventClassLogicalToDisplay(), EventClassLogicalToOdbc(), EventClassNormalize(), EventClassSet()
property Grant as %String (MAXLEN = 512);
Resource(s) granted when logged in.
Property methods: GrantDisplayToLogical(), GrantGet(), GrantIsValid(), GrantLogicalToDisplay(), GrantLogicalToOdbc(), GrantNormalize(), GrantSet()
property GroupById as %String (MAXLEN = 1024);
Group By ID
Property methods: GroupByIdDisplayToLogical(), GroupByIdGet(), GroupByIdIsValid(), GroupByIdLogicalToDisplay(), GroupByIdLogicalToOdbc(), GroupByIdNormalize(), GroupByIdSet()
property InboundWebServicesEnabled as %Installer.Boolean [ InitialExpression = 1 ];
Flag for inbound web services enabled
Property methods: InboundWebServicesEnabledDisplayToLogical(), InboundWebServicesEnabledGet(), InboundWebServicesEnabledIsValid(), InboundWebServicesEnabledLogicalToDisplay(), InboundWebServicesEnabledLogicalToXSD(), InboundWebServicesEnabledNormalize(), InboundWebServicesEnabledSet(), InboundWebServicesEnabledXSDToLogical()
property IsNamespaceDefault as %Installer.Boolean [ InitialExpression = 0 ];
Is Namespace default
Property methods: IsNamespaceDefaultDisplayToLogical(), IsNamespaceDefaultGet(), IsNamespaceDefaultIsValid(), IsNamespaceDefaultLogicalToDisplay(), IsNamespaceDefaultLogicalToXSD(), IsNamespaceDefaultNormalize(), IsNamespaceDefaultSet(), IsNamespaceDefaultXSDToLogical()
property JWTAccessTokenTimeout as %Integer (MINVAL = 1);
Specifies the timeout (in seconds) for JWT Access Tokens.
This is only relevant for REST Web Applications where JWTAuthEnabled is true.
Property methods: JWTAccessTokenTimeoutDisplayToLogical(), JWTAccessTokenTimeoutGet(), JWTAccessTokenTimeoutIsValid(), JWTAccessTokenTimeoutLogicalToDisplay(), JWTAccessTokenTimeoutNormalize(), JWTAccessTokenTimeoutSet(), JWTAccessTokenTimeoutXSDToLogical()
property JWTAuthEnabled as %Installer.Boolean;
Indicates that this application uses JWT Bearer tokens for authentication.
For REST Web Application only.
Property methods: JWTAuthEnabledDisplayToLogical(), JWTAuthEnabledGet(), JWTAuthEnabledIsValid(), JWTAuthEnabledLogicalToDisplay(), JWTAuthEnabledLogicalToXSD(), JWTAuthEnabledNormalize(), JWTAuthEnabledSet(), JWTAuthEnabledXSDToLogical()
property JWTRefreshTokenTimeout as %Integer (MINVAL = 1);
Specifies the timeout (in seconds) for JWT Refresh Tokens.
This is only relevant for REST Web Applications where JWTAuthEnabled is true.
Property methods: JWTRefreshTokenTimeoutDisplayToLogical(), JWTRefreshTokenTimeoutGet(), JWTRefreshTokenTimeoutIsValid(), JWTRefreshTokenTimeoutLogicalToDisplay(), JWTRefreshTokenTimeoutNormalize(), JWTRefreshTokenTimeoutSet(), JWTRefreshTokenTimeoutXSDToLogical()
property LockCSPName as %Installer.Boolean [ InitialExpression = 1 ];
Lock CSP Name property
Property methods: LockCSPNameDisplayToLogical(), LockCSPNameGet(), LockCSPNameIsValid(), LockCSPNameLogicalToDisplay(), LockCSPNameLogicalToXSD(), LockCSPNameNormalize(), LockCSPNameSet(), LockCSPNameXSDToLogical()
property LoginClass as %String (MAXLEN = 128);
Login class
Property methods: LoginClassDisplayToLogical(), LoginClassGet(), LoginClassIsValid(), LoginClassLogicalToDisplay(), LoginClassLogicalToOdbc(), LoginClassNormalize(), LoginClassSet()
property MatchRoles as %String (MAXLEN = 32767);
Mapping of Match Roles to added Target Roles
Property methods: MatchRolesDisplayToLogical(), MatchRolesGet(), MatchRolesIsValid(), MatchRolesLogicalToDisplay(), MatchRolesLogicalToOdbc(), MatchRolesNormalize(), MatchRolesSet()
property PackageName as %String (MAXLEN = 256);
Package Name
Property methods: PackageNameDisplayToLogical(), PackageNameGet(), PackageNameIsValid(), PackageNameLogicalToDisplay(), PackageNameLogicalToOdbc(), PackageNameNormalize(), PackageNameSet()
property PermittedClasses as %String;
PermittedClasses default
Property methods: PermittedClassesDisplayToLogical(), PermittedClassesGet(), PermittedClassesIsValid(), PermittedClassesLogicalToDisplay(), PermittedClassesLogicalToOdbc(), PermittedClassesNormalize(), PermittedClassesSet()
property Recurse as %Installer.Boolean [ InitialExpression = 0 ];
Flag to Recurse (service subdirectories)
Property methods: RecurseDisplayToLogical(), RecurseGet(), RecurseIsValid(), RecurseLogicalToDisplay(), RecurseLogicalToXSD(), RecurseNormalize(), RecurseSet(), RecurseXSDToLogical()
property RedirectEmptyPath as %Installer.Boolean;
This specifies whether to use FHIR-standard redirects of empty paths.
For REST Web Application only.
For example, if the request is for WPath/csp/appname and the app /csp/appname/
has this property enabled, then instead of serving the request with the next level down
(csp, if it exists), the request will be served by /csp/appname/.
For REST Web Application only.
For example, if the request is for WPath/csp/appname and the app /csp/appname/
has this property enabled, then instead of serving the request with the next level down
(csp, if it exists), the request will be served by /csp/appname/.
Property methods: RedirectEmptyPathDisplayToLogical(), RedirectEmptyPathGet(), RedirectEmptyPathIsValid(), RedirectEmptyPathLogicalToDisplay(), RedirectEmptyPathLogicalToXSD(), RedirectEmptyPathNormalize(), RedirectEmptyPathSet(), RedirectEmptyPathXSDToLogical()
property Resource as %String;
Resource required to access web app.
Property methods: ResourceDisplayToLogical(), ResourceGet(), ResourceIsValid(), ResourceLogicalToDisplay(), ResourceLogicalToOdbc(), ResourceNormalize(), ResourceSet()
property ServeFiles as %Installer.Boolean;
Service Files
0-No
1-Always
2-Always and cached
3-Use InterSystems security
0-No
1-Always
2-Always and cached
3-Use InterSystems security
Property methods: ServeFilesDisplayToLogical(), ServeFilesGet(), ServeFilesIsValid(), ServeFilesLogicalToDisplay(), ServeFilesLogicalToXSD(), ServeFilesNormalize(), ServeFilesSet(), ServeFilesXSDToLogical()
property ServeFilesTimeout as %Installer.Integer;
Serve Files Timeout
Property methods: ServeFilesTimeoutDisplayToLogical(), ServeFilesTimeoutGet(), ServeFilesTimeoutIsValid(), ServeFilesTimeoutLogicalToDisplay(), ServeFilesTimeoutNormalize(), ServeFilesTimeoutSet(), ServeFilesTimeoutXSDToLogical()
property SessionScope as %Integer (DISPLAYLIST = ",None,Lax,Strict", VALUELIST = ",0,1,2");
SameSite value that is used for CSP Session cookies.
For REST and CSP Web Application only.
This setting affects whether session cookies are sent for cross-site requests.
The default setting for a new application is Strict.
0 - None - Send cookie with cross-site requests .
1 - Lax - Send cookie with top-level cross-site navigation.
2 - Strict - Do not send cookie with cross-site requests. Default.
For REST and CSP Web Application only.
This setting affects whether session cookies are sent for cross-site requests.
The default setting for a new application is Strict.
0 - None - Send cookie with cross-site requests .
1 - Lax - Send cookie with top-level cross-site navigation.
2 - Strict - Do not send cookie with cross-site requests. Default.
Property methods: SessionScopeDisplayToLogical(), SessionScopeGet(), SessionScopeIsValid(), SessionScopeLogicalToDisplay(), SessionScopeNormalize(), SessionScopeSet(), SessionScopeXSDToLogical()
property TwoFactorEnabled as %Installer.Boolean [ InitialExpression = 0 ];
Flag for two factor authentication enabled
Property methods: TwoFactorEnabledDisplayToLogical(), TwoFactorEnabledGet(), TwoFactorEnabledIsValid(), TwoFactorEnabledLogicalToDisplay(), TwoFactorEnabledLogicalToXSD(), TwoFactorEnabledNormalize(), TwoFactorEnabledSet(), TwoFactorEnabledXSDToLogical()
property Url as %String (MAXLEN = 1024) [ Required ];
Application URL
Property methods: UrlDisplayToLogical(), UrlGet(), UrlIsValid(), UrlLogicalToDisplay(), UrlLogicalToOdbc(), UrlNormalize(), UrlSet()
property UseSessionCookie as %Installer.Integer;
Use Cookie for Session
Property methods: UseSessionCookieDisplayToLogical(), UseSessionCookieGet(), UseSessionCookieIsValid(), UseSessionCookieLogicalToDisplay(), UseSessionCookieNormalize(), UseSessionCookieSet(), UseSessionCookieXSDToLogical()
property UserCookieScope as %Integer (DISPLAYLIST = ",None,Lax,Strict", VALUELIST = ",0,1,2");
Default SameSite value for cookies created by users' calls to %CSP.Response.SetCookie().
For REST and CSP Web Application only.
This setting affects whether session cookies are sent for cross-site requests.
Users can override the default by specifying the SameSite value in their SetCookie call.
0 - None - Send cookie with cross-site requests .
1 - Lax - Send same-site cookies with top-level cross-site navigation.
2 - Strict - Do not send same-site cookies with cross-site requests. Default.
For REST and CSP Web Application only.
This setting affects whether session cookies are sent for cross-site requests.
Users can override the default by specifying the SameSite value in their SetCookie call.
0 - None - Send cookie with cross-site requests .
1 - Lax - Send same-site cookies with top-level cross-site navigation.
2 - Strict - Do not send same-site cookies with cross-site requests. Default.
Property methods: UserCookieScopeDisplayToLogical(), UserCookieScopeGet(), UserCookieScopeIsValid(), UserCookieScopeLogicalToDisplay(), UserCookieScopeNormalize(), UserCookieScopeSet(), UserCookieScopeXSDToLogical()
property WSGIAppLocation as %String (MAXLEN = 256);
This is the path of the directory containing the python application
Property methods: WSGIAppLocationDisplayToLogical(), WSGIAppLocationGet(), WSGIAppLocationIsValid(), WSGIAppLocationLogicalToDisplay(), WSGIAppLocationLogicalToOdbc(), WSGIAppLocationNormalize(), WSGIAppLocationSet()
property WSGIAppName as %String (MAXLEN = 256);
This is the name of the WSGI-compliant python application (e.g flask_app)
Property methods: WSGIAppNameDisplayToLogical(), WSGIAppNameGet(), WSGIAppNameIsValid(), WSGIAppNameLogicalToDisplay(), WSGIAppNameLogicalToOdbc(), WSGIAppNameNormalize(), WSGIAppNameSet()
property WSGICallable as %String (MAXLEN = 256);
This is the name of the WSGI application callable.
Property methods: WSGICallableDisplayToLogical(), WSGICallableGet(), WSGICallableIsValid(), WSGICallableLogicalToDisplay(), WSGICallableLogicalToOdbc(), WSGICallableNormalize(), WSGICallableSet()
property WSGIDebug as %Installer.Boolean;
This describes if the WSGI application is in Debug Mode
Property methods: WSGIDebugDisplayToLogical(), WSGIDebugGet(), WSGIDebugIsValid(), WSGIDebugLogicalToDisplay(), WSGIDebugLogicalToXSD(), WSGIDebugNormalize(), WSGIDebugSet(), WSGIDebugXSDToLogical()
property WSGIType as %Integer (DISPLAYLIST = ",WSGI,ASGI", VALUELIST = ",1,2");
This determines if the application is WSGI or ASGI compliant.
Property methods: WSGITypeDisplayToLogical(), WSGITypeGet(), WSGITypeIsValid(), WSGITypeLogicalToDisplay(), WSGITypeNormalize(), WSGITypeSet(), WSGITypeXSDToLogical()
property iKnowEnabled as %Installer.Boolean;
Indicates whether iKnow access is enabled for this application.
Like the DeepSeeEnabled property , this corresponds with the Analytics option shown in Management Portal.
Property methods: iKnowEnabledDisplayToLogical(), iKnowEnabledGet(), iKnowEnabledIsValid(), iKnowEnabledLogicalToDisplay(), iKnowEnabledLogicalToXSD(), iKnowEnabledNormalize(), iKnowEnabledSet(), iKnowEnabledXSDToLogical()
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %Indent()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()