Oracle® Retail Advanced Science Engine Implementation Guide Release 14.1 E59126-02 |
|
![]() Previous |
![]() Next |
This chapter describes the major configuration points in ORASE, including:
Note: Since MBA is distinct from the other ORASE applications, much of what is described here is not applicable for MBA. For clarity, MBA implementation, configuration, operations and data model are described separately in "Market Basket Analysis Overview". |
This section describes details regarding WebLogic configuration.
The following are necessary before you configure WebLogic:
WebLogic Server 12c (12.1.3) must be installed on a supported server.
ORASE uses the Oracle Application Development Framework (ADF) for authentication and authorization. Authentication is done through the Oracle WebLogic-integrated LDAP service.
For authorization, ORASE modules have been built with role-based access. Access to application user interface components is done by assigning application roles. Application roles are defined as part of the application and deployed as part of the installation process. Application roles are mapped to enterprise roles during initial environment provisioning. Enterprise roles exist as LDAP groups in OID. Refer to the Oracle Retail Advanced Science Engine Installation Guide, Oracle Retail Advanced Science Engine User Guide, and Oracle Retail Assortment and Space Optimization User Guide for the definition of standard user roles.
After installing AC, ASO, CDT, and/or DT, a Customer Delegated Administrator uses Oracle Identity Manager create users and place them in appropriate groups.
Note: Users cannot log into AC, ASO, CDT, and/or DT until the mapping is done. |
This can be done through Oracle Enterprise Manager Fusion Middleware Control that is included with WebLogic Server Standard Edition, WebLogic Server Enterprise Edition, and WebLogic Suite Edition. It is also possible to specify this mapping through Oracle WebLogic scripting. Also, there is an option in the ORASE Installer to have the Installer perform the mapping automatically.
This section provides detailed instructions on setting up enterprise-level user management using Oracle WebLogic 12c with Enterprise Manager. ORASE user management configuration is handled using the WLS Console and the WLS Enterprise Manager (EM).
ORASE supports the roles listed in Table 5-1.
Table 5-1 ORASE User Roles
Role Name | Display Name | Description |
---|---|---|
ACAdvancedRole |
AC Advanced Analytic User |
Responsible for analytical configuration, testing, and cluster analysis in the Advanced Clustering (AC) module. |
ACBusinessRole |
AC Business User |
Responsible for analytical configuration, testing, and cluster analysis in the Advanced Clustering (AC) module. |
CustomerDecisionTreeRole |
Maintain Customer Decision Tree |
Responsible for analytical configuration, testing, and cluster analysis in the Customer Decision Tree (CDT) module. |
DemandTransferenceRole |
Maintain Demand Transference |
Responsible for analytical configuration, testing, and cluster analysis in the Demand Transference (DT) module. |
MicroSpaceOptAnalyst |
Micro Space Optimization Analyst |
Responsible for day-to-day Micro ASO activities. |
CategoryManagement |
ASO Category Management User |
Product Assortment-centric user who is interested in viewing ASO results and the translation of data between CatManAR and ASO. |
Administrator |
ASO Administrator |
Responsible for general system setup and configuration tasks related to Micro ASO |
AnalyticalSuperUser |
ASO Analytical Super User |
Responsible for analytical configuration, testing, and model diagnosis in MicroASO. |
The following steps describe how to set up users and application roles.
Create Users and Groups
Log into your WebLogic Admin console as administration user.
From the left pane, navigate to Security Realms, then select myrealm from the Realms list.
Select the Users and Groups tab and click the New button to create a new user.
Enter the desired user information for a new application user and click OK to confirm.
Navigate to the Groups tab and click the New button to create a new group.
Enter a group name (for example, DT_business_users) for the group of users to be assigned to a specific application role (for example, DemandTransferenceRole) and click OK to confirm.
Select the Users tab again and select the name of the new user. Select the Groups sub-tab and find the new group in the left-side multi-select list. Select the group and click the ">" icon in the center to add the Group to your User.
Click Save to persist your changes and log out of your Admin Console.
Assign Users and Groups to Roles
Log into the Enterprise Manager console, locate the application, and right-click to find the Security Application Roles sub-menu.
In the Search panel, click the blue and green arrow icon to search for all application roles.
Select the desired application role to add users to and click Edit. See User Roles for details.
Select Group from the Type drop-down menu and then click the blue and green arrow button to search. Select the newly created group name in the list and click OK.
Repeat the previous two steps for any additional users or groups you want to assign to roles. Note that if a user has been assigned to a group, then the user automatically inherits the role when a group is assigned to a role. It is not necessary to have both a group and a user assigned to the same role.
When finished, click OK in the top right corner of the screen to complete the role mapping.You can now log out of the Enterprise Manager console or continue mapping roles for other applications.
You can verify that the users have been successfully created by logging into the appropriate application as the new user.
For ASO MicroApp, see the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client for information about WLS clustering in the context of a Fusion Client installation.For AC, ASO standalone, CDT, or DT, WLS Clustering should be installed in a Managed Server setting.
Note: In a Managed Server setting, the MDS Data Source must be targeted to all of the managed servers using it. |
ORASE components that run WebLogic can be configured to use the available CPU/cores of the node they run on.
Configuration is done in each module's WEB-INF\*tojp-application-context.xml where * corresponds to the component. The configuration file itself is stored in the web archive (WAR) file. In RME's case, CDT/DT and AC applications are deployed as shared libraries. Unjar; edit the file, jar and re-deploy; restart WebLogic for changes to take effect.
CDT example:
The fixedThreadPoolSize value specifies the number of threads to spawn. The first bean processes the overall concurrent job requests (default is 2).
The second bean processes CDT step 3, which runs in the middle-tier. In this case, the default number of worker threads is 3 - 2 spawned plus the current one (useCurrentThread is true).
WEB-INF\cdttojp-application-context.xml :
<bean id="cdtLocalConcurrentService" class="oracle.retail.rse.common.jobprocessor.service.LocalServiceAdapter" scope="singleton" lazy-init="true" destroy-method="close"> <constructor-arg name="logInDb" value="true"/> <constructor-arg name="useCurrentThread" value="false"/> <constructor-arg name="fixedThreadPoolSize" value="2"/> </bean> <bean id="cdtLocalSynchConcurrentServiceNoDbLog" class="oracle.retail.rse.common.jobprocessor.service.LocalServiceAdapter" scope="singleton" lazy-init="true" destroy-method="close"> <constructor-arg name="logInDb" value="false"/> <constructor-arg name="useCurrentThread" value="true"/> <constructor-arg name="fixedThreadPoolSize" value="2"/> </bean>
Note: Each module (CDT, DT, AC and ASO) has its own *tojp-application-context.xml files that corresponds to the DB metadata configuration (tables RSE_PROC_TASK_TMPL.CTL and RSE_PROC_TMPL.CTL). |
The ORASE database includes a set of configurations in the table RSE_CONFIG.
Note: Note: ORASE is called RSE in the database. AC is called CIS in the database. |
Table 5-2 describes configuration variables common to all ORASE applications that can be changed by the user. Many of these items requiring initialization cannot be configured later. Most of the listed parameters have default values that are loaded as part of the seed data loading process. However, you should review the default values before you begin to use the application.
See Oracle Retail Advanced Science Engine Implementation Guide, Volume 2 - Data Processes and Configuration Variables for the complete list of which configurations are configurable, updateable by the application, and required at initialization.
Table 5-2 Common RSE Database Configuration Variables
Application Code | Parameter Name | Description | Must Initialize | Example Parameter Value |
---|---|---|---|---|
RSE |
BATCH_INSERT_SIZE |
Batch size for job processor-based processing. |
N |
512 |
RSE |
CAL_HIER_TYPE |
The ID of the calendar type that contains the primary calendar. |
N |
10 |
RSE |
CAL_PERIOD_LEVEL |
This is the calendar hierarchy level that is used to drive RSE processing. |
Y |
4 |
RSE |
CAT_MAN_APP_ID |
The application identifier to use for obtaining external IDs when communicating with CM. |
N |
1 |
RSE |
CDM_helpInfo |
Either a full URL or a partial URI (after the port) of the static help location. Note that if SSL is configured, full URL must be used. |
N |
/cdm-help/help/state?navSetId=cdm-help&navId=0 |
RSE |
CHAIN_LEVEL_DESC |
The description to use for any top level hierarchy element when one must be manually created. |
Y |
CHAIN |
RSE |
CMGRP_HIER_TYPE |
The hierarchy ID to use for the CM Group (installation configuration). |
Y |
5 |
RSE |
CMGRP_LEVEL_ID |
The hierarchy level ID that contains the level of the product hierarchy where the CM Group level exists. (Installation configuration). |
Y |
2 |
RSE |
CUSTSEG_HIER_TYPE |
The ID of the hierarchy type that contains the customer segment hierarchy. |
N |
4 |
RSE |
DEFAULT_APP_NAME |
The default application that is invoked when RSE is run with multiple applications after login. Valid options are: set PARAM_VALUE = 'CDT' set PARAM_VALUE = 'CIS' set PARAM_VALUE = 'DT' set PARAM_VALUE = 'SO' |
Y |
DT |
RSE |
DEFAULT_SRG_DOP |
The default configuration for any module that does not specify a degree of parallelism. |
N |
1 |
RSE |
DEFAULT_SR_DOP |
The default configuration for any module that does not specify a degree of parallelism. |
N |
1 |
RSE |
DISPLAY_DATE_FORMAT |
The default date mask to be used by the UI. |
N |
Mon dd, yyyy |
RSE |
FISCAL_CAL_HIER_TYPE |
The ID of the hierarchy type that contains the fiscal calendar. |
N |
11 |
RSE |
LOC_HIER_TYPE |
The ID of the hierarchy type that contains the primary location hierarchy. |
N |
2 |
RSE |
MT_TZ |
Time zone that is used by application server(s), that is, by the middle-tier. Must match SELECT tzname FROM V$TIMEZONE_NAMES. |
Y |
America/New_York |
RSE |
PRIMARY_LANGUAGE_CODE |
The name of the language code to use for all RSE data sourced from RA. |
Y |
EN |
RSE |
PROD_HIER_TYPE |
The ID of the hierarchy type that contains the primary product hierarchy. |
N |
1 |
RSE |
RA_APP_ID |
The application identifier to use for obtaining external IDs when communicating with RA. This should align with RSE_APP_SOURCE. |
N |
1 |
RSE |
RA_FISCAL_CAL_ID |
The ID of the calendar to use from RA since RA supports multiple calendars. |
Y |
1240 |
RSE |
RDF_APP_ID |
The application identifier to use for obtaining external IDs when communicating with RDF. |
N |
1 |
RSE |
RSE_SLS_TXN_SR_DOP |
The number of weeks that can be simultaneously processed by the SLS_TXN_ETL. |
N |
1 |
RSE |
ASO_helpInfo |
Either a full URL or a partial URI (after the port) of the static help location. Note that if SSL is configured, full URL must be used. |
N |
/aso-help/help/state?navSetId=aso-help&navId=0 |
RSE |
TRADE_AREA_HIER_TYPE |
The hierarchy ID to use for the trade area (installation configuration). |
Y |
6 |
RSE |
UI_TZ |
Time zone for display. Must match SELECT tzname FROM V$TIMEZONE_NAMES. |
Y |
America/New_York |
This section describes the advanced configuration available for or required by the ORASE applications.
CDT and DT configurations
AC Configuration
ASO configuration, which includes Gurobi configuration.
This section describes the configuration and parameter settings for CDT and DT.
All ORASE applications have configurable parameters in the RSE_CONFIG table. All have default values and are configurable and editable by the administrator. In general, if the user does not select a value for a particular field, it will default to the value set in this table. Often the parameter is not selectable from the UI, and this value is used by the application until it is changed in the database. Note that some parameters must be initialized at setup. See Table 5-3. Many of these items that require initialization cannot be configured later. See Oracle Retail Advanced Science Engine Implementation Guide, Volume 2 - Data Processes and Configuration Variables for the complete list of which configurations are configurable, updateable by the application, and required at initialization.
The following are the major categories of CDT and DT parameters:
CDT and DT time scale, filter, and priority controls
CDT and DT UI field value and histogram report defaults
CDT calculation controls, including trees calculation, pruning, demand, and replenishment settings (the settings for demand and replenishment models)
DT default controls for attributes, similarities, and DT calculation
Table 5-3 URLs
Application Code | Parameter Name | Description | Must Initialize | Example Parameter Value |
---|---|---|---|---|
CDT |
START_URL |
CDT starting URL |
N |
/faces/oracle/retail/rse/cdm/fe/view/page/index.jspx |
CDT |
END_URL |
CDT logout URL |
N |
/faces/oracle/retail/rse/cdm/fe/view/page/login.jspx |
DT |
START_URL |
DT starting URL |
N |
/faces/oracle/retail/rse/cdm/fe/view/page/index.jspx |
DT |
END_URL |
DT logout URL |
N |
/faces/oracle/retail/rse/cdm/fe/view/page/login.jspx |
Table 5-4 CDT and DT
Application Code | Parameter Name | Description | Must Initialize | Example Parameter Value |
---|---|---|---|---|
CDT |
CDT_CAL_HIER_TYPE |
The hierarchy ID to use for the fiscal calendar. (Installation configuration). |
Y |
11 |
CDT |
CDT_CAL_LEVEL_ID |
The hierarchy level ID that contains the level of the calendar hierarchy that CDT operates on. (This should equate to Week - Installation configuration.) |
Y |
4 |
CDT |
CDT_CMGRP_LEVEL_ID |
The hierarchy level ID that contains the level of the product hierarchy that CDTs are created for. (Installation configuration.) |
Y |
5 |
CDT |
CDT_CUSTSEG_HIER_TYPE |
The hierarchy ID to use for customer segment. (Installation configuration.) |
Y |
4 |
CDT |
CDT_CUSTSEG_LEVEL_ID |
The hierarchy level ID that contains the level of the customer segment hierarchy that CDTs are created for. (Installation configuration.) |
Y |
2 |
CDT |
CDT_ESC_PRIORITY |
The default priority for escalation. Choices are LOC (location/trade area (default)) or CUST (customer segment). |
N |
LOC |
CDT |
CDT_EXPORT_START_DATETIME |
Start date and time of CDT export. Format: yyyy-mm-dd hh24:mi:ss |
N |
11/10/2013 12:11 |
CDT |
CDT_FILTER_SLS_TXN_SR_DOP |
The number of parallel threads to use for processing data filtering steps. |
N |
1 |
CDT |
CDT_LOC_HIER_TYPE |
The hierarchy ID to use for location. (Installation configuration). |
Y |
2 |
CDT |
CDT_LOC_LEVEL_ID |
The hierarchy level ID that contains the level of the location hierarchy that CDTs are created for. (Installation configuration.) |
Y |
4 |
CDT |
CDT_PROD_HIER_TYPE |
The hierarchy ID to use for the CM Group. (Installation configuration.) |
Y |
1 |
CDT |
CDT_SLS_TXN_SR_DOP |
The number of weeks that can be simultaneously processed by the CDT SLS Txn ETL. |
N |
1 |
CDT |
CDT_STATS_CALC_METHOD |
The approach to use for calculating statistics on transient tables (CALC, NONE, or 0-10 for a fixed dynamic sampling level). |
N |
2 |
CDT |
CDT_UI_DEF_CALC_PARENT_SEGMENT_FLG |
UI default for the calculate-only parent customer segments flag. |
N |
Y |
CDT |
CDT_UI_DEF_CALC_PARENT_TRADE_AREA_FLG |
UI default for calculate-only parent trade areas flag. |
N |
N |
CDT |
CDT_UI_DEF_CDT_SCORE_HIST_CNT |
UI default for the number of histogram buckets for the CDT scores histogram. |
N |
20 |
CDT |
CDT_UI_DEF_DATA_FILTER_HIST_CNT |
UI default for the number of histogram buckets for the data filtering histograms. |
N |
20 |
CDT |
CDT_UI_DEF_EXCLUDE_CUST_CNT |
UI default for minimum required customer counts for pruning process. |
N |
1000 |
CDT |
CDT_UI_DEF_EXCLUDE_MIN_SCORE |
UI default for minimum CDT score required for the pruning process. |
N |
0.25 |
CDT |
CDT_UI_DEF_EXCLUDE_SKU_CNT |
UI default for minimum number of SKUs for the pruning process. |
N |
10 |
CDT |
CDT_UI_DEF_EXCLUDE_TREE_LEVEL_CNT |
UI default for minimum number of levels of the tree for the pruning process. |
N |
2 |
CDT |
CDT_UI_DEF_LOWEST_EXPANSION_LEVEL |
UI default for lowest number of levels allowed for a tree. |
N |
15 |
CDT |
CDT_UI_DEF_MAX_CUST_AVG_DY_TXN |
UI default for maximum number of times greater than average that a customer's daily transaction count can be. |
N |
100 |
CDT |
CDT_UI_DEF_MAX_MISS_ATTR_CNT |
UI default for maximum number of missing attributes a SKU can have. |
N |
3 |
CDT |
CDT_UI_DEF_MIN_ATTR_SKU_CNT |
UI default for minimum number of SKUs assigned to an attribute, to be used by the process. |
N |
5 |
CDT |
CDT_UI_DEF_MIN_ATTR_VALUE_SKU_CNT |
UI default for minimum number of SKUs assigned to an attribute value, to be used by the process. |
N |
5 |
CDT |
CDT_UI_DEF_MIN_CUST_TXN_CNT |
UI default for minimum number of transactions required for a customer, as a percent of the average number. |
N |
0.01 |
CDT |
CDT_UI_DEF_MIN_NODE_ITEM_CNT_PCT |
UI default for the minimum percent of SKUs required for a node of the tree before it is considered a terminal node. |
N |
0.05 |
CDT |
CDT_UI_DEF_MIN_SKU_TXN_CNT |
UI default for minimum number of transactions required for a SKU, as a percent of the average number. |
N |
0.01 |
CDT |
CDT_UI_DEF_PRUNING_HIST_CNT |
UI default for the number of histogram buckets for the pruning histograms. |
N |
20 |
CDT |
CDT_XML_PRECISION |
Default precision of weight field in CDT XML. |
N |
4 |
CDT |
DEF_NUM_WEEKS_FOR_SIMILARITY |
The default number of weeks of sales transaction data to be used by the similarity process. This is used when the user does not specify time intervals. |
Y |
15 |
CDT |
HISTOGRAM_DEFAULT_BIN_APPROACH |
The default histogram bin approach (C=Custom, W=Width) |
N |
C |
CDT |
HISTOGRAM_DEFAULT_NUM_BINS |
The default number of bins to display for a CDT histogram. |
N |
7 |
CDT |
MAX_NUM_WEEKS_FOR_SIMILARITY |
The maximum number of weeks of sales transaction data to be used by the similarity process. This prevents the process from using too much data. |
N |
104 |
CDT |
TREE_CALC_ALPHA_LEVEL |
The default alpha level for CDT tree calculation. Available options are 1, 2, and 3. |
N |
2 |
CDT |
TREE_CALC_METH_OVR |
Override for the default approach for calculating the CDT. Available options are PEARSON and SPEARMAN. |
N |
PEARSON |
DT |
AE_CALC_INT_LENGTH |
The number of weeks to group together for in an interval for the AE calculation. |
Y |
4 |
DT |
AE_CALC_LOC_JOIN_METHOD |
An identifier to define how the AE calculation should limit its joins of the location hierarchy. SELF=Limit data to same location. TA=Limit joins to locations in same Trade Area. FULL=Complete cross product of all locations. |
N |
SELF |
DT |
ATTRIBUTE_LIST_SEPARATOR |
A separator to be used to display a list of attributes in the Similarity Calculation screen. |
N |
|
DT |
CDT_SIMILARITY_AVAILABLE |
Whether CDT similarity has been made available to DT. |
N |
Y |
DT |
DT_BASELINE_SR_DOP |
The number of degrees of parallelism the baseline calculation should use. |
N |
1 |
DT |
DT_CAL_HIER_TYPE |
The hierarchy ID to use for the fiscal calendar. |
Y |
11 |
DT |
DT_CAL_LEVEL_ID |
The hierarchy level ID that contains the level of the calendar hierarchy that DT operates on. (It should equate to week.) |
Y |
4 |
DT |
DT_CALC_AE_SR_DOP |
The number of degrees of parallelism the DT AE calculation service should use. |
N |
1 |
DT |
DT_CAT_LOC_SKU_CNT_DOP |
The number of degrees of parallelism the Category/Location/Week SKU count routine should use. |
N |
1 |
DT |
DT_CMGRP_LEVEL_ID |
The hierarchy level ID that contains the level of the product hierarchy that DTs are created for. |
Y |
5 |
DT |
DT_CUSTSEG_HIER_TYPE |
The hierarchy ID to use for customer segment. |
N |
4 |
DT |
DT_CUSTSEG_LEVEL_ID |
The hierarchy level ID that contains the level of the customer segment hierarchy that DTs are created for. |
N |
2 |
DT |
DT_ESC_PRIORITY |
The default priority for escalation. Choices are LOC (location/trade area (default)) or CUST (customer segment). |
N |
LOC |
DT |
DT_FILTER_SR_DOP |
The number of simultaneous threads to use while filtering data for DT. |
N |
1 |
DT |
DT_LOC_HIER_TYPE |
The hierarchy ID to use for location. |
Y |
2 |
DT |
DT_LOC_LEVEL_ID |
The hierarchy level ID that contains the level of the location hierarchy that DTs are created for. |
Y |
4 |
DT |
DT_MDL_AP_EXP_WKS_BACK_END |
The number of weeks back from the last date that range data has been loaded for (PR_LOC_STATUS_LAST_COMPLETED_WK) to end using for model apply export. |
N |
1 |
DT |
DT_MDL_MIN_REQ_LC_SLS_WKS |
The minimum number of weeks per location required for model build. |
N |
10 |
DT |
DT_MDL_MIN_REQ_PR_LC_SLS_WKS |
The minimum number of weeks per product/location required for model build. |
N |
10 |
DT |
DT_PROD_HIER_TYPE |
The hierarchy ID to use for the CM Group. |
Y |
1 |
DT |
DT_REMOVE_REDUNDANCY |
If set to Y, then remove redundancy while calculating attribute-based similarities. |
N |
N |
DT |
DT_SIM_DISPLAY_ROWNUM |
The number of distinct similarity values to show in the UI pop-up. Setting too high a number effectively eliminates this limit. |
N |
9999999 |
DT |
DT_STATS_CALC_METHOD |
The approach to use for calculating statisitcs on transient tables (CALC, NONE, or 0-10 for a fixed dynamic sampling level). |
N |
2 |
DT |
DT_WGT_CALC_SR_DOP |
The number of degrees of parallelism the weight calculation script should use. |
N |
1 |
DT |
GENERIC_SEPARATOR |
A separator to be used to display a list of items, for example, SKU prod_ext_code name. |
N |
|
DT |
HISTOGRAM_DEFAULT_BIN_APPROACH |
The default histogram bin approach (C=Custom, W=Width). |
N |
W |
DT |
HISTOGRAM_DEFAULT_NUM_BINS |
The default number of buckets used for the contextual BIs. |
N |
7 |
DT |
MAX_NUM_WEEKS_FOR_ATTR_WGT |
The maximum number of weeks of input data to use for calculating attribute weights. |
N |
104 |
DT |
MAX_NUM_WEEKS_FOR_AVG_SLS |
The maximum number of weeks of input data to use for calculating the average sales. |
N |
104 |
DT |
MAX_NUM_WEEKS_FOR_FILTERING |
The maximum number of weeks of input data to use for data filtering. Setting this value lower than the other MAX_NUM_WEEKS_FOR* configurations will override the other configurations. |
N |
104 |
DT |
MAX_NUM_WEEKS_FOR_MDL_CALC |
The maximum number of weeks that should be used during the model build calculation. |
N |
104 |
DT |
MAX_NUM_WEEKS_FOR_MDL_UPDT |
The maximum number of weeks that should be used during the model build update calculation. |
N |
104 |
DT |
MAX_NUM_WEEKS_FOR_SIMILARITY |
The maximum number of weeks of input data to use for calculating similarity. |
N |
104 |
DT |
MAX_SIGNIF_SIM_CODE |
Significant SKUs count is done from this code and up (see SIM_DISPLAY_CODE_PCT). |
N |
3 |
DT |
MDL_AP_EXP_WKS_BACK_START |
The number of weeks back from the last date that range data has been loaded for (PR_LOC_STATUS_LAST_COMPLETED_WK) to start using for model apply export. |
N |
4 |
DT |
MDL_CALC_UPDT_MDL_DOP |
The number of parallel threads that can be used to update individual models in a version during the auto update process. |
N |
1 |
DT |
MDL_CALC_UPDT_SCHED_LIMIT |
The percentage value (expressed as a decimal) of versions to be attempted to be updated each execution. |
N |
0.25 |
DT |
MDL_CALC_UPDT_VERSION_DOP |
The number of parallel threads that can be used to update version MDL AE values during the auto update process. |
N |
1 |
DT |
POLLING_INTERVAL |
Stage status polling interval (in seconds). |
N |
30 |
DT |
PRUNED_CATEGORIES_SEPARATOR |
A separator to be used to display a list of pruned attributes in the Calculation screen. |
N |
|
DT |
PR_LOC_STATUS_CHG_WINDOW_LEN |
The window length to use for product/location status changes. |
N |
1 |
DT |
PR_LOC_STATUS_LAST_COMPLETED_WK |
The last completed week for SKU/Store ranging data copying. |
Y |
1104005807 |
DT |
SIM_DISPLAY_CODE_PCT |
This configuration supports different codes, along with different percent limits for those codes. |
N |
0 |
DT |
UI_DEF_CALC_PARENT_CS_ONLY_FLG |
The UI default for the calculate only parent customer segments flag. |
N |
N |
DT |
UI_DEF_CALC_PARENT_TA_ONLY_FLG |
The UI default for calculate-only parent trade areas flag. |
N |
N |
DT |
UI_DEF_MAX_MISS_ATTR_CNT |
The maximum number of missing attributes to use for a SKU before requiring it to be filtered from use. |
N |
3 |
DT |
UI_DEF_MIN_SKU_CNT |
The UI default for minimum number of SKUs required for a segment/store. |
N |
10 |
DT |
UI_DEF_MIN_SKU_TXN_LEN_PCT |
The UI default for minimum SKU transaction length as a percent of the CM Group average. |
N |
0.01 |
DT |
UI_DEF_MIN_TOT_SLS_UNIT_PCT |
The UI default for minimum total sales units as a percent of the CM group average. |
N |
0.01 |
DT |
WGT_CALC_INTERVAL_LENGTH |
The number of weeks to group into an interval that is then used to perform weight calculations. |
N |
4 |
This section describes the configuration and parameter settings for AC. AC can be installed individually and can be extensively configured using tables specific to AC.
As with CDT, DT, and ASO, AC shares the Common RSE Database Configurations for general configuration. It also has a number of additional tables, described in detail below, for additional configurability.
AC can be configured by:
Objective (currently only Store is supported),
Business objective (for example, Category Management), or
Type criteria (for example, (Consumer Profile/Store Attribute/Product Profile/Product Performance/Mixed Attribute)).
This section describes configurations for the following settings:
Basic or frequently used settings. These settings are applicable for Business Objective/Objective/Criteria.
Generic settings. These settings are applicable to the entire AC application. These settings are application-wide settings with pre-configured default values that should be updated at deployment.
Advanced analytic settings. These settings relate to the BaNG algorithm and are updated by advanced analytic users.
Rules-based settings. These settings allow extension of rules that are defined for outliers or new stores.
These configurations listed in Table 5-5 are the most frequently used during implementation and they are pre-populated as part of the application installation using the cis_master.ksh -a Attribute Maintenance option. Further updates to the clustering attributes can be performed using below documentation.
Table 5-5 Basic or Frequently Used Configuration Settings
Name | Configuration Description | Table |
---|---|---|
Flexibility to add and remove attributes in the application |
Add attributes Remove attributes These attributes are a collection of attributes and can be applied to any criteria/objective/business objective. |
|
Enable criteria for an objective (for example, stores), business objective (for example, Category Management |
Enable criteria for a objective/business objective by setting current_flg as on/off. This table also holds settings that are specific to a criteria. |
|
Enable attributes for a objective (for example, stores), business objective (for example, Category Management), type criteria (for example, consumer profile/store attribute) and attributes applicable to them |
Enable attributes for a objective/type criteria/criteria by setting participant flag to 'Y'. Disable attributes for a objective/type criteria/criteria by setting participant flag to 'N.' These attributes are a collection of attributes that are displayed in BI as KPI or attributes that are used for clustering process. |
CIS_BUS_OBJ_TCRITERIA_ATT_XREF |
Flexibility to enable or disable nested clustering for a specific criteria |
This configuration enables nested criteria under another criterion for each objective/business objective. Example: Consumer Segment can have Store Attribute or Store Attribute can have Store Attribute. |
|
Flexibility to load predefined planning periods into Clustering Solution |
Buying or planning periods can be loaded into the system using sqlldr. |
|
The settings listed in Table 5-6 are applicable only to AC and are generic settings that allows user to format and control AC. Note that the actual application code in RSE_CONFIG uses the acronym CIS instead of the acronym AC. For a complete list of abbreviations, see "Glossary of Acronyms".
Some parameters must be initialized at setup. See Table 5-6. Many of these items that require initialization cannot be configured later. See Oracle Retail Advanced Science Engine Implementation Guide, Volume 2 - Data Processes and Configuration Variables for the complete list of which configurations are configurable, updateable by the application, and required at initialization.
Table 5-6 Advanced Clustering
Application Code | Parameter Name | Description | Must Initialize | Example Parameter Value |
---|---|---|---|---|
CIS |
START_URL |
CIS starting URL |
N |
/faces/oracle/retail/rse/cdm/fe/view/page/index.jspx |
CIS |
END_URL |
CIS logout URL |
N |
/faces/oracle/retail/rse/cdm/fe/view/page/login.jspx |
CIS |
ATTR_NAME_SEPARATOR |
The separator character(s) to use to separate the different components of the attribute names in CIS_TCRITERIA_ATTR. |
N |
|
CIS |
C_ALG_CLUSTER_CATEGORY |
Constant declaration for algorithm cluster category. |
N |
4 |
CIS |
C_ALG_SPEC_PROPS |
Constant declaration for cluster-specific properties |
N |
4 |
CIS |
C_ATTR_SCALE_PROPS |
Constant declaration for retrieve attribute scale properties. |
N |
3 |
CIS |
C_PERCENT_ATTR_TYPE_ID |
Constant declaration for percentage clustering attributes type. |
N |
2 |
CIS |
C_STMT_CLUSTER_PROPS |
Constant declaration for retrieve cluster-specific properties. |
N |
1 |
CIS |
C_STMT_SCALE_PROPS |
Constant declaration for retrieve scale-specific properties |
N |
2 |
CIS |
CIS_DFLT_CALENDAR_HIER_TYPE_ID |
Default calendar hierarchy for clustering. |
Y |
11 |
CIS |
CIS_DFLT_LOCATION_HIER_TYPE_ID |
Default location hierarchy for clustering. |
Y |
6 |
CIS |
CIS_DFLT_PRODUCT_HIER_TYPE_ID |
Default product hierarchy for clustering. |
Y |
5 |
CIS |
CIS_DFT_PIVOT_LVL |
Default pivot level shown in explore data. |
N |
3 |
CIS |
CIS_NUMERIC_DFT |
Default value for numeric attributes shown in BI or UI when values are not available. |
N |
0 |
CIS |
CIS_STRING_DFT |
Default attribute value for string. |
N |
UNKNOWN |
CIS |
DEFAULT_APPL_USER_ID |
Default user ID for batch processing records. |
N |
1 |
CIS |
DEFAULT_CUST_ADVANCED_USER |
Identifies the advanced user. |
N |
AdvancedUser |
CIS |
DEFAULT_CUST_BUSINESS_USER |
Identifies the business user. |
N |
BusinessUser |
CIS |
DEFAULT_DYNAMIC_SAMPLING_LEVEL |
Default level of dynamic sampling to apply to sessions |
N |
4 |
CIS |
DEFAULT_NUM_ATTR_VALUE |
Constant for number of discrete values allowed for store attr clustering |
N |
15 |
CIS |
DEFAULT_NUM_BIN |
Default number of bins |
N |
3 |
CIS |
DEFAULT_STR_CATEGORICAL_ATTR |
Default String description for row added in cis_tcriteria_attr_type_value table for unmatched grouping |
N |
UNKNOWN |
CIS |
DEF_DST_CENTRD_THRSLH_VAL |
Default threshold for outlier rule for Distance from Centroid rule. This value can be changed by type criteria. |
N |
.95 |
CIS |
DEF_PORTIO_OUTLR_THRSLH |
Default threshold for outlier rule for % cluster size below a threshold rule. This value can be changed by type criteria. |
N |
5 |
CIS |
INSIGHT_BI_SALES_AMT_MARGIN |
Flag to show sales BI based on Sales Amount and Margin |
N |
N |
CIS |
INSIGHT_BI_SALES_AMT_UNIT |
Flag to show sales BI based on Sales Amount and Units |
N |
Y |
CIS |
MAX_HIST_WEEK_CNT |
The maximum number of weeks which should be selectable by the UI when processing historic data |
N |
104 |
CIS |
MAX_ITEMS_IN_GRAPH_CLUSTER_DETAIL |
Maximum number of clusters to be displayed in Cluster Details graph. |
N |
12 |
CIS |
MAX_ITEMS_IN_GRAPH_CLUSTER_LIST |
Maximum number of clusters to be displayed in Cluster List graph. |
N |
20 |
CIS |
MNG_RUN_NO_WKS |
ODisplay run for past n weeks |
N |
26 |
CIS |
PERF_ATTR_TOPN_COUNT |
The number of attribute values to be used per product category for performance based clustering |
N |
3 |
CIS |
PERF_CIS_APPROACH |
The approach to use for performance-based clustering. Available options are CDT and DT. |
N |
CDT |
CIS |
PERF_NUM_WEEKS_FOR_SLS_SHARE |
The number of weeks to be used when calculating the sales share for the product attributes. |
N |
16 |
CIS |
PERF_NUM_WEEKS_FOR_TOPN_CALC |
The number of weeks to be used when identifying the top N attributes. |
N |
16 |
CIS |
SELECT_ALL_MERCH_NODES |
Flag to identify if all (or only first) merchandise node(s) to be selected by-default |
N |
N |
CIS |
SUMM_CAL_ALL_LVL |
Flag to identify whether performance summarization is allowed at all available calendar levels. |
N |
N |
CIS |
SUMM_MERCH_ALL_LVL |
Flag to identify whether performance summarization is allowed at all available merchandise levels. |
N |
N |
Table 5-7 lists the store clustering parameters.
Table 5-7 Store Clustering Parameters
Parameter Name | Parameter Code | Description | Value |
---|---|---|---|
MERCH_HIER_TYPE |
MERCH_HIER1 |
Hierarchy type available for selection in UI - for Primary hierarchy |
1 |
MERCH_HIER_TYPE |
MERCH_HIER2 |
Hierarchy type available for selection in UI - for alternate product hierarchy |
5 |
LOC_HIER_TYPE |
LOC_HIER1 |
Hierarchy type available for selection in UI - for primary location hierarchy |
2 |
LOC_HIER_TYPE |
LOC_HIER2 |
Hierarchy type available for selection in UI - for alternate hlocation hierarchy |
6 |
Table 5-8 lists the advanced algorithm settings.
Table 5-8 Advanced Algorithm Settings
Category | Name | Configuration Description | Table |
---|---|---|---|
Advanced Algorithm |
Flexibility to update algorithm properties |
Change default distance metric or scaling methods. For example, update distance metric, scaling methods, and default properties of the algorithm. |
Advanced Algorithm Settings: cis_algorithm_attr |
Advanced Algorithm |
Flexibility to override algorithm property by each criteria. |
Can have Euclidean distance and seasonality can have correlation. Override default settings of the algorithm by criteria. For example, have the Euclidean distance metric for consumer profile criteria and have correlation metric for criteria having seasonality or time-driven attributes. |
Advanced Algorithm: cis_bus_obj_tcrit_algo_attr |
Outlier rules and new store rules can be configured by defining Oracle types.
Table 5-9 Outlier and New Store Rules
Category | Name | Configuration Setting | Table |
---|---|---|---|
Advanced |
Flexibility to enable or disable outlier rules to indicates outliers in the cluster set. |
Example: Supported rules are "X Percent Less Than Total Size" or distance from centroid greater than x value. Update statement to enable or disable a record. UPDATE cis_outlier_rules SET current_flg = 'N', |
cis_outlier_rules |
Advanced |
Flexibility to allocate new stores or stores with poor profiles. |
Example: Supported rules are: Post Algorithm: Assign to the largest cluster Assign to the cohesive cluster Assign to like location |
cis_newstr_rules |
Table 5-10 contains all the possible attributes in the clustering process.
Table 5-10 CIS_TCRITERIA_ATTR
Column Name | Data Type | Comments | Nullable? |
---|---|---|---|
ID |
NUMBER(10) |
FK for this table. |
N |
NAME |
VARCHAR2(50) |
Name for the criteria attribute. |
N |
DESCR |
VARCHAR2(200) |
Additional descriptive text for the criteria attribute. |
Y |
SRC_ENTITY_NAME |
VARCHAR2(30) |
Name of table or view that holds the attribute information and value coming from RA or an external system. |
Y |
SRC_COLUMN_NAME |
VARCHAR2(30) |
Name of the column in RA or external system table or view. |
Y |
SRC_ENTITY_ALIAS |
VARCHAR2(30) |
Alias of the column in the RA or external system table or view. |
Y |
ATTR_TYPE_ID |
NUMBER(10) |
Type of the attribute. |
N |
CURRENT_FLG |
VARCHAR2(1) |
A flag to indicate whether this row is the most recent row (Y) or if it a historical row (N). |
Y |
CREATED_BY_USER |
VARCHAR2(255) |
User who created the record. |
N |
DELETE_FLG |
VARCHAR2(1) |
A flag to indicate whether the row is considered deleted (Y) or not (N). |
Y |
CREATED_ON_DT |
TIMESTAMP(6) |
Record creation date. |
N |
CHANGED_BY_USER |
VARCHAR2(255) |
User who last changed the record. |
Y |
CHANGED_ON_DT |
TIMESTAMP(6) |
Last changed date. |
Y |
BUS_OBJ_ATTR_MD_ID |
NUMBER(10) |
Business object attribute MD ID. |
Y |
UI_DISPLAY_NAME |
VARCHAR2(200) |
The value to display in the UI when showing this criteria attribute. |
Y |
DISPLAY_FORMAT_ID |
NUMBER(10) |
Foreign key to the RSE_DISPLAY_FORMAT table, to enable control of how the attribute should be formated for display. |
Y |
TCRITERIA_ATTR_SRC_XREF_ID |
NUMBER(10) |
Field contains the reference to the PK of the of the object which this attribute definition belongs to. For example, if an attribute is representative of a specific consumer segment, then this column will contain the FK to that consumer segment. |
Y |
A few routines can perform maintenance of the data in the CIS_TCRITERIA_ATTR and CIS_BUS_OBJ_TCRITERIA_ATT_XREF tables. These routines use the information defined in applicable source tables to set up fields in these tables.A table called CIS_TCRITERIA_SRC_XREF can also help define what attributes should be configured for the different type criteria.
The first task to perform to customiz the different attributes for the different type criteria is to modify the data in CIS_TCRITERIA_SRC_XREF so that it identifies what data sources should be used for a given business object, objective, and type criteria. A default configuration is provided as seed_data for this table. The maintenance routines use the data in this table to determine what attributes should be used by a given business object, objective, and type criteria.
The data in CIS_TCRITERIA_SRC_XREF can be manipulated by reloading data from the SQL*Loader control file, or it can be manipulated directly with SQL. To load a new copy of the control file, you must first update all existing rows so that they are deleted (UPDATE cis_tcriteria_src_xref SET delete_flg = 'Y'; ). Then you must load a modified version of the file via SQL*Loader ( SQLLDR USER/PASSWORD@DB control=cis_tcriteria_src_xref.ctl).
The next step is to run the maintenance routines to populate the attributes into the appropriate tables. These can be performed by executing the following UNIX scripts:
To load consumer segment attributes, use:
cis_conseg_attr_maint.ksh
exec cis_maint_util.tcriteria_attr_cs_maint;
To load performance attributes, use:
cis_perf_attr_maint.ksh
To load product attributes, use:
cis_prod_attr_maint.ksh
To load store location attributes, use:
cis_store_attr_maint.ksh
Table name: cis_bus_obj_tcriteria_att_xref
Description: CIS_BUS_OBJ_TCRITERIA_ATT_XREF
After the above maintenance routines are complete, you can manually adjust the data in CIS_BUS_OBJ_TCRITERIA_ATT_XREF (BOTAX) in order to customize which attributes should be used and how. When adjusting the data in CIS_BUS_OBJ_TCRITERIA_ATT_XREF, consider the following:
Any attribute that is a participating attribute (PARTICIPATING_ATTR_FLG =Y) with a non-zero weight (DFLT_ATTR_WEIGHT) will be considered a primary attribute.
An attribute that you do not want to use can be marked as deleted by setting its DELETE_FLG=Y.
An attribute that is not participating, but is informational (INFORMATIONAL_ATTR_FLG=Y) cannot be used by the clustering algorithm, but is available for review within the UI.
The ATTR_SEQ column facilitates the ordering of attributes within the UI so that they can be presented in a desired sequence. The PL/SQL routine, cis_maint_util.tcriteria_attr_seq_maint, can set the values according to the selection of participating and primary attributes.
When maintaining data in this table, you should join this table to the CIS_TCRITERIA_ATTR (TCA) table by TCA.ID = BOTAX.TCRITERIA_ATTR_ID. This helps you identify the attribute that is being manipulated.
After performing any maintenance of the data in this table, you must make sure that the attribute weights are correctly set. You can run the cis_maint_util.updt_attr_wgts routine to get the weights to total 100%.
To enable a field:
update cis_bus_obj_tcriteria_att_xref, set participating_attr_flg = 'Y', and informational_attr_flg = 'N' where id = :id
To change the sequence of the attribute in the UI:
update cis_bus_obj_tcriteria_att_xref set attr_seq = 10 where id = :id
Sample WHERE clause components (note that a join with cis_tcriteria_attr is necessary to check CURRENT_FLG and DELETE_FLG in that table as well):
from CIS_BUS_OBJ_TCRITERIA_ATT_XREF cbotax, CIS_TCRITERIA_ATTR cta
where cbotax.BUSSOBJ_ID=1 and cbotax.OBJECTIVE_ID=3 and cbotax.TYPE_CRITERIA_ID in (1) and cbotax.TCRITERIA_ATTR_ID=cta.ID
and nvl(cbotax.CURRENT_FLG, 'Y') = 'Y' and nvl(cbotax.DELETE_FLG, 'N') = 'N'
and nvl(cta.CURRENT_FLG, 'Y') = 'Y' and nvl(cta.DELETE_FLG, 'N') = 'N'
and cta.SRC_COLUMN_NAME='SLS_AMT');
Table name: cis_tcriteria_src_xref
To delete data, you can update values in the table:
UPDATE cis_tcriteria_src_xref
SET delete_flg ='Y'
WHERE bussobj_id = :bussobj_id
AND objective_id = :objective_id
AND type_criteria_id = :type_criteria_id
AND src_entity_name = :src_entity_name;
To update data so that a source of attributes is available as a participating or information attribute, you can update the data like this:
UPDATE cis_tcriteria_src_xref
SET participating_attr_flg = :participating_attr_flg,
Informational_attr_flg = :informational_attr_flg
WHERE bussobj_id = :bussobj_id
AND objective_id = :objective_id
AND type_criteria_id = :type_criteria_id
AND src_entity_name = :src_entity_name;
Table name: cis_tcriteria_attr
Description: CIS_TCRITERIA_ATTR
Most maintenance of this data should occur through the cis_maint_util database package, so there should be no need to add rows to this table. However, an attribute can be removed by an update like this:
UPDATE cis_tcriteria_attr SET DELETE_FLG='Y' WHERE id=:id;
To change a label (note that label changes in UI-supplied XLF files are required as well):
UPDATE cis_tcriteria_attr set ui_display_name = 'Sample label' where id = :id
Table name: cis_bus_obj_nested_tcriteria
Description: CIS_BUS_OBJ_NESTED_TCRITERIA
To update value:
UPDATE cis_bus_obj_nested_tcriteria SET current_flg = 'N', delete_flg = 'Y' WHERE bussobj_id = :bussobj_id AND objective_id = :objective_id AND type_criteria_id = :type_criteria_id AND chl_type_criteria_id = :chl_type_criteria_id;
To make a type criteria available for a nested cluster of another type criteria, the data in this table can be modified by updating the CURRENT_FLG, DELETE_FLG and CHL_CRITERIA_ALLWD_FLG to appropriate values (e.g. CURRENT='Y', DELETE_FLG='N', CHL_CRITERIA_ALLWD_FLG='Y').
Table name: cis_effective_period
Description: CIS_EFFECTIVE_PERIOD
To insert value: Use following SQL Loader command to insert records using the .ctl file.
SQLLDR USER/PASSWORD@DB control=cis_effective_period.ctl
To insert using regular insert:
INSERT INTO cis_effective_period (id, descr, start_period_id, end_period_id, bussobj_id, objective_id, type_criteria_id, active_flg) VALUES (1, 'Winter Jan 12', 1005040907, 1005040937, 1, 3, -1, 'Y');
Table name: cis_bus_obj_tcriteria_xref
Description: CIS_BUS_OBJ_TCRITERIA_XREF
To insert values use following SQL Loader command:
SQLLDR USER/PASSWORD@DB control= cis_bus_obj_tcriteria_xref.ctl
To insert using regular insert:
INSERT INTO cis_bus_obj_tcriteria_xref (bussobj_id, objective_id, type_criteria_id, primary_flg, bus_obj_tcriteria_seq, def_scre_threshold_pct, outlier_rule_id, outlier_attr_value_1, outlier_attr_value_2, outlier_attr_value_3, newstr_rule_id, disable_attr_wts, current_flg, delete_flg, created_by_user, created_on_dt, changed_by_user, changed_on_dt) VALUES (1, 3, 1, '', 2, NULL, 1, NULL, NULL, NULL, 2, 'Y', 'Y', '', USER, SYSDATE, USER, SYSDATE);
Advanced Algorithm Settings: cis_algorithm_attr
Description: CIS_ALGORITHM_ATTR
To insert values use following SQL Loader command:
SQLLDR USER/PASSWORD@DB control= cis_algoritm_attr.ctl
To insert using regular insert:
INSERT INTO cis_algorithm_attr (id, NAME, keyword_name, descr, algorithm_attr_type_id, dflt_value, attr_seq, cis_algorithm_id, user_provided_flg, current_flg, delete_flg, created_by_user, created_on_dt, changed_by_user, changed_on_dt) VALUES (1, 'Lambda Stop', 'lambdaStop', 'Given the original lambda, calculate how many epochs need to run (Should be specific to Cluster Criteria)', 4, '.1', 1, 1, 'N', 'Y', 'N', USER, SYSDATE, USER, SYSDATE);
To delete value:
DELETE FROM cis_algorithm_attr WHERE id=:id;
Advanced Algorithm: cis_bus_obj_tcrit_algo_attr
Description: CIS_BUS_OBJ_TCRIT_ALGO_ATTR
Table 5-11 CIS_BUS_OBJ_TCRIT_ALGO_ATTR
Field | Description |
---|---|
ALGORITHM_ATTR_ID |
FK for the algorithm attribute table. |
BUSSOBJ_ID |
FK for the business object objective. |
OBJECTIVE_ID |
FK for the clustering objective. |
TYPE_CRITERIA_ID |
Type Criteria ID. |
NAME |
This is the name of the clustering algorithm attribute. There are some specific attributes per algorithm. For example, BaNG uses attributes such as distance metric, converge factor, and number of iterations. |
KEYWORD_NAME |
This field contains the attribute or property name recognized internally by the application code. This value is used within the code to identify the property and must be provided with the correct case and format recognized within the code. |
DESCR |
Additional descriptive text for this algorithm attribute. |
ALGORITHM_ATTR_TYPE_ID |
Algorithm attribute type ID. |
DFLT_VALUE |
Default value to be used for the attribute. |
ATTR_SEQ |
Sequence in which the attribute should be processed or presented. |
CIS_ALGORITHM_ID |
This is the algorithm ID. This field is populated only for algorithm specific properties or attributes; otherwise, this field is null. |
USER_PROVIDED_FLG |
This flag = 'Y' indicates the user must set this value using the UI while creating the scenario configuration. |
CURRENT_FLG |
A flag to indicate whether this row is the most recent row (Y) or if it a historical row (N). |
DELETE_FLG |
A flag to indicate whether the row is considered deleted (Y) or not (N). |
CREATED_BY_USER |
User who created the record. |
CREATED_ON_DT |
Record creation date. |
CHANGED_BY_USER |
User who last changed the record. |
CHANGED_ON_DT |
Last changed date. |
To update statement to enable or disable a record:
UPDATE cis_bus_obj_tcrit_algo_attr SET current_flg = 'N', delete_flg = 'Y' WHERE algorithm_attr_id = :algorithm_attr_id AND bussobj_id = :bussobj_id AND objective_id = :objective_id AND type_criteria_id = :type_criteria_id;
ASO has configurable parameters, listed in Table 5-12, "ASO Configuration Parameters". All have default values, and values chosen as a reasonable starting value, but are configurable and editable by the administrator. In many cases, if the user does not select a value for a particular field, it will default to the value set in this table.
Note that some parameters must be initialized at setup. See Table 5-12. Many of these items that require initialization cannot be configured later. See Oracle Retail Advanced Science Engine Implementation Guide, Volume 2 - Data Processes and Configuration Variables for the complete list of which configurations are configurable, updateable by the application, and required at initialization.
The following are the major categories of ASO parameters:
Alert settings (conditions in which ASO triggers a user alert).
ASO objective and constraints settings (the settings determining units and default settings for constraints).
Demand and replenishment settings (the settings for demand and replenishment models).
Demand transference and service level control settings.
Gurobi solver parameters (these require expertise in optimization and LP solvers to adjust).
Default ranges (minimum and maximum values for capacity, height, facings, blocks, and service levels).
Name, column, and label settings for summary reports.
Table 5-12 ASO Configuration Parameters
Application Code | Parameter Name | Description | Must Initialize | Example Parameter Value |
---|---|---|---|---|
SO |
ALRT_LESS_THAN_PCT_USED_SPACE |
An alert will be triggered if the run optimization results use less space than the value specified by this global parameter. |
N |
0.8 |
SO |
ALRT_LESS_THAN_SERVICE_LEVEL_AMT |
An alert will be triggered if the run optimization results have a sales service level lower than the value specified by this global parameter. |
N |
0.8 |
SO |
ALRT_LESS_THAN_SERVICE_LEVEL_QTY |
An alert will be triggered if the run optimization results have a quantity service level lower than the value specified by this global parameter. |
N |
0.8 |
SO |
ALRT_MORE_THAN_CNT_PRODUCT_DROPPED |
An alert will be triggered if the run optimization results dropped more products than the value specified by this global parameter. |
N |
10 |
SO |
ALRT_MORE_THAN_PCT_PRODUCT_DROPPED |
An alert will be triggered if the run optimization results dropped a percent of product higher than the value specified by this global parameter. |
N |
0.2 |
SO |
ALRT_NO_FEASIBLE_SOLUTION |
An alert will be triggered if the run optimization results have no results. |
N |
0 |
SO |
ALWAYS_REVIEW_MAPPING_RES_FLG |
Default=N. A Y flag indicates a user mapping review is always required (regardless of results or errors). N triggers a review base on other flags and conditions. |
N |
N |
SO |
CAPACITY_RANGE_UNITS |
Capacity range units used by ASO Solver. This parameter value maps to a CRU row with this value ID within so_prod_constr_range_values table. |
N |
25 |
SO |
DEFAULT_APPL_USER |
User identifier to be used for batch activities that require user tracking. |
N |
SO_BATCH_USR |
SO |
DEFAULT_BAY_MERGE_CONSTR_FLG |
Default indicator for the use of merging bays constraint. |
N |
N |
SO |
DEFAULT_BLOCKING_CONSTR_FLG |
Default indicator for the use of blocking constraint. |
N |
Y |
SO |
DEFAULT_OBJECTIVE_FUNC_ID |
Internal ID that identifies the default objective function to use for optimization locations. |
N |
1 |
SO |
DEFAULT_SPACING_CONSTR_FLG |
Default indicator for use of spacing constraint. |
N |
Y |
SO |
DEFAULT_USABLE_SPACE_CONSTR_FLG |
Default flag indicating if space constraint should be used. |
N |
N |
SO |
DEFAULT_USABLE_SPACE_CONSTR_PCT |
Default usable space constraint percentage. |
N |
1 |
SO |
DEMAND_DISTRIBUTION |
Demand distribution used by ASO Solver. |
N |
Normal |
SO |
DFLT_ANALYTICAL_THETA |
Analytical parameter to calculate tolerance in a blocking diagram is set to theta * (min width of items in a group). |
N |
0.1 |
SO |
DFLT_HORIZONTAL_BLOCKING_FLG |
A Y value for this flag indicates the analytics that combining adjacent attribute blocks should be done (when possible). |
Y |
Y |
SO |
DFLT_REPL_CASEPACK |
Default replenishment parameter for casepack. |
N |
1 |
SO |
DFLT_REPL_FACINGS_LIFT |
Default facing lift. |
N |
0 |
SO |
DFLT_REPL_SHELF_PARAM |
Default shelf replenishment parameter. |
N |
0 |
SO |
DFLT_REPL_SHELF_TT |
Default replenishment type. |
N |
2 |
SO |
DFLT_REPL_STDEV_BOOSTER |
Default standard deviation booster. |
N |
0 |
SO |
DFLT_REPL_TYPE |
Default replenishment type. |
N |
2 |
SO |
DFLT_SHELF_THICKNESS |
Default shelf thickness that is used by the POG-shelf interface to create the initial bottom shelf for empty shelf fixtures. |
Y |
1 |
SO |
DT_DAMPENING_FACTOR |
Factor to dampen the DT effects for ASO. |
N |
0.5 |
SO |
EMPTY_BLOCK_CONSTR_ALRT |
Alert internal ID for empty visual guideline group alert. |
N |
1 |
SO |
END_URL |
Application Login End URL. |
N |
/faces/oracle/retail/rse/so/fe/view/page/SpaceOptimizationHome.jspx |
SO |
GUR_CLIQUECUTS |
Gurobi parameter. Clique cut generation. |
N |
-1 |
SO |
GUR_COVERCUTS |
Gurobi parameter. Cover cut generation. |
N |
-1 |
SO |
GUR_FLOWPATHCUTS |
Gurobi parameter. Flow path cut generation. |
N |
-1 |
SO |
GUR_HEURISTICS |
Gurobi parameter. Turn MIP heuristics up or down. |
N |
0.05 |
SO |
GUR_IMPLIEDCUTS |
Gurobi parameter. Implied bound cut generation. |
N |
-1 |
SO |
GUR_MIPFOCUS |
Gurobi parameter. Set the focus of the MIP solver. |
N |
0 |
SO |
GUR_MIPSEPCUTS |
Gurobi parameter. MIP separation cut generation. |
N |
0 |
SO |
GUR_MIRCUTS |
Gurobi parameter. MIR cut generation. |
N |
-1 |
SO |
GUR_MODKCUTS |
Gurobi parameter. Mod-k cut generation. |
N |
-1 |
SO |
GUR_NODEMETHOD |
Gurobi parameter. Method used to solve MIP node relaxations. |
N |
1 |
SO |
GUR_PRESOLVE |
Gurobi parameter. Presolve level. |
N |
-1 |
SO |
GUR_RINS |
Gurobi parameter. RINS heuristic. |
N |
-1 |
SO |
GUR_SYMMETRY |
Gurobi parameter. MIP symmetry detection. |
N |
-1 |
SO |
GUR_TIMELIMIT |
Gurobi parameter. Time limit. |
N |
90 |
SO |
GUR_THREADS |
Gurobi Parameter. Number of allowed threads. |
N |
0 |
SO |
GUR_ZEROHALFCUTS |
Gurobi parameter. Zero-half cut generation. |
N |
-1 |
SO |
GV_DAYS_TO_VALIDATE_WO_CHANGES |
Number of days without direct changes the validation process will consider data objects for validation. |
N |
21 |
SO |
GV_RESULT_DETAIL_LEVEL |
Level of detail for each validation that is used to produce the results (DETAIL: rows for every failure or SUMMARY: a row at the data object level). |
N |
SUMMARY |
SO |
GV_VALIDATION_SECTIONS_TO_RUN |
Global validations will be executed for the selected data objects. ASSORTMENT, POG, MAPPING and DS (Display Style). |
N |
ASSORTMENT_POG_MAPPING_DS |
SO |
INVALID_ATTR_VALUE_CONSTR_ALRT |
Alert internal ID for attribute value alert. |
N |
3 |
SO |
MAX_CAPACITY_RANGE |
Maximum capacity range used by ASO Solver. |
N |
80 |
SO |
MAX_HEIGHT_RANGE |
Maximum height range used by ASO Solver. |
N |
72 |
SO |
MAX_NUMBER_OF_FACINGS |
Maximum number of facings used by ASO Solver. |
N |
5 |
SO |
MAX_NUM_OPT_LOC_BLOCK |
Maximum number of blocks per optimization location. |
N |
10 |
SO |
MAX_SHELF_THICKNESS |
Maximum shelf thickness that can be used while doing shelf fixture edits. |
Y |
2.5 |
SO |
MIN_CAPACITY_RANGE |
Minimum capacity range used by ASO Solver. |
N |
0 |
SO |
MIN_HEIGHT_RANGE |
Minimum height range used by ASO Solver. |
N |
0 |
SO |
MIN_NUMBER_OF_FACINGS |
Minimum number of facings used by ASO Solver. |
N |
1 |
SO |
MIN_SHELF_DEPTH |
Minimum shelf depth that can be used while doing shelf fixture edits. The maximum shelf depth is defined by the fixture depth. |
Y |
2 |
SO |
MIN_SHELF_THICKNESS |
Minimum shelf thickness that can be used while doing shelf fixture edits. |
Y |
0.5 |
SO |
MIN_SHELF_VERTICAL_GAP |
Specific smallest allowable vertical offset (SAVO) value. |
Y |
2.5 |
SO |
MNG_ASSORT_NO_WKS |
Display assortments for past n weeks. |
N |
52 |
SO |
MNG_RUN_NO_WKS |
Display run for past n weeks. |
N |
52 |
SO |
NUMBER_OF_SIMULATED_DAYS |
Number of simulated days used by ASO Solver. |
N |
1000 |
SO |
OPT_LOC_LVL1_NAME_STR |
This value is used entirely or as a prefix to generate the pogset location and optimization location top level names. |
N |
All Locations |
SO |
OPT_LOC_LVL2_NAME_STR |
This value is used as a prefix to generate the pogset location and optimization location mid level names. |
N |
PC_ |
SO |
OPT_LOC_LVL3_NAME_STR |
This value is used as a prefix to generate the pogset location and optimization location bottom level names. |
N |
SC_ |
SO |
PC_SUM_CAPRANGE |
Capacity Range label for Product Constraints Summary. |
N |
Set Capacity Range |
SO |
PC_SUM_ELEVATION |
Elevation label for Product Constraints Summary. |
N |
elevation |
SO |
PC_SUM_ELEVRANGE |
Elevation Range label for Product Constraints Summary. |
N |
Set Elevation Range |
SO |
PC_SUM_FACERANGE |
Facing Range label for Product Constraints Summary. |
N |
Set Facing Range |
SO |
PC_SUM_FACINGS |
Facings label for Product Constraints Summary. |
N |
facings |
SO |
PC_SUM_INCLUSION |
Inclusion label for Product Constraints Summary. |
N |
Inclusion |
SO |
POGC_SUM_MERGEBAYS |
Merge Adjacent Bays label for POG Constraints. |
N |
Merge Adjacent Bays |
SO |
POGC_SUM_PRODSPACE |
Use Product Spacing label for POG Constraints. |
N |
Use Product Spacing |
SO |
POGC_SUM_USABLESPACE |
Set Usable Space label for POG Constraints. |
N |
Set Usable Space |
SO |
POGC_SUM_VG |
Visual Guidelines label for POG Constraints. |
N |
Use Visual Guidelines |
SO |
POG_SET_LVL1_NAME_STR |
This value is used to generate the name for the top level node on planogram list. |
N |
All Planograms |
SO |
PRODUCT_INCLUSION |
Product inclusion rule used by ASO Solver. This parameter value maps to a IN row with this value ID within so_prod_constr_range_values table. |
N |
2 |
SO |
PRODUCT_STACKING_HEIGHT_LIMIT |
Product stacking height limit that is applied as a global setting to all top products (TEMPORARY PARAM). |
N |
24 |
SO |
PROD_ATTR_NAME_DELIMITER |
This value is used as a delimiter between the product name and description and the attribute name and description when setting up POG attributes. A NULL value here will result in no concatenations. |
N |
- |
SO |
REPLENISHMENT_FREQUENCY |
Replenishment frequency used by ASO Solver. |
N |
1 |
SO |
REVIEW_DSF_ERROR_FLG |
A Y flag indicates a user review is required for DSF errors. N lets the process move forward to the next stage using the DSF available. |
N |
Y |
SO |
REVIEW_UNMAPPED_PROD_FLG |
A Y flag indicates a user review is required for unmapped products. N lets the process move forward to next stage, eliminating unmapped products. This is not desired for products. |
N |
Y |
SO |
REVIEW_UNMAPPED_STORE_FLG |
A Y flag indicates a user review is required for unmapped stores. N lets the process move forward to the next stage, eliminating unmapped stores. |
N |
Y |
SO |
SO_CAL_HIER_TYPE |
The hierarchy ID to use for the calendar. (Installation configuration) |
Y |
10 |
SO |
SO_FISCAL_CAL_HIER_TYPE |
The hierarchy ID to use for the fiscal calendar. (Installation configuration) |
Y |
11 |
SO |
SO_LOC_HIER_TYPE |
The hierarchy ID to use for location. (Installation configuration) |
Y |
2 |
SO |
SO_MIN_SERVICE_LEVEL |
Minimum target service level for ASO optimization process. |
N |
0.8 |
SO |
SO_PROD_HIER_LEVEL_FOR_LEAF_NODE |
Product hierarchy level number for leaf node. |
Y |
7 |
SO |
SO_PROD_HIER_TYPE |
The hierarchy ID to use for the product. (Installation configuration) |
Y |
1 |
SO |
START_URL |
Application Login Start URL. |
N |
/faces/oracle/retail/rse/so/fe/view/page/SpaceOptimizationHome.jspx |
SO |
STD_ADJUSTMENT_COEFFICIENT_1 |
Analytical parameter. Demand standard deviation adjustment parameter 1. |
N |
0.05 |
SO |
STD_ADJUSTMENT_COEFFICIENT_2 |
Analytical parameter. Demand standard deviation adjustment parameter 2. |
N |
0.19 |
SO |
TOP_SHELF_STACKING_HEIGHT_LIMIT |
Top shelf stacking height limit that applies as a global setting to all top shelves. |
N |
18 |
SO |
TRANSIT_TIME |
Default transit time used by ASO Solver. |
N |
0 |
SO |
UI_CONFIG_PC_RENDERED_COL_7 |
UI configuration for product constraints render column 7. Default Y means column is rendered. |
N |
N |
SO |
UI_CONFIG_PC_RENDERED_COL_8 |
UI configuration for product constraints render column 8. Default Y means column is rendered. |
N |
N |
SO |
UI_CONFIG_PC_RENDERED_COL_9 |
UI configuration for product constraints render column 9. Default Y means column is rendered. |
N |
N |
SO |
UI_CONFIG_PC_VISIBLE_COL_1 |
UI configuration for product constraints visible column 1. Default Y means column is visible. |
N |
N |
SO |
UI_CONFIG_PC_VISIBLE_COL_2 |
UI configuration for product constraints visible column 2. Default Y means column is visible. |
N |
N |
SO |
UI_CONFIG_PC_VISIBLE_COL_3 |
UI configuration for product constraints visible column 3. Default Y means column is visible. |
N |
N |
SO |
UI_CONFIG_PC_VISIBLE_COL_4 |
UI configuration for product constraints visible column 4. Default Y means column is visible. |
N |
Y |
SO |
UI_MAX_POG_CONFIG_LENGTH |
UI configuration for maximum length bound for the Create Lengths pop-up. |
N |
600 |
SO |
UI_MIN_POG_CONFIG_NO_OF_BAYS |
UI configuration for minimum number of bays bound for the Create Lengths pop-up. |
N |
1 |
SO |
UI_MAX_POG_CONFIG_NO_OF_BAYS |
UI configuration for maximum number of bays bound for the Create Lengths pop-up. |
Y |
N |
SO |
UI_THRESHOLD_SL |
UI configuration for Thresholds Configurable for Service Level formatting. |
N |
Y |
SO |
UI_THRESHOLD_SL_MAX |
UI configuration for Thresholds MAX, after which color green is shown. |
N |
0.85 |
SO |
UI_THRESHOLD_SL_MIN |
UI configuration for Thresholds MIN, below which color red is shown. |
N |
0.75 |
SO |
UNMAPPED_ATTR_VALUE_CONSTR_ALRT |
Alert internal ID for unmapped attribute alert. |
N |
2 |
SO |
USE_OPT_DT |
ASO global indicator for applying DT. |
N |
N |
SO |
USE_SERVICE_LEVEL_CONSTRAINT |
ASO global indicator for applying service level constraints. |
N |
Y |
SO |
WEEK_LENGTH |
Length of the week recognized by ASO Solver. |
N |
7 |
The CDT, DT, AC, and ASO user interfaces can be configured by adjusting UI labels and date masks. Oracle Metadata Services (MDS) is used for personalization and customization.
Label Customizations
It is possible to replace most labels and text strings displayed in the user interface with custom labels, if desired. Editing these strings requires extracting and modifying a file within the application archive, which will vary based on the primary language being displayed in the browser. Figure 5-6 shows an example for ASO.
Similar UI label customizations are possible for any ORASE UI application by making corresponding changes to the file and directory names for the application in question.
For ASO, the file name uses the following format:
SOViewControllerBundle.xlf (English only)
SOViewControllerBundle_<lang_code>.xlf (All other languages, where lang_code is the Oracle abbreviated language code, such as SOViewControllerBundle_el.xlf)
Use the following process to make changes to the UI labels in the above files:
Locate the directory containing your deployed application archive. For example:
WLS_DOMAIN_HOME/servers/AdminServer/stage/SO_UI/SpaceOptimization_application1.ear
Execute the following command to extract the application interface files:
jar -xvf SpaceOptimization_application1.ear soviewcontroller.war
Execute this command to extract the desired label bundle:
jar -xvf soviewcontroller.war WEB-INF/classes/oracle/retail/rse/so/fe/view/SOViewControllerBundle.xlf
Edit the extracted file by locating the labels that will be changed and entering new text strings. Only the text in the <source></source> tags may be modified; the rest of the file must not be changed or the user interface will not function properly.
When your changes have been completed, save the file.
Execute the following command to add the file back into the application interface package:
jar -uvf soviewcontroller.war WEB-INF/classes/oracle/retail/rse/so/fe/view/SOViewControllerBundle.xlf
Execute the following command to add the interface files back into the application archive:
jar -uvf SpaceOptimization_application1.ear soviewcontroller.war
Restart your WebLogic server to pick up the modified files.
Metadata for ASO, AC, CDT, and DT can be adjusted as needed by modifying the corresponding database entries for each application. See AC Configuration for examples of MDS customizations.
In addition to the configuration points described above, the user interface can be customized by using Oracle JDeveloper and Oracle Metadata Services (MDS). Out-of-the-box, MDS is used by CDT, DT, AC, and ASO standalone (not installed as part of CM under the Fusion Client). It is possible to add matching back end objects as well.
For ETL customization and configuration, the metadata-driven set of data validation rules and corresponding database types can be extended in the event that additional data validation rules are required above what is already provided.
It is also possible to customize the level at which data validation rules will cause the loader to abort, instead of just bypassing the rows that were invalid. There are two required steps:
A new configuration is needed.
A new function call is required that references that configuration record, which actually does the data validation.
A few options are available for performing metadata adjustments to customize some algorithms used by the applications. It is possible to extend provided database application code so that an alternate implementation is used in order to add some pre processing, some post processing, or to alter an existing algorithm. Since many components of the applications are implemented with database types, these types can be extended, in order to customize the implementation. Although the details of this customization are outside the scope of this document, these tables (RSE_SRVC_CONFIG, RSE_LOAD_SRVC_CFG, DT_EXCLUDE, CDT_EXCLUDE, CIS_NEWSTR_RULES, CIS_OUTLIER_RULES) define details of an implementation to be used for a process. It is possible to alter data in these tables in order to specify a different implementation for a process, without requiring changes to the provided implementations.
It is possible to adjust the stages and steps for the CDT and DT data mining activities. It is possible to configure what is being run and to remove and add steps, as desired. The configuration is done through database tables. RSE_PROC_TMPL specifies a computation group, while RSE_PROC_TASK_TMPL specifies the computation stages and steps.
In addition to the supplied sequence of steps, it is possible to define implementation-specific sequences. The actual procedures to be executed are defined in XML files application-context.xml being kept in module's corresponding WAR file. (See WebLogic Configuration.) An example application-context.xml file can be found in Appendix F, "Sample Application Context File (DT)."
The computation and data mining algorithms have several configuration points. All of computational modules have adjustable configuration entries that can affect the various processes and algorithms. Some of these configurations can be adjusted prior to using the applications to adjust performance.
AC: the clustering algorithm setup is done through XML and metadata.
DT: the configuration of the modules that execute as a part of the algorithm and the stages and steps are configurable in the database and XML, per above.
CDT: the configuration of the modules that execute as a part of the algorithm and the stages and steps are configurable in the database and XML, per above.
MBA: the configuration is in the database.
Data filtering and results pruning for DT and CDT can be adjusted by changing metadata in the appropriate DB tables, per above.
Most database-based batch processes and analytics are implemented in extendable database types, which offer the ability to adjust portions of the algorithms:
Parameter collections enable extensibility through external options.
Parallelism can be adjusted to limit or increase database resource utilization.
Implementation specific pre-processing or post-processing routines can be easily added by extending provided types and adjusting metadata to call alternate implementations.
The user interface supports multiple languages in a single instance, but the underlying database only supports a single language in an instance.
The database default language is selected at installation. Once set, there is no support for switching the database language. The application user interfaces adhere to the language setting for each user's browser. For example, to change the language for the Firefox browser:
Select Tools from the menu bar.
Select Options.
Select Choose.
Select the language to add.
The following language are supported: English, German, Greek, Spanish, French, Croatian, Hungarian, Italian, Japanese, Korean, Dutch, Polish, Brazilian Portuguese, Russian, Swedish, Turkish, Simplified Chinese, and Traditional Chinese.