Configure for Actions with the Action Framework

You can run scripts for the configuration of actions in your organization.

Users can create actions in the Presentation Services user interface. An action is an operation or process invoked explicitly by a user clicking a link, or invoked automatically, as the final step of an agent. See Make Analyses Interactive and Create Agents to Deliver Content.

For a comprehensive discussion of how to use the Action Framework to enable actions for external systems, including descriptions of configuration settings and detailed examples, see "Using Actions to Integrate Oracle BI EE with External Systems" and "Sample Files" in Integrator's Guide for Oracle Business Intelligence Enterprise Edition.

Note:

If you use the Integrator's Guide for Oracle Business Intelligence Enterprise Edition when you configure the Action Framework, you must take into account the following differences between Oracle Analytics Server and Oracle BI EE.

• In Oracle Analytics Server, you use scripts to configure the Action Framework. The scripts extract, create, or update the Action Framework configuration, and load the ActionFrameworkConfig.xml and policy file to a specified location.
• In Oracle BI EE you don't use scripts to configure the Action Framework, instead you manually configure the ActionFrameworkConfig.xml file and policy file, and save them to a specific location, for example, <Oracle Middleware Home>\user_projects\domains\bifoundation_domain\config\fmwconfig\biinstances\coreapplication.

Topics:

• Modify the Actions Registry Configuration
• Modify the Actions Policy Configuration
• About Scripts to Retrieve, Create, or Update the Actions Framework Configuration

Modify the Actions Registry Configuration

Run scripts to update the actions registry configuration.

See Script to Extract the Current Actions Registry Configuration and Script to Update the Current Actions Registry Configuration File.

1. Run the script extract_actions_registry_config.sh|.cmd located in /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin to extract the current ActionFrameworkConfig.xml file.
   The actions registry configuration is extracted to the location that you specify.
2. Make your changes to the extracted ActionFrameworkConfig.xml file.
3. Save your changes.
4. Run the script update_actions_registry_config.sh|.cmd located in /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin to upload your changes to the service instance.
5. Restart Oracle Analytics Server.
   See Start and Stop Your System.

Modify the Actions Policy Configuration

Run scripts to update the actions policy configuration.

See Script to Extract the Actions Policy Configuration File and Script to Create or Update the Actions Policy Configuration File.

1. Run the script extract_actions_policyRefFile.sh|.cmd located in /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin to extract the current ActionsPolicyFile.xml file.
   The actions registry configuration is extracted to the location that you specify.
2. Make your changes to the extracted ActionsPolicyFile.xml file.
3. Save your changes.
4. Run the script create_or_update_actions_policyRefFile.sh|.cmd located in /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin to upload your changes to the service instance.
5. Restart Oracle Analytics Server.
   See Start and Stop Your System.

About Scripts to Retrieve, Create, or Update the Actions Framework Configuration

You can use scripts to retrieve, create, or update the actions framework registry and policy configuration.

Topics:

• Script to Extract the Current Actions Registry Configuration

• Script to Update the Current Actions Registry Configuration File

• Script to Extract the Actions Policy Configuration File

• Script to Create or Update the Actions Policy Configuration File

Script to Extract the Current Actions Registry Configuration

Use this script to extract the current actions registry configuration on the service instance. If the registry isn't configured, the script doesn't return any content.

extract_actions_registry_config.sh|.cmd

Usage: /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin/extract_actions_registry_config.sh|cmd [-h domainHome] -a actionFrameworkRegistryConfigDestinationFilePath -k serviceInstanceKey

-h: Use to specify the domain home including the target domainName directory, which in this case is /bi. The default is DOMAIN_HOME if set, otherwise it's /Oracle/Middleware/Oracle_Home/user_projects/domains/bi

-a: Use to specify the destination file path of the actions framework registry configuration.

-k: Use to specify the service instance key.

The script extracts the existing actions framework registry to a specified actions framework registry configuration destination file.

