Configure Oracle E-Business Suite Cloud Manager Features

This chapter covers the following topics:

Set Up Network Profiles

Before Oracle E-Business Suite Cloud Manager can be used to provision environments, a network and associated network profiles must be created. A network profile maps Oracle Cloud Infrastructure network definitions with the network requirements for Oracle E-Business Suite instances.

First, the network administrator creates a network, as described in Create Network Resources for Deploying Oracle E-Business Suite Environments. Next, the Oracle E-Business Suite Cloud Manager administrator uses Oracle E-Business Suite Cloud Manager to define related network profiles. Oracle E-Business Suite administrators can then select the network profiles when provisioning environments.

The network administrator can optionally use the ProvisionOCINetwork.pl script to create a default network and two default network profiles, one for One-Click Provisioning and one for Advanced Provisioning. The default network profiles are named DEFAULT_PROFILE_ONECLICK and DEFAULT_PROFILE_ADVANCED, respectively. The Oracle E-Business Suite Cloud Manager administrator can then use the UploadOCINetworkProfile.pl script to upload these network profiles. If the default network profiles have been created and uploaded to your Oracle E-Business Suite Cloud Manager instance, then they appear in the list in the Network Profiles page. To preserve consistency in the network, you cannot delete these network profiles. See Use a Default Network with Automated Scripts.

Review Network Profiles

  1. To review the network profiles that identify the network resources available for use in provisioning, click the Navigator icon, select Administration, and then select Network Profiles.

  2. The Network Profiles page displays the network profiles to which you have access. You can optionally enter a full or partial value in the search field to display only network profiles whose properties contain that value. You can search by the following properties shown in this page:

    • Network profile name

    • Oracle E-Business Suite compartment

    • Network compartment

    • Region

    • VCN

    • Availability domain

    • Creation date and time

  3. If you are logged in as an Oracle E-Business Suite Cloud Manager administrator, then you can use this page to perform the following actions:

    • To create a new custom network profile, click Create Network Profile. See Create a Network Profile.

    • To resubmit a network profile after correcting invalid property entries, click the Actions icon next to that network profile, and then select Resubmit. See Create a Network Profile.

    • To delete a network profile, click the Actions icon next to that network profile, and then select Delete Network Profile.

      Note: To preserve consistency in the network, you cannot delete a network profile that is associated with an existing environment. Additionally, you cannot delete the two default network profiles DEFAULT_PROFILE_ONECLICK and DEFAULT_PROFILE_ADVANCED.

    If you are logged in as a user without administrator privileges, then you can review the details for network profiles assigned to you, but you cannot perform any administrative actions for them.

  4. To review additional details for a network profile, click the network profile name link.

  5. In the network profile details page, review the following properties:

    • Network profile name

    • Region

    • VCN

    • Network profile description

    • Oracle E-Business Suite compartment

    • Subnet type

    • Network compartment

    • Availability domain

  6. In the Subnet Assignments region, review the following properties:

    • Database tier

      • Database tier subnet access, either Public or Private

      • Database tier subnet

    • Application tier internal zone

      • Application tier nodes subnet access, either Public or Private

      • Application tier nodes subnet

      • Load balancer visibility type, either Public or Private

      • Load balancer subnet

      • Load balancer subnet for high availability (displayed only for network profiles with the Availability Domain-Specific subnet type and Public load balancer visibility type)

    • Application tier external zone (displayed only if external zone support is enabled for this network profile)

      • Application tier nodes subnet access, either Public or Private

      • Application tier nodes subnet

      • Load balancer visibility type, either Public or Private

      • Load balancer subnet

      • Load balancer subnet for high availability (displayed only for network profiles with the Availability Domain-Specific subnet type and Public load balancer visibility type)

  7. If you are logged in as an Oracle E-Business Suite Cloud Manager administrator, then you can use this page to perform the following actions:

    • To resubmit the network profile after correcting invalid property entries, click Resubmit. See Create a Network Profile.

    • To delete the network profile, click Delete Network Profile.

      Note: To preserve consistency in the network, you cannot delete a network profile that is associated with an existing environment. Additionally, you cannot delete the two default network profiles DEFAULT_PROFILE_ONECLICK and DEFAULT_PROFILE_ADVANCED.

    If you are logged in as a user without administrator privileges, then you can review the details for a network profile assigned to you, but you cannot perform any administrative actions for it.

Create a Network Profile

