A Using RIAF for Generic URLs (Release 9.1)

This appendix replaces the Using RIAF for Generic URLs chapter if you are currently using Release 9.1 with no updates.

This appendix contains the following topics:

A.1 Understanding Related Information Application Framework for Generic URLs

The Related Information Application Framework (RIAF) for External Web Applications enables authorized JD Edwards EnterpriseOne users to associate an external website URL (also referred to as a generic URL) to a JD Edwards EnterpriseOne application form without involvement from development. This association is accomplished by an enabled user opening an enabled JD Edwards EnterpriseOne application form in RIAF and creating a tab page that contains the website URL. The same website URL can be reused and shared by multiple end users in multiple transactions on the same application form.

Your system administrator determines whether you can create new generic URL tab pages or whether you can only view existing generic URL tab pages for the environment, form, version combination. If you have permission to create a generic URL tab, your system administrator also determines whether the tab you create can be published for viewing to a list of predefined users or is available to only you. If you have permission to publish your generic URL, the system administrator determines if it can be published as soon as it is created and saved or whether the URL needs to be manually approved for publishing. Each application form for which the generic URL feature is available must be enabled by your system administrator with user or role, environment, form, and application version combination.

Note:

Unless your system administrator has established other procedures, notify your system administrator when you have created a new generic URL that you want published.

A.1.1 Understanding Generic URLs

The generic URL is a parameterized URL. A parameterized URL contains parameters that are dynamic parts of the URL that can be linked to form-level text fields (key fields) on the open application form. A key field is a text field with a value. When a URL parameter is linked to a key field, the content or reference of the generic URL is changed when you change the value of the key field on the open application form and then click Refresh on the RIAF Title bar.

The following is an example of a generic URL:

http://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=zipcode&ie=UTF8&t=h&z=15&utput=embed

The italics part of the URL contains dynamic parameters. The zipcode parameter is mapped to an EnterpriseOne form-level field. If the content of the form-level field is 80111, the following URL replaces the original URL when you click Refresh.

http://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=80111&ie=UTF8&t=h&z=15&utput=embed

A.1.2 Enabling RIAF

Your JD Edwards EnterpriseOne system administrator enables users and forms for collaboration in RIAF and grants specific permissions for creating, viewing, and publishing generic URL tabs. Authorized users create, publish, and view generic URL tabs in RIAF.

You are an authorized user when your system administrator enables you, or a role to which you are a member, an environment, and an application form and version to the GenericURL product type. When you open the specified form and application version within the specified environment, you will see the Related Information Application Framework. If the Related Information Application Framework does not appear, verify that the Hide Related Information option in the EnterpriseOne Menu, Preferences section is cleared. This option is located in the EnterpriseOne menu, under the Preferences section.

Before RIAF appears in your web client browser window, these conditions must exist:

  • You are enabled for viewing or creating generic URLs.

  • The environment, application form, and application version are enabled for your access.

  • The Hide Related Information option is cleared.

The JD Edwards EnterpriseOne application form and the Related Information Application Framework share vertical space on your web client browser window. You can manage the Related Information Application Framework in the following ways:

  • Adjust and store the layout of the Related Information Application Framework.

  • Show and hide the Related Information Application Framework.

Chapter 2 discusses the initial layout of the Related Information framework and provides instructions for adjusting the height of the Related Information framework and for hiding and showing the Related Information framework.

See Understanding RIAF

A.1.3 Using RIAF

If your system administrator has granted you permission to create generic URLs, the Related Information bar shows a Create Tab icon. If your system administrator has granted you viewing permission only, the Create Tab icon is not available. A Refresh Tab Page icon also appears on the Related Information bar. Generic URL tab pages that you create or are permitted to view appear on the Related Information bar as a tab. The first time you open an enabled application form, the Related Information Welcome page appears. The Welcome page explains how to add a new generic URL if you have permission, and also warns you about embedding website URLs that are not trusted or that are copyright protected. Adding a new generic URL is discussed in the Creating a URL Tab section.