Example: /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin/extract_actions_registry_config.sh|.cmd -a /MyUserName/ActionsFrameworkRegistry.xml -k myService1

When this script successfully executes, you can find the current configured actions registry in the /MyUserName/ActionsFrameworkRegistry.xml file.

Script to Update the Current Actions Registry Configuration File

Use this script to update the current actions registry configuration file with content that you specify in a source actions registry file.

update_actions_registry_config.sh|.cmd

If the actions registry configuration file isn't available in the service instance, the script creates the registry file with the source actions registry file content.

Usage: /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin/update_actions_registry_config.sh|.cmd [-h domainHome] -a actionFrameworkRegistryConfigDestinationFilePath -k serviceInstanceKey

-h: Use to specify the domain home including the target domainName directory, which in this case is /bi. The default is DOMAIN_HOME if set, otherwise it's /Oracle/Middleware/Oracle_Home/user_projects/domains/bi

-a: Use to specify the destination file path of the actions framework registry configuration.

-k: Use to specify the service instance key.

The script updates the existing actions framework registry with the content of specified actions framework registry configuration source file.

Example: /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin/update_actions_registry_config.sh|.cmd -a /MyUserName/ActionsFrameworkRegistry.xml -k myService1

When this script successfully executes, content from the /MyUserName/ActionsFrameworkRegistry.xml file is pushed or updated to the service instance as an actions registry configuration.

Script to Extract the Actions Policy Configuration File

Use this script to extract the actions policy configuration file if it's available in the service instance. If the policy file isn't available the script doesn't return any content.

extract_actions_policyRefFile.sh|.cmd

Usage: /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin/extract_actions_policyRefFile.sh|.cmd [-h domainHome] -a actionsPolicyRefFileDestinationPath -p policyFileRefName -k serviceInstanceKey

-h: Use to specify the domain home including the target domainName directory, which in this case is /bi. The default is DOMAIN_HOME if set, otherwise it's /Oracle/Middleware/Oracle_Home/user_projects/domains/bi

-a: Use to specify the destination file path of the actions framework policy configuration.

-p: Use to specify the policy reference file name.

-k: Use to specify the service instance key.

The script extracts the existing actions policy reference file to a specified actionsPolicyFileDestinationPath.

Example: /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin/extract_actions_policyRefFile.sh|.cmd -a /MyUserName/ActionsPolicyFile.xml -p ActionsPolicyFile.xml -k myService1

When this script successfully executes, you can find the policy file content for the specified policy file name in the /MyUserName/ActionsPolicyFile.xml file.

Script to Create or Update the Actions Policy Configuration File

Use this script to create or update the existing actions policy file content with content that you specify in a source actions policy file.

create_or_update_actions_policyRefFile.sh|.cmd

If the actions policy file isn't available as a key in the service instance, the script creates the actions policy file with the source actions policy file content.

Usage: /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin/create_or_update_actions_policyRefFile.sh|.cmd [-h domainHome] -a actionsPolicyRefFileSourcePath -p policyFileRefName -k serviceInstanceKey

-h: Use to specify the domain home including the target domainName directory, which in this case is /bi. The default is DOMAIN_HOME if set, otherwise it's /Oracle/Middleware/Oracle_Home/user_projects/domains/bi

-a: Use to specify the destination file path of the actions policy reference file source path.

-p: Use to specify the policy reference file name.

-k: Use to specify the service instance key.

The script extracts the existing actions policy reference file to a specified actionsPolicyFileDestinationPath.

Example: /Oracle/Middleware/Oracle_Home/user_projects/domains/bi/bitools/bin/create_or_update_actions_policyRefFile.sh|.cmd -a /MyUserName/ActionsPolicyFile.xml -p ActionsPolicyFile.xml -k myService1

When this script successfully executes, the actions policy file content from the /MyUserName/ActionsPolicyFile.xml file is updated to the service instance as a value for the key ActionsPolicyFile.xml file.