Before you create a network profile, ensure that the network administrator has created the network resources for the profile to use, as described in Create Network Resources for Deploying Oracle E-Business Suite Environments.

  1. Click the Navigator icon, select Administration, and then select Network Profiles. In the Network Profiles page, click Create Network Profile.

  2. In the Provision Network Profiles page, enter the following details:

    • Network Profile Name: Enter a name for the network profile, such as ebsprodlondonad1-profile.

    • Network Profile Description: Enter a description for the network profile.

    • EBS Compartment: Select the Oracle E-Business Suite compartment for this profile, such as ebsprod-compartment.

    • Network Compartment: Select the network compartment, such as network-compartment.

    Note: The compartments you can select are determined by policies defined in Oracle Cloud Infrastructure Identity and Access Management.

  3. In the Network Assignment, region, enter the following details:

    • Region: Oracle E-Business Suite Cloud Manager displays the region for the network profile, which is determined by the region of its associated VM, such as uk-london-1.

    • VCN: Select a VCN, such as ebscm-vcn.

    • Subnet Type: Select the subnet type, either Regional or Availability Domain-Specific.

    • Availability Domain: Select the availability domain in which your Compute or VM database resources will be created, such as POKh:UK-LONDON-1-AD-1.

  4. In the Subnet Assignments - Database Tier region, enter the following details:

    • Subnet Access: Select either Public or Private.

    • Subnet: Select the subnet for the database tier, such as db-subnet-ad1.

  5. In the Subnet Assignments - Applications Tier region, enter the following details for internal zones:

    • App Nodes Subnet Access: Select either Public or Private.

    • App Nodes Subnet: Select the subnet for the application tier nodes in internal zones, such as apps-subnet-ad1.

    • Load Balancer Visibility Type: Select either Public or Private.

    • Load Balancer Subnet: Select the subnet for the application tier load balancer in internal zones, such as ebslbaas-subnet-ad1.

    • Load Balancer HA Subnet: Select the load balancer subnet for high availability, such as, ebslbaas-subnet-ad2.

      Note: This field appears only if you select the Availability Domain-Specific subnet type and the Public load balancer visibility type. The field is not shown if you choose the Regional subnet type or if you use a single availability domain.

  6. In the Subnet Assignments - Applications Tier region, optionally click the Support for External Zones toggle switch to enable external zones for this network profile. If you do so, the External Zones region appears.

  7. In the Subnet Assignments - Applications Tier region, enter the following details for external zones:

    • App Nodes Subnet Access: Select either Public or Private.

    • App Nodes Subnet: Select the subnet for the application tier nodes in external zones, such as apps-subnet-ad1.

    • Load Balancer Visibility Type: Select either Public or Private.

    • Load Balancer Subnet: Select the subnet for the application tier load balancer in external zones, such as ebslbaas-subnet-ad1.

    • Load Balancer HA Subnet: Select the load balancer subnet for high availability, such as, ebslbaas-subnet-ad2.

      Note: This field appears only if you select the Availability Domain-Specific subnet type and the Public load balancer visibility type. The field is not shown if you choose the Regional subnet type or if you use a single availability domain.

  8. Click Submit.

  9. You can check the status of the job to create the network profile in the Jobs page. Locate the create-network-profile job that you want to monitor, and click the job name link to go to the Job Details page. See Monitor Job Status.

    When you create a network profile, the create-network-profile job is initially placed in the status Input Validation in Progress while Oracle E-Business Suite Cloud Manager validates that the network and subnets assigned to the network profile include the required ingress and egress security rules.

    The Job Details page provides links to the log files for each task performed to create the network profile, including pre-validation tasks and main execution tasks. If a network profile creation job does not succeed, you can review the related log files for the specific task that failed to troubleshoot the issue.

    • If the network properties for the profile are specified correctly, but some security rules are missing, then you should first have the network administrator define the required security rules. Then, after the security rules are in place, you can retry the failed create-network-profile job from the Job Details page. See Monitor Job Status.

    • If you need to correct the network properties specified in the network profile definition, then you should update and resubmit the network profile. You can either navigate to the Network Profiles page, click the Actions icon next to the network profile you need to update, and then select Resubmit, or navigate to the network profile details page for this network profile and click Resubmit. See Review Network Profiles.

      The Provision Network Profile page appears to let you re-enter the network and subnet properties. After entering all the required properties, click Resubmit. Then monitor the status of the new create-network-profile job. See Monitor Job Status.

    Note: You can only resubmit a network profile that failed its initial validation. After a network profile is successfully created and validated, you cannot make any further changes in its properties.

Delete a Network Profile