RIAF provides the following features, which are discussed in detail; however, whether you can perform the feature depends on the permissions your system administrator has granted you:

  • Create a URL tab

  • View a URL tab

  • Inspect the details of a URL tab

  • Edit a URL tab

  • Remove a URL tab

  • Organize URL tabs

The following example shows the layout of the JD Edwards EnterpriseOne application form and the Related Information framework after the user has created several generic URL tab pages:

Description of image009.gif follows
Description of the illustration image009.gif

A.2 Creating a URL Tab

If you have permission to create generic URL tab pages, the first time you open an enabled JD Edwards EnterpriseOne form, version, and environment combination, the Related Information Application Framework Welcome page appears showing a Create Tab icon. Clicking this icon opens the Create Generic URL page in the Related Information framework. You use this page to create and save a URL tab. The Create Generic URL page is grouped into three sections:

  • Generic URL Information.

  • Select the fields to define when to display Generic URL.

  • Define URL Parameters.

The Select the fields to define when to display Generic URL and the Define URL Parameters sections each have a capture mode. You can use both capture modes when creating the URL tab, but you can use only one of these capture modes at a time.

A.2.1 Generic URL Information

To create a URL tab, you must enter a name for the tab in the Name field. Because the system dynamically changes the width of existing tabs as you create new tabs, you should enter a short name. You can include extra information in the Description field. After you create and save the URL tab, the description appears on the tab page toolbar when you open the tab. Entering information in the Description field is optional. You must enter a valid website URL in the URL field. When you enter a URL into the URL field, the website is embedded in JD Edwards EnterpriseOne. You must follow these rules when entering a URL:

  • The URL must start with http:// or https://.

  • The URL must be to a trusted website.

  • Embedding links to only trusted websites helps to avoid the introduction of undesirable content into JD Edwards EnterpriseOne.

  • The URL must be able to be rendered within a browser iFrame. This is discussed in more detail in the Validate the Template URL section.

  • The URL must not be to a website that has content that is copyright protected.

  • The URL must not be to the JD Edwards EnterpriseOne HTML server.

This could cause JD Edwards EnterpriseOne to malfunction.

After you enter the website URL, click Validate to verify that the URL you entered is valid. If the system determines that the website in not valid for embedding into JD Edwards EnterpriseOne, Save is disabled.

This URL is also called a template URL or a parameterized URL and is used by JD Edwards EnterpriseOne to generate URL parameters for mapping to EnterpriseOne.

After entering the tab information, you can click Save to create the URL tab, or you can continue with another section on the Create Generic URL page. If you save now, without mapping URL parameters to EnterpriseOne, the URL becomes a static resource and does not change dynamically when you change the values on the application form. Mapping URL parameters is discussed in the Define URL Parameters section.

A.2.2 Select the Fields to Define when to Display Generic URL

Defining a JD Edwards EnterpriseOne key field is optional. An EnterpriseOne key field is a text field and its value. You can link the URL to one or more key fields on the form. These links are called context links because you are associating information in the text field to the URL. This information tells the system when to open a tab page. In order for a URL tab to appear in the Related Information bar, the values that you enter in the open EnterpriseOne application form must match the values that you previously defined in the key field. If you defined multiple generic URLs with the same EnterpriseOne key field, each generic URL appears on the Related Information framework as a tab page. If you do not define an EnterpriseOne key field, the URL is linked to the application form in general and when the form is opened, the tab appears in the Related Information bar.

To define a JD Edwards EnterpriseOne key field

  1. On the Create Generic URL page, in the Select the fields to define when to display Generic URL area, click the Start Key Capture icon.

    You can select one or more text fields and their values on the application form to define EnterpriseOne key fields that link the application data and the generic URL.

    During the capture phase, a key indicator, which appears as a green box, shows the text fields that you select.

    You can capture only header fields as EnterpriseOne key fields. Data privacy fields, password fields, hidden text, fields with wildcard values, and grid cells cannot be captured.

    As you capture fields, the system displays a table of the data dictionary aliases and values of the fields that you select as EnterpriseOne key fields.

  2. After you define all of the desired EnterpriseOne key fields on the application form, click Stop Key Capture.

  3. Click Save.

    You can cancel this process by clicking Close instead of Save.

A.2.3 Define URL Parameters

