Design Specification for Correlation, Event Map and Policy Rule User Interface , Integration Platform

Project ID: Integration Platform

Author: Jian Zhang

 
Change Log
Version Reviewers Changes
10/07/02 Jian Zhang  Creation

 

Review and Approval

The reviewers should have the technical knowledge and authority to state that the project is doing the right thing. If they do not have the authority and knowledge to do this, then they should not be on a review team. (This restriction is for formal technical reviews that determine acceptance. The author is always free to call for informal peer reviews to obtain guidance without approval.)

A formal technical review ends with accepting or not accepting the reviewed product. The review team accepts the document when they believe it is right. Right means that the design meets all of the functional requirements and can be implemented within the feature schedule and resources. Update the title page "Status" line to Approved when all issues are resolved and the document is ready for source control.

Table of Contents

1 Introduction

2 High Level Design

2.1 System Placement
2.2 Top Level Design
2.3 Patentable Design
3 Design Description
3.1 Correlation, Event Map and Policy Rule Design
3.1.1 Correlation, Event Map and Policy Rule Description
3.1.2 Correlation, Event Map and Policy Rule Task List
3.1.3 Correlation, Event Map and Policy Rule Page Hierarchy
3.1.4 Common Page Design
3.1.5 Correlation, Event Map and Policy Rule Screen Design
                       3.1.5.1 Correlation
                       3.1.5.2 Event Map
                       3.1.5.3 Policy Rule

 Appendix A - References

 Appendix B - Glossary

 Appendix C - Design Decisions

 Appendix D - Open Issues
 
 

1 Introduction

This section provides some background on the project and briefly explains why it is being developed. The audience for this document is Oracle internal developers and maintainers of code. You may wish to copy this paragraph from the Overview Section of the Functional Specification. Following are some examples of things you might want to say; feel free to add, modify, or delete as you see fit.

This document is the Design Specification (2002-10-07, Review Draft  version) for the Correlation, Event Map and Policy Rule User Interface of the Integration Platform. It explains the architecture and detailed design of the Correlation, Event Map and Policy Rule User Interface to internal Server Technologies developers and other development people with a need to understand how the project will be implemented.

It is assumed that readers of this Design Specification have read and are familiar with the contents of the following documents:

2 High Level Design


2.1 System Placement

This document describes the user interface which provides correlation, event map and policy rule  functionality for the Integration
Platform.
 

2.2 Top Level Design

Please see the Integration Platform documents listed in section 1 for a description of the UI Framework, BLL interaction, validation, query filters, design guidelines, etc.

This document is strictly concerned with the design of the user interface for correlation, event map and policy rule functionality. This design assumes that the correlation, event map and policy rule user interface will be implemented using the same HTML component stack as other portions of the Integration Platform user interface. Describe the projects in terms of the major functional component pieces. Each functional component piece will be further defined in section 3.

2.3 Patentable Design

No patentable designs noted.

3 Design Description


3.1 Correlation, Event Map and Policy Rule Design

Please note that the screen shots in this document do not include any overall Integration Platform tool navigation structure. Also, wizard for creating native event types will be included since define an event map may logically flow from creating native event types.

In addition, the language of the user interface of correlation, event map and policy rule does not match 1 to 1 with the IP model.

3.1.1 Correlation, Event Map and Policy Rule Description

The user interface of correlation, event map and policy rule  is a tool that provides a way for a user to define correlation, event map and policy rule for the Integration Platform. Refer to Functional Specification for the Correlation Event Map and Policy Rule Supportfor a description of those functionalities

3.1.2 Correlation, Event Map and Policy Rule Task List

Correlation

Event Map

Policy Rule


3.1.3 Correlation, Event Map and Policy Rule Page Hierarchy

Correlation


 

Event Map

Policy Rule


 

3.1.4 Common Page Design

Delete

Unless otherwise noted, the delete of correlation, event map and policy rule objects follows the convention of other IP objects. The user is prompted to verify that the delete should occur.

3.1.5 Correlation, Event Map and Policy Rule Screen Design

Screen design for each screen in the Correlation, Event Map and Policy Rule UI is broken out into

