This appendix provides essential OAAM properties and enums.
OAAM properties are summarized in the following sections.
These properties and default values are used to create the Oracle Access Manager Client Object Pool. These parameters can be configured to higher values if the login volume is high.
Table C-1 Pool Configuration Properties
| Properties | Description |
|---|---|
|
oaam.oam.oamclient.minConInPool |
Defines the minimum number of OAP connections that OAAM will maintain in its pool. It is recommended to keep this value the same as Max Connections as oaam.uio.oam.num_of_connections. |
|
oaam.oam.oamclient.initDelayForWatcher |
Defines the initial delay (in milliseconds) before the OAAM Pool Watcher thread starts to check connections. |
|
oaam.oam.oamclient.periodForWatcher |
Defines the rest period (in milliseconds) for the OAAM Pool Watcher thread, a thread which periodically checks the health of connections in the pool. Keep this a low value, if connections can go bad frequently. |
|
oaam.oam.oamclient.timeout |
Period (in milliseconds) that a request will wait for an available OAP connection before timing out if no connections are available in the pool. Keep this value to a low number. |
|
oaam.uio.oam.num_of_connections |
Primary OAM Server Setting Defines the target (maximum) number of OAP connections to the primary OAM server that OAAM will maintain in its pool. Change default to sufficiently high number. |
|
oaam.uio.oam.secondary.host.num_of_connections |
Secondary OAM Server Setting (if used) Defines the target (maximum) number of OAP connections to the secondary OAM server that OAAM will maintain in its pool. Change default to sufficiently high number. |
Table C-2 Policies, Rules, and Condition Properties
| Properties | Description |
|---|---|
|
vcrypt.tracker.rules.trace.policySet.XXXXXX |
Specifies the checkpoint in which to log the rules. Make sure that "vcrypt.tracker.rules.trace.policySet.XXXXXX" is set to |
|
vcrypt.tracker.rulelog.detailed.minMillis |
Controls threshold and logging for rules. By default, the Session Details page does not display the trigger sources if the execution time for alerts is less than 2000 millisecond (2000 ms) since detailed logging is dependent on the execution time. Set this property to 2000 |
|
vcrypt.tracker.rules.allowControlledActions |
Enables/disables the Action Override feature. This feature is turned off by default. |
Table C-3 Autolearning Properties
| Properties | Description |
|---|---|
|
vcrypt.tracker.autolearning.enabled |
Enables/disables the autolearning feature. This property must always be set to |
|
vcrypt.tracker.autolearning.use.auth.status.for.analysis |
Enables/disables the authentication patterns. Authentication patterns are the patterns that analyze the data related to authentication (login) related information only. You can set it to True or False. |
|
vcrypt.tracker.autolearning.use.tran.status.for.analysis |
Enables the transaction-related patterns. Set to true for the transaction-related patterns to work. Transaction related patterns analyze the transaction related data for autolearning. An example is a pattern that profiles users who are performing wire transfer operations. |
|
oracle.oaam.transactions.analyzepatterns |
Enables the collection of pattern data for transactions. Set to true for pattern data to be collected for transactions. |
|
vcrypt.bharosa.autolearning.numPriorities |
Creates the number of threadpools as the number of priorities. These threadpools are used for post processing the autolearning data. This number should be more than 1. |
|
vcrypt.bharosa.autolearning.threadMultiplier |
Create the number of threads for post processing. These threads are part of the threadpool that is used for post processing autolearning data. Keep this number to at least 5. |
|
vcrypt.tracker.autolearnin.enabled |
Controls the status for the product level. Setting the value to false disables some of the post processing for autolearning. Rules continue to run but may be using stale data. |
|
vcrypt.tracker.autolearning.use.auth.status.for.analysis |
Enables/disables autolearning post processing if you do not want to change the client code. Setting this property to true results in autolearning processing for the authentication type of updateAuthStatus requests if the status is SUCCESS for that authentication request. However if the status is not SUCCESS, autolearning does not occur. Running autolearning rules with this property set to false runs the rules on the data that is stale. If this property is set to false and autolearning rules are running, and if the log level is set to "debug" for "com.bharosa.vcrypt.tracker.rules.impl.VCryptTrackerAutoLearningImpl" class; then a message is written to the log saying that this property is disabled and rules are still being run. Use this property when the client code does not explicitly call the autolearning API. |
|
oracle.oaam.transactions.analyzepatterns |
Enables/disables the collection of pattern data for transactions. Set to true for pattern data to be collected for transactions. |
|
vcrypt.tracker.autolearning.use.tran.status.for.analysis |
Enable this property if you want autolearning (post processing) to occur but do not want to change the client code. Setting this property to true results in autolearning processing for updateTransactionStatus requests if the status is SUCCESS for that transaction request. However if the status is not SUCCESS, autolearning does not occur. Running autolearning rules with this property set to false runs the rules on the data that is stale. If this property is set to false and you have autolearning rules running, and if the log level is set to "debug" for the "com.bharosa.vcrypt.tracker.rules.impl.VCryptTrackerAutoLearningImpl" class; a message is written to the log saying that this property is disabled and rules are still running. |
|
vcrypt.tracker.autolearning.use.synchronous.execution.for.pattern.analysis |
Controls whether the pattern analysis occurs in synchronous mode. If set to true, pattern analysis is performed synchronously. The updateAuthStatus or updateTransactionStatus call may take longer to complete since all the pattern data update occurs as part of the same updateStatus call. |
|
vcrypt.tracker.autolearning.update.entity.profile.for.auth.patterns |
Enables/disables update of profiles for entities as part of pattern analysis. |
|
bharosa.menu.queries.entities |
Determines whether the menu item to view historical data should be shown in the OAAM Administration Console. |
|
bharosa.arm.pagetitle.queries.entities.patternworkflow |
Default location of the menu for the pattern historical data. Use this historical data page to check to see whether pattern data collection is functioning properly. |
| Properties | Description |
|---|---|
|
Sets the Secure Only flag on any cookies set by OAAM applications directly (does not apply to JSESSIONID). It will mainly apply to the VSC cookie |
Table C-5 Entity and Transaction Properties
| Properties | Description |
|---|---|
|
bharosa.trackeradmin.show.transaction.detail=true |
Enables you to view transactions in the Session Details page if set to true. Turns off the display for transactions is set to false. |
|
oaam.admin.detail.ip.enabled oaam.admin.detail.user.enabled oaam.admin.detail.device.enabled oaam.admin.detail.fingerprint.enabled oaam.admin.detail.alert.enabled oaam.admin.detail.challengecount.enabled |
Enables you to be able to use the details pages. |
|
oaam.transaction.mapping.startindex.min |
Starts the substring operation from the first character of the string if you set this property to |
Table C-6 Encrypted Data Masking Properties
| Properties | Description |
|---|---|
|
oaam.transaction.encrypted.data.mask.suffix.length |
Shows the number of characters unmasked. The default length is 3. |
|
oaam.transaction.encrypted.data.mask.char |
Shows mask characters to represent encrypted transaction data. For example, set the property to ******** |
|
oaam.transaction.encrypted.data.mask |
Set to true to enables masking of encrypted transaction data globally. |
| Properties | Description |
|---|---|
|
bharosa.kba.active |
Enables KBA if set to true. |
|
bharosa.config.type.kba_config.enum.regQuestionsCount.validation.minValue bharosa.config.type.kba_config.enum.regQuestionsCount.validation.maxValue |
Specifies the maximum and minimum limits for questions the user will register. bharosa.config.type.kba_config.enum.regQuestionsCount.validation.minValue=3 bharosa.config.type.kba_config.enum.regQuestionsCount.validation.maxValue=7 The setting should be between 3 and 7 to offer security but not over burden a user's memory. The basic industry standard for KBA is 3 registered questions. |
|
challenge.question.registration.groups.minimum.questions.per.category.count challenge.question.registration.groups.categories.count challenge.question.registration.groups.questions.count challenge.question.registration.groups.count challenge.question.registration.groups.maxlimit |
Controls the listing of questions in the OAAM server. challenge.question.registration.groups.minimum.questions.per.category.count =1 challenge.question.registration.groups.categories.count=5 challenge.question.registration.groups.questions.count=5 challenge.question.registration.groups.count=3 challenge.question.registration.groups.maxlimit=5 |
| Properties | Description |
|---|---|
|
bharosa.uio.default.ums.integration.webservice |
http://<UMS Server URL>:<UMS Port>/ucs/messaging/webservice UMS Server Web service URL |
|
bharosa.uio.default.ums.integration.parlayx.endpoint |
http://<UMS Server URL>:<UMS Port>/sdpmessaging/parlayx/SendMessageService UMS Server ParlayX Endpoint URL |
|
bharosa.uio.default.ums.integration.useParlayX |
False Configures the use of web service or parlayx API. The value is false by default (Web services recommended). |
|
bharosa.uio.default.ums.integration.userName |
User name for UMS server |
|
bharosa.uio.default.ums.integration.password |
Password for UMS server |
|
bharosa.uio.default.ums.integtaion.policies |
UMS authentication policies |
|
bharosa.uio.default.ums.integration.fromAddress |
jane@mycompany.example.com OAAM from address for OTP messages. |
|
bharosa.uio.default.ums.integration.message.status.poll.attempts |
3 Number of times to attempt status poll each time the wait page is displayed. |
|
bharosa.uio.default.ums.integration.message.status.poll.delay |
1000 Delay between status polls while the wait page is being displayed |
|
bharosa.uio.default.ums.integration.sleepInterval |
10000 |
|
bharosa.uio.default.ums.integration.deliveryPage.delay |
3000 |
|
bharosa.uio.default.challenge.type.enum.ChallengeSMS |
2 SMS Challenge enum value |
|
bharosa.uio.default.challenge.type.enum.ChallengeSMS.name |
SMS Challenge Name of SMS challenge type |
|
bharosa.uio.default.challenge.type.enum.ChallengeSMS.description |
SMS Challenge Description of SMS challenge type |
|
bharosa.uio.default.challenge.type.enum.ChallengeSMS.processor |
com.bharosa.uio.processor.challenge.ChallengeSMSProcessor Processor class for SMS challenge type Specifies the java class for handling challenges of this type. The challenge mechanism is customizable through Java classes. See the Oracle Fusion Middleware Developer's Guide for Oracle Adaptive Access Manager for information. |
|
bharosa.uio.default.challenge.type.enum.ChallengeSMS.requiredInfo |
mobile Required fields to challenge user with SMS challenge type A comma separated list of inputs from registration input enum |
|
bharosa.uio.default.challenge.type.enum.ChallengeSMS.available |
Makes available the SMS challenge type Specifies if the challenge type is available for use (service ready and configured). To enable/disable an OTP challenge type, the available flag should be set. |
|
bharosa.uio.default.challenge.type.enum.ChallengeSMS.otp |
true OTP property for SMS challenge type |
|
bharosa.uio.default.challenge.type.enum.ChallengeEmail |
1 Email Challenge enum value |
|
bharosa.uio.default.challenge.type.enum.ChallengeEmail.name |
Email Challenge Name of email challenge type |
|
bharosa.uio.default.challenge.type.enum.ChallengeEmail.description |
Email Challenge Description of email challenge type |
|
bharosa.uio.default.challenge.type.enum.ChallengeEmail.processor |
com.bharosa.uio.processor.challenge.ChallengeEmailProcessor Processor class for email challenge type Specifies the java class for handling challenges of this type. The challenge mechanism is customizable through Java classes. See the Oracle Fusion Middleware Developer's Guide for Oracle Adaptive Access Manager for information. |
|
bharosa.uio.default.challenge.type.enum.ChallengeEmail.requiredInfo |
Required fields to challenge user with email challenge type A comma separated list of inputs from registration input enum |
|
bharosa.uio.default.challenge.type.enum.ChallengeEmail.available |
false Makes available the email challenge type Specifies if the challenge type is available for use (service ready and configured). To enable/disable an OTP challenge type, the available flag should be set. |
|
bharosa.uio.default.challenge.type.enum.ChallengeEmail.otp |
true OTP property for email challenge type |
|
bharosa.uio.default.register.userinfo.enabled |
Enables/disables the profile registration pages if the OTP channel is enabled and requires registration. |
|
bharosa.uio.default.userpreferences.userinfo.enabled |
Enables/disables the ability to set preferences if the OTP channel is enabled and allows preference setting. User Preferences is a page that allows the user to change their image/phrase, challenge questions, un-register devices, and update their OTP profile. |
|
bharosa.uio.default.challenge.type.enum.ChallengeSMS.available |
Enables the SMS Challenge Type. This makes it possible for the policies to challenge using OTP via SMS. |
|
bharosa.uio.default.messages.enum.terms.name |
Terms and Conditions |
|
bharosa.uio.default.messages.enum.terms.description |
PLACEHOLDER TEXT FOR TERMS AND CONDITIONS |
|
bharosa.uio.default.messages.enum.privacy.name |
Privacy Policy |
|
bharosa.uio.default.messages.enum.privacy.description |
PLACEHOLDER TEXT FOR PRIVACY POLICY |
|
bharosa.uio.default.userinfo.inputs.enum.terms |
4 Terms and Conditions enum value |
|
bharosa.uio.default.userinfo.inputs.enum.terms.name |
Terms and Conditions Name for Terms and Conditions checkbox |
|
bharosa.uio.default.userinfo.inputs.enum.terms.description |
Terms and Conditions Description for Terms and Conditions checkbox |
|
bharosa.uio.default.userinfo.inputs.enum.terms.inputname |
terms HTML input name for Terms and Conditions checkbox |
|
bharosa.uio.default.userinfo.inputs.enum.terms.inputtype |
checkbox HTML input type for Terms and Conditions checkbox |
|
bharosa.uio.default.userinfo.inputs.enum.terms.values |
true Required values for Term and Conditions checkbox during registration and user preferences |
|
bharosa.uio.default.userinfo.inputs.enum.terms.maxlength |
40 HTML input max length for Terms and Conditions checkbox |
|
bharosa.uio.default.userinfo.inputs.enum.terms.required |
true Required flag for Term and Conditions checkbox during registration and user preferences |
|
bharosa.uio.default.userinfo.inputs.enum.terms.order |
5 Order on the page for Terms and Conditions checkbox |
|
bharosa.uio.default.userinfo.inputs.enum.terms.enabled |
true Enabled flag for Terms and Conditions enum item |
|
bharosa.uio.default.userinfo.inputs.enum.terms.regex |
.+ Regular expression for validation of Terms and Conditions checkbox |
|
bharosa.uio.default.userinfo.inputs.enum.terms.errorCode |
otp.invalid.terms Error code to get error message from if validation of Terms and Conditions fails |
|
bharosa.uio.default.userinfo.inputs.enum.terms.managerClass |
com.bharosa.uio.manager.user.DefaultContactInfoManager Java class to use to save / retrieve Terms and Conditions from data storage |
|
bharosa.uio.default.userinfo.inputs.enum.mobile |
0 Mobile phone enum value |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.name |
Mobile Phone Name for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.description |
Mobile Phone Description for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.inputname |
cell number HTML input name for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.inputtype |
text HTML input type for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.maxlength |
15 HTML input max length for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.required |
true Required flag for mobile phone field during registration and user preferences |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.order |
1 Order on the page for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.enabled |
true Enabled flag for mobile phone enum item |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.regex |
\\D?(\\d{3})\\D?\\D?(\\d{3})\\D?(\\d{4}) Regular expression for validation of mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.errorCode |
otp.invalid.mobile Error code to get error message from if validation of mobile phone entry fails |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.managerClass |
com.bharosa.uio.manager.user.DefaultContactInfoManager Java class to use to save / retrieve mobile phone from data storage |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2 |
2 Mobile phone enum value |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.name |
Mobile Phone 2 Name for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.description |
Mobile Phone 2 Description for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.inputname |
cell number 2 HTML input name for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.inputtype |
text HTML input type for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.maxlength |
15 HTML input max length for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.required |
true Required flag for mobile phone field during registration and user preferences |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.order |
2 Order on the page for mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.enabled |
true Enabled flag for mobile phone enum item |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.regex |
\\D?(\\d{3})\\D?\\D?(\\d{3})\\D?(\\d{4}) Regular expression for validation of mobile phone field |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.errorCode |
otp.invalid.mobile Error code to get error message from if validation of mobile phone entry fails |
|
bharosa.uio.default.userinfo.inputs.enum.mobile2.managerClass |
com.bharosa.uio.manager.user.DefaultContactInfoManager Java class to use to save / retrieve mobile phone from data storage |
|
bharosa.uio.default.userinfo.inputs.enum.email |
1 Email address enum value |
|
bharosa.uio.default.userinfo.inputs.enum.email.name |
Email Address Name for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email.description |
Email Address Description for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email.inputname |
HTML input name for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email.inputtype |
text HTML input type for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email.maxlength |
40 HTML input max length for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email.required |
true Required flag for email address field during registration and user preferences |
|
bharosa.uio.default.userinfo.inputs.enum.email.order |
2 Order on the page for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email.enabled |
false Enabled flag for email address enum item |
|
bharosa.uio.default.userinfo.inputs.enum.email.regex |
.+@[a-zA-Z_]+?\\.[a-zA-Z]{2,3} Regular expression for validation of email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email.errorCode |
otp.invalid.email Error code to get error message from if validation of email address entry fails |
|
bharosa.uio.default.userinfo.inputs.enum.email.managerClass |
com.bharosa.uio.manager.user.DefaultContactInfoManager Java class to use to save / retrieve email address from data storage |
|
bharosa.uio.default.userinfo.inputs.enum.email2 |
2 Email address enum value |
|
bharosa.uio.default.userinfo.inputs.enum.email2.name |
Email Address 2 Name for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email2.description |
Email Address 2 Description for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email2.inputname |
email2 HTML input name for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email2.inputtype |
text HTML input type for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email2.maxlength |
40 HTML input max length for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email2.required |
true Required flag for email address field during registration and user preferences |
|
bharosa.uio.default.userinfo.inputs.enum.email2.order |
2 Order on the page for email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email2.enabled |
false Enabled flag for email address enum item |
|
bharosa.uio.default.userinfo.inputs.enum.email2.regex |
.+@[a-zA-Z_]+?\\.[a-zA-Z]{2,3} Regular expression for validation of email address field |
|
bharosa.uio.default.userinfo.inputs.enum.email2.errorCode |
otp.invalid.email Error code to get error message from if validation of email address entry fails |
|
bharosa.uio.default.userinfo.inputs.enum.email2.managerClass |
com.bharosa.uio.manager.user.DefaultContactInfoManager Java class to use to save / retrieve email address from data storage |
|
bharosa.uio.default.userinfo.inputs.enum.mobile.name |
Mobile Phone Name for mobile phone field |
Table C-9 Investigation Properties
| Properties | Description |
|---|---|
|
bharosa.trackeradmin.show.transaction.detail |
Set to true to be able to view transactions in the Session Details page. Setting the property to false turns off the display for transactions. |
|
oaam.customercare.agent.case.allow.userinfo |
Turns on/off user information display for Agent case (which is not in escalated status |
|
oaam.admin.investigator.default.landing.page=customercare oaam.admin.investigator.landing.page2=sessions oaam.admin.investigator.landing.page3=transactionlogs |
Changes the landing page to either Cases, Sessions or Search Transactions with the use of property |
|
incrementCacheCounter |
Set to true in the rule.action.enum so that different actions performed by the user along with the aggregate count for each one of them is available in the user details: profile data. |
Table C-11 Virtual Authentication Device Properties
| Properties | Description |
|---|---|
|
bharosa.user.noun.list bharosa.user.adj.list |
Customize the phrase in the virtual authentication device by setting the following two parameters. The authenticator phrase is created by these two properties. Both are comma-separated lists of words. Examples: actors,age,air,aircraft abundant,accessible,accommodating |
|
vcrypt.user.image.dirlist.property.name=bharosa.image.dirlist bharosa.image.dirlist=<imagePath> |
Set the properties for images to be displayed. bharosa.image.dirlist sets is the location of the image files that the application will use when creating authentication images. The directory contains 1000 images. bharosa.image.dirlist=/bharosa_images/allpads/textpad/ vcrypt.user.image.dirlist.property.name=bharosa.image.dirlist |
|
bharosa.authentipad.questionpad.datafield.input.type |
The property in Valid values are text and password. |
|
bharosa.authentipad.image.url |
bharosa.authentipad.image.url=kbimage.jspaction=kbimage& Specifies the URL file and query parameters to use when displaying an image for challenge. |
|
vcrypt.caption.assignDefault |
Instructs the server not to assign a caption to the user's registration image if set to false. |
|
desertref.authentipad.isADACompliant |
Enables accessible versions of the virtual authentication devices in native integration if this ADA compliant property is set to true. The accessible versions of the pads contain tabbing, directions and ALT text necessary for navigation via screen reader and other assistive technologies. |
|
bharosa.uio.default.authentipad.is_ada_compliant |
Enables accessible versions of the virtual authentication devices in UIO if this ADA compliant property is set to true. The accessible versions of the pads contain tabbing, directions and ALT text necessary for navigation via screen reader and other assistive technologies. |
| Properties | Description |
|---|---|
|
vcrypt.tracker.ip.detectProxiedIP bharosa.ip.header.name |
Enables use of the "X-Forwarded-For" IP, set this property to true. OAAM does not use the header IP by default. When using OAAM with LBR and SNAT enabled, the client IP address needs to be preserved. This is critical since OAAM relies on the client IP Address when evaluating policies. Make sure the following OAAM properties are set as follows: vcrypt.tracker.ip.detectProxiedIP=true bharosa.ip.header.name=X-Forwarded-For For information on load balancers preserving the Client IP Addresses, see the "Preparing the Network for an Enterprise Deployment" chapter in Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Identity Management. |
|
Indicates that the application is not protected by the OAAM proxy solution and that OAAM server should not proxy requests for UIO to the OAAM admin system. Set it to true for proxy mode. OAAM Server is configured to be in non-proxy mode with the flag set to false by default. |
Table C-14 Device Registration Properties
| Properties | Description |
|---|---|
|
bharosa.uio.default.registerdevice.enabled bharosa.uio.default.userpreferences.unregister.this.enabled bharosa.uio.default.userpreferences.unregister.all.enabled |
Adds text and a checkbox to the bottom of the challenge page if the property is set to true. When a user is challenged, the checkbox and text would allow him to register the current device (if it is not already registered). If the device is already registered for that user, the option will not appear unless the user unregisters the device in user preferences. |
|
bharosa.tracker.send.devideId |
Enables device registration in native integration if property is set to true so that data can be captured. |
Table C-16 User Interface Properties
| Properties | Description |
|---|---|
|
bharosa.uio.default.username.case.sensitive |
Specifies the user name to be in lowercase if set to false By default this property is set to true. When it is set to true, the user name is always in lower case. If it is set to false, the user name is taken as is. For example:
If property is true (default), all of these are the same user and will appear in the OAAM Administration Console as "myusername". If property is false, all of these are different users and will appear in the OAAM Administration Console as entered. |
|
oaam.export.max.rows.allowed |
Limits the maximum row selection for exporting a report of the results to EXCEL. Reports are the results from the Search pages for policies, questions, validations, snapshots, properties, entities, transactions, conditions, groups, patterns, and so on. |
|
fa.default.daterange.in.hours |
Search screen default time range. |
|
oaam.session.filter.timerange.enum.oneday.typevalue |
Session screen default time range. |
| Properties | Description |
|---|---|
|
oaam.adf.timezone |
To set the time zone that will be used for all timestamps in the user interface, use the Property Editor to set For example,
The time zones are as follows: Pacific/Midway (GMT-11:00) Midway - Samoa Time (ST) Pacific/Pago_Pago (GMT-11:00) Pago Pago - Samoa Time (ST) Pacific/Honolulu (GMT-10:00) Honolulu - Hawaii Time (HT) Pacific/Fiji (GMT+12:00) Fiji - Fiji Time (FJT) |
|
oaam.adf.timezone |
America/Anchorage (GMT-09:00) Alaska Time (AKT) America/Tijuana (GMT-08:00) Tijuana - Pacific Time (PT) America/Vancouver (GMT-08:00) Vancouver - Pacific Time (Canada) (PT) America/Los_Angeles (GMT-08:00) Los Angeles - Pacific Time (PT) America/Chihuahua (GMT-07:00) Chihuahua - Mexico Time 2 (MT) America/Denver (GMT-07:00) Denver - Mountain Time (MT) America/Edmonton (GMT-07:00) Mountain Time Canada (MT) America/Panama (GMT-05:00) Panama - Eastern Time (ET) America/Montreal (GMT-05:00) Montreal - Eastern Time (Canada) (ET) America/New_York (GMT-05:00) New York - Eastern Time (ET) America/Puerto_Rico (GMT-04:00) Puerto Rico - Atlantic Time (AT) America/Halifax (GMT-04:00) Canada Atlantic Time (AT) America/Santiago (GMT-04:00) Santiago - Chile Time (CLT) America/Caracas (GMT-04:00) Caracas - Venezuela Time (VET) America/Godthab (GMT-03:00) Godthab - Western Greenland Time (WGT) America/Argentina/Buenos_Aires (GMT-03:00) Buenos Aires - Argentine Time (ART) America/Sao_Paulo (GMT-03:00) Sao Paulo - Brasilia Time (BRT) America/St_Johns (GMT-03:30) St Johns - Newfoundland Time (NT) America/Noronha (GMT-02:00) Noronha - Fernando de Noronha Time (FNT) Atlantic/Azores (GMT-01:00) Azores - Azores Time (AZOT) Atlantic/Cape_Verde (GMT-01:00) Cape Verde - Cape Verde Time (CVT) |
|
oaam.adf.timezone |
Europe/Dublin (GMT+00:00) Dublin - Greenwich Mean Time (GMT) Europe/London (GMT+00:00) London - Greenwich Mean Time (GMT) Etc/UTC (GMT+00:00) Coordinated Universal Time (UTC) Africa/Casablanca (GMT+00:00) Casablanca - Western European Time (WET) Europe/Lisbon (GMT+00:00) Lisbon - Western European Time (WET) Africa/Nouakchott (GMT+00:00) Nouakchott - Greenwich Mean Time (GMT) Atlantic/Reykjavik (GMT+00:00) Reykjavik - Greenwich Mean Time (GMT) Europe/Prague (GMT+01:00) Prague - Central European Time (CET) Europe/Budapest (GMT+01:00) Budapest - Central European Time (CET) Europe/Madrid (GMT+01:00) Madrid - Central European Time (CET) Europe/Vienna (GMT+01:00) Vienna - Central European Time (CET) Africa/Algiers (GMT+01:00) Algiers - Central European Time (CET) Africa/Lagos (GMT+01:00) Lagos - Western African Time (WAT) Europe/Belgrade (GMT+01:00) Belgrade - Central European Time (CET) Europe/Oslo (GMT+01:00) Oslo - Central European Time (CET) Europe/Rome (GMT+01:00) Rome - Central European Time (CET) Africa/Tunis (GMT+01:00) Tunis - Central European Time (CET) Europe/Stockholm (GMT+01:00) Stockholm - Central European Time (CET) Europe/Copenhagen (GMT+01:00) Copenhagen - Central European Time (CET) Europe/Tirane (GMT+01:00) Tirane - Central European Time (CET) Europe/Zurich (GMT+01:00) Zurich - Central European Time (CET) Europe/Paris (GMT+01:00) Paris - Central European Time (CET) Europe/Berlin (GMT+01:00) Berlin - Central European Time (CET) Europe/Warsaw (GMT+01:00) Warsaw - Central European Time (CET) Europe/Amsterdam (GMT+01:00) Amsterdam - Central European Time (CET) Europe/Brussels (GMT+01:00) Brussels - Central European Time (CET) Europe/Luxembourg (GMT+01:00) Luxembourg - Central European Time (CET) Europe/Bucharest (GMT+02:00) Bucharest - Eastern European Time (EET) |
|
oaam.adf.timezone |
Asia/Nicosia (GMT+02:00) Nicosia - Eastern European Time (EET) Europe/Kiev (GMT+02:00) Kiev - Eastern European Time (EET) Europe/Sofia (GMT+02:00) Sofia - Eastern European Time (EET) Europe/Riga (GMT+02:00) Riga - Eastern European Time (EET) Africa/Johannesburg (GMT+02:00) Johannesburg - South Africa Time (SAT) Europe/Athens (GMT+02:00) Athens - Eastern European Time (EET) Africa/Tripoli (GMT+02:00) Tripoli - Eastern European Time (EET) Africa/Cairo (GMT+02:00) Cairo - Egypt Time (ET) Asia/Beirut (GMT+02:00) Beirut - Eastern European Time (EET) Europe/Tallinn (GMT+02:00) Tallinn - Eastern European Time (EET) Europe/Vilnius (GMT+02:00) Vilnius - Eastern European Time (EET) Europe/Helsinki (GMT+02:00) Helsinki - Eastern European Time (EET) Asia/Amman (GMT+02:00) Amman - Eastern European Time (EET) Asia/Damascus (GMT+02:00) Damascus - Eastern European Time (EET) Africa/Harare (GMT+02:00) Harare - Central African Time (CAT) Asia/Jerusalem (GMT+02:00) Jerusalem - Israel Time (IT) Europe/Istanbul (GMT+02:00) Istanbul - Eastern European Time (EET) Africa/Khartoum (GMT+03:00) Khartoum - Eastern African Time (EAT) Asia/Aden (GMT+03:00) Aden - Arabia Time (AT) Africa/Mogadishu (GMT+03:00) Mogadishu - Eastern African Time (EAT) Asia/Baghdad (GMT+03:00) Baghdad - Arabia Time (AT) Asia/Bahrain (GMT+03:00) Bahrain - Arabia Time (AT) Africa/Djibouti (GMT+03:00) Djibouti - Eastern African Time (EAT) Africa/Nairobi (GMT+03:00) Nairobi - Eastern African Time (EAT) Europe/Moscow (GMT+03:00) Moscow - Moscow Time (MSK) |
|
oaam.adf.timezone |
Europe/Moscow (GMT+03:00) Moscow - Moscow Time (MSK) Asia/Qatar (GMT+03:00) Qatar - Arabia Time (AT) Asia/Kuwait (GMT+03:00) Kuwait - Arabia Time (AT) Asia/Riyadh (GMT+03:00) Riyadh - Arabia Time (AT) Asia/Tehran (GMT+03:30) Tehran - Iran Time (IRT) Asia/Dubai (GMT+04:00) Dubai - Gulf Time (GT) Asia/Baku (GMT+04:00) Baku - Azerbaijan Time (AZT) Asia/Muscat (GMT+04:00) Muscat - Gulf Time (GT) Asia/Kabul (GMT+04:30) Kabul - Afghanistan Time (AFT) Asia/Yekaterinburg (GMT+05:00) Yekaterinburg - Yekaterinburg Time (YEKT) Asia/Karachi (GMT+05:00) Karachi - Pakistan Time (PKT) Asia/Tashkent (GMT+05:00) Tashkent - Uzbekistan Time (UZT) Asia/Kolkata (GMT+05:30) Kolkata - India Time (IT) Asia/Colombo (GMT+05:30) Colombo - Sri Lanka Time (LKT) Asia/Katmandu (GMT+05:45) Katmandu - Nepal Time (NPT) Asia/Dhaka (GMT+06:00) Dhaka - Bangladesh Time (BDT) Asia/Almaty (GMT+06:00) Almaty - Alma-Ata Time (ALMT) Asia/Novosibirsk (GMT+06:00) Novosibirsk - Novosibirsk Time (NOVT) Asia/Rangoon (GMT+06:30) Rangoon - Myanmar Time (MMT) Asia/Krasnoyarsk (GMT+07:00) Krasnoyarsk - Krasnoyarsk Time (KRAT) Asia/Ho_Chi_Minh (GMT+07:00) Ho Chi Minh - Indochina Time (ICT) Asia/Jakarta (GMT+07:00) Jakarta - West Indonesia Time (WIT) Asia/Bangkok (GMT+07:00) Bangkok - Indochina Time (ICT) Asia/Kuala_Lumpur (GMT+08:00) Kuala Lumpur - Malaysia Time (MYT) |
|
oaam.adf.timezone |
Asia/Kuala_Lumpur (GMT+08:00) Kuala Lumpur - Malaysia Time (MYT) Asia/Shanghai (GMT+08:00) Shanghai - China Time (CT) Asia/Taipei (GMT+08:00) Taipei - China Time (CT) Asia/Irkutsk (GMT+08:00) Irkutsk - Irkutsk Time (IRKT) Asia/Singapore (GMT+08:00) Singapore - Singapore Time (SGT) Asia/Hong_Kong (GMT+08:00) Hong Kong - Hong Kong Time (HKT) Asia/Manila (GMT+08:00) Manila - Philippines Time (PHT) Australia/Perth (GMT+08:00) Perth - Western Time (Australia) (WT) Asia/Yakutsk (GMT+09:00) Yakutsk - Yakutsk Time (YAKT) Asia/Tokyo (GMT+09:00) Tokyo - Japan Time (JT) Asia/Seoul (GMT+09:00) Seoul - Korea Time (KT) Australia/Adelaide (GMT+09:30) Adelaide - Central Time (South Australia) (CT) Australia/Darwin (GMT+09:30) Darwin - Central Time (Northern Territory) (CT) Asia/Vladivostok (GMT+10:00) Vladivostok - Vladivostok Time (VLAT) Pacific/Guam (GMT+10:00) Guam - Chamorro Time (ChT) Australia/Hobart (GMT+10:00) Hobart - Eastern Time (Tasmania) (ET) Australia/Sydney (GMT+10:00) Sydney - Eastern Time (New South Wales) (ET) Australia/Brisbane (GMT+10:00) Brisbane - Eastern Time (Queensland) (ET) Asia/Magadan (GMT+11:00) Magadan - Magadan Time (MAGT) Pacific/Auckland (GMT+12:00) Auckland - New Zealand Time (NZT) Pacific/Fiji (GMT+12:00) Fiji - Fiji Time (FJT) Asia/Kamchatka (GMT+12:00) Kamchatka - Petropavlovsk-Kamchatski Time (PETT) Etc/GMT-12 (GMT+12:00) Dateline Standard Time (UTC+12:00) Pacific/Tongatapu (GMT+13:00) Tongatapu - Tonga Time (TOT) |
Table C-18 Customer Care Properties
| Properties | Description |
|---|---|
|
customercare.case.expirybehavior.enum.csrcase.behavior = expiry customercare.case.expirybehavior.enum.csrcase.label = Expired customercare.case.expirybehavior.enum.csrcase.durationInHrs = 24 customercare.case.expirybehavior.enum.csrcase.resetonaccess = false |
Sets expiry behavior for CSR cases |
|
customercare.case.expirybehavior.enum.csrcase.behavior = none |
Disables the expiry behavior for CSR cases |
|
oaam.permission.creatagentcase=oaam.perm.create.case.type.csr |
Allows investigator access to create Agent cases |
|
oaam.permission.creatagentcase=oaam.perm.create.case.type.csr |
Allows CSR access to Agent cases |
|
customercare.case.actiontype.enum.accesscase.description |
The values for the Notes column in the Logs tab for notes that are not added by the user will appear in English by default. The notes are taken from the action enums "note" field (property).The value of that property is saved into database (as notes). After being saved, users cannot change that data. Implementations can customize the "note" in the enum property to the localized value. "Access case" is inside the customercare.case.actiontype.enum.accesscase.description=Access case Case creation / access logic will use that string for the creating records after that point. |
|
customercare.case.expirybehavior.enum.agentcase.behavior customercare.case.expirybehavior.enum.agentcase.label customercare.case.expirybehavior.enum.agentcase.durationInHrs customercare.case.expirybehavior.enum.agentcase.resetonaccess |
Sets "expiry/overdue" behavior for Agent cases customercare.case.expirybehavior.enum.agentcase.behavior = overdue customercare.case.expirybehavior.enum.agentcase.label = Overdue customercare.case.expirybehavior.enum.agentcase.durationInHrs = 24 customercare.case.expirybehavior.enum.agentcase.resetonaccess = true |
|
customercare.case.expirybehavior.enum.agentcase.behavior |
customercare.case.expirybehavior.enum.agentcase.behavior = none Disables the "overdue/expiry" behavior for Agent cases |
|
customercare.case.autostatuschange.enum.flowone.enabled |
Enables Auto Change of Case Status if set to true. |
|
customercare.case.autostatuschange.enum.flowone.enabled |
Disables Auto Change of Case Status if set to false. |
|
customercare.case.autostatuschange.enum.flowone customercare.case.autostatuschange.enum.flowone.name onecustomercare.case.autostatuschange.enum.flowone.description onecustomercare.case.autostatuschange.enum.flowone.enabled customercare.case.autostatuschange.enum.flowone.from customercare.case.autostatuschange.enum.flowone.to |
customercare.case.autostatuschange.enum.flowone=1 customercare.case.autostatuschange.enum.flowone.name=Flow onecustomercare.case.autostatuschange.enum.flowone.description=Status flow onecustomercare.case.autostatuschange.enum.flowone.enabled=true customercare.case.autostatuschange.enum.flowone.from=new customercare.case.autostatuschange.enum.flowone.to=pending Configurable actions create cases with a status of "New". When the case is opened, the status is changed to "Pending." For these cases to change from "New" to "Pending" automatically on access, the properties are configured by default to the values. |
|
customercare.case.autostatuschange.enum.flowtwo customercare.case.autostatuschange.enum.flowtwo.name customercare.case.autostatuschange.enum.flowtwo.description customercare.case.autostatuschange.enum.flowtwo.enabled customercare.case.autostatuschange.enum.flowtwo.from customercare.case.autostatuschange.enum.flowtwo.to customercare.case.autostatuschange.enum.flowtwo.casetype |
customercare.case.autostatuschange.enum.flowtwo=2 customercare.case.autostatuschange.enum.flowtwo.name=Flow Two customercare.case.autostatuschange.enum.flowtwo.description=Status flow two customercare.case.autostatuschange.enum.flowtwo.enabled=true customercare.case.autostatuschange.enum.flowtwo.from=escalated customercare.case.autostatuschange.enum.flowtwo.to=pending customercare.case.autostatuschange.enum.flowtwo.casetype=agent Escalated cases have a Case Status of Escalated. When the case is opened, the status is changed to "Pending". For cases to change from Escalated to Pending automatically on access, the properties are configured by default. |
|
oaam.comparetrx.max.rows.allowed |
oaam.comparetrx.max.rows.allowed=10 Limits the number of transaction rows selected for Compare Transaction. |
|
oaam.generic.idmshellrhs.tab.width |
oaam.generic.idmshellrhs.tab.width=400 IDM shell right hand side width |
|
oaam.customercare.linksessions.max.rows.allowed |
oaam.customercare.linksessions.max.rows.allowed=25 Limits the number of session rows to be linked to agent case. |
|
oaam.admin.investigator.default.landing.page oaam.admin.investigator.landing.page2 oaam.admin.investigator.landing.page3 oaam.admin.investigator.landing.showhometab |
oaam.admin.investigator.default.landing.page=customercare oaam.admin.investigator.landing.page2=sessions oaam.admin.investigator.landing.page3=transactionlogs oaam.admin.investigator.landing.showhometab=false Default landing page for the investigator |
|
oaam.admin.csr.default.landing.page |
oaam.admin.csr.default.landing.page=customercare Default landing page for the CSR;points to the taskflowId(oaam.menu.enum) |
|
oaam.utility.max.filter.items.allowed |
oaam.utility.max.filter.items.allowed=15 Maximum filter items under tagged panel |
|
oaam.utility.filter.isconjuctionall |
oaam.utility.filter.isconjuctionall=true Utility filter items conjunction type (all or any) |
|
oaam.utility.filter.timerange.default |
oaam.utility.filter.timerange.default=oneday Utility filter default time-range: oaam.session.filter.timerange.enum |
|
oaam.customercare.agent.case.allow.userinfo |
oaam.customercare.agent.case.allow.userinfo=false Turns on/off userinfo for Agent case(which is not in escalated status) |
|
customercare.case.agent.landingtf.access customercare.case.csr.landingtf.access |
customercare.case.agent.landingtf.access=oaam.perm.do.case.agent.landingtf customercare.case.csr.landingtf.access=oaam.perm.do.case.csr.landingtf High-level permissions for landing pages for CSR and Investigator |
|
bharosa.multitenant.boolean |
Turns on the access control in the OAAM Administration Console for multitenant deployments, you must set the bharosa.multitenant.boolean property to true. By default, the value is set to false. |
Table C-21 Agent Case Properties
| Properties | Description |
|---|---|
|
oaam.customercare.agent.case.allow.userinfo |
Turns on/off user information for Agent case, which are not in the Escalated status. |
|
oaam.admin.investigator.default.landing.page oaam.admin.investigator.landing.page2 oaam.admin.investigator.landing.page3 |
oaam.admin.investigator.default.landing.page=customercare oaam.admin.investigator.landing.page2=sessions oaam.admin.investigator.landing.page3=transactionlogs Changes the landing page to either Cases, Sessions or Search Transactions, use the following the properties: |
Table C-22 Digital Fingerprint Properties
| Properties | Description |
|---|---|
|
bharosa.uio.default.device.identification.scheme |
Enables use of custom digital fingerprints if you set this property to the type of digital fingerprint you want to capture. For Instance, bharosa.uio.default.device.identification.scheme=applet Note: Flash is set to be the default digital fingerprint in OAAM. |
Table C-23 Encryption Properties
| Property | Description |
|---|---|
|
bharosa.cipher.encryption.algorithm.system.default |
Switches to different encryption types |
|
keystorepasswd |
Password for opening the keystore. |
|
keystorealiaspasswd |
Password reading alias (key) in the keystore |
|
keyFile |
keyFile=soap_key.file File containing from key. Please note, keys in AES could be binary. Also note algorithms like 3DES require minimum 24 characters in the key |
|
keystorefilename |
keystorefilename=system_soap.keystore Keystore file name. |
|
keystorealias |
keystorealias=vcrypt.soap.call.passwd This is the keystore alias. |
|
vcrypt.soap.auth.keystorePassword=<base64 encoded keystore password> vcrypt.soap.auth.aliasPassword=<based64 encoded password to the alias> vcrypt.soap.auth.username=<user configured for accessing the soap services> vcrypt.soap.auth.keystoreFile=system_soap.keystore |
Properties with the encoded passwords and the authentication user name to add to |
Table C-25 SOAP Web Service Access Properties
| Property | Description |
|---|---|
|
vcrypt.soap.auth |
Disables or enables HTTP authentication for Authenticator. set the following property to true (enabled) or false (disabled). |
|
vcrypt.tracker.soap.url |
SOAP Server Side URL. This setting is the location of the web services with which the application will communicate. |
|
vcrypt.common.util.vcryptsoap.impl.classname |
Specifies for the application which libraries to use when creating SOAP messages to exchange with the OAAM services. The available option is com.bharosa.vcrypt.common.impl.VCryptSOAPGenericImpl |
|
vcrypt.soap.call.timeout |
SOAP call timeout in milliseconds |
|
keystorepasswd |
Password for opening the keystore. |
|
keystorealiaspasswd |
Password reading alias (key) in the keystore |
|
keyFile= |
File containing from key. Please note, keys in AES could be binary. Also note algorithms like 3DES require minimum 24 characters in the key. For example, keyFile=soap_key.file. |
|
keystorefilename |
keystorefilename=system_soap.keystore Keystore file name. |
|
keystorealias |
keystorealias=vcrypt.soap.call.passwd Keystore alias. |
|
vcrypt.soap.auth.keystorePassword=<base64 encoded keystore password> vcrypt.soap.auth.aliasPassword=<based64 encoded password to the alias> vcrypt.soap.auth.username=<user configured for accessing the soap services> vcrypt.soap.auth.keystoreFile=system_soap.keystore |
Properties with the encoded passwords and the authentication user name to add to |
This section contains the following topics:
In this example, "myStatus" is the status that is being created. Other than the first line which specifies customercare.case.status.enum. myStatus is 100, all others are properties of this enum element.
Table C-27 New Status Enumeration
| Properties | Description and Values |
|---|---|
|
customercare.case.status.enum. myStatus |
100 Specify a number that is not used by an existing case status enum |
|
customercare.case.status.enum. myStatus.name |
myStatus The status name |
|
customercare.case.status.enum. myStatus.description |
myStatus A description of the status |
|
customercare.case.status.enum. myStatus.availableactions |
1,2,3,4,5,8,9,10,11,102,103 Enum numbers for case.action.enum that tells the system which actions can be performed on the case in this state |
|
customercare.case.status.enum. myStatus.access |
oaam.perm.view.case.status.new Enum for the access permission for this case status (who can access the case in this state) |
|
customercare.case.status.enum. myStatus.order |
12 Specify an order number that will be used in the display when the case status is displayed in various drop down menus |
|
customercare.case.status.enum. myStatus.display |
true Specify whether the status is displayed in the interface. If you do not want this status to be displayed in the user interface, then set this to false |
|
customercare.case.status.enum. myStatus.messagelist |
customercare.case.statuschange.message.enum List of messages that you can see on screen when the status changes |
|
customercare.case.status.enum. myStatus.notelist |
customercare.case.statuschange.new.notes.enum List of canned notes that you can see for this status. If you are defining a new status, define your new notes enum. For instructions, refer to the "Adding Canned Notes to Case Status" section. |
To add new alert levels add the enum element for the alert level. An example for an "ultralow" alert level is shown below.
Table C-28 New Alert Level Enumeration
| Property | Description and Value |
|---|---|
|
alert.level.enum.ultralow |
20000 Specify a number not used by alerts |
|
alert.level.enum.ultralow.name |
ALERT_ULTRA_LOW Name of the alert level |
|
alert.level.enum.ultralow.label |
Ultra Low Label that will be used in user interface |
|
alert.level.enum.ultralow.description |
Ultra Low alert Description of the alert level |
|
alert.level.enum.ultralow.color |
Magenta Color to display on session |
|
alert.level.enum.ultralow.viewColor |
Cyan Color to display on alert screen |
|
alert.level.enum.ultralow.order |
23 Order to display in the drop down menu |
When you add a new status to case status, you should define the New Notes enum as defined on this first line below and then add note options to that enum. Those options will appear as canned notes. Note that you must configure the enum name as a note enum in the new status enum element that you defined.
Table C-29 Adding Canned Notes Enumeration
| Property | Description and Value |
|---|---|
|
customercare.case.statuschange.myStatus.notes.enum |
My Status Canned Notes |
|
customercare.case.statuschange.myStatus.notes.enum.review |
1 |
|
customercare.case.statuschange.myStatus.notes.enum.review.name |
My Review |
|
customercare.case.statuschange.myStatus.notes.enum.review.description |
My review needed |
|
customercare.case.statuschange.myStatus.notes.enum.review.order |
1 |
|
customercare.case.statuschange.myStatus.notes.enum.other |
2 |
|
customercare.case.statuschange.myStatus.notes.enum.other.name |
Other |
|
customercare.case.statuschange.myStatus.notes.enum.other.description |
Other |
|
customercare.case.statuschange.myStatus.notes.enum.other.order |
2 |
When you add a case severity enum you will need to define the corresponding properties for it. A sample of a "superhigh" severity enum is shown below.
customercare.case.severity.enum.superhigh=4 // Number that is not used by existing severity enum element. customercare.case.severity.enum. superhigh.name=Super High //Name customercare.case.severity.enum. superhigh.description=Super High Severity level // some description customercare.case.severity.enum. superhigh.image=flag_lg_h.gif // Image file for the icon that displays the severity customercare.case.severity.enum. superhigh.access=oaam.perm.view.case.severity.high // Access permission to view the cases of high severity // define new if you do not want to resuse the enum customercare.case.severity.enum. superhigh.order=3 // Order in the drop down menu displays customercare.case.severity.enum. superhigh.display=true // Whether to display on user interface or not customercare.case.severity.enum. superhigh.messagelist=customercare.case.severitychange.message.enum // Message to be given when severity change is done customercare.case.severity.enum. superhigh.notelist=customercare.case.severitychange.high.notes.enum // Canned notes when severity change to this severity happens. You may want to define new here.
By default the Auto Change of Case Status is enabled. The property is as follows:
customercare.case.autostatuschange.enum.flowone.enabled=true
To disable Auto Change of Case Status set the following parameter:
customercare.case.autostatuschange.enum.flowone.enabled=false
Configurable actions create cases with a status of New. When the case is opened, the status is changed to Pending.
These cases change from New to Pending automatically on access. The default setting are as follows:
customercare.case.autostatuschange.enum.flowone=1 customercare.case.autostatuschange.enum.flowone.name=Flow onecustomercare.case.autostatuschange.enum.flowone.description=Status flow onecustomercare.case.autostatuschange.enum.flowone.enabled=true customercare.case.autostatuschange.enum.flowone.from=new customercare.case.autostatuschange.enum.flowone.to=pending
Escalated cases have a Case Status of Escalated. When the case is opened, the status is changed to Pending.
These cases change from Escalated to Pending automatically on access. The default settings are as follows:
customercare.case.autostatuschange.enum.flowtwo=2 customercare.case.autostatuschange.enum.flowtwo.name=Flow Two customercare.case.autostatuschange.enum.flowtwo.description=Status flow two customercare.case.autostatuschange.enum.flowtwo.enabled=true customercare.case.autostatuschange.enum.flowtwo.from=escalated customercare.case.autostatuschange.enum.flowtwo.to=pending customercare.case.autostatuschange.enum.flowtwo.casetype=agent
The default setting is for CSR cases to expire after 24 hours. After a CSR case expires, a CSR cannot access them. CSR Managers have to extend the expiration time so that the CSR can access them.
The properties for setting and disabling expiry behavior are provided below.
To disable the expiry behavior for CSR cases, modify the following property:
customercare.case.expirybehavior.enum.csrcase.behavior = none
Note:
You do not need to change the other parameters.To set expiry behavior for CSR cases (default setting), modify the following properties:
customercare.case.expirybehavior.enum.csrcase.behavior = expiry customercare.case.expirybehavior.enum.csrcase.label = Expired customercare.case.expirybehavior.enum.csrcase.durationInHrs = 24 customercare.case.expirybehavior.enum.csrcase.resetonaccess = false
Agent Cases have a default expiration date of 24 hours from the date of creation.
Information to change the default behavior is provided below.
To disable the expiry behavior for Agent cases, modify the following property as shown below.
customercare.case.expirybehavior.enum.agentcase.behavior = none
To set expiry behavior for Agent cases, modify the following properties as shown below.
Note:
You will not need to change the other parameters.customercare.case.expirybehavior.enum.agentcase.behavior = expiry customercare.case.expirybehavior.enum.agentcase.label = Expired customercare.case.expirybehavior.enum.agentcase.durationInHrs = 24 customercare.case.expirybehavior.enum.agentcase.resetonaccess = false
By default only Investigators and Investigation Managers have access to create Agent cases. The property for investigator access is oaam.permission.creatagentcase=oaam.perm.create.case.type.agent
To give a CSR access to Agent cases, configure the property as follows: oaam.permission.creatagentcase=oaam.perm.create.case.type.csr
After setting the property, the CSR has full access to create agent cases.