You can delete a custom network profile either from the Network Profiles page or from the details page for a particular network profile. See Review Network Profiles.

Note: To preserve consistency in the network, you cannot delete a network profile that is associated with an existing environment. Additionally, you cannot delete the two default network profiles DEFAULT_PROFILE_ONECLICK and DEFAULT_PROFILE_ADVANCED.

Known Limitation

If you are using the Internet Explorer browser, you may encounter an issue while creating a network profile. As a workaround, switch to another browser to create your network profiles.

Set Up the Extensibility Framework

The Extensibility Framework lets Oracle E-Business Suite Cloud Manager administrators extend the jobs performed by Oracle E-Business Suite Cloud Manager by adding tasks to meet your own requirements. You can create extended job definitions for jobs including Advanced Provisioning, cloning, and promoting standby environments.

Oracle E-Business Suite Cloud Manager provides several seeded tasks for commonly required processing, which you can add to an extended job definition as needed. For a list of seeded tasks, see Seeded Tasks in the Extensibility Framework.

You can also create your own tasks to use in your extended job definitions. For a custom task, you must develop a script that defines the processing performed in the task and package that script in a zip file together with all its supporting files. You can then upload the zip file when you create the task in the Extensibility Framework UI. For guidelines on developing and packaging a script for a custom task, see Custom Task Scripts in the Extensibility Framework.

Note: You must be logged in as a user with Oracle E-Business Suite Cloud Manager administrator privileges to manage tasks and extended job definitions in the Extensibility Framework.

Review and Manage Tasks

  1. To review and manage the tasks available for use in extended job definitions, click the Navigator icon, select Administration, and then select Extensibility . If the Tasks page is not already displayed, click the Tasks tab.

    Note: You must be logged in as a user with Oracle E-Business Suite Cloud Manager administrator privileges to manage tasks in the Extensibility Framework.

  2. The Tasks page displays both seeded tasks and custom tasks that you created. You can optionally enter a full or partial value in the search field to display only tasks whose properties contain that value. You can search by the following properties shown in this page:

    • Task name

    • Task type, either Seeded or Custom

    • The location from which the task is run, either the Oracle E-Business Suite Cloud Manager VM (EBSCloudManager), all nodes for the environment (AllNodes), all database tier nodes for the environment (AllDbNodes), all application tier nodes for the environment (AllAppNodes), or the primary application tier node for the environment (PrimaryAppNode)

      Note: Only seeded tasks can be run from the Oracle E-Business Suite Cloud Manager VM.(EBSCloudManager).

    • The user who created the task

    • Creation date and time

  3. To review additional details for a task, click the task name link. In the task details window, review the following properties:

    • Task name

    • Description

    • The location from which the task is run

    • Whether the task is a lifecycle management activity

    • The script that is run to perform the task

    • The file name of the zip file that contains the script and any supporting libraries

    • Any input parameters for the script, including the following details

      • Internal parameter name

      • Displayed parameter label

      • Whether the parameter is considered sensitive and should have its value masked in display

      • The default value defined for the parameter, if any

    For a custom task, you can click the download icon next to the library file name to download a copy of that file.

  4. To create a new custom task, click Create Task. See Create a Custom Task.

  5. To edit a custom task, click the Actions icon next to that task, and then select Edit. See Create a Custom Task.

    Note: You cannot edit seeded tasks.

    Additionally, you cannot edit a custom task that is part of the running job definition while a provisioning, cloning, or standby promotion job is in progress.

  6. To delete a custom task, click the Actions icon next to that task, and then select Delete.

    Note: You cannot delete seeded tasks.

    Additionally, you cannot delete a custom task that is part of an extended job definition. You must first delete all custom extended job definitions that reference a task before you can delete that task.

Create a Task