3.1.5.1 Correlation

3.1.5.1.1 Correlation List

3.1.5.1.1.1 Screen Shots


This screen will list the correlations that exist in the system. It will be a part of an another screen that list all native events, located at Modeling / Event Types / Native Event Types.

3.1.5.1.1.2 Implementation Details / Assumptions / Notes
Implementation Details

3.1.5.1.2 Create Correlation

Creating correlation is done in a wizard-like fashion. The first step is to select correlating and correlated native event types. The second step is to create condition. The screen of creating condition are similiar as hose of  transformation condition. Refer to Design Specification for Transformation User Interface, Integration Platform.

3.1.5.1.3 Create Correlation - Select Native Events

3.1.5.1.3.1 Screen Shots

 
3.1.5.1.3.2 Implementation Details / Assumptions / Notes
Implementation Details

3.1.5.1.4 Create Correlation - Create Condition ( Initial Screen )

3.1.5.1.4.1 Screen Shots



 

3.1.5.1.4.2 Implementation Details / Assumptions / Notes
Implementation Details

3.1.5.1.5 Create Correlation - Create Condition Expression

3.1.5.1.5.1 Screen Shots



 

3.1.5.1.5.2 Implementation Details / Assumptions / Notes
Notes

3.1.5.1.6 Create Correlation - Create Condition ( final Screen )

3.1.5.1.6.1 Screen Shots

 
3.1.5.1.6.2 Implementation Details / Assumptions / Notes
Implementation Details

3.1.5.1.8 Correlation Details

3.1.5.1.8.1 Screen shots

 
3.1.5.1.8.2 Implementation Details / Assumptions / Notes
Implementation Details

3.1.5.1.9 Update Correlation Condition

3.1.5.1.9.1 Screen shots


3.1.5.1.9.2  Implementation Details / Assumptions / Notes
Notes:

The same as Create Correlation - Create Condition  except that the condition is specified.

3.1.5.2 Event Map

3.1.5.2.1 Native Event Type Detail

This screen will show the event map for that native event type that exist in the system.
 
3.1.5.2.1.1 Screen Shots
When no Event Map is defined, the contents under the header will be "No event map defined for this native event." and Create button
 
 

When an Event Map is defined, the contents under the header will be the value of the condition and Delete and Update buttons
 

3.1.5.2.1.2 Implementation Details / Assumptions / Notes

 

3.1.5.2.2 Create Event Map

3.1.5.2.2.1 Screen Shots



 
 
 

3.1.5.2.2.2 Implementation Details / Assumptions / Notes


Notes:

3.1.5.2.3  Create Event Map - Create Condition Expression

3.1.5.2.3.1 Screen shots



 

3.1.5.2.3.2 Implementation Details / Assumptions / Notes
 Implementation Details

3.1.5.2.4 Update Event Map Condition

3.1.5.2.4.1 Screen shots

 
3.1.5.2.4.2  Implementation Details / Assumptions / Notes


3.1.5.3 Policy Rule

3.1.5.3.1 Policy Rule List

3.1.5.1.3.1.1 Screen Shots
This screen will list the policy rules that exist in the system. It will be a part of an another screen of  native event type details, located at Modelling / Event Types / Native Event Types.
 3.1.5.3.1.2  Implementation Details / Assumptions / Notes
Implementation Details

3.1.5.3.2 Create Policy Rule

Working against application event types, thus the native event must first be translated. implying restriction that the translation must be identified before policy rule. Create a policy rule  is done in a wizard-like fashion. The first step is to select a port owned by a native role.  The second step is to create
condition. The screen shots of creating condition are customized from those of transformation condition. Refer to Design Specification for Transformation User
Interface, Integration Platform.  The third step is to review the policy rule.

3.1.5.3.3 Create Policy Rule - Select Port

