| Oracle® Retail Predictive Application Server Cloud Edition Administration Guide Release 19.0 F25569-31 |
|
 Previous |
 Next |
| Oracle® Retail Predictive Application Server Cloud Edition Administration Guide Release 19.0 F25569-31 |
|
Previous |
Next |
This chapter details the following operational utilities of RPASCE:
This section describes the Domain Property Service task.
The Domain Property Utility service is used by the administrator to inspect and reset properties of a domain. The supported functions include:
Reset properties to Default Value
Display current value of properties
Display current value of property
Update property to value provided (name=value)
To submit a task for domain property utility, complete the following steps:
From Task Flow, select Administration under Tasks.
Select Online Admin Tools.
To submit a new Administration task, select Submit Admin Task.
Select System Admin Tasks and click Next.
From the list of all available system administration tasks, select Domain Property Utility and click Next.
Enter a descriptive label in the Task Label text box.
Select from the following operations:
Reset properties to default value
Display current value of properties
Display current value of property
Update property to value provided (name=value)
Each available task may also have extra input boxes for the administrator to provide arguments for that task.
This service resets domain properties to the default value. Users can use it to restore domain properties back to the initial state. An administrator can define an arbitrary property in the domain. This service only resets a set of properties defined by RPASCE. It will not reset any properties that the administrator has defined for applications that are not known to RPASCE.
This service also does not modify the domain property, domain_type.
To reset properties to default value, follow the procedure described in Setting Miscellaneous Domain Properties, steps 1 through 5.
When you are asked to specify the argument for the task, select Reset properties to default value and click Next.
You see Schedule Task, where you can run the task ASAP or on a schedule. If you choose to run on a schedule, you can select a frequency or a specific start and stop date and time.
Click Next to navigate to the next page, where you verify and confirm the task information entered.
Click Previous to make changes or Finish to submit the task.
You see the just-scheduled task in the dashboard.
Click the task to see the log.
Use this option to audit changes to domain properties completed in the past.
Here is an example line from the output:
<U 2021Jun21 15:28:44.816> Modify, uid00001, rms_im_defblock, '15'
The output consists of comma-separated values in the following order: date and time of the domain property change and action performed, user ID of the user making the change, name of the domain property, value of the domain property.
The user can use this domain properties service to display the current value of all domain properties currently defined in the domain.
To Display the current value of properties, begin by following the procedure described in Setting Miscellaneous Domain Properties, steps 1 through 5.
Enter a descriptive label in the Task Label text box.
When you are asked to select the operation, select Display current value of properties and click Next.
Figure 9-13 Display the Current Value of Properties
You see Schedule Task, where you can run the task ASAP or on a schedule. If you choose to run on a schedule, you can select a frequency or a specific start and stop date and time.
Click Next to navigate to the next page, where you verify and confirm the task information entered.
Click Previous to make changes or Finish to submit the task.
You see the just-scheduled task in the dashboard.
Click the task to see the log.
The user can use this domain properties service to display the current value of a particular domain property. User must specify the valid property name for this service.
To display the current value of a specific property, begin by following the procedure described in Setting Miscellaneous Domain Properties, steps 1 through 5.
Enter a descriptive label in the Task Label text box.
When you are asked to specify the operation, select Display current value of property and type in a valid property name in the input box right beneath it.
Figure 9-18 Display Current Value of Property
You see Schedule Task, where you can run the task ASAP or on a schedule. If you choose to run on a schedule, you can select a frequency or a specific start and stop date and time.
Click Next to navigate to the next page, where you verify and confirm the task information entered.
Click Previous to make changes or Finish to submit the task.
You see the just-scheduled task in the dashboard.
Click the task to see the log.
The user can use this domain properties service to update the value of a particular domain property. Users must specify the valid property name and value in the form name=value.
To update a property to the value provided, begin by following the procedure described in Setting Miscellaneous Domain Properties, steps 1 through 5.
Enter a descriptive label in the Task Label text box.
When you are asked to specify the operation, select Update property to value provided and type in the name=value expression in the input box right beneath it.
Click Next. Specify the value type of the property. For the property navalue_opt, select boolean or numeric.
You see Schedule Task, where you can run the task ASAP or on a schedule. If you choose to run on a schedule, you can select a frequency or a specific start and stop date and time.
Click Next to navigate to the next page, where you verify and confirm the task information entered.
Click Previous to make changes or Finish to submit the task.
You see the just-scheduled task in the dashboard.
Click the task to see the log.
Available Domain Properties
Table 9-1 Available Domain Properties
| Property Name | Type | Description |
|---|---|---|
|
fixedwidth_utf8 |
Boolean |
If this property is set to true, loadhier, loadmeasure, and exporthier will use character count for the start position and the width of the field. If it is false or unset, fixed-width uses byte count instead of character count. By default, this property is set to false. |
|
max_active_wb_per_user |
Integer |
The maximum number of workbooks that can be opened simultaneously for a user is determined by this domain property. The actual count is one more than the value for the property to account for dashboard workbooks that are automatically opened when the user logs in. The domain property can be changed using "Domain Property Utility Task". |
|
ovr_def_admin_privileges |
Boolean |
Using the Security Administration workbook, administrators can set workbook template access for every user in the system. Non-administrative users cannot access the workbook templates to which they have not explicitly been given access. However, if a user is an administrator, by default, they can see all the workbooks in the system. Some retailers want to prevent this from happening. Reasons for this include reducing clutter and having different kind of administrators manage different administrative tasks in their RPASCE systems. Ability to control template access for administrators from the Security Administration workbook is made possible by setting this domain property to true. By default, this property is false. |
|
skipped_records_log_limit |
Integer |
The limit on the number of lines in the skipped/invalid records log file. The default value is 1000. |
|
rpas_rule_cycle_max |
Integer |
This domain property is used for protection processing during workbook edits. It takes an integer value; the system default is 3000. It controls the number of iterations that RPASCE must run when trying to decide whether a certain measure is protected or not. Modifying the value can change the performance of protection processing. Setting the number higher will cause RPASCE to run longer. Setting the number lower will cause RPASCE to run faster; however, it may cause measures to be unnecessarily protected. Values below 2000 are not recommended. |
Customers previously set the RPAS_TODAY and RPAS_LOG_LEVEL environment variables as a global setting. These settings were then applied to all their tasks and operations scheduled through OAT. In order to accomplish this, customers would contact a cloud administrator (or raise an SR), who would set these environment variables and restart all services.
The RPAS_DOMAIN_TIMEZONE setting is new and helps customers whose home time zone is distant from Greenwich Mean Time to set their chosen local time zone. All Oracle servers are required to run using the GMT time zone setting for the server. For customers who want to have the batches, system downtime, system availability, and RPASCE values such as today and now to be calculated basen on their own chosen time zone rather than GMT, this setting may be used.
Customers themselves can set these variables using the OAT task (as a domain property and not as an environment variable). They do not need to call a cloud administrator or raise an SR. Once the customer has set the variables, these properties are applied to all processes. In order for the RPAS_DOMAIN_TIMEZONE time change to take effect, ldip must be restarted after changing RPAS_DOMAIN_TIMEZONE.
|
Note: Note that the following priority order list is adhered to by these settings:
|
You can access the List /Set /Unset /Domain Env Variable task by selecting the option List/Set/Unset/Domain Env Variable from System Admin Tasks. You see the Submit An Admin Task dialog box, as shown in Figure 9-28.
Figure 9-28 Submit An Admin Task Domain Environment
The following options are available:
List all environment variable set in the domain. Use this option to see the current values for the RPAS_TODAY and or RPAS_LOG_LEVEL. This also lists the timezone property, if set.
Set/Unset RPAS_TODAY. Use this option to manage the RPAS_TODAY domain property.
Set/Unset RPAS_LOG_LEVEL. Use this option to manage the RPAS_LOG_LEVEL domain property.
Set/Unset RPAS_DOMAIN_TIMEZONE. Use this option to manage the RPAS_DOMAIN_TIMEZONE property.
When you select Set/Unset RPAS_TODAY and click Next, you see the dialog box shown in Figure 9-29.
Figure 9-29 Submit An Admin Task Additional Options
The following additional options are available:
Set RPAS_TODAY. With this option and with the date selection, you can set the RPAS_TODAY domain property.
Unset RPAS_TODAY. Use this option to clear the RPAS_TODAY domain property.
If you selected Set/Unset RPAS_LOG_LEVEL in the first option page, you see the dialog box shown in Figure 9-30.
Figure 9-30 Submit An Admin Task RPAS_LOG_LEVEL
The following additional options are available:
Set RPAS_LOG_LEVEL. With this option and the level drop-down box, you can set the RPAS_LOG_LEVEL domain property.
Unset RPAS_LOG_LEVEL. Use this option to clear the RPAS_LOG_LEVEL domain property.
Note that this task is automatically run in offline mode. As a result, all non-administrative users will be logged off and the task will be executed. This prevents users from running any batch or workbook operations while these settings are updated in the domain.
If you selected Set/Unset RPAS_DOMAIN_TIMEZONE in the first option page, you see the dialog box shown in Figure 9-31.
Figure 9-31 RPAS_DOMAIN_TIMEZONE Dialog Box
The following additional options are available:
Set RPAS_DOMAIN_TIMEZONE. With this option and the timezone drop-down box, you can set the RPAS_DOMAIN_TIMEZONE. The values shown in the drop-down box are all the standard timezone names recognized by the system.
Unset RPAS_DOMAIN_TIMEZONE.Clear the RPAS_DOMAIN_TIMEZONE domain property using this option.
The mace service (Multi-Dimensional Array Calculation Engine) is for informational use only. The administrator can use the service to inspect rule and rule group information currently configured in the domain. It does not allow the administrator to modify any existing rule or rule groups or run any expressions or rule groups in the domain to modify domain measure data. The supported functions include:
Search for a specific string
Validate a specific expression
Print the specified rule
Print the specified rule group
Print all rule and rule groups
To submit a mace service task, complete the following steps:
From Task Flow, select Administration under Tasks.
Select Online Admin Tools.
To submit a new Administration task, select Submit Admin Task.
Select System Admin Tasks and click Next.
From the list of all available system administration tasks, select Mace Service and click Next.
Enter a descriptive label in the Task Label text box.
Select an operation from the following list of operations.
Search for a specific string
Validate a specific expressions
Print the specified rule
Print the specified rule group
Print all the rules and rule groups
Figure 9-37 Search for a Specific String Operation
This service finds all occurrences of a user-specified string in all the expressions configured in the domain. The string search is case insensitive. If a user searches for "ttlsales", expressions such as "TtlSales=..." and "TTLSALES = ..." will be identified. A user can search for any meaningful text in the expressions, not just measure names. For example, a user can search for function names to show all expressions configured to evaluate that function. Or a user can search for a modifier such as "level([clnd].[week])" to show all expressions that used that modifier.
The most common use for this function is to discover how a certain measure is calculated or referenced by rules configured in the domain. In this case, the administrator can search for the measure name as a string. Mace will return all rules that reference the measure.
Select Search for a specific string, enter the search term (here, 'TotalSales') in the Search for a specific string text box and click Next.
You see Schedule Task, where you can run the task ASAP or on a schedule. If you choose to run on a schedule, you can select a frequency or a specific start and stop date and time.
Click Next to navigate to the next page, where you verify and confirm the task information entered.
Click Previous to make changes or Finish to submit the task.
You see the just-scheduled task in the dashboard.
Click the task to see the log.
The log file is named after the task label. Search for measure name totalsales.log.
The output lists expressions involving the measures WtotalSales, QtotalSales, and W4TotalSales, which all include the string "TotalSales".
This service determines whether or not an RPASCE expression is written in the correct syntax. If it is not, some helpful diagnostic information is provided.
Select Validate a specific expression, enter the expression to be validated, and click Next.
Figure 9-44 Validate a Specific Expression
You see Schedule Task, where you can run the task ASAP or on a schedule. If you choose to run on a schedule, you can select a frequency or a specific start and stop date and time.
Click Next to navigate to the next page, where you verify and confirm the task information entered.
Click Previous to make changes or Finish to submit the task.
You see the just-scheduled task in the dashboard.
Click the task to see the log.
This service prints out all the configured expressions in the user-specified rule. The administrator can use this service to inspect the content of the rule.
Select Print the specified rule, enter the rule name to be printed, and click Next.
Figure 9-48 Print Operation for Specified Rule
You see Schedule Task, where you can run the task ASAP or on a schedule. If you choose to run on a schedule, you can select a frequency or a specific start and stop date and time.
Click Next to navigate to the next page, where you verify and confirm the task information entered.
Click Previous to make changes or Finish to submit the task.
You see the just scheduled task in the dashboard.
Click the task to see the log.
This mace service prints out all rules and the expressions configured for a particular rule group. The administrator can use this service to inspect the content of a complete rule group.
Select Print the specified rule group, enter the rule group name to be printed, and click Next.
You see Schedule Task, where you can run the task ASAP or on a schedule. If you choose to run on a schedule, you can select a frequency or a specific start and stop date and time.
Click Next to navigate to the next page, where you verify and confirm the task information entered.
Click Previous to make changes or Finish to submit the task.
You see the just-scheduled task in the dashboard.
Click the task to see the log.
This mace service prints out all the expressions configured for all rule groups in the domain. The administrator can use this service to inspect the content of all rule groups.
Select Print all the rules and rule groups and click Next.
Figure 9-56 Print All Rule Groups Arguments
You see Schedule Task, where you can run the task ASAP or on a schedule. If you choose to run on a schedule, you can select a frequency or a specific start and stop date and time.
Click Next to navigate to the next page, where you verify and confirm the task information entered.
Click Previous to make changes or Finish to submit the task.
You see the just-scheduled task in the dashboard.
Click the task to see the log.
The Segment/Workspace Batch Operation Task is used by the administrator to perform the following operations.
Figure 9-60 Segment/Workspace Batch Operation Task
Remove a segment
Remove a workbook for a segment
Remove all segments belonging to a specific user
Remove all segments belonging to a specific template
Remove all segments in the domain
Build a Segment
Commit a segment
Refresh a segment
Add a segment to the batch build queue
Add a segment to the batch commit queue
Add a segment to the batch refresh queue
Remove a segment from the batch build queue
Remove a segment from the batch commit queue
Remove a segment from the batch refresh queue
Start a batch operation on all/build/commit/refresh queues
Print a segment in all/build/commit/refresh queues
Remove a Segment
This option is used to select the segment from the drop-down list and remove the segment from the domain. It also deletes all the workbooks that are built based on this segment.
Figure 9-62 Remove a Segment Argument: Select User and Template
Figure 9-63 Remove a Segment Task Argument: Select Segment
Remove Workbook for a Segment
This option is used to select the segment and delete its workbook, built based on this selected segment, while this segment remains.
Remove All Segments Belonging to a Specific User
This option is used to select the user from the drop-down list and remove all the segments belonging to that specific user from the domain.
Figure 9-65 Remove All Segments Belonging to Specific User
Figure 9-66 Remove All Segments Belonging to a Specific User Task Argument: Select User
Remove All Segments Belonging to a Specific Template
This option is used to select the template from the drop-down list and remove all the segments belonging to that specific template from the domain.
Figure 9-67 Remove Segments Belonging to Specific Template
Figure 9-68 Remove All Segments Belonging to a Specific Template Task Argument: Select Template
Remove All Segments in the Domain
This option is used to remove all the segments in the domain.
Build a Segment
This option is used to select a segment from the segment drop-down list and build a workbook based on it. The segments that already have their associated workbook are filtered from this drop-down list.
|
Note: This online administration task can also be used to schedule all the administration templates (for example, Performance Diagnostic Tools, Security Administration, Translation Administration, and Measure Analysis). |
If the user defines a segment by specifying Rolling Calendar PQD on the calendar wizard, and then uses OAT to schedule a segment build, the actual calendar positions included in the built segment will be the result of the evaluation of the Rolling Calendar PQD at the time of the actual segment build. For example, the user defines the segment at the time 2020 Jan 01, and specifies that two days after the day should be included in the segment, (assuming the calendar wizard is at DAY) level. Then, the user schedules the segment to be rebuilt on 2020 March 1st. The actual days included in the built segment in this case would be March 1st, 2nd, 3rd of 2020.
Commit a Segment
This option is used to select a segment and commit its change in the workbook to the domain. The drop-down list only retains those segments that have their associated workbooks in the domain. If this segment is in the commit queue, it will be taken out once this commit operation completes.
Refresh a Segment
This option is used to select a segment and refresh its workbook data from the domain. The drop-down list only retains those segments that have their associated workbooks in the domain.
Add Segment to Batch Build Queue
This option is used to add the selected segments to the build queue. The segment list includes all the segments in the domain, and it supports multiple segment selection operation.
Add Segment to Batch Commit Queue
This option is used to add the selected segments to the commit queue. The segment list includes all the segments that have their associated workbook in the domain, and it supports multiple segment selection operation.
Add Segment to Batch Refresh Queue
This option is used to add the selected segments to the refresh queue. The segment list includes all the segments that have their associated workbook in the domain, and it supports multiple segment selection operation.
Figure 9-74 Add Segment to Batch Refresh Queue
Remove Segment from Batch Build Queue
This option is used to remove the selected segments out of the build queue. The segment list includes all the segments in the domain, and it supports multiple segment selection operation. If the selected segment is not in the queue, it will provide a warning message in the output log file.
Figure 9-75 Remove Segment from Batch Build Queue
Remove Segment from Batch Commit Queue
This option is used to remove the selected segments from the commit queue. The segment list includes all the segments that have their associated workbook in the domain, and it supports multiple segment selection operation. If the selected segment is not in the queue, it will provide a warning message in the output log file.
Figure 9-76 Remove Segment from Batch Commit Queue
Remove Segment from Batch Refresh Queue
This option is used to remove the selected segments from the refresh queue. The segment list includes all the segments that have their associated workbook in the domain, and it supports multiple segment selection operation. If the selected segment is not in the queue, it will provide a warning message in the output log file.
Figure 9-77 Remove Segment from Batch Refresh Queue
Start Batch Operation on All/Build/Commit/Refresh Queues
This option is used to batch process all the segments in the all/build/commit/refresh queues.
Print Segment in All/Build/Commit/Refresh Queues
This option is used to print out the detailed information of the segments in the all/build/commit/refresh queues.
FAQ
Question: How to build/commit/refresh multiple segments at the same time.
Answer: Add those segments into the build/commit/refresh queue, then start a batch operation on that queue.
Print Segment in All/Build/Commit/Refresh Queues
When you print the segments in the domain, the output is displayed in the following format. The owner of the segment is assigned the ID uid00000. This ID maps to the user in the domain. Use the User Manager, described in "User Maintenance", to list all users in the domain.
Note that when the administrator is viewing the files in the browser, the administrator will see the actual user names instead of the IDs. Only the log files display the IDs; the user names are obscured.
The Workbook Manager Utility, WbMgr, is the administration task that can be used to inspect or remove existing workbooks. It supports workbook domain transparency, which means a user can use it to manage all the workbooks throughout the domains (including the workbooks in the master domain and the ones in the local domains).
WbMgr provides the following functionality:
List all the workbooks in the domain
Show segment label (optional)
List workbooks belonging to a specific user
Show segment label (optional)
List workbooks belonging to a specific template
Filtered by a specific user
Show segment label (optional)
Remove all workbooks in the domain
Remove workbooks belonging to a specific user
Support multiple workbook selection
Remove workbooks belonging to a specific template
Filtered by a specific user
Print detailed information about workbooks
Support multiple workbook selection
List All Workbooks in the Domain
This option is used to list all the workbooks in the domain. A wizard page (Figure 9-83) provides an optional argument to display the segment label in the output file.
Figure 9-82 List All Workbooks in the Domain
Figure 9-83 List All Workbooks in the Domain Arguments
List Workbooks Belonging to a Specific User
This option is used to list all the workbooks owned by a specific user (from the user drop-down list) in the domain. A wizard page (Figure 9-85) provides an optional argument to display the segment label in the output file.
Figure 9-84 Workbooks Belonging to a Specific User
Figure 9-85 Workbooks Belonging to a Specific User Arguments
List Workbooks Belonging to a Specific Template
This option is used to list all the workbooks built based on the workbook template (from workbook template drop-down list) in the domain. A wizard page (Figure 9-87) provides two optional arguments, a segment label to display the segment label in the output file and user filtering by the workbook owner (from the user drop-down list).
Figure 9-86 Workbooks Belonging to a Specific Template
Figure 9-87 Workbooks Belonging to a Specific Template Arguments
Remove All Workbooks in the Domain
This option is used to delete all the workbooks in the domain.
Figure 9-88 Remove All Workbooks in the Domain
Remove Workbooks Belonging to a Specific User
This option is used to delete all the workbooks owned by a specific user (from the user drop-down list) in the domain. A wizard page (Figure 9-90) can be used to select multiple workbooks to be deleted.
Figure 9-89 Remove Workbooks Belonging to a Specific User
Figure 9-90 Remove Workbooks Belonging to a Specific User Arguments
Remove Workbooks Belonging to a Specific Template
This option is used to delete all the workbooks built based on the workbook template (from the workbook template drop-down list) in the domain. A wizard page (Figure 9-92) provides the option to filter the workbook by the workbook owner (from the user drop-down list).
Figure 9-91 Remove Workbooks Belonging to a Specific Template
Figure 9-92 Remove Workbooks Belonging to a Specific Template Arguments
Print Detailed Information About Workbooks
This option is used to print out the detailed information about the workbook selected by the user. It supports the selection of multiple workbooks. The detailed information about workbook includes Label, Last opened by, User privilege, Group privilege, World privilege, User ID, User Name, Group, Created, Modified, and Committed.
Figure 9-93 Print Detailed Information About Workbooks
When you print the workbook information in the domain, the output is displayed in the following format. The owner of the segment is assigned the ID uid00000. This ID maps to the user in the domain. Use the User Manager, described in "User Maintenance", to list all users in the domain.
Note that when the administrator is viewing the files in the browser, the administrator will see the actual user names instead of the IDs. Only the log files display the IDs; the user names are obscured.
