You are on page 1of 4

EnterpriseOne Page Generator Examples Guide Perhaps the easiest way to learn the generator syntax is by example.

. For this reason, several example dat files have been provided to highlight key features of the E1 Page Generator. This document is intended to be a guide to those examples and will draw attention to the core features of each example.

Example 1: example_01_basic_flow.dat This is an example of a very basic flow-type E1 Page. (It is the same as the Financial Planning, Forecasting, and Budgeting page available on the Update Center

Example 2: example_02_hover_disabled_color.dat Here, we start with the file from #1, but we make a few changes: We remove the line *hover=off to enable hover tooltips. We define appIds formIds, reportIds, versions, and in some cases descriptions for the items in the flow. Any such information specified will appear in the hover tooltip We set one item to disabled, making it visually distinct, non-clickable, and non-hoverable. We set a custom color on a few items. There are four colors available: blue (default), red, green, and yellow. A couple advanced notes about hover: By default, hover is on for all enabled items. It is off for disabled items. o The global option *hover=off or *hover=on can be used to set the default hover capability for all You can override the global hover setting for a specific item by using its hover=on or hover=off option. For example, you could use this to turn hover back on for a specific, disabled item. You may not wish to have the detailed information of appId, formId, version, product code, or reportId show up in the hover tooltip, but you may still wish to include them for icon purposes. (See examples 11 and 12). To hide the detailed info, add the flag liteHover

Example 3: This page shows the smallIcons style of page. It is similar to the default, except that each object has been annotated with an icon. See examples 11 and 12 for more information on how the icon is determined. Hover over the last (right-most) element of the second row. Note that the hover info contains a link to documentation. This is done through the hoverLinkText and hoverLinkUrl options. In this case, the values are in-line in the dat file. They could alternatively be specified in the properties file. Note that, when using a colon in the URL, it must be escaped with a backslash so the generator knows it is not a delimiter.

Example 4: example_04_swimLanes.dat This page demonstrates how the ASCII art structural representation can be used to make a swim lane layout by adding a row of hyphens (---------------------)

Example 5: example_05_rightToLeft.dat This page shows how a page may be rendered in right-to-left format. There are actually three ways to do this: Add the global option *dir=rtl, as shown in the example. Add the global option *dir=DIRECTION and then define DIRECTION=rtl in the properties files for right-to-left languages only. Do nothing. When the page is viewed from within E1 by a user whos preference is right-to-left, the page will automatically switch to right-to-left mode. However, note that the page will still be left-to-right when not viewed from within E1.

Example 6: example_06_largeIcons.dat E1Pages are not meant to be used exclusively for process flows. This page shows the largeIcons display mode for a page. This mode can be used to expose an assortment of tasks in a rectangular grid arrangement where the tasks dont necessarily have an A leads to B leads to C ordering to them. Note that the lines and arrows have been removed from the structure portion of the dat file, but it still must obey the rule of fives. Note also that the descriptions show up under the icons by default.

Example 7: example_07_largeIconsNoDesc.dat Here, the descriptions beneath the tiles have been suppressed by *showDescr=hoverOnly because it is redundant to have the description show all the time and in the hover tooltip. Alternatively, if the goal were to show the description under the icon all the time and not on hover, we could have used *showDescr=tilesOnly. The equals signs in the structure indicate to leave a completely blank row, simply for the purposes of spacing.

Example 8: example_08_largeIconsFlow.dat This example shows that it is possible to have large icons and a flow structure.

Example 9: example_09_largeIconsWithDividingLines.dat It is also possible to use the flow structure to create horizontal and vertical separating lines without creating an actual flow.

Example 10: example_10_tiles.dat This example shows the tiles display mode for E1Pages. The tiles are functionally equivalent to large Icons but have a distinct visual appearance in that they are more button like. This mode is ideal for pages intended for use on iPad or other tablets.

Example 11: example_11_customIcons.dat This example shows how icons are assigned to items. In the absence of other information, the default application icon will be used. When the 'report' flag (or 'reportId=') is in the options list, the default report icon will be used. When appId and formId are specified, the default application icon will be used until the page is inserted into E1. When the page is viewed from an E1 WebClient running Tools or later, the icon will be replaced at runtime with the icon for the specific application and form. A customIcon may be specified as an option for an item. A few other notes on icons: If you wish to have the automatic icon replacement take place, but you do not wish to show the appId and formId in the hover tooltip, you may use the liteHover flag as described in example 2. If you do not wish to have automatic icon replacement take place, you may use the flag noAutoIcon. If you specify a customIcon, this will disable the automatic icon replacement. When using custom icons, you should make sure the size of the icon is 76x76 for tiles and largeIcons, 38x38 for smallIcons. The browser will attempt to scale your image to this size, but the quality of browser-resized images is unreliable, and any non-square images will be stretched out of proportion. You will achieve the best results by using your image editor of choice to prepare an icon that is 38x38 or 76x76 exactly as you want it. Custom icons used on one or a handful of pages can be placed in the directory of the generated page(s) after the generator runs. o Running the generator a second time after the file has been added will NOT delete the added file and WILL add the file to the zip. o Note, however, that if you modify any generated files, those will be over-written when you re-run the generator. Custom icons used on many pages can be added to the template_page directory and will then be copied into all E1 Pages built with the generator.

Example 12: example_12_automatic_icon_replacement.dat This page is simply a demo of automatic icon replacement. When loaded into an E1 WebClient running Tools or later, each of the default app icons will be replaced with the actual icon for the application.

Example 13: example_13_sections.dat This page shows the syntax for creating sections or sub headings within an E1 Page.

Example 14: example_14_collapsible_sections.dat These sections can also be made expandable/collapsible.

Example 15: example_15_vertical_lines_between_boxes.dat This page shows some examples of using vertical lines between boxes. Note that such vertical lines are merely a convenience and are never strictly necessary; any flow can be created without using them.

Example 16: example_16_advanced_box_style_options.dat This example showcases some advanced box styles that can be applied to individual elements.

Example 17: example_17_show_grid_for_troubleshooting.dat When a built page does not render as expected, it can be helpful to turn on the grid with the *showGrid option.

Example 18: example_18_using_special_characters.dat This page elucidates some of the finer points of using special characters in the dat file.