4 Creating Notifications with Orchestrator Studio 9.2.4 (Release 9.2.4.0)

Important:

This chapter has been updated in support of Orchestrator Studio 9.2.4. The features related to this release are notated with the release number.

Orchestrator Studio 9.2.4 is the latest version which requires a minimum of EnterpriseOne Tools 9.2.4.0. If you have not installed Orchestrator Studio 9.2.4, see "Getting Stated" in the JD Edwards EnterpriseOne Tools Orchestrator Guide.

Instructions for using prior versions of the Orchestrator Studio are in the appendices of this guide.

This chapter describes how to take your notification design from analysis to implementation. It contains the following topics:

Understanding Notifications and Orchestrator Studio

Just like all other orchestration components, notifications and schedules:

  • Are created using Orchestrator Studio design pages, which have the standard design page features.

  • Are reusable components.

  • Are saved and managed as user defined objects (UDOs) in EnterpriseOne.

  • Utilize the standard UDO life cycle features (for example, can be published or shared).

For more information, see:

You can use the Orchestrator Studio to create the following components related to notifications:

  • Notifications. A notification is an object that enables the system to notify users of business events as they happen without the need for the user to be online. You can specify that the notification execute a Watchlist or an orchestration. You define what the notification message looks like and whether it includes a shortcut to an application. You can also attach report output from an EnterpriseOne report or BI Publisher report, and you can link to an orchestration, notification, or URL. You attach the schedule for when it runs, and any rules that must be met to send the notification message.

  • Schedules. A schedule defines how often the system runs a particular job. A schedule consists of a time interval in minutes, hours, or days, or a Cron string. A schedule can be attached to multiple notifications or orchestrations to determine how often they run. The scheduler runs as a process on the Application Interface Services (AIS) server and is managed using a set of REST APIs.

  • Orchestrations. An orchestration is a high-level object that provides a unique name for an orchestration process. The orchestration is where you define the inputs for the orchestration, the expected incoming data. It also includes orchestration steps, which are invocations to the other components. When the Orchestrator invokes an orchestration, it processes the steps defined in the orchestration to enable the transfer of data within EnterpriseOne or between third-party sources and EnterpriseOne.

  • Rules. A rule on a notification is used to determine whether the message is dispatched to the subscribers. The rule must evaluate to true in order for the message to be dispatched. If there is no rule specified, the message is always dispatched.

Accessing the Orchestrator Studio

The Orchestrator Studio is a web application that runs in a web browser. Ask your system administrator for the URL to the Orchestrator Studio.

Important:

Before users can access the Orchestrator Studio, an administrator must set up security to authorize access to the Orchestrator Studio and determine the actions Orchestrator Studio users can perform. SeeManaging Notifications and UDO Security for more information.

To access the Orchestrator Studio:

  1. In a web browser, enter the URL to the Orchestrator Studio 9.2.4:

    http://<ais_server>:<port>/studio

  2. On the Orchestrator Studio Sign In screen, enter your EnterpriseOne User credentials, environment, and role.

    Note:

    It is highly recommended that you enter an EnterpriseOne environment used for testing, not a production environment.
  3. Click the Login button.

In the Orchestrator Studio, click the drop-down menu in the upper-right corner to access the link to log out of the Orchestrator Studio.

Navigating the Orchestrator Studio

The component icons on the Orchestrator Studio Home page take you to the design pages for creating and modifying each orchestration component.

Figure 4-1 shows the Orchestrator Studio Home page.

Figure 4-1 Orchestrator Studio Home

This image is described in surrounding text.

The icons at the bottom panel of the Orchestrator Studio Home page provide access to the Run Orchestrations page for testing orchestrations, the Import tool for importing orchestration files, the JD Edwards EnterpriseOne web client, Orchestrator Monitor, and the Scheduler user interface page for managing the scheduled jobs. For more information, see:

Creating a Notification

With the JD Edwards EnterpriseOne Orchestrator Studio, you can create notifications that provide pertinent and actionable notification messages to your users.

Important:

Remember that when you are ready to "request to publish" a notification, you need to make sure that you also request to publish all components associated with the notification. The administrator also needs to apply the correct view security to the shared components so that when the notification runs, all dependent objects are available and the notification process will not end in error.