Defining URL parameters is optional. Most of the URLs contain candidate contextual parameters. You can pass content from the EnterpriseOne form-level fields to the URL parameters by selecting Override Parameter.

When you select Override Parameter, the JD Edwards EnterpriseOne system formats the URL candidate contextual parameters into table format, and the original URL appears at the bottom of the Related Information pane. When you finish mapping a URL parameter to a form-level field, the value of the form-level field appears in the URL at the bottom of the Related Information pane. If you want to see the original URL, clear the Override Parameter option.

URL parameter mapping enables you to dynamically change the parameters of the URL by changing the value of the EnterpriseOne form-level field. When you change a field that is mapped to a URL parameter, you must manually refresh the Related Information framework by clicking the Refresh icon. After Refresh, the URL reflects the new parameter value. When a URL contains multiple parameters, you can map multiple fields on the form to multiple parameters. If you want to change a mapping, just change the Configuration column to remains as to reset the value to the default mapping, and then start a new mapping by changing the Configuration column to is mapped to.

To map URL parameters to EnterpriseOne form-level fields:

  1. On the Create Generic URL page, select the Override Parameter option under the Define URL Parameters area.

    The system lists the URL parameters on the Create Generic URL page. The list is in a three-column table:

    • Parameter column lists the URL parameters.

    • Configure column provides a drop-down list from which you choose whether to map a parameter to a field on the current EnterpriseOne form or leave it as is.

    • Parameter Value column shows the value of the form field that is mapped to the parameter.

  2. Select one of the URL parameters.

  3. Change the Configuration column to is mapped to.

    This action starts the capture mode.

  4. Click a valid form-level field on the open EnterpriseOne form.

    This action stops the mapping mode.

    A valid form-level field is a text field and value in the header area of the form. Data privacy fields, password fields, hidden text, fields with wildcard values, and grid cells cannot be mapped.

    After you finish mapping a parameter, the contextual parameter indicator, which is an orange highlight, appears in the EnterpriseOne form-level field, in the parameter value field in the mapping area, and as a parameter in the generic URL.

A.2.4 Validate the Template URL

Validating the template URL is optional, but recommended. When you select a generic URL website, that website is embedded in the Related Information Application Framework. You are responsible for ensuring that the embedded URL website is safe and valid.

The generic URL in the Related Information Framework is implemented as an embedded iFrame. Basically, an iFrame is a website that is embedded within another website with both websites appearing in the browser. Some websites implement code to prevent other websites from embedding their website in an iFrame.

The validate function detects whether the URL you have selected can be embedded in an iFrame within the same browser as EnterpriseOne forms. Clicking Validate triggers a validation process that displays the generic URL in an iFrame of a popup browser window.

If validation is successful, the system displays a message notifying you that validation was successful, and the popup browser window automatically closes.

If validation fails, the system displays an alert notifying you that validation failed, and the popup browser window automatically closes. The system disables the Save option.

Important:

Because of the many different ways a website can be built, the validation process cannot guarantee that a URL you select will always be able to be embedded on the same screen as EnterpriseOne, especially if the website changes dynamically. Please refer to the Troubleshooting tips when a URL that you selected is not displayed in the Related Information tab.

You should review the content of the URL you select to ensure it is legal and appropriate. Clicking the Popup icon enables you to preview the generic URL in a separate browser window. The Popup icon is available on Create, View, Edit, and Inspect the Detail pages.

If you have contextually linked (defined a key field or mapped URL parameters to form-level fields) the generic URL to an EnterpriseOne form, the URL that is validated or available for preview contains the values from the EnterpriseOne application form.

You also are responsible for ensuring that the website is not copyright protected; embedding a website URL that is copyright protected is a legal issue.

A.2.5 Save

After you save your newly created generic URL, a tab with the name you specified appears as the active tab on the Related Information framework.

