Tutorial - Creating and Manually Launching a Universal Task

Owned by
Former user (Deleted)
Last updated: Nov 29, 2022 by
IT Stonebranch
Version comment
4 min read

Overview

To run a Universal Task, you must:

  • Create a Universal Template, for which Universal Controller automatically creates a Universal Task type. This includes:
    • Entering a script that any Universal Task created for that Universal Task type will execute.
    • Creating fields, for which the Controller will both automatically assign variables (to be used in the script) and add to any Universal Task created for that Universal Task type.
  • Replace variables in the script with the variables assigned to the user-defined Fields that you created in the Universal Template.
  • Create a Universal Task for the Universal Task type based on the Universal Template that you created.
  • Enter/select values for the user-defined fields in the Universal Task that match the fields you created in the Universal Template.
  • Run the Universal Task.
  • Retrieve the task output and verify that the script variables have been resolved to the Universal Task field values.

In this tutorial, you will:

Before You Begin

When you create a Universal Template, you create fields that will display in the Details of the Universal Task (based on this Universal Template) that you will create. These Universal Template fields are assigned variables to be used in the script. The script should contain these variables in a specific format based on information that you provide when creating the Universal Template.

Create a Universal Template

First, create a Universal Template:

Step 1

From the Administration navigation pane, select Configuration> Universal Templates. The Universal Templates list displays.

Step 2

Click New. The Universal Template Details displays.

Step 3

Optionally, in the Icon field, browse for an icon (PNG image, 48x48 pixels) to be used instead of the default icon for any Universal Tasks based on this Universal Template.
 
If you select an icon, the file name display next to the Browse button. When you save the Universal Template, the logo itself displays in the Icon field (see #Create Universal Template Fields, below).

Step 4

Click Save.

Create Universal Template Fields

Next, create fields in the template:
 

Step 1

Open the Oracle EBS template that you just created.
 

Step 2

Click the Fields tab to display an empty Fields list.
 

Step 3

Click New. The Field Details for a new Field displays.

Step 4

Click Save to save the Field and re-display the Fields list.

Step 5

Click New and create four more Fields.

Click Save to save each Field.

Step 6

When you save the progname field, the Choices tab is enabled so that you can define user-selectable Choices for that Field. An empty Choices list displays under the enabled Choices tab. Click New to display an empty Choice Details for a new Choice:

Step 7

Click Save to save the Choice and then create two more Choices for the progname field:

Click Save to save each Field.

Step 8

Click the Field tab to re-display the Field Details, click the Close to return to the Fields list, and then click click the Universal Template tab to return to the Universal Template Details.

Step 9

Check the script to make sure that the variables for the five Fields that you created are in the following format: ops_<Variable Prefix>_<Field Name>. For example: ops_oebs_appscredential.

Step 10

Click Save to save the template.

Create a Universal Task

You now can create a Universal Task based on Stonebranch Template One.

Step 1

Select the Automation Center navigation pane.

Step 2

Right-click inside the navigation pane and, on the Action menu that displays, click Refresh Navigation Tree. An Oracle EBS Tasks Universal Task task type now displays in the Universal Tasks folder.

Step 3

Click Oracle EBS Tasks to display an empty tasks list for this Universal Task type.

Step 4

Click New to display Details for a new Oracle EBS Tasks task.
 

Step 5

In the Task Name field, enter: Active Users Report.

Step 6

Review the Details section fields that you defined in the Oracle EBS Universal Template to make sure that their names, defaults, and requirement settings are correct.

Step 7

Enter the following field values:

  • Oracle Application Credential: APPS
  • Responsibility Application: SYSADMIN
  • Responsibility Name: System Administrator
  • Application User: SYSADMIN

Step 8

Click the Save button to save the task.

Step 9

Right-click Active Users Report on the Oracle EBS Task list and, on the Action menu that displays, click Launch Task.

Step 10

Click Activity in the Automation Center navigation pane and open the Active Users Report task instance:
 

Step 11

In the Status section of the task instance Details, check the Status and Exit Code fields to verify that the task ran to success. Optionally, retrieve output from the task instance to view details about the run.


For additional information, see: