4 Creating Notifications with Orchestrator Studio

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

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).

Notifications also have a graphical representation in Orchestrator Studio similar to orchestrations.

For more information, see:

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

  • Notifications. A notification is a master component 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 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 master component 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 design pages and determine the actions Orchestrator Studio users can perform. See Chapter 7, "Managing Notifications and UDO Security" for more information.

To access the Orchestrator Studio:

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

    http://<adf_server>:<port>/OrchestratorStudio/faces/index.jsf

  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 view the path to the AIS Server. The drop-down menu also provides a 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. You can click the Home icon at the top left of the Home page to display a side panel, which provides another way to access the component design pages. You can also access this side panel within the component design pages for easy navigation between the different design pages. Figure 4-1 shows the Home page with the side panel enabled.

Figure 4-1 Orchestrator Studio Home

This image is described in surrounding text.

The Tools link in the upper-right corner of the Home page provides access to the Orchestrator Studio Tools page. This page provides links to the Schedule design page for creating schedules, Orchestrator Client for testing orchestrations, the Import tool for importing orchestration files, and the JD Edwards EnterpriseOne web client. 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.

> Tutorial:

Click on one of these titles to view tutorials for this feature:

> Creating a Simple Notification

> Creating a Notification Based on a Watchlist

> Creating a Notification Based on an Orchestration

To create a notification:

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

  2. On the Notifications page, click the New Notification button.

  3. On the Notification design page, enter a unique name for the notification in the Notification 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 space provided, 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. Select the Run As Subscriber option 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. Select the Allow Subscriber Overrides option if you want to give subscribers the ability to enter override values for the notification inputs in Subscription Manager.

    This option is only available if you have selected Run As Subscriber in the previous step. Starting with Orchestrator Studio 6.1.0, this option is available regardless of how the Run As Subscriber option is set.

  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 use the 'Where Used' functionality of Orchestrator studio 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. Open the Notification Input 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 desired.

  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 Notification Type Only)

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

To add a Watchlist to a notification:

  1. Open the Watchlist section of the notification design form.

  2. Select the Watchlist from the Watchlist drop-down menu.

  3. 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 Notification Type Only)

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

To add an orchestration to a notification:

  1. Open the Orchestration section of the notification design form.

  2. Select the orchestration from the Orchestration drop-down menu.

    A list of orchestration inputs appears.

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

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

  5. 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. Open the Rule section of the notification design form.

  2. Select the rule from the Rule drop-down menu.

    A list of rule inputs appears.

  3. 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.

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

  5. 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 a shortcut to an application, and to add a Data Dictionary text item.

To define the notification message:

  1. Open the Message section of the notification design form.

  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 6.

    Note:

    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.

    Note:

    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 Text section.

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

    3. If the message template contains variables, use the grid below it to override the variables with text substitution.

  5. To include a shortcut to an application:

    1. Expand the JD Edward EnterpriseOne Shortcut section.

    2. Complete the Application, Form, and Version fields to specify the form that you want the shortcut to launch.

    3. Click Load. Starting with Orchestrator Studio 6.1.0, this button was removed as it is no longer necessary to "load" the shortcut.

    4. In the Link Text field, enter the text you would like to appear in the message for the shortcut. This shortcut text appears when users access the notification message from the Notification List icon on the EnterpriseOne menu bar, but it does not apply to email or Work Center messages.

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

  6. 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.

  7. 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. Open the Schedule section of the notification design form.

  2. Use the Schedule drop-down menu to select an existing schedule.

    OR

    Click the New Schedule button to create a new schedule.

    See Creating Schedules for more information.

    Note:

    Schedules are UDOs so you must have the proper permissions to see the New Schedule button.
  3. 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.

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 Tools link in the upper-right corner.

  2. On the Tools page, click the Schedules icon.

    The Orchestrator Studio displays the Schedules design page.

  3. Click the New Schedule button.

  4. In the Schedules field, enter a name for the schedule.

  5. 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.

  6. In the space provided, 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.

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

  8. Do one of the following:

    • In the Schedule to Run 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.

  9. 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.

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: