Running an Orchestration on a Schedule

Before You Begin

This 20-minute OBE (Oracle By Example) shows you how to attach a schedule to an orchestration and how to use the scheduler user interface in the on the JD Edwards EnterpriseOne Studio to run the orchestration according to its schedule.

In this example, you will use the JD Edwards EnterpriseOne Orchestrator Studio to create an orchestration that includes a message request for sending emails to an email address that you can access. After attaching a schedule to the orchestration, you will use the scheduler page to start the process of running the orchestration on a schedule. You can then verify that the orchestration is running according to its schedule if you receive emails at the scheduled interval.

Notifications can also run through the scheduler.

Background

In the JD Edwards EnterpriseOne Orchestrator Studio, you can create and attach a schedule to an orchestration or a notification. A schedule determines how often the scheduler executes an orchestration or notification. You can define a schedule using minutes, hours, days, or a Cron string (for example, every Tuesday at 2:00 pm). You can attach the same schedule to multiple orchestrations or notifications.

Use the scheduler page in the Studio to start, stop, and manage scheduled orchestrations or notifications. For more information see: Working With Scheduler.

What Do You Need?

• JD Edwards EnterpriseOne test environment with a minimum of EnterpriseOne Tools 9.2.4.0
  The AIS server must be configured to be a scheduler server and the scheduler must be running. See "Configuring AIS Server Manager Settings" in the JD Edwards EnterpriseOne Application Interface Services Server Reference Guide.
• The EnterpriseOne environment must be configured with an SMTP server to send emails.

Creating an Orchestration with a Message Request

In this task, you will use the Orchestrator Studio to create an orchestration with a message request.

1. Access the Orchestrator Studio.
2. Click the Messages icon and then click the New button.
3. On the Message design page, complete these fields:
• Name= Scheduled Message
• Description = Send an Email message.
4. Click the Product Code drop-down list and select a customer product code, 55 – 59.
5. Enter the recipient, subject, and message:
• To = Click the drop-down list and select Email Address.
• E-mail Address = Enter an email address to which you have access. This is the email that you will use later to verify that the orchestration is running as scheduled.
• Subject = Sending email message.
• Message box = This is an email to test orchestrations running on a schedule.
6. Click Save.
   The message service request should look like this when complete:

   

7. Click the Manage menu, and then click Create Orchestration.
8. On the Orchestration design page, change these fields:
   
   • Name = Scheduled Message
     
   • Description = Send a scheduled message
9. Click the Product Code drop-down list and select a customer product code, 55 – 59.
10. Save the orchestration.

Attaching a Schedule to the Orchestration

In this task, you will attach a schedule to this orchestration.

1. On the Orchestration design page with the Scheduled Message orchestration, click the Start node.
2. Click the Schedule icon.
3. Click Select Schedule.
4. Click New.
5. On the Schedules page, complete these fields:
• Name= Five Minutes
• Description = Every 5 minutes
• Product Code = Select a customer product code, 55 – 59.
6. In the Schedule to run every field, notice the default value is already set to 5 Minutes. To set a different time, click the Increment (up arrow) icon to set it to the desired timing and select the required value (Minutes, Hours, or Days) from the drop-down list.
7. Click Save. The resulting schedule looks like this:



8. Click Close (X icon) to close the Schedules page and return to the orchestration.
9. Notice the new schedule is now attached to the orchestration.



10. Click Save. The orchestration should look like this when complete (notice the schedule icon, an indicator that a schedule is attached):

Using the Scheduler to Run and Test the Scheduled Orchestration

In this task, you will start the scheduled orchestration using the Scheduler page.

1. Click the Tools menu (top right) and select Scheduler.
2. Verify that the scheduler is running by looking at the top right of the page, which should show the Scheduler uptime as shown in the following screenshot:
   

   

   If this is not shown, then the configuration of the server is not enabled to run the scheduler. Configuration changes are necessary. For more information, see the Before You Begin section of this OBE file.
3. All scheduled orchestrations and notifications that your user has access to will display in the grid. In the Filter field, enter Scheduled Message.This is the name of the orchestration you just created.
4. Enable the Started option to start the schedule.



5. You should now be receiving emails from the orchestration every 5 minutes. Wait for the orchestration to complete a few runs to see the emails.



6. Click the i button in the grid row to see information about the scheduled job.



7. Disable the Started option to stop the schedule.
8. Click the i button and notice that there is no information in the Next Run field. This is because the Started option is disabled (the schedule is off).

Want to Learn More?

• "Creating Schedules for Orchestrations" in the JD Edwards EnterpriseOne Tools Orchestrator Guide
  
• See the scheduler services in the REST API for JD Edwards EnterpriseOne AIS Server Guide

To know more about generating the tokens, see:

• "Authentication" in the REST API for JD Edwards EnterpriseOne AIS Server Guide
  
• "Understanding AIS Authentication" in the JD Edwards EnterpriseOne Application Interface Services Server Reference Guide