Web UI Design Requirements

  • Article

Server Appliance Kit

When you create Web UI pages to work with the Server Appliance Kit, they must meet the following requirements:

  • Localization. All the text in every components and page must come from the Localization Manager. Text should be stored in related DLLs - that is, all the text for each element of a primary navigation page must be stored in one or more DLLs. Furthermore, each DLL must not contain text for more than one primary navigation page.

  • OEM Branding. You can provide an image for the Status bar. The image must be no more than 50 pixels high, and can be between 200 and 400 pixels wide. The image must be on a black background and contain the company and product name. The image should be in the .gif file format.

  • Primary Navigation Item. The caption for a primary navigation item must be one word. The description must be a single sentence describing the page. The long description can provide more information; the general rule for long descriptions is that they are two to four sentences in length.

    Each primary navigation page must also have a unique graphic. The large graphic must be 192x192 pixels in size. The smaller element graphic must be 32x32 pixels in size. The graphic should match the look of the existing items.

  • Secondary Navigation Item. The caption for a secondary navigation item must be no more than two words. The description should be a single sentence describing the page. The long description can provide more information; the general rule for long descriptions is that they are two to four sentences in length.

    Each secondary navigation page should have a unique graphic. The graphic must be 32x32 pixels in size. The graphic should match the look of the existing items.

  • Custom Navigation Pages. Custom navigation pages have the same requirements as primary navigation pages.

  • System Resources. System resources must include status data, as well as an icon and caption. The caption must be no more than two words. The description must be a single sentence describing the resource. The icon must be 16x16 pixels in size. Resources can include a link to an extended status page or pagelet.

  • System Resource Details. System resource detail pages and pagelets must use the appropriate API call and include the icon, caption, and status of the system resource.

  • Alerts. The caption of an alert must be meaningful, such as Date and time not set up. The alert must include a link to another location in the UI, which will allow the user to resolve the problem.

  • Property Pages. Property pages must include a graphic in the header bar. The graphic must be a 16x16 pixel version of the graphic used on the navigation page

  • Multitabbed Property Pages. Multitabbed property pages must include a graphic in the header bar. The graphic must be a 16x16 pixel version of the graphic used on the navigation page. Additionally, the label for each tab is limited to two words.

  • Wizard Pages. Wizard pages must include a graphic in the header bar. The graphic must be a 16x16 pixel version of the graphic used on the navigation page. Additionally, wizard pages must include a graphic for the left panel of both the welcome and finish pages.

    The title of the welcome page must be Welcometo the <wizard name> Wizard. The title of each of the interior pages must indicate the purpose of that page. The title of the finish page must be Completing the <wizard name> Wizard. The finish page must display all the configurable elements addressed by the wizard and how they will be configured.

  • Area Pages. Area pages must include a graphic in the header bar. The graphic must be a 16x16 pixel version of the graphic used on the navigation page.

  • Object/Task Selector Area Pages. Object/Task Selector area pages have the same requirements as other area pages. In addition, they must provide sort, search, and virtual page capabilities. You can use the appropriate Object/Task Selector Routines for these capabilities.