3.1.5.3.3.1 Screen shots
3.1.5.3.3.2  Implementation Details / Assumptions / Notes
  • The user selects from a list of native roles already defined in the system
  • After selecting native rules,  LOV of port is refreshed to a list of ports owned by this native role.
  • Make an association between PolicyRule and Port
  • Policy rule name is an extended property which identify the policy rule and is listed in the policy rule table.
  • Cancel button will take the user to the screen that lists the policy rule
  • Next button will take the user to the next step.

    • 3.1.5.3.4 Create Policy Rule - Create Condition

    3.1.5.3.4.1 Screen shots



     

    3.1.5.3.4.2  Implementation Details / Assumptions / Notes
    Implementation Details

    3.1.5.3.5 Create Policy Rule - Create Condition Expression

    3.1.5.3.5.1 Screen shots



     
     

    3.1.5.3.5.2 Implementation Details / Assumptions / Notes
    Implementation Details

    3.1.5.3.6 Create Policy Rule - Review

    3.1.5.3.6.1 Screen Shots



     

    3.1.5.3.6.2  Implementation Details / Assumptions / Notes
    Implementation Details
     


    Notes

    3.1.5.3.7 Policy Rule Details

    3.1.5.3.7.1 Screen shots
    3.1.5.3.7.2 Implementation Details / Assumptions / Notes
    Implementation Details

    3.1.5.3.8 Update Policy Rule Condition

    3.1.5.3.8.1 Screen shots


    3.1.5.3.8.2 Implementation Details / Assumptions / Notes
    Notes:

    The same as Create Policy Rule - Create Condition  except that the condition is specified.

    Appendix A - References


    No references noted

    Appendix B - Glossary


    No terms noted

    Appendix C Design Decisions


     


    Appendix D Open Issues


     

    Review Sheet


     
    Comments
    # Section Comment Severity A/B/C Action Taken
    01 3.1.5.1.1.1 - Correlation List
    1. The Detail column should be Details
    2. The content of the Details column should be the details icon and not the correlation expression
    3. There should be an Update column with an Update icon that takes the user to Update Correlation page
    		 B  yes
    02 3.1.5.1.1.2 If there is only one native event in the system is the Create button enabled? B  No
    03 All 2 step processes The BLAF guidelines for multi-step processes that only have 2 steps do not use the standard wizard buttons (after further review). 
    • No train is used for 2 step processes
    • A review step is optional - after looking at the screens shots involved and the lack of complexity to the review step, I believe the review step is not necessary
    • The first page buttons should be Cancel Continue. A Return to X link can be put as the return navigation for the first step of the 2 step process (optional).
    • The second page buttons should be Cancel Back Finish.
    		 A
  • Train is not used. 
  • No review page 
  • The first page buttons should be Cancel Next Step 1 of  2
  • The second page buttons should be Cacel Back Finish Step 2 of 2 

    •  
    03 3.1.5.1.3.1 - Create Correlation - native events
    1. No train
    2. Header should read - Create Correlation: Native Event Types
    3. Prompt should read - Please specify the native event type for the correlation and choose Continue.
    4. Page buttons should be Cancel Continue
    		 A  yes except page buttons 
    see # 03
    04 3.1.5.1.4.1 - Create Correlation - condition
    1. No train
    2. Header should read - Create Correlation: Correlation Condition
    3. Prompt should read - Please create the condition for the correlation and choose Finish.
    4. Page buttons should be Cancel Back Finish
    5. After the prompt and before the "Use the table" line - put in the following context information.

      6.  

       
       
       
       
       
       
       
       
       

      Correlating Native Event Type XXX 
      Correlated Native Event Type XXX 

      where the controls are aligned properly (prompts right aligned) and the data is styleClass="OraDataText".

    		 A  yes
    05 3.1.5.1.4.2 Is this truly an optional step in the process? What does it mean to create a correlation without the condition? I personally don't think it should be optional. Even though the model allows for the condition expression to be specified separately, the definition of a correlation is 2 native events and a condition expression. 

    If it is optional, what is the text and where is it placed for showing the user that it is optional?

    		 B  not an optional step
    06 3.1.5.1.5.1 - Create condition expression
    1. Default the radio button to 1 of the 2 values
    2. The prompt should read - Select the native event type item, the operator and specify a constant value or select the correlated native event type item and select Apply.
    3. Right Operand header should be - Value
         		 B  yes
    07 3.1.5.1.6.1 Same comments at in 04 above A  yes
    08 3.1.5.1.7.1 - review screen Not needed with new 2 step process outlined above B  yes
    09 3.1.5.8.1 - Correlation Details Items with links do not take user to an update screen - they navigate to a details or list screen (unless the link specifically states Update) 
    1. Change the value for the condition - to value (but no link)
    2. Add an Update button to the page level buttons (just like any other Update). This will take the user to the Update Correlation page. 
    		 B  yes
    10 3.1.5.1.9.1 - Update Condition Should be Update Correlation not simply Update Condition. Change the design of this page so it is a normal update page. 
    1. Header is Update Correlation
    2. In a table layout put read only controls for -

      3.  

       
       
       
       
       
       
       
       
       

      Correlating Native Event Type XXX 
      Correlated Native Event Type XXX 

      where the controls are aligned properly (prompts right aligned) and the data is styleClass="OraDataText". 
       

    3. Have a Condition header section with the current content
    		 A  yes
    11 3.1.5.2 Can you create an event map outside of the native event creation wizard? Seems like you should be able to. Is there a reason this is not allowed? 

    If allowed - 

    1. where would the create be launched from? This affects the design of this entire section. Is there a separate Event Maps table on the Native Events page? What does this table look like? Or is the create launched from the details page of a specific native event? (probably)
    2. what does the create page/pages look like?
    		 A  redesign event map
    12 3.1.5.2.1.1 - Native Event Types Regardless of the outcome of 10 above, the native event type list doesn't work well. The Event Map column is confusing - it seems to indicate by the Unspecified in the second row that an Event Map should or needs to be created. I don't believe this is the case. 

    If there is no event map, the cell should be blank (should not read unspecified) 

    As in 09 above, links do not take users to an update screen. The Event Map value in the column should not be a link. You will update the event map condition from the native event details screen. In addition, what happens when/if the condition becomes very lengthy? It could be an item that should not be placed in a table. Perhaps we need to indicate that an event map is present (Event Map Exists?) but not what the condition is.

    		 A  redesign event map
    13 3.1.5.2.2.1 - Create Event Map How many pages will the "create native event" process be (from the spec it looks like create event map is a part of this process). Is it a 2 step or 3+ step process? I need to know this before reviewing this section. 

    If it is a 3+ step process, the train should change to be nouns instead of verbs like what was shown in the modeling wizards. I will need to discuss when the overall native event creation is formalized. 

    It appears that this step is truly optional - the user did not choose to create an event map, they chose to create a native event, 1 step of which is specify an event map. Therefore, the prompt should read - Please create the condition for the event map and choose Next. If no event map is necessary, simply choose Next. 

     

    		 A  # of pages depends on # of event body elements, at least 1 event body element, 
    Create native event at least 2 steps. 
    14 3.1.5.2.2.1 - Create Event Map
    1. The prompt should read - Please create the condition for the event map and choose Next.
    2. After the prompt and before the "Use the table" line - put in the following context information -

      3.  

       
       
       
       
       
       
       
       
       

      Native Event Type XXX 

      where the data is styleClass="OraDataText".

    		 B  yes
    15 3.1.5.2.2.2 You state - "For the outbound native event map, the event map is implicit. The user should definitely skip this step." Which step, what are you referring to? If the step should be skipped why even have one? B  There is no eventmap for outbound native event. Therefore this step will be skipped for outbound native event creation
    16 3.1.5.2.3.1 - Create Condition Expression
    1. exist should be Exists
    2. The prompt should read - Select the native event type item, the operator and specify the constant value and select Apply.
    3. Right Operand header should be - Value
    		 B  yes
    17 3.1.5.2 How do you delete an event map from a native event? Where do you invoke this? A  redesign event map
    18 3.1.5.2.4.1 - Update Condition Should be Update Event Map not simply Update Condition. Change the design of this page so it is a normal update page. 
    1. Header is Update Event Map
    2. In a table layout put read only controls for -

      3.  

       
       
       
       
       
       
       
       
       

      Native Event Type XXX 

      where the controls are aligned properly (prompts right aligned) and the data is styleClass="OraDataText". 
       

    3. Have a Condition header section with the current content
    		 A  yes
    19 Native Event Details I believe activity for an Event Map should result from the Native Event Details screen. This is not detailed in this spec. 
    1. Where is the Event Map section on the details page?
    2. How do you launch the update an Event Map?
    3. How do you delete an Event Map?
    I believe there will be a Event Map header section on the Native Event details screen. 

    When no Event Map is defined, the contents under the header will be "No event map defined for this native event." and a Create button will be right aligned under the header (not a page level button but a section level button) 

    When an Event Map is defined, the contents under the header will be a prompt of Condition and the value of the condition. Delete and Update buttons will be right aligned under the header (not page level buttons but section level buttons)

    		 A  redesign event map
    20 3.1.5.3.1.1 - Policy Rule List Where is the Update column? This entity has a name that can be changed - perhaps the role and port cannot be changed but the name can. A  N/A
    21 3.1.5.3.3.1 - Create Policy Rule - select port
    1. No train
    2. Header should read - Create Policy Rule: Role Port
    3. Prompt should read - Please specify the native role and port for the policy rule and choose Continue.
    4. Page buttons should be Cancel Continue
    		 A  N/A
    22 3.1.5.3.4.1 - Create Policy Rule - create condition
    1. No train
    2. Header should read - Create Policy Rule: Policy Rule Condition
    3. Prompt should read - Please create the condition for the policy rule and choose Finish. 
    4. Page buttons should be Cancel Back Finish
    5. After the prompt and before the "Use the table" line - put in the following context information.

      6.  

       
       
       
       
       
       
       
       
       

      Native Role XXX 
      Port XXX 

      where the controls are aligned properly (prompts right aligned) and the data is styleClass="OraDataText".

    		 A  N/A
    23 3.1.5.3.4.2 Is this truly an optional step in the process? What does it mean to create a policy rule without the condition? I personally don't think it should be optional. Even though the model allows for the condition expression to be specified separately, the definition of a policy rule is a native role port and a condition expression. 

    If it is optional, what is the text and where is it placed for showing the user that it is optional.

    		 B  N/A
    24 3.1.5.3.5.1 - Create Condition Expression What makes up the left operator? 

    You selected a native role and port on the previous screen and what is being shown here? A native event type? Where was this selected? This is very confusing. 

    • What is the contents of the Left Operand. The header for this should be like other pages - Native Event Type or whatever.
    • The prompt should read - Select the xxx, the operator and specify the constant value and select Apply.
    • Right Operand header should be - Value
    • value should be Constant Value to match the other pages
    • What is in drop down list of operator? Only =? If only = should not be drop down list. Should simply be = sign. Then, the prompt would need to change.
         		 A  N/A
    25 3.1.5.3.6.1 - Create Policy Rule - review Not needed with new 2 step process outlined above A  N/A
    26 3.1.5.3.7.1 - Policy Rule details Items with links do not take user to an update screen - they navigate to a details or list screen (unless the link specifically states Update) 
    1. Change the value for the condition - to value (but no link)
    2. Add an Update button to the page level buttons (just like any other Update). This will take the user to the Update Policy Rule page. 
    		    N/A
    27 3.1.5.3.8.1 - Update Condition Should be Update Policy Rule not simply Update Condition. Change the design of this page so it is a normal update page. 
    1. Header is Update Policy Rule
    2. In a table layout put read only controls for -

      3.  

       
       
       
       
       
       
       
       
       

      Native Role XXX 
      Port XXX 

      where the controls are aligned properly (prompts right aligned) and the data is styleClass="OraDataText". 
       

    3. Have a Condition header section with the current content
    		 A N/A 

    Severity

    A: Major issue, requires document to be re-reviewed
    B: Minor issue, need to be addressed in document
    C: Comment
    General Comments
    # Comment Action Taken

     
     
     

    Copyright, 1999 Oracle Corporation
    Last Modified: Tuesday, Oct. 29, 2002