Class ecm.model.admin.RepositoryConfig
Extends
ecm.model.admin._ConfigurationObject.
Represents the configuration information for a repository. For all repository types, the
RepositoryConfig class includes the following information:
- Repository type
- Name of the server on which the repository is located
- Maximum size for retrieving and downloading information
- Date, time, and timestamp format
- System properties for documents and folders
- Search information
- Document and work item status
For IBM Content Manager OnDemand repositories, the RepositoryConfig class includes the
following information:
- Transform information for PDF and XML files
- Secure socket layer
- Custom properties
- Maximum number of folders and search results
- Folder search expression
- Trace directory and trace level
For IBM FileNet P8 repositories, the RepositoryConfig class includes the following
information:
- Object store name and display name
- Versioning for adding and checking in documents
- Annotation security
- Connection point
- Protocol
For common management information service (CMIS) repositories, the RepositoryConfig class
includes the following information:
- Repository identifier
- Flag that indicates whether gzip encoding is used
For IBM Content Manager repositories, the RepositoryConfig class includes the following
information:
- Flag that indicates whether single sign-on (SSO) is used
- Language codes
- Flag that indicates whether folders are supported
- The identifier of the root folder
- The default configuration
- Definitions for constants such as float, integer, object, and string.
Defined in: <ecm\model\admin\RepositoryConfig.js>.
Constructor Summary
| Constructor Attributes | Constructor Name and Description |
|---|---|
Field Summary
| Field Attributes | Field Name and Description |
|---|---|
|
A private boolean value indicating whether Workflow is connected used by DesktopWorkflow tab.
|
|
|
IBM Content Manager only.
|
|
|
IBM Content Manager only.
|
|
|
IBM Content Manager only.
|
Method Summary
Field Detail
connected
A private boolean value indicating whether Workflow is connected used by DesktopWorkflow tab.
enableBoxShareTracking
IBM Content Manager only. An array of content class ID strings. Each content class will be enabled for Box
share tracking when this repository configuration is saved and addOns are deployed. This array is not saved
to the repository configuration.
- Since:
- 2.0.3.6
enableEntryTemplateFolderAssocations
IBM Content Manager only. An array of content class ID strings. Each content class will be enabled for entry
template folder associations when this repository configuration is saved and addOns are deployed. This array
is not saved to the repository configuration.
- Since:
- 2.0.3
enableEntryTemplateTracking
IBM Content Manager only. An array of content class ID strings. Each content class will be enabled for entry
template tracking when this repository configuration is saved and addOns are deployed. This array is not
saved to the repository configuration.
- Since:
- 2.0.3
Method Detail
constructor(id, name, action)
Constructs a repository.
- Parameters:
- id
- The repository id.
- name
- The repository name.
- action
- Filters the items displayed on the tree (supersedes showFoldersOnly).
getPropertiesMapping(callback, params)
- Parameters:
- callback
- params
<static> ecm.model.admin.RepositoryConfig.RepositoryConfig.createRepositoryConfig(id)
Static function that constructs a repository config object. Use Application or server object to save this.
- Parameters:
- id
- Repository identifier.
<static> ecm.model.admin.RepositoryConfig.RepositoryConfig.getDefaultRepositoryConfig(type, callback, params)
Static function that constructs a new RepositoryConfig and fills it with default values. You must call setId in
order to save it.
- Parameters:
- type
- The repository type.
- callback
- Function called when the repository configuration is retrieved.
- params
- Since:
- ICN 2.0.3.4 passing extra parameters to mid-tier
setAddAsMajorVersion(addAsMajorVersion)
- Parameters:
- addAsMajorVersion
setAfp2PdfConfigFile(afp2PdfConfigFile)
- Parameters:
- afp2PdfConfigFile
setAfp2PdInstallDirectory(afp2PdfInstallDir)
- Parameters:
- afp2PdfInstallDir
setAllClassesSearch(allClassesSearch)
- Parameters:
- allClassesSearch
- Since:
- 2.0.3.5
setAnnotationSecurity(annotationSecurity)
- Parameters:
- annotationSecurity
setAnonymousAccessEnabled(anonymousAccessEnabled)
- Parameters:
- anonymousAccessEnabled
setApprovalWorkflowEnabled(enabled)
- Parameters:
- enabled
- Since:
- 2.0.3.7
setBoxCopyEnabled(enabled)
- Parameters:
- enabled
- Since:
- 2.0.3.6
setBoxOAuthSubdomain(val)
- Parameters:
- val
- Since:
- 2.0.3.6
setBoxShareEnabled(boxShareEnabled)
- Parameters:
- boxShareEnabled
- Since:
- 2.0.3.6
setCheckinAsMajorVersion(checkinAsMajorVersion)
- Parameters:
- checkinAsMajorVersion
setCmEntryTemplateRootFolderAssociations(val)
- Parameters:
- val
setCMISReposID(cmisReposID)
- Parameters:
- cmisReposID
setCompoundDocumentsEnabled(compoundDocumentsEnabled)
- Parameters:
- compoundDocumentsEnabled
setConnected(connected)
- Parameters:
- connected
setConnectionPoint(connectionPoint)
- Parameters:
- connectionPoint
setConnectionsActivityStreamConnectionsUrl(val)
- Parameters:
- val
setConnectionsActivityStreamEnable(val)
- Parameters:
- val
setConnectionsActivityStreamIgnoreGroupIds(val)
- Parameters:
- val
setConnectionsActivityStreamIgnoreUserIds(val)
- Parameters:
- val
setConnectionsActivityStreamPassword(val)
- Parameters:
- val
setConnectionsActivityStreamUserId(val)
- Parameters:
- val
setConnectionsAnonymousEnable(val)
- Parameters:
- val
setConnectionsAnonymousUserId(val)
- Parameters:
- val
setConnectionsCommunityLibrary(bool)
- Parameters:
- bool
setConnectionsGlobalAdminGroupIds(val)
- Parameters:
- val
setConnectionsGlobalAdminUserIds(val)
- Parameters:
- val
setConnectionsReviewAdminGroupIds(val)
- Parameters:
- val
setConnectionsReviewAdminUserIds(val)
- Parameters:
- val
setConnectionsSeedlistEnable(val)
- Parameters:
- val
setConnectionsUrlHttp(val)
- Parameters:
- val
setConnectionsUrlHttps(val)
- Parameters:
- val
setCustomProperties(customProps)
- Parameters:
- customProps
setDatabaseEncodingUTF8(databaseEncodingUTF8)
- Parameters:
- databaseEncodingUTF8
setDateFormat(dateFormat)
- Parameters:
- dateFormat
setDefaultEmailClassForAdd(value)
- Parameters:
- value
setDefaultFolderClassForAdd(value)
- Parameters:
- value
setDefaultSearchType(default_search_type)
- Parameters:
- default_search_type
- Since:
- 2.0.2
setDefaultSearchVersion(defaultSearchVersion)
- Parameters:
- defaultSearchVersion
- Since:
- 2.0.3
setDelimiterForOfficeProperty(value)
- Parameters:
- value
- Since:
- 2.0.3 FP6
setDirectRetrieveEnabled(directRetrieveEnabled)
- Parameters:
- directRetrieveEnabled
setDisplayRecentTeamspaces(bool)
- Parameters:
- bool
setDisplayRecentTeamspacesValue(value)
- Parameters:
- value
setDocNameProperty(docNameProp)
- Parameters:
- docNameProp
setDocNamePropSetWithFileName(bool)
- Parameters:
- bool
- Since:
- 2.0.3.6
setDocumentSystemProperties(documentSystemProps)
- Parameters:
- documentSystemProps
setEnableOnlyDocumentItemTypesEnabled(enableOnlyDocumentItemTypes)
- Parameters:
- enableOnlyDocumentItemTypes
setEnableTaskManagerDelete(bool)
- Parameters:
- bool
setEntryTemplatePermissions(val)
- Parameters:
- val
setEntryTemplatesEnabled(entryTemplatesEnabled)
- Parameters:
- entryTemplatesEnabled
setFolderDefaultColumns(folderDefCols)
- Parameters:
- folderDefCols
setFolderingEnabled(bool)
- Parameters:
- bool
setFolderMagazineDefaultColumns(folderDefCols)
- Parameters:
- folderDefCols
- Since:
- 2.0.2
setFolderNameProperty(folderNameProp)
- Parameters:
- folderNameProp
setFolderSearchExpression(folderSearchExpression)
- Parameters:
- folderSearchExpression
setFolderSystemProperties(folderSystemProps)
- Parameters:
- folderSystemProps
setIncludeAttrGroupInAttrDisplayName(includeAttrGroupInAttrDisplayName)
- Parameters:
- includeAttrGroupInAttrDisplayName
- Since:
- 2.0.3 FP2
setIncludeFormTemplate(includeFormTemplate)
- Parameters:
- includeFormTemplate
setIncludeMIMETypesInSearchResults(includeMIMETypesInSearchResults)
- Parameters:
- includeMIMETypesInSearchResults
setIncludeWorkflowDefinition(includeWorkflowDefinition)
- Parameters:
- includeWorkflowDefinition
setKeepInAutoFolder(keepInAutoFolder)
- Parameters:
- keepInAutoFolder
setLanguage(language)
- Parameters:
- language
setLanguageCodes(languageCodes)
- Parameters:
- languageCodes
setMatchAll(matchAll)
- Parameters:
- matchAll
setMaxDownloadSize(maxDownloadSize)
- Parameters:
- maxDownloadSize
setMaxFolders(maxFolders)
- Parameters:
- maxFolders
setMaxHits(maxHits)
- Parameters:
- maxHits
setMaxInMemoryRetrieveSize(maxInMemoryRetrieveSize)
- Parameters:
- maxInMemoryRetrieveSize
setMaxItemTypes(maxItemTypes)
- Parameters:
- maxItemTypes
setMaxResults(maxResults)
- Parameters:
- maxResults
setMaxWorklists(maxWorklists)
- Parameters:
- maxWorklists
setName(name)
- Parameters:
- name
setOAuthClientId(val)
- Parameters:
- val
- Since:
- 2.0.3.5
setOAuthClientSecret(val)
- Parameters:
- val
- Since:
- 2.0.3.5
setOAuthEnabled(val)
- Parameters:
- val
- Since:
- 2.0.3.5
setOAuthEndpoint(val)
- Parameters:
- val
- Since:
- 2.0.3.5
setObjectStore(objectStore)
- Parameters:
- objectStore
setObjectStoreDisplayName(objectStore)
- Parameters:
- objectStore
setODKeyringDBFile(odKeyringDBFile)
- Parameters:
- odKeyringDBFile
setODKeyringStashFile(odKeyringStashFile)
- Parameters:
- odKeyringStashFile
setODSSL(odSSL)
- Parameters:
- odSSL
setP8DownloadRecord(val)
- Parameters:
- val
- Since:
- 2.0.3
setP8DownloadRecordIgnoreUserIds(val)
- Parameters:
- val
setPluginConfiguration(value)
This string is for plugin repository types, for the plugin to save config. This string should be kept less
than 1K in length. Typically, JSON is the best structure to use for saving configuration information.
- Parameters:
- value
setPortNumber(portNumber)
- Parameters:
- portNumber
setProtocol(protocol)
- Parameters:
- protocol
setRedactionEnabled(enabled)
- Parameters:
- enabled
- Since:
- 2.0.3.7
setRedactionPermissions(val)
- Parameters:
- val
- Since:
- 2.0.3.7
setRedactionPolicyPermissions(val)
- Parameters:
- val
- Since:
- 2.0.3.7
setRestrictedSearchDocumentsType(isChecked)
- Parameters:
- isChecked
- Since:
- 2.0.3.6
setRestrictedSearchFoldersType(isChecked)
- Parameters:
- isChecked
- Since:
- 2.0.3.6
setRootFolderId(rootFolderId)
- Parameters:
- rootFolderId
setSearchDefaultColumns(searchDefCols)
- Parameters:
- searchDefCols
setSearchFilteredDocumentProperties(searchProperties)
- Parameters:
- searchProperties
setSearchFilteredFolderProperties(searchProperties)
- Parameters:
- searchProperties
setSearchFilteredOperators(type, values)
- Parameters:
- type
- values
setSearchMagazineDefaultColumns(searchDefCols)
- Parameters:
- searchDefCols
- Since:
- 2.0.2
setSearchMaxResults(searchMaxResults)
A return value of zero means maximum for P8 and CM. In the OD system, there is no infinitive concept; it has
to be a finite number.
- Parameters:
- searchMaxResults
setSearchPermissions(val)
- Parameters:
- val
setServerName(serverName)
- Parameters:
- serverName
setShareAdminUserId(val)
- Parameters:
- val
- Since:
- 2.0.3.6
setShareAdminUserName(val)
- Parameters:
- val
- Since:
- 2.0.3.6
setStatusDocBookmarks(bool)
- Parameters:
- bool
setStatusDocCheckedOut(bool)
- Parameters:
- bool
setStatusDocCompoundDocument(bool)
- Parameters:
- bool
setStatusDocDeclaredRecord(bool)
- Parameters:
- bool
setStatusDocHold(bool)
- Parameters:
- bool
setStatusDocMinorVersions(bool)
- Parameters:
- bool
setStatusDocNotes(bool)
- Parameters:
- bool
setStatusWorkItemCheckedOut(bool)
- Parameters:
- bool
setStatusWorkItemDeadline(bool)
- Parameters:
- bool
setStatusWorkItemLocked(bool)
- Parameters:
- bool
setStatusWorkItemSuspended(bool)
- Parameters:
- bool
setSyncEnabled(syncEnabled)
- Parameters:
- syncEnabled
- Since:
- 2.0.3
setSyncRepositoryId(val)
- Parameters:
- val
- Since:
- 2.0.3
setTaskManagerProxyUserId(value)
- Parameters:
- value
- Since:
- 2.0.3.6
setTaskManagerProxyUserPwd(value)
- Parameters:
- value
- Since:
- 2.0.3.6
setTeamspaceOwnerModifyRoles(bool)
- Parameters:
- bool
setTeamspacePermissions(val)
- Parameters:
- val
setTeamspacesEnabled(teamspacesEnabled)
- Parameters:
- teamspacesEnabled
setTeamspaceTaskManagerId(value)
- Parameters:
- value
- Since:
- 2.0.3
setTeamspaceTaskManagerPwd(value)
- Parameters:
- value
- Since:
- 2.0.3
setTeamspaceTemplatePermissions(val)
- Parameters:
- val
- Since:
- 2.0.3
setTempDir(tempDir)
- Parameters:
- tempDir
setTempId(tempId)
- Parameters:
- tempId
setTimeFormat(timeFormat)
- Parameters:
- timeFormat
setTimeoutInSeconds(timeoutInSeconds)
There is no timeout setting for OD and CM8.
- Parameters:
- timeoutInSeconds
setTimestampFormat(timestampFormat)
- Parameters:
- timestampFormat
setTraceDir(traceDir)
- Parameters:
- traceDir
setTraceLevel(traceLevel)
- Parameters:
- traceLevel
setTransformXMLFile(transformXMLFile)
- Parameters:
- transformXMLFile
setType(type)
- Parameters:
- type
setUnifiedSearchesEnabled(unifiedSearchesEnabled)
- Parameters:
- unifiedSearchesEnabled
setUpdateStorageCollection(updateStorageCollection)
- Parameters:
- updateStorageCollection
setUseGzipEncoding(useGzipEncoding)
- Parameters:
- useGzipEncoding
setUsePartFileName(usePartFileName)
- Parameters:
- usePartFileName
- Since:
- 2.0.3
setUseSSO(useSSO)
- Parameters:
- useSSO
setWarning(isWarning)
- Parameters:
- isWarning
- Since:
- 2.0.3.6