This chapter describes Oracle API Catalog's System Settings that administrators use to configure basic operations and specific features.
This chapter contains the following sections:
To access the system settings, perform the following steps:
Click the Admin button to open the Oracle API Catalog Admin page.
Click System Settings in the sidebar on Admin page.
The System Settings section is displayed. System Settings are organized into categories. Each category is further divided into feature groups.
Click the plus icon to expand the display of any category or feature group.
Click the minus icon to collapse the display.
System settings for particular features can be located using the System Settings Search.
Enter a search term in the Search field. The relevant category sections expand to display the relevant System Settings.
Click Cancel to clear the search results.
Note:
Exercising this option moves all system settings stored in property files to the database. This action cannot be reversed.Click Move settings to database. All system settings are saved to the database. This is for a clustered environment. All servers in the clustered environment will now have one source for system settings.
This section describes all the system setting available in Oracle API Catalog.
This section contains the following topics:
This section contains the following topics:
Maximum number of results for Asset Search
cmee.search.assets.maxresults
The numerical value entered in the text box determines the maximum number of assets returned by a search. Entering 0 returns an unrestricted number.
Search Specific Field
cmee.search.specific.field
The True and False options toggle the ability to search specific fields during Standard Searches by identifying the field to be searched in the Keyword text box.
Use default XSLT for asset types
cmee.asset.pdf.xslt.default
The True and False options specifies that when exporting an asset to PDF, a default asset type is used. Failing its existence, an error is shown.
PDF Asset Export Destination
cmee.asset.xml.paths.export-destination
Text entered in the text box identifies the PDF asset export destination.
PDF Asset Export Destination URL
cmee.asset.xml.paths.export-destination-url
Text entered in the text box identifies the PDF asset export destination URL.
PDF Asset XSL Directory
cmee.asset.xml.paths.xsl-source
Text entered in the text box identifies the PDF asset XSL directory.
PDF Asset Generated PDF Destination
cmee.asset.xml.paths.out-destination
Text entered in the text box identifies the PDF asset generated PDF destination.
PDF Asset Generated PDF Destination URL
cmee.asset.xml.paths.out-destination-url
Text entered in the text box identifies the PDF asset generated PDF destination URL.
PDF Asset Export WebApp URL
cmee.asset.xml.paths.webapp-url
Text entered in the text box identifies the PDF asset export WebApp URL.
This section contains the following topics:
Asset Editor Enable Embedded HTML in Asset Description
cmee.asseteditor.enable-embedded-html-asset-description
True allows embedded HTML to be entered into an API's description.
This section contains the following topics:
Unapproved User Login
enterprise.security.unapproveduser.allowlogin
The True and False options toggle the ability for unapproved users to log in to the system. This is useful when using LDAP or container-managed authentication.
Enable LDAP Login
enterprise.authentication.ldap.enabled
Enables the LDAP Login Module for authentication.
Plug-in Login Module Class Name
enterprise.loginmodules.pluggableloginmodule.classname
Text entered in the text box identifies the class name for the plug-in login module.
Click +Add as necessary to add class names for additional plug-in login modules.
LDAP Server Host Name
ldap.host
Enter the host name for the LDAP server. This is a mandatory field.
LDAP Server Port Number
ldap.port
Enter the LDAP server port number. The default is 389. This is an optional field.
LDAP Mask
ldap.mask
Enter the LDAP mask, either the authentication bind or search criteria. This is a mandatory field.
Creation of Unapproved User Accounts
ldap.allow-user-creation
Select True to determine if unapproved user accounts can be created. The default value is true. This is an optional field.
Assign default roles to users
ldap.assign-default-roles
Select true to determine, if users shall be assigned default roles.
Auto create missing roles
ldap.auto-create-missing-roles
Select true to determine, if auto create missing roles is enabled.
Auto create missing departments
ldap.auto-create-missing-depts
Select true to determine if auto create missing departments is enabled.
LDAP Version
ldap.version
The LDAP version used, which can be either 2 or 3. The default value is 2. This is an optional field.
Administrator Account Distinguished Name
ldap.bindDN
The distinguished name of the administrator account. This is an optional field.
Administrator Account Password
ldap.bindPassword
The password for the administrator account. This is an optional field.
Use SSL Connection
ldap.ssl.enabled
Enables an SSL Connection for LDAP. The default is false.
Follow referrals
ldap.follow-referrals
If true, follow referrals.
Retrieve data using the admin account
ldap.retrieve-data-as-admin
If true, then bindDN must be set. The default is false.
Search Start Location
ldap.baseDN
Start location for a search, works with ldap.mask and ldap.scope to define the search. This is an optional field.
Search Scope
ldap.scope
Determines the scope of the search. This is an optional field.
Attribute Name that Identifies a Found Entry
ldap.uniqueIDAttrib
Attribute name that identifies a found entry beyond the use of the distinguished name, if not specified, then defaults to uid. This is a mandatory field.
Found Entry Email Attribute Name
ldap.emailAttrib
Email attribute name of a found entry. This is an optional field.
Found Entry First Name Attribute Name
ldap.givennameAttrib
First name attribute name of a found entry. This is an optional field.
Found Entry Middle Name Attribute Name
ldap.middlenameAttrib
Middle name attribute name of a found entry. This is an optional field.
Found Entry Last Name Attribute Name
ldap.surnameAttrib
Last name attribute name of a found entry. This is an optional field.
Found Entry Telephone Number Attribute Name
ldap.telephoneAttrib
Telephone number attribute name of a found entry. This is an optional field.
Use LDAP Departments
ldap.enable-synch-depts
If true, get user departments from LDAP upon login.
Department Attribute
ldap.deptAttrib
Name of attribute of the departments of the entry found.
Use LDAP Roles
ldap.enable-synch-roles
If true, get user roles from LDAP upon login.
Role Attribute
ldap.rbac.roleAttrib
Name of attribute of the roles of the entry found.
Second Level Lookup Attribute
ldap.redirectDnAttrib
Attribute which identifies a second level lookup to retrieve user info; must be a dn(distinguished name). This is an optional field.
Bridge Class Name
ldap.bridge.classname
This is a required field. The text for this property represents the class name of the bridge to be used.
Container Login Module Display Name
enterprise.loginmodules.containerloginmodule.displayname
Text entered in the text box appears as the display name of the container login module.
Container Login Module
enterprise.loginmodules.containerloginmodule.enabled
Select the True option to enable the container login module.
Container Login Module - Internal Checking
enterprise.loginmodules.containerloginmodule.internalchecking
Select the True option to enable internal checking for the container login module.
This section contains the following topics:
Import/Export job monitor max idle (msecs)
cmee.extframework.impexp.monitor.maxidle
The value entered in the text field represents the maximum time (in msecs) that an import/export job can be idle before it is automatically killed by the job monitor.
Import/Export job monitor max idle for Rex transactions(msecs)
cmee.extframework.impexp.monitor.rex.maxidle
The value entered in the text field represents the maximum time (in msecs) that a rex transaction can be idle before it is automatically killed by the job monitor.
Import/Export job monitor max runtime (msecs)
cmee.extframework.impexp.monitor.maxruntime
The value entered in the text field represents the maximum time (in msecs) that an import/export job can run before it is automatically killed by the job monitor.
Import/Export job monitor period (msecs)
cmee.extframework.impexp.monitor.period
The value entered in the text field represents the time (in msecs) between scans for the job monitor.
Import/Export job proxy period (msecs)
cmee.extframework.impexp.proxy.period
The value entered in the text field represents the time (in msecs) between checks by job proxies for job status on other cluster nodes.
Import/Export job proxy timeout (msecs)
cmee.extframework.impexp.proxy.timeout
The value entered in the text field represents the time (in msecs) before a job proxy stops monitoring status of remote jobs on other clustered nodes.