Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

There are a host of database properties. Some have historically been accessible from Database class, but some are accessible only via DXL. You can view these in Domino Designer, in the Package Explorer view, by opening up AppProperties and database.properties.

How Are They Stored and Retrieved

The key here is that you need to export more than one design note to get the database element (e.g. export the ACL and Icon note, which is what's done in this design element). From here, all the properties visible on the Database Properties infobox in Notes are accessible as well as some database properties not exposed there (e.g. whether DAOS is enabled). Some are attributes of the database element, some are items on the Icon note. Some are set as attributes if they're checked, some set if they're not checked. Some are boolean values. Some, like fromtemplate, are text. Some, like softdeletionsexpirein or maxupdatedby, have numeric values stored as text attributes. The good news is the API makes them all accessible from the DatabaseDesign object, even if they're actually stored in the Icon note.

Retrieving the Database Design

To access the Database Design object for a specific database, just use Database.getDesign().

Database Properties

The Database Properties are available via the getDatabaseProperties and setDatabaseProperties methods. The getter returns a List<DatabaseProperties> object and the setter takes a Map<DatabaseProperties, boolean>. However, some Database Properties cannot be set because they have specific setter methods (template name) or need to be enabled via server commands (e.g. DAOS). Below are the details of all the Database Properties available, where they appear on the Database Properties infobox and setter information.

On InfoboxLabelDatabase PropertyStored AsValueNotes
Basics TabUse JS when generating pagesUSE_JSusejavascriptinpages attributefalseMissing in DXL if checked
Basics TabRequire SSLREQUIRE_SSLrequiressl attributetrueMissing in DXL if not checked
Basics TabDon't Allow URL OpenNO_URL_OPENnourlopen attributetrueMissing in DXL if not checked
Basics TabEnable Enhanced HTML GenerationENHANCED_HTML$AllowPost8HTML item in Icon1Missing if not checked
Basics TabDon't Allow ICAABLOCK_ICAA$DisallowOpenInNBP item in Icon1Missing if not checked
Basics TabDisable Background AgentsDISABLE_BACKGROUND_AGENTSallowbackgroundagents attributefalseMissing if not checked
Basics TabAllow Stored FormsALLOW_STORED_FORMSallowstoredforms attributefalseMissing if checked
Basics TabDisplay Images After LoadingDEFER_IMAGE_LOADINGimageloadsdeferred attributetrueMissing in DXL if not checked
Basics TabAllow Document LockingALLOW_DOC_LOCKINGallowdocumentlocking attributetrueMissing in DXL if not checked
Basics TabInherit OS ThemeINHERIT_OS_THEMEinheritostheme attributetrueMissing in DXL if not checked
Cache Expiry Days (DDE)CSS files $CSSExpires in Icon2setCssExpiry(int), use Integer.MIN_VALUE to remove it. Added in ODA 4.3.0
Cache Expiry Days (DDE)Files $FileExpires in Icon2setFileExpiry(int), use Integer.MIN_VALUE to remove it. Added in ODA 4.3.0
Cache Expiry Days (DDE)Image Files $ImageExpires in icon2setImageExpiry(int), use Integer.MIN_VALUE to remove it. Added in ODA 4.3.0
Cache Expiry Days (DDE)JavaScript Files $JSExpires in Icon2setJsExpiry(int), use Integer.MIN_VALUE to remove it. Added in ODA 4.3.0
Design TabAllow Design LockingALLOW_DESIGN_LOCKINGallowdesignlocking attributetrueMissing in DXL if not checked
Design TabShow in Open DialogSHOW_IN_OPEN_DIALOGshowinopendialog attributefalseMissing in DXL if checked
Design TabInclude in Multi-Db IndexingMULTI_DB_INDEXINGmultidbindexed attributetrueMissing in DXL if not checked
Design TabDon't Mark Modified UnreadMODIFIED_NOT_UNREADmarkmodifiedunread attributefalseMissing in DXL if not checked
Design TabMark Parent on Reply / ForwardMARK_PARENT_REPLY_FORWARDtrackreplyforward attributetrueMissing in DXL if not checked
Design TabInherit Design from Master TemplateINHERIT_FROM_TEMPLATEfromtemplate attributedemoDatabaseDatabase Property determines if the database is set to inherit from a template. Use getTemplateName() to get the name of the template it inherits from. setTemplateName(String) must be used to set / clear the property.
Design TabDatabase File is a Master TemplateDB_IS_TEMPLATEtemplatename attributedemoDatabaseDatabase Property determines if the database is a template. Use getNameIfTemplate() to get the template name. setNameIfTemplate(String) must be used to set / clear the property.
Design TabList as Advanced Template in 'New Application' DialogADVANCED_TEMPLATEadvancedtemplate attributetrueMissing in DXL if not checked
Design TabMultilingualMULTILINGUALmultilingual attributetrueMissing in DXL if not checked
Advanced TabDon't Maintain UnreadDONT_MAINTAIN_UNREADmaintainunread attributefalseMissing in DXL if checked
Advanced TabReplicate Unread MarksREPLICATE_UNREADreplicateunread attributeallUse specific setter, setReplicateUnreadSetting(UnreadReplicationSetting), to set or unset.
Advanced TabOptimize Document Table MapOPTIMIZE_DOC_MAPoptimizetablebitmaptrueMissing in DXL if not checked
Advanced TabDon't Overwrite Free SpaceDONT_OVERWRITE_FREE_SPACEoverwritefreespacefalseMissing in DXL if checked
Advanced TabMaintain Last AccessedMAINTAIN_LAST_ACCESSEDsavelastaccessedtrueMissing in DXL if not checked
Advanced TabDisable Transaction LoggingDISABLE_TRANSACTION_LOGGINGlogtransactionsfalseMissing in DXL if checked
Advanced TabDon't Support Special Response HierarchyNO_SPECIAL_RESPONSE_HIERARCHYallowspecialhierarchyfalseMissing in DXL if not checked
Advanced TabUse LZ1 CompressionUSE_LZ1uselz1trueMissing in DXL if not checked
Advanced TabDon't Allow Headline MonitoringNO_HEADLINE_MONITORINGallowheadlinemonitoring  
Advanced TabAllow More FieldsALLOW_MORE_FIELDSincreasemaxfields  
Advanced TabSupport Response Thread HierarchySUPPORT_RESPONSE_THREADSsupportrespthread  
Advanced TabDon't Allow Simple SearchNO_SIMPLE_SEARCHnosimplesearch  
Advanced TabCompress DesignCOMPRESS_DESIGNcompressdesign  
Advanced TabCompress DataCOMPRESS_DATAcompressdata  
Advanced TabDisable Auto-Update ViewsNO_AUTO_VIEW_UPDATEnoautoviewupdate  
Advanced TabDisable Export of View DataNO_EXPORT_VIEW$DisableExport  
Advanced TabAllow Soft DeletionsALLOW_SOFT_DELETEallowsoftdeletion  
Advanced TabPermanently Delete Documents AfterSOFT_DELETE_EXPIRYsoftdeletionsexpirein  
Advanced TabLimit $UpdatedByMAX_UPDATED_BYmaxupdatedbyentries  
Advanced TabLimit $RevisionsMAX_REVISIONSmaxrevisionentries  
Advanced TabAllow DASALLOW_DAS$AllowRESTDbAPI  
Not ExposedDAOSDAOS_ENABLED$Daos  
LaunchRun server-based XPages apps directly on ServerLAUNCH_XPAGE_ON_SERVER$LaunchXPageRunOnServer  
Not Exposed     
  • No labels