To create a notification:

  1. On the Orchestrator Studio Home page, click the Notifications icon.

  2. On the Notifications side panel, click the New button.

  3. On the Notifications design page, enter a unique name for the notification in the Name field. Make sure that it is very descriptive and includes scheduling information for subscribers. For example, you might enter "Check for Purchase Orders Received Every Four Hours," and not "trkPO_h4."

    Note:

    The name cannot be empty, blank or contain the following characters: ~`'!@#$%^&*()+={[}]|\;:"<,>.?/.
  4. Click the Product Code drop-down list to select a product code to associate with the notification. If you leave this field blank, the notification defaults to product code 55.

    This gives an administrator the option to manage UDO security for orchestration components by product code.

  5. In the Description field, enter a short description with a maximum of 200 characters.

    This description will show as hover text when your subscribers choose to subscribe to this notification, so this is a good place to tell your subscribers about any inputs they may provide and how often they can expect the notification to run. For example: "This notification allows you to track the status of a purchase order. Enter the purchase order number as input. You will receive updates hourly."

  6. Click the Edit Long Description button to provide more detail about the component.

    Use this field to describe the purpose of the notification and any details that differentiate the notification from other notifications that you create.

  7. Click the Type drop-down menu and select the appropriate type. The type you choose is very important because it defines the events or conditions on which the notification is sent, as described below:

    • Simple (default). A simple notification does not check for any events or conditions; it simply sends the notification message on the schedule you choose. This type of notification is best suited for informational messages or reminders to your subscribers.

    • Orchestration. An orchestration can be a very powerful way to detect an event or condition upon which you want to send a notification. Orchestrations can read data from JD Edwards tables, invoke JD Edwards applications, and even query external systems. When you create an orchestration you can also define its output, which can then be input into your notification. Refer to the JD Edwards EnterpriseOne Tools Orchestrator Guide for more information about building orchestrations.

    • Watchlist. If you have created a Watchlist in EnterpriseOne you can use that Watchlist as the trigger to send the notification. For example, if you have a Watchlist that monitors the number of backlogged items, you can build a notification that sends that information to subscribers.

  8. Enable the Run As Subscriber toggle if you would like to run the notification once for each individual user who is subscribed to the notification. If selected, the subscriber's security settings will be used when the notification is run for them. If you do not select this option, the notification will only be run once with the user information of the person who starts the notification job and all subscribers will receive the same notification message.

  9. Enable the Allow Subscriber Overrides toggle if you want to give subscribers the ability to enter override values for the notification inputs in Subscription Manager.

  10. At this point, you can click Save to save your notification.

    You can also use Save As and rename an existing notification to create a new one.

    The Orchestrator Studio saves the notification as a "Personal" UDO.

    Caution:

    If you use Save As to create a copy of a notification, only the notification is copied. The Orchestrator Studio does NOT create a copy of the components that are associated with the notification. That is, both the original notification and the new notification use the same components that comprise the notification. Therefore, in the new notification, do NOT modify the components in any way that would break other notifications that use the same components.

    You can also click the About link from Manage drop-down menu to understand where else the component is being used, so that you don't break other usages.

    See "Reusable Orchestration Components" in the JD Edwards EnterpriseOne Tools Orchestrator Guide.

  11. Next, refer to the appropriate sections to complete the remaining parts of the notification: notification inputs, orchestration, Watchlist, rule, message, and schedule.

Adding Inputs to a Notification

You can use notification inputs to specify default input values or enable subscribers to manually enter an override value when creating a subscription in the Subscription Manager. In the notification, you enter names for the inputs. For example, you might enter "Customer Number" to enable entering a specific customer number as an override value.

You also use these notification inputs to configure other components used by the notification, such as an orchestration or rule. For example, if the notification requires a rule, you can use the notification inputs or orchestration outputs to define the conditions for the rule.

To add the notification inputs:

  1. Expand the Notification Inputs section of the Notification design page.

  2. In the first empty row in the grid, enter the name of the input in the Name column.

  3. In the Value Type column, select the input value type. Valid values are:

    • String

    • Numeric

    If the input is a date, you can use any of the following date formats:

    • dd/MM/yyyy

    • dd/MM/yy

    • yyyy/MM/dd

    • MM/dd/yyyy

    • MM/dd/yy

    • yy/MM/dd

    You can also use the following date formats, which create additional inputs derived from the passed value as described in "Configuring Orchestration XML" in the JD Edwards EnterpriseOne Tools Orchestrator Guide.

    • Milliseconds

    • yyyy-MM-dd'T'HH:mm:ss.SSSZ

  4. In the Default Value column, enter a default value for the input if required.

  5. In the Required column, toggle left or right to specify whether the input is required or not.

  6. Click Save to save your changes.

Adding a Watchlist to a Notification (Watchlist Type Only)

This section only appears if you have selected "Watchlist" as your notification Type.

To add a Watchlist to a notification:

  1. Expand the Watchlist section of the notification design page.

  2. Click the Select Watchlist button.

    A dialog appears listing all the Watchlists that you have access to.

  3. Select the Watchlist from the list.

  4. Click Save to save your changes.

Important:

Remember if you are using a Watchlist in your notification, the Watchlist, as well as the notification, needs to be published. Watchlists are published in JD Edwards EnterpriseOne, not Orchestrator Studio.

For more information on creating Watchlists, see the JD Edwards EnterpriseOne Applications One View Watchlists Implementation Guide.

Adding an Orchestration to a Notification (Orchestration Type Only)

This section only appears if you have selected "Orchestration" as your notification Type.

To add an orchestration to a notification:

  1. Expand the Orchestration section of the notification design page.

  2. Click the Select Orchestration button.

    A dialog appears listing all the orchestrations that you have access to.

  3. Click the orchestration from the orchestration list.

    A list of orchestration inputs appears.

  4. In the Mapped From column for an input, use the drop-down menu to choose a notification input to use.

  5. In the Default Value column for an input, enter a default value if required.

  6. Click Save to save your changes.

Important:

Remember that when you are ready to "request to publish" a notification, you need to make sure that you also request to publish the orchestration associated with the notification.

For more information on creating orchestrations, see the JD Edwards EnterpriseOne Tools Orchestrator Guide.

Adding Rules to a Notification

If you want to add a rule that determines whether or not the notification message should be sent, use the Rule section of the form.

To add a rule to a notification:

  1. Expand the Rule section of the notification design page.

  2. Click the Select Rule button.

    A dialog appears listing all the rules that you have access to.

  3. Click a rule from the rule list.

    A list of rule inputs appears.

  4. In the Mapped From column for an input, use the drop-down menu to choose a notification input, Watchlist output (Watchlist type only), or orchestration output (orchestration type only) to use.

  5. In the Default Value column for an input, enter a default value if required.

  6. Click Save to save your changes.

For more information on creating rules, see the JD Edwards EnterpriseOne Tools Orchestrator Guide.

Defining the Notification Message

Use the Message section of the Notification design page to define the subject and text of the notification message, to add application and other links, to add attachments and to add a Data Dictionary text item.

To define a notification message:

  1. Expand the Message section of the notification design page.

  2. Use the Output and Output Type fields to define user options in Subscription Manager. If you specify a Boolean Output Type, subscribers can decide if they want to be notified if the Boolean value is true or false. If the notification is based on a Watchlist, the Output Type is Watchlist Level and cannot be changed; subscribers can decide if they want to be notified for warning, critical, or normal Watchlist levels. See "Adding a New Subscription" in the JD Edwards EnterpriseOne Tools Foundation Guide for more information.

  3. In the Subject and Body fields, enter text, variables, or a combination of both. To insert variables, see step 8.

    Notes:

    • If using only a variable in the Subject field, remember that it is possible the variable could be blank and then the message will have a blank subject. This makes it difficult for a user to open the message, which is done by clicking on the subject, in both the Notification List and Message Center.

    • Keep in mind that the Work Center only allows 40 characters for the subject. This means that if you create a subject line that is longer than 40 characters and it is delivered to the Work Center, the subject will be truncated.

  4. To include boilerplate text from a message template in the data dictionary:

    1. Expand the Data Dictionary section.

    2. In the Data Dictionary field, enter the name of the message template data item and click Load.

    3. If the message template contains variables, use the grid to override the variables with a default value or a variable.

      For each variable used in the message template, a row is added to the adjacent grid.

      In the grid, slide the Literal toggle to right to replace the variable in the template with a literal value. Slide the Literal toggle to left to select an existing notification, orchestration, or a watchlist input variable from the drop-down list.

  5. To include a shortcut to an application:

    1. Expand the Actions section, and then the Application Links section.

    2. In the Applications Links section, click Add.

    3. In the New Shortcut section, complete the Application, Form, and Version fields to specify the form that you want the shortcut to launch.

    4. If required, define a personal form, query, or watchlist to be used when the application opens.

      If the user receiving the message does not have view access to that particular personal form, query, or watchlist, the application will open without it.

    5. In the Link Text field, enter the text you would like to appear in the message for the shortcut. This shortcut text appears in the notification message.

    6. In the Pre Text and Post Text fields, enter the text you want to appear before and after the shortcut text.

    7. In the grid, you can use variables to pass in data to the application when the application is launched from the shortcut.

    8. Click the Add button in the Application Links section and repeat these steps to include multiple application links in a message.

      You can click the Remove button (X) at the end of the New Shortcut section header to delete the application link that is added.

  6. To include other links (for example, to launch an orchestration or notification):

    1. In the Other Links section, click Add and expand the section.

    2. Select the type of link you would like to add from the Type drop-down menu. Valid values are Orchestration, Notification, or URL.

    3. Depending on the type you have selected, either select the orchestration name, notification name, or enter the URL.

    4. In the Link Text field, enter the text you would like to appear as link in the message.

      This link text appears in the notification message.

    5. In the Pre Text and Post Text fields, enter the text you want to appear before and after the link text.

    6. Use the grid to work with orchestration input, notification input, or a key for the URL, depending on which type of link you are using. In the Value column, you can enter either a variable or a default value as the input.

    7. Click the Add button in the Other Links section and repeat these steps to include multiple links in a message.

      You can click the Remove button (X) at the end of the GroupBy section header to delete the links that were added.

  7. To include report output as an attachment:

    1. In the Attachments section, click Add and expand the section.

    2. In the grid, enter Link Text, Job Number, Server, and File Type for the report output that you want to attach. The report output can be generated at this stage by an orchestration or it can be previously generated outside of any orchestrations or notifications. Either standard EnterpriseOne reports or BI Publisher reports can be attachments. You can define the Link Text, Job Number, and Server as variables.

    3. Enable the Send As Link toggle to attach the report as a link in the message.

    4. Click the Add button in the Attachments section and repeat these steps to include multiple attachments in a message.

      Click the Remove button (X) at the end of the each row in the grid to delete the reports that were added.

  8. To include variables in the subject, body, message template text, or shortcut:

    1. Type ${var name} where var name is the name of the variable that you want to include.

    2. Make sure the syntax includes the $ sign and brackets, for example:

      ${creditmanager}

    The variable will be substituted into the message when the notification is sent. The variable can come from any of these places:

    • Any input you define for the notification

    • Watchlists return a set of output that you can use as variables. You can see them by pressing the Test button with the Dispatch Notification switch off. For example, if you want to include the number of Watchlist records in your message you could include this sentence:

      "There are ${records} records in this Watchlist."

    • Orchestrations also return outputs, which you can define when you create the orchestration. You can see them by pressing the Test button with the Dispatch Notification switch off.

  9. Click Save to save your changes.

Adding a Schedule to a Notification

A schedule defines how often the system will run the notification, whether it is based on an orchestration, a Watchlist, or simply sending a notification message. You can define a schedule using minutes, hours, days, or a Cron string. Cron is a time-based job scheduler that can be used to schedule jobs to run periodically at fixed times, dates, or intervals (for example, every Tuesday and Friday at 9:00 am).

To add a schedule to a notification:

  1. Expand the Schedule section of the notification design page.

  2. Click the Select Schedule button.

    A dialog appears listing all the schedules that you have access to.

    Note:

    Schedules are UDOs so you must have the proper permissions to see the New Schedule button.
  3. Click a schedule from the list.

    A schedule is associated to the notification.

  4. Click Save to save your changes.

Caution:

Be aware that just associating the schedule with the notification does not mean that the schedule starts running. The scheduler must be started by an administrator for the scheduled notifications to start running on their schedules.

Creating Schedules

This section contains the following topics:

For information on using schedules with orchestrations, see "Creating Schedules for Orchestrations" in the JD Edwards EnterpriseOne Tools Orchestrator Guide.

For information on scheduler resilience through the use of a database with your scheduler, see "Configuring Scheduler Resilience" in the JD Edwards EnterpriseOne Application Interface Services Server Reference Guide.

Understanding Schedules

A schedule defines how often the system executes a notification. You can define a schedule using minutes, hours, days, or a Cron string, such as every Tuesday at 2:00 pm. The schedule is then attached to a notification to determine how often it runs. You can attach the same schedule to multiple notifications, but a single notification can only be associated with one schedule.

As a notification designer you can assign your notifications to existing schedules by picking a schedule from the drop-down list. You may also have privileges to create new schedules, in which case the New Schedule button will be active for you. Schedules are managed as UDOs, so you can publish and share your schedules for others to use, and you can use schedules that others have published.

The task of starting, stopping, and managing the scheduler itself is a system administrator task. The scheduler runs as a process on the Application Interface Services (AIS) server.

Note:

The AIS server instance where the scheduler is started cannot be clustered. The scheduler should only be started on one instance.

Starting with Tool 9.2.4, you can use the Scheduler user interface page to manage the scheduled jobs. You can start and stop jobs using the Scheduler user interface. See Working with Scheduler for more information.

The scheduler is managed using a set of REST APIs, which are documented with all other JD Edwards REST APIs:

JD Edwards EnterpriseOne Tools REST API for the Application Interface Services Server

Creating a Schedule

Create a schedule to define how often an orchestration or notification runs.

To create a schedule:

  1. On the Orchestrator Studio Home page, click the Schedules icon.

    The Orchestrator Studio displays the Schedules design page.

  2. Click the New button on the Schedules side panel.

  3. In the Schedules design page, enter a name for the schedule in the Name field.

  4. Click the Product Code drop-down list to select a product code to associate with the schedule.

    This gives an administrator the option to manage UDO security for orchestration components by product code.

  5. In the Description field, enter a short description with a maximum of 200 characters. This description should clearly describe the frequency of the schedule so that it can be attached to notification as needed.

  6. Click the Edit Long Description button to add a long description to provide more detail about the purpose of the component.

  7. Do one of the following:

    • In the Schedule to Run every section, select a number of minutes, hours, or days to define how often you want the schedule to run.

      If you select minutes, you cannot run more often than every five minutes.

    • In the Or Enter a Cron String section, enter a Cron string to define the schedule.

      Cron is a time-based job scheduler that can be used to schedule jobs to run periodically at fixed times, dates, or intervals (for example, every Friday at 10:00 am). There are many third-party Cron expression generators available that can help you create a Cron string.

  8. Click the Save or Save As icon in the upper-right corner.

The first time a new schedule is saved, it is saved as a "Personal" UDO. Thereafter, you can use the UDO buttons described in the User Defined Object (UDO) Features section to move the schedule to the appropriate status.

Adding a schedule to a notification in the Notification design page does not invoke the notification as scheduled. Starting the scheduler is a separate step. You need to ask an administrator to start and administer the schedule using REST API services.

Starting with Tool 9.2.4, you can use the Scheduler user interface to manage the scheduled notification and orchestration jobs. You can start and stop the jobs using the Scheduler user interface in the Orchestrator Studio 9.2.4. See Working with Scheduler for more information.

For more information on REST APIs used for managing the scheduler, see "Scheduler Service" in the JD Edwards EnterpriseOne Tools REST API for the Application Interface Services Server Guide.

Modifying or Deleting Notifications after You Share Them

Do not modify a notification once it has subscribers. Instead, create a new notification and delete the old one. If a user has subscribed and a notification is changed, the inputs may change and the subscription input overrides may no longer be correct, which can cause the user to no longer receive notifications without realizing why. On the other hand, if a notification is deleted, when a user goes into Subscription Manager, he will see an indication that the subscription has an issue.

Exporting and Importing Notifications in the Orchestrator Studio

Notifications are exported and imported just like any other orchestration component. For more information, see:

  • "Exporting Orchestration Components" in the JD Edwards EnterpriseOne Tools Orchestrator Guide

  • "Importing Orchestration Files" in the JD Edwards EnterpriseOne Tools Orchestrator Guide

Working with Scheduler

This chapter contains the following topics:

Understanding Scheduler

The Orchestrator Studio provides a user interface, which is called the Scheduler user interface, where you can view the notification and orchestration jobs along with the attached schedules. Using the Scheduler user interface, you can view all the jobs and perform tasks, such as starting and stopping individual or multiple jobs. The Scheduler user interface eliminates the need to use third-party applications to start and stop jobs.

You must have been granted proper UDO security to work with the notification and orchestration jobs on the Scheduler user interface.

The Scheduler user interface provides information about the jobs that are running and the ones that need to be started.

The scheduler runs as a process on the Application Interface Services (AIS) server. You can view only those schedules on the AIS server that you are currently logged-in to. For information on designating the AIS server as a scheduler, see Configuring AIS Server Manager Settings in the JD Edwards EnterpriseOne Application Interface Services Server Reference Guide.

Note:

When a Scheduler server points to a JAS server that supports an environment, which is also supported on another Scheduler server pointing to another JAS server, two instances of the same job could exist. This is because the job is running for a specific environment and that environment is supported in two different scheduler configurations. This is applicable when the scheduler is not resilient.

Prerequisites

Complete the following prerequisites:

For information on scheduler resilience through the use of a database with your scheduler, see "Configuring Scheduler Resilience" in the JD Edwards EnterpriseOne Application Interface Services Server Reference Guide.

Accessing the Scheduler

To access the Scheduler user interface:

  1. Log in to JD Edwards EnterpriseOne Orchestrator Studio.

  2. On the Orchestrator Studio Home page, click the Scheduler icon to access the Scheduler user interface.

Set Up User Access to the Scheduler Program

An administrator must use EnterpriseOne application security to enable user access to the Orchestrator Studio (P98I0000) and Scheduler (W98I0000B) programs. See "Managing Application Security" in the JD Edwards EnterpriseOne Tools Security Administration Guide and "Managing Orchestrator Studio Security" in the JD Edwards EnterpriseOne Tools Orchestrator Guide.

Enable UDO View Security to Orchestrations, Notifications, and Schedules

Users must have UDO view security access to the orchestrations, notifications, and schedules that they want to work with using the Scheduler user interface. For more information about UDO view security, see "Managing UDO View Security" in the JD Edwards EnterpriseOne Tools Security Administration Guide.

Scheduler User Interface Features

Use the Scheduler user interface to view, start, and stop notification or orchestration jobs with their associated schedules. This user interface enables you to review the state of the jobs that are running.

The Scheduler user interface contains the following features:

  • Jobs list. The Scheduler user interface displays a list of existing notification or orchestration jobs. By default, the list is displayed in the ascending order of the notification and orchestration names.

  • Select or Select All check box. Click the check box in the individual row to select specific jobs, or click the Select All check box to select all the jobs. Note that you can select only those jobs that are created by the currently logged-in user and have a schedule attached.

  • Sort Order button. Enables you to sort the jobs in ascending or descending order. When you hover the mouse over the column header, the Sort Order button is displayed next to column name. By default, the jobs are sorted in the ascending order of Notification/Orchestration Name.

  • Filter field. Search for specific notification or orchestration jobs in the list. The search runs over values in the Notification/Orchestration Name, Schedule Name, User, Environment, and Role fields. You can also filter the jobs based on the Notification ID and the Orchestration ID.

  • Scheduler uptime (d:h:m). Displayed when the scheduler server is running. Displays the duration for which the scheduler has been running in days, hours, and minutes.

    When the scheduler server is not running, the message "Scheduler not started" is displayed. For information on designating the current AIS server as the Scheduler server, see Configuring AIS Server Manager Settings.

    Note:

    If the current AIS server is not designated as a scheduler server, a message "AIS Server not designated as Scheduler" is displayed.
  • Restore button. Updates the notification and orchestration jobs displayed in the table so that the changes to the job information are reflected. For example:

    Jobs could have been started or stopped by another user by using the Scheduler user interface.

    Changes could have been made to the jobs using REST services.

    Changes could have been made to the jobs using the Work With Categories (P980059) application and so on.

    When using the Restore button, the values in the Filter field and drop-down selections are preserved.

  • i (About). Displays a dialog box that provides two sets of information: Scheduler information and JAS server information.

  • Scheduler Server. Indicates whether the AIS server to which you are currently logged-in is designated as a scheduler in Server Manager.

    • Scheduler Information

    • Resilient. Displays whether the scheduler is resilient.

    • Started. Displays whether the scheduler is running.

    • Running Since. Displays the date on which the scheduler started running and the duration for which the scheduler has been running.

    • JAS Server Information

    • Host. Displays the host JAS server URL.

    • Environment. Displays the environment to which the user is currently signed in.

    • Role. Displays the role that the user has currently signed in as.

    Note:

    If the current AIS server is not designated as a Scheduler server and the Scheduler server has been started using REST API, the Scheduler Server, Started, and Running Since fields are displayed in red color indicating that there is a configuration error. Also, you will not be able to start or stop any of the orchestration and notification jobs.
  • Close. Exit the user interface.

Working with Scheduler

Using the Scheduler user interface you can perform the following:

  • Use the Start selected Ascending/Descendingbutton to start anto start an individual or multiple notification and orchestration jobs that you have selected. The Start selected button is enabled only when you select a job from the notification and orchestration jobs list.

    When you click the button, the selected jobs are started and the Scheduler user interface displays the following information in a dialog box:

    • Jobs Selected. Displays the number of jobs that are selected.

    • Jobs Started. Displays the number of jobs that have been started.

    • Jobs in Error. Displays the number of jobs that have errors or were not started.

    • Already Started. Displays the number of jobs that are already running among the selected jobs.

    Alternatively, you can start an individual job by enabling the Start/Stop toggle in the Started column located in each row.

  • Use the Stop selected Ascending/Descendingbutton to stop an individual or multiple notification and orchestration jobs that you have selected. The Stop selected button is enabled only when you select a job from the notification and orchestration jobs list.

    When you click the button, the selected jobs are stopped and the Scheduler user interface displays the following information in a dialog box:

    • Jobs Selected. Displays the number of jobs that are selected.

    • Jobs Stopped. Displays the number of jobs that have been stopped.

    • Jobs in Error. Displays the number of jobs that have errors or were not stopped.

    • Already Stopped. Displays the number of jobs that are already stopped among the selected jobs.

    Figure 4-2 Jobs Stopped

    This image is described in surrounding text.

    Alternatively, you can stop an individual job by enabling the Start/Stop toggle in the Started column located in each row.

    In the following example, the user is currently logged in as JDE, so the JDE user can access all the jobs that have JDE as the value in the User column. The JDE user can start the highlighted job by sliding the "Click to start job" toggle to the right. As the "Demo Get Item Availability" job also has JDE as the user, by sliding the toggle to left the user can stop the job.

    The rest of the jobs in this example are disabled because these jobs have LK as the value in the User column. The toggle in the Running column indicates that the job is already running.

    Figure 4-3 User, Role, and Environment

    This image is described in surrounding text.

    Note:

    You can start only those jobs that are created by the currently logged-in user using the current environment, and the current role that the user is logged-in as. You can stop all the jobs that are created by the currently logged-in user. For the rest of the jobs, the Start/Stop toggle is disabled.
  • Use the Started column to view the status of the notification and orchestration jobs for which you have access.

    Select one of the following values from the Started drop-down menu:

    • All. To view all the notification and orchestration jobs.

    • Started. To view only those notification and orchestration jobs that are currently being executed. This is the default option in the Started drop-down list.

    • Stopped. To view only those notification and orchestration jobs that are currently stopped.

  • Use the Type column to filter the notification and orchestration jobs. The icon in the column indicates if the job is an orchestration Ascending/Descendingor a notification Ascending/Descending.

    You can click the notification or orchestration icon to open the corresponding notification or orchestration. To navigate back to the Scheduler user interface from the notification design page or orchestration, click the Scheduler link in the location link displayed at the top of page.

    Select one of the following values from the Type drop-down menu:

    • All. To view all the notifications and orchestrations.

    • Notifications. To view only the notification jobs.

    • Orchestrations. To view only the orchestration jobs.

  • Use the Product Code column to view the product code that was associated with the notification or orchestration when it was created. The Product Code drop-down menu displays all the product codes for the notifications and the orchestrations in the table.

    Selecting a product code from the drop-down menu displays only the associated notifications and orchestrations.

  • Use the Notification/Orchestration Name column to view the name of the notification and orchestration. When you click the notification or orchestration name, the corresponding description is displayed.

    Use the Filter field to look for specific notifications or orchestrations. Use the Notification/ Orchestration Name sort button to sort the jobs in ascending or descending order of the notifications and orchestrations names.

  • Enable the Auto Start toggle to designate a notification or an orchestration job to automatically start whenever the Scheduler server is started. For information on the autostart job records, see Scheduler Autostart Jobs Manager.

    Note:

    Enabling the Auto Start toggle does not start a job, but only designates the job to be started automatically whenever the Scheduler server is started. Use the Started toggle to start an individual job.
  • Use the Schedule Name column to view the name of the schedule when a notification or an orchestration has an attached schedule. When you click the schedule name, its corresponding description is displayed.

    Select one of the following values from the Schedule Name drop-down menu:

    • All. To view all the notification and orchestration jobs.

    • Schedule. To view only those notification and orchestration jobs that have a schedule attached. This is the default option in the Schedule Name drop-down list.

    • No schedule. To view only those notification and orchestration jobs that do not have any attached schedule.

    Note:

    When you select the No Schedule option for the Schedule Name column, you have to select the All option for the Started column to view the jobs in the list.
  • Click the Info icon to view the information about the job. When you click the Info icon, a dialog box appears displaying two sets of information: scheduled job information and health monitor.

    Scheduled Job Information:

    Displays the following data for the selected job that is associated with a specific user, environment, and role:

    • Notification or Orchestration Name

    • Notification or Orchestration ID

    • UDO Group

    • Last Run

    • Last Run Duration

    • Next Run

    • Total Runs

    • Schedule Name

    • Schedule ID

    • Interval

    • Consecutive Errors

    • % Errors

    • Total Errors

    For the jobs that are not executing currently, only the Notification or Orchestration Name and ID, Schedule ID, and Interval information are displayed.

    Health Monitor:

    Displays high-level information about the performance of the selected job. A bar-chart shows up to the last 10 instances that the job was executed, with each bar representing a single instance. The instances are listed earliest to latest, from left to right. A red bar indicates a failure. A green bar indicates a success. The height of each bar indicates the time taken to process the job. Move your cursor over each bar to see the date and time when the job was executed and the time in seconds taken to complete processing the job.

    For more information, see "Orchestrator Health and Exception Monitoring" in the JD Edwards EnterpriseOne Tools Orchestrator Guide.

    The information that is displayed in the bar-chart for a job is based on the name of the notification or orchestration regardless of the user, environment, and role values.

    As shown in the following example, the Scheduled Job Information section displays the information only for the highlighted job with respect to the specific user, environment, and role. In the Health Monitor section, each bar in the chart could be for any of the instances of the job with the notification name "Demo_Sold to Capital System RAP with Overrides" regardless of the user, environment, or role values.

    Figure 4-4 Info

    This image is described in surrounding text.

    The Info icon indicates an error when the icon is displayed in red.

  • Use the User, Environment, and Role columns to view the user, environment, and roles information for the jobs.

    • User

      The user who created the orchestration or notification. In the case of jobs that are currently executing, the User, Environment, and Role columns display the user who started the job.

    • Environment

      The environment that the user who created the orchestration or notification is signed in to. The environments listed in this column are the environments that are available on the JAS server that is connected to the current AIS server. Therefore, if you log in to a different AIS server, the environments are listed based on the environments that are supported on the JAS server for that AIS server.

    • Role

      The role of the user who created the orchestration or notification.

    Use the drop-down menus to filter the jobs based on user, environment, and role. The user who is currently logged in will not be able to select, start, or stop the jobs that have been created by another user.

    When you have jobs with the same notification or orchestration name running multiple times based on different user, environment, and role combinations, the Scheduler user interface lists the job that is associated with the currently logged-in user, the currently used environment, and current role of this user, as the primary record.

    Next, the jobs that are associated with the currently logged-in user but created in different environments and through other roles are displayed. Followed by the jobs with the same notification or orchestration name, but associated with different user, environment, and role values. These instances of the job with the same name are displayed in italics.

The Orchestrator Studio preserves the options that are selected for the drop-down menus in the Scheduler user interface. The next time you log in, the Scheduler user interface will display the jobs according to the selection made in the previous session.

Note:

For the User drop-down list, only the All Jobs and My Jobs options are preserved.

When you filter a job based on a Role or an Environment, the system preserves the filter values. However, if the next time you log in and no data exists for that selection (for example, you filtered based on a role that no longer has any jobs that are currently executing), the drop-down menu will display the value All.

Starting and Stopping Jobs using Scheduler

Using the Scheduler user interface, you can start and stop the notification and orchestration jobs that have a schedule attached.

To start an individual job:

  1. Open the Scheduler user interface.

  2. Select the notification or orchestration job you want to start.

    Note:

    You can only start the jobs that are associated with the currently logged-in user, the currently used environment, and the user's current role. The currently logged-in user cannot start the jobs that are created by another user.
  3. For the selected job, slide the toggle to the right in the Started column.

    Alternatively, you can click the Start selected button to start the selected job.

To start multiple jobs:

  1. Open the Scheduler user interface.

  2. Click the check box next to the Type column to select the jobs you want to start, or click the Select All check box to select all the jobs.

    Note:

    You can only start the jobs that are created by the currently logged-in user, the currently used environment, and the user's current role. The currently logged-in user cannot start the jobs created by another user.
  3. For the selected jobs, click the Start selected button to start the jobs.

To stop jobs:

  1. Open the Scheduler user interface.

  2. Select the notification or orchestration jobs you want to stop.

    Note:

    You can stop all the jobs that are created by the currently logged-in user, regardless of the environment in which the user is logged in, and role the user is logged in as. The currently logged-in user cannot stop the jobs created by another user.
  3. For the selected jobs, click the Stop selected button to stop the selected jobs.

    To stop an individual job, slide the toggle to right in the Started column for selected row.

Scheduler Autostart Jobs Manager

The Scheduler Autostart Jobs Manager (P980059) is an EnterpriseOne application that provides information about notification and orchestration jobs that are automatically started when the Scheduler server is started.

With the Scheduler Autostart Jobs Manager application, you can view and manage the notification and orchestration jobs that are automatically started by the Scheduler for all the users, roles, and environments.

Note:

For the jobs to be automatically started, the JAS server must be running before the AIS server is started.

For information on designating the current AIS server as a Scheduler server, see Configuring AIS Server Manager Settings.

Accessing the Scheduler Autostart Jobs Manager

You can access the Scheduler Autostart Jobs Manager application from EnterpriseOne.

In EnterpriseOne, click Navigator, and select EnterpriseOne Menus, EnterpriseOne Life Cycle Tools, Orchestrator Management, and Scheduler Autostart Jobs Manager (P980059). Alternatively, you can type P980059 in the Fast Path and press the Enter key to access the Scheduler Autostart Jobs Manager application.

If the Scheduler Autostart Jobs Manager does not display the information about the jobs that are automatically started, contact your system administrator and request UDO view security access to the orchestrations and notifications.

Managing Scheduler Autostart Jobs in EnterpriseOne

EnterpriseOne stores autostart job records in the Scheduler Autostart Jobs (F980059) table. When you enable the Auto Start toggle for a notification or an orchestration job on the Scheduler user interface, a record is added to the Scheduler Autostart Jobs (F980059) table and the Scheduler Autostart Jobs Manager application (P980059). Whenever the AIS server that is designated as a Scheduler server is started, the Scheduler refers to the Scheduler Autostart Jobs (F980059) table to automatically start the jobs.

When you slide the Auto Start toggle to left for a job on the Scheduler user interface, the corresponding record is deleted from the F980059 table and the P980059 application.

EnterpriseOne provides the Scheduler Autostart Jobs Manager application (P980059) so that you can access these autostart job records outside the Scheduler user interface. This application enables you to delete the notification and orchestration jobs that you no longer want to automatically start. These notification and orchestration jobs could have been created by any user. Deleting a record from the P980059 application, sets the Auto Start toggle for the corresponding job to Off on the Scheduler user interface.

Note:

Before managing the autostart job records in EnterpriseOne, ensure that an administrator has enabled access to the Scheduler Autostart Jobs Manager application (P980059).

To view autostart job records in EnterpriseOne:

  1. From the EnterpriseOne Navigator, select EnterpriseOne Life Cycle Tools, Orchestrator Management, and Scheduler Autostart Jobs Manager (P980059).

  2. In the Work with Scheduler Autostart Jobs form (P980059_W980059A), click Find to load all the records.

  3. You can also search for autostart job records based on the values that you enter in the following fields:

    • Object Type

    • UDO Name

    • Environment

    • Product Code

    • User

    • Environment

    • Role

To delete an autostart job record:

  1. In the Work with Scheduler Autostart Jobs form, click the check box next to the records you want to delete.

  2. Click Delete.

Using Notifications with Orchestrator Studio 8

You can use the Orchestrator Studio 8 to edit and save changes to the existing notifications. You can not create new notifications using the Orchestrator Studio 8.