Access to your newly created generic URL depends on the publishing option and the publication list that your system administrator specified when enabling the form. Your system administrator creates publication lists. Each publication list has a name and a list of JD Edwards EnterpriseOne users who can view your URL tab. Publishing options, also assigned by your system administrator, are as follows:

  • Create the URL without publish permission-only you can view and edit the URL. No other users will see this URL.

  • Create the URL with automatic publish permission-only you can edit the URL and all members of the publication list that your system administrator assigned for this form, version, user, and environment combination can view this URL.

  • Create the URL with approval required to publish permission-only you can edit the URL and all members of the publication list that your system administrator assigned for this form, version, user, and environment combination have PENDING permission to view this URL. Members of the publication list do not have access to this URL until your system administrator manually changes the PENDING permission to VIEWER permission for each member of the publication list. If approval is required to publish your URLs, notify your system administrator and request that the PENDING permission be changed to VIEWER permission.

A.3 Viewing a URL Tab

For each generic URL that you create, a tab appears on the Related Information framework. When you create a new generic URL tab, that tab appears as the active tab on the Related Information framework. You can view the tab contents by opening the EnterpriseOne form that the URL is placed on. If key values are defined for the URL, the values of the screen must match the key values for the URL tab to be displayed.

When you open the tab page, the description you defined when you created the generic URL is displayed above the URL contents. If you have been granted editor permission, you can change the data you entered in the key field on the application form.

A.4 Inspecting the Details of a URL Tab

When you have an active tab page, you can click the Inspect Detail icon on the Related Information framework. The detail page is read only and shows this information:

  • Name of tab.

  • Description of tab.

  • Owner of the generic URL link.

  • JD Edwards EnterpriseOne application form key fields.

  • URL parameter mappings to JD Edwards EnterpriseOne form-level fields.

A.5 Editing a URL Tab

If you are the creator of the tab or if you have been granted Editor permission, you can change the name, description, URL definition, JD Edwards EnterpriseOne key field, and contextual parameters on the active tab page.

If you select a different field on the application form (either key field or form-level field for mapping parameters), or if you change the original entry in the application form field, you must manually refresh the contents of the tab page. You refresh the tab page contents by clicking the Refresh icon on the Related Information bar.

If you have been granted permission to publish with approval required, the system displays a confirmation message notifying you that saving the edited tab page revokes the viewer permission for all current viewers of this generic URL. The system changes Viewer status to Pending.

Before saving your edits, you can click Close to cancel your edits and revert back to the original key fields.

If an error occurs during the save process, an error message appears.

A.6 Removing a URL Tab

If you are the creator of the tab or have Editor permission, you can remove the URL tab and its contents by clicking Delete on the active tab page bar, and then respond appropriately to the confirmation message. If you do not have Editor permission, you will not see the Delete icon.

When you delete a tab, the tab to the left becomes the active tab. If there are no tabs to the left, the tab to the right of the deleted tab becomes the active tab. If you delete all tabs, the Welcome page appears.

You can request that your JD Edwards EnterpriseOne system administrator remove a generic URL tab and its contents.

A.7 Organizing URL Tabs

The system displays generic URL tabs left to right in the order they are created, with the generic URL tab that was created last being the active tab and appearing to the right of existing tabs. The system determines the width of the tabs and dynamically adjusts the width as you create more generic URLs. The system might truncate the name of the tab to allow more tabs to be added to the Related Information framework. You can use the right and left arrow keys on the Related Information framework bar to scroll the range of tabs left or right. If you create more tabs than can be displayed on the Related Information framework, the system displays additional generic URL tabs on a drop-down list on the Related Information framework bar. The drop-down list shows all of the generic URL tabs you have defined for the open form. You open a tab page by clicking the tab name in the drop-down list. The drop-down list shows the active tab page in bold type.

You can change the order of the generic URL tabs by dragging and dropping the desired tab between two existing tabs. You drag the desired tab to either the left edge or the right edge of the existing generic URL tabs. The system scrolls the existing tabs to either the right or left, depending on which tab edge you chose. When you start dragging the desired tab to the new location, an image of the dragged tab moves with your mouse, and when you release the mouse button, the dragged tab moves to the new location. The system stores the generic URL tab location so that the next time you open the application with the appropriate key field information, the changed location of the generic URL tabs appears.

When you finish your session, the system saves the current active tab and automatically opens that generic URL tab page the next time you access the JD Edwards form and enter the key field that you defined.