The steps for creating a new custom task and for editing an existing custom task are the same, except that you cannot change the name of an existing task.

  1. Click the Navigator icon, select Administration, and then select Extensibility . If the Tasks page is not already displayed, click the Tasks tab. Then click Create Task.

    If you are editing an existing task, in the Tasks page, click the Actions icon next to that task, and then select Edit.

  2. In the Create Task or Edit Task page, enter the following details:

    • Task Name: Enter a name for the task. Note that you cannot change the name of a task after you enter all the required task details and the task details are saved.

    • Description: Enter an optional description for the task.

    • Run From: Select the location from which the task is run, either All Nodes, All Database Nodes, All Application Tier Nodes, or Primary Application Tier Node.

    • Script to Run: Enter the file name of the shell script to run to perform the task. The file name can only contain alphanumeric characters and must end with the file extension .sh.

      For more information about writing a script for a custom task, see Create a Wrapper Script.

    • Source Code Library: Upload the zip file that contains the main script for the task as well as any supporting libraries required to run the main script. You can either drag and drop the library file onto the Source Code Library field, or click in the field and browse to the location of the file to select it.

      For more information about packaging the source code for a custom task in a library zip file, see Package the Script in a Zip File.

      After you upload the library file, Oracle E-Business Suite Cloud Manager displays the uploaded file name.

  3. If the script requires input parameters to be entered when the job is submitted, specify those parameters in the Input Parameters region. Click Add to add a new parameter and then enter the following details:

    • Name: Enter the internal name for the parameter. The internal name can contain only alphanumeric characters and underscores.

    • Label: Enter the parameter label displayed in the Oracle E-Business Suite Cloud Manager UI.

    • Sensitive: Use this toggle switch to specify whether the value for this parameter is considered sensitive and should be masked in display.

    • Default Value: Optionally enter a default value for the parameter.

    To remove a parameter that you no longer need, click the remove icon next to that parameter.

  4. Click Create Task.

Review and Manage Extended Job Definitions

  1. To review and manage extended job definitions, click the Navigator icon, select Administration, and then select Extensibility. Then click the Extended Job Definitions tab.

    Note: You must be logged in as a user with Oracle E-Business Suite Cloud Manager administrator privileges to manage extended job definitions in the Extensibility Framework.

  2. The Extended Job Definitions page displays a list of the extended job definitions that have been created in your Oracle E-Business Suite Cloud Manager instance. You can optionally enter a full or partial value in the search field to display only extended job definitions whose properties contain that value. You can search by the following properties shown in this page:

    • Extended job definition name

    • The base job definition that this job definition extends, either EBS Provisioning, EBS Clone, or EBS Promote Standby.

    • The user who created the extended job definition

    • Creation date and time

  3. To review additional details for an extended job definition, click the extended job definition name link. In the extended job definition details window, review the list of phases included in the extended job definition and the tasks included in each phase. The extended job definition details window also displays whether each phase and task is seeded or custom.

  4. To create a new extended job definition, click Extend Job Definition. See Extend a Job Definition.

  5. To edit an extended job definition, click the Actions icon next to that extended job definition, and then select Edit. See Extend a Job Definition.

    Note: You cannot edit an extended job definition that is currently in use by an in-progress job.

  6. To delete an extended job definition, click the Actions icon next to that extended job definition, and then select Delete.

    Note: You cannot delete an extended job definition that is currently in use by an in-progress job.

Extend a Job Definition

The steps for creating a new extended job definition and for editing an existing extended job definition are the same, except that you cannot change the name or template for an existing extended job definition.

  1. Click the Navigator icon, select Administration, and then select Extensibility. Click the Extended Job Definitions tab. Then click Extend Job Definition.

    If you are editing an existing extended job definition, then in the Extended Job Definitions page, click the Actions icon next to that extended job definition, and then select Edit.

  2. Enter the following basic properties:

    • Name: Enter a name for the extended job definition. Note that you cannot change the name of an existing extended job definition.

    • Description: Enter an optional description for the extended job definition.

    • Base Job Definition: Select the base definition for the job you want to extend, either EBS Provisioning, EBS Clone, or EBS Promote Standby. Note that you cannot change the base job definition for an existing extended job definition.

    Then click Next.

  3. Specify the details for the extended job definition. The Job Definition Details page initially displays the default phases that are part of the base job definition. You can optionally add a phase to the extended job definition with additional tasks to meet your own requirements.

    • Click the Actions icon next to the last phase in the base job definition, and then select Insert After to insert an additional phase at the end of the extended job definition.

    • The Select Tasks window displays the list of available tasks, including seeded tasks provided by Oracle and any custom tasks defined in your Oracle E-Business Suite Cloud Manager instance. You can enter a full or partial value in the Filter field to display only tasks whose name matches that value. Select the tasks you want to add to the extended job definition and then click Add Tasks.

    • To change the order of the tasks, click the reorder icon next to a task and drag it to the position you want in the list.

    • To add more tasks, click the Actions icon next to your additional phase, and then select Add Tasks.

    • To delete a task, click the Actions icon next to that task, and then select Delete Task.

    • To delete the entire additional phase, including all tasks within it, click the Actions icon next to that phase, and then select Delete Phase.

    When you have finished updating the details for the extended job definition, click Next.

  4. In the Review Extended Job Definition page, review the extended job definition's basic properties and the phase and task details. To save the extended job definition, click Submit.

Use an Extended Job Definition in Oracle E-Business Suite Cloud Manager Processing

After an Oracle E-Business Suite Cloud Manager administrator has created an extended job definition for Advanced Provisioning, cloning, or promoting a standby environment, Oracle E-Business Suite administrators can select that extended job definition when submitting that type of job. The Oracle E-Business Suite administrator must provide any input parameters required by the added tasks. Oracle E-Business Suite Cloud Manager will then perform the job according to the extended job definition, including any tasks specified in the additional phase. See Advanced Provisioning, Clone an Oracle E-Business Suite Instance, and Promote a Standby Environment.

Set Up Scheduling Policies

You can create backups for an Oracle E-Business Suite environment automatically on a schedule by defining scheduling policies.

Note: The backup feature is available for environments created using Advanced Provisioning. For more information about prerequisites for backups, see Back Up an Oracle E-Business Suite Instance.

To create a scheduling policy, you first define the policy itself, and then add one or more schedules to the policy. Schedules define the frequency at which backups are created. You can define the following types of schedules:

Note: Scheduled backups are not guaranteed to start at the exact time specified by the schedule. You may see up to several hours of delay between the scheduled start time and the actual start time for the backup in scenarios where the system is overloaded.

Review Scheduling Policies

  1. To review the scheduling policies available for use in scheduling backups, click the Navigator icon, select Administration, and then select Scheduling Policies.

  2. The Policies page displays the scheduling policies defined in your Oracle E-Business Suite Cloud Manager instance. You can optionally enter a full or partial value in the search field to display only policies whose properties contain that value. You can search by the following properties shown in this page:

    • Policy name

    • Policy type (create-ossbackup for backup scheduling policies)

    • The user who created the policy

    • Creation date and time

  3. To create a new policy, click Create Policy. See Create a Scheduling Policy.

  4. To review details or define schedules for a policy, either click the policy name link or click the Actions icon next to that policy and then select Edit. See Manage Policy Details.

  5. To delete a policy, click the Actions icon next to that policy, and then select Delete.

Create a Scheduling Policy

To create a scheduling policy, you first define the policy itself, and then add one or more schedules to the policy.

Create a Policy

  1. Click the Navigator icon, select Administration, and then select Scheduling Policies. In the Policies page, click Create Policy.

  2. In the Create Policy window, enter a name for the policy.

  3. Select the compartment in which backups created using this policy will be stored.

  4. Click Create.

Manage Policy Details

  1. Click the Navigator icon, select Administration, and then select Scheduling Policies. In the Policies page, either click the policy name link or click the Actions icon next to that policy and then select Edit.

  2. In the policy details page, review the following details:

    • Policy name

    • Compartment

    • The user who created the policy

    • Creation date and time

    • Any schedules defined for the policy, including the schedule type and start time

  3. To add a schedule to the policy, click Add Schedule. See Define a Schedule.

  4. To edit a schedule, click the Actions icon next to that schedule, and then select Edit. See Define a Schedule.

  5. To delete a schedule, click the Actions icon next to that schedule, and then select Delete.

  6. After you finish updating schedules for the policy, click Save Policy to commit your changes.

  7. To delete the policy, click Delete Policy.

Define a Schedule

  1. In the Create Schedule window or Edit Schedule window, select the schedule type: Daily, Weekly, Monthly, or Yearly.

  2. Specify the appropriate schedule options depending on the schedule type.

    • Daily: Specify the hour of the day for the backup.

    • Weekly: Specify the day of the week and the hour of that day for the backup.

    • Monthly: Specify the day of the month and the hour of that day for the backup.

    • Yearly: Specify the month, the day of that month, and the hour of that day for the backup.

    The schedule settings are based on the UTC time zone.

  3. Click Create Schedule for a new schedule, or Edit Schedule for an existing schedule.

  4. Click Save Policy in the policy details page to commit your changes.

Assign a Scheduling Policy to an Environment

After you create a policy, you can use it to create backups for an environment automatically on the specified schedule. To do so, assign the policy to the environment in the environment details page.

If you no longer want to create backups on that schedule, you can remove the policy assignment for the environment in the environment details page.

See Schedule Backups and Review Environment Details.

Delete a Scheduling Policy

You can delete a scheduling policy either from the Policies page or from the details page for a particular policy. See Review Scheduling Policies or Review Policy Details.