Incuity Portal - Rockwell Automation Knowledgebase

Transcript

Incuity Portal Version 2.6 Table Of Contents Incuity Portal ...................................................................................................1 Overview of the Incuity Portal .........................................................................1 What is the Incuity Portal? ...........................................................................1 Who Uses the Incuity Portal?........................................................................2 What is in the Incuity Portal? .......................................................................2 Integration with Incuity companion applications .............................................3 Installing Incuity Clients ..............................................................................3 Basic Trends ..............................................................................................4 Adding Content to the Portal ...........................................................................4 Common Web Part Settings .........................................................................8 Add Web Parts to this Page control ............................................................. 10 Configuring Portal Report Web Parts ........................................................... 11 Configuring Defined Trend/XY Plotter Web Parts ........................................... 21 Configuring External Sources ..................................................................... 28 Configuring a Database Query Web Part ...................................................... 28 Adding HTML Web Parts............................................................................. 32 Using the HTML Editor ............................................................................... 34 Adding Web Pages .................................................................................... 43 Incuity Tag Manual Data Entry ................................................................... 45 Portal Explorer ............................................................................................ 47 Personalizing the View List......................................................................... 47 Display Options ........................................................................................ 48 Zones...................................................................................................... 49 Minimized Report...................................................................................... 50 Show Parameters ..................................................................................... 50 Save Display As........................................................................................ 50 Content Viewer ........................................................................................... 51 Published Reports........................................................................................ 52 Navigate, Select and Generate a Report ...................................................... 53 Modifying Parameters of a Published Report ................................................. 54 Change the Time Period Parameter for a Report ........................................... 56 Interacting with a Published Report............................................................. 58 Queries ...................................................................................................... 59 Database-Linked Queries ........................................................................... 59 iii Incuity Portal Portal Administration ................................................................................... 60 Site Menu Configuration ............................................................................ 61 Site Appearance Configuration ................................................................... 68 Adding Shared Pages ................................................................................ 75 External Source File Integration.................................................................. 76 Configuring the Content Viewer .................................................................. 79 Incuity Log Files Location........................................................................... 85 Reverting the Portal to Default Settings....................................................... 85 Advanced Portal Topics ................................................................................ 88 Serving up Custom Query Grids.................................................................. 88 Serving up Custom Trend Controls.............................................................. 89 Serving up Custom Reports........................................................................ 90 Advanced Portal Configuration.................................................................... 93 iv Incuity Portal The Incuity Portal is where users can go to see what is in the Incuity System. The Incuity Portal has many of the same characteristics as other commonly known portals. It is web based and users browse to it. It can be fully customized to suit your business, and individual users can personalize parts of the portal for their own use. The Portal is extensible; it can reach out to other sources of data beyond Incuity data: other web based objects and content can be incorporated into the portal that Incuity may not know about at all. The Incuity Portal can easily link to other sites for content such as weather or news. What makes the Incuity Portal especially powerful, however, is its ability to find data that is already inside Incuity - with only a browser. This includes enterprise data that Incuity can access via data connectors as well as any items created in the Incuity Model. Overview of the Incuity Portal What is the Incuity Portal? The Incuity Portal, like the rest of the Incuity system, is built using the latest technology platforms. It is constructed on the web parts technology from Microsoft and uses Web Part Pages, or Smart Pages, for displaying content. This web-part approach allows you to arrange various kinds of content within each web page as you see fit. Existing parts can be re-located on the page using standard drag-anddrop functionality, or removed all together. New content can be added to existing pages, or organized on brand new web pages created automatically on demand. Furthermore, Personalization features allow these new web-pages to be specific to each user, meaning that each user of the Portal can have a personal set of pages that are not shared or visible to the other users, organized in whatever manner best suits him or her. By building the Incuity Portal upon cutting-edge technologies like Microsoft .Net, XML web services and web-parts, rather than mature technologies that are already reaching their functional limits, the Portal is well positioned to take advantage of future innovations and integration opportunities. Existing Microsoft products such as Office and SharePoint are being rapidly moved to the new technology paradigms, 1 Incuity Portal and new solutions that have been designed with this in mind will enjoy a significant integration advantage in the near future. Who Uses the Incuity Portal? As the key data presentation tool in Incuity, the Portal is used by different levels of Incuity users. Casual Users will browse to the Portal for: • Key Performance Indicator (KPI) monitoring and alerting • viewing real time executive dashboard displays • interaction with automated and on-demand production reporting • data analysis using Trend displays • company content such as news and events Power Users will play several roles with regards to the Portal. They may: • Create sophisticated, rich, multi-layered reports in Excel that are then published to the Portal • Create animated, real-time graphical dashboard displays • Create Trends and XY Plots that are the basis for plant analysis • Create shared corporate content System Administrators will use the Portal for: • Analyzing key Incuity system indicators with built-in and custom reports • Establishing and maintaining corporate customization • Performing certain administrative tasks What is in the Incuity Portal? The Incuity Portal hosts several different functional aspects of Incuity. Home - a home page that is completely customizable Explorer - a tool for quickly accessing and viewing published items and an aid in building custom web pages Reports - a place to view and interact with Published Reports Trends - use zero-touch deployment of Trend and XY Plotter applications, open Model-saved Trends and interact with them Queries - view and interact with database queries saved in the Incuity Model Tools - Launch client applications, administer the Portal, open the Incuity documentation 2 Incuity Portal My Incuity - Create custom, personal pages by picking from a catalog of web parts, organize your pages with a menu personalization tool. Integration with Incuity companion applications The Incuity Portal integrates very well with the Incuity applications, especially the Excel Add-In, Trend, and the new XY Plotter. From these applications it is very easy, for example, to build a Trend that has the tags, time periods, data and configuration needed to be able to answer the question: is that compressor is running well? It is very easy from within Trend to take that report and publish it as content into the Portal. Other people can now look at this Trend display, and they do not need to know how it was built – that Trend was used and that tags were dragged and dropped, and a custom background graphic was built to make a meaningful representation as to whether the compressor is running well. They just navigate to the Portal and choose the "Compressor Operational Display", for example, and see information they need. The end user does not care how the content was created: he just fetches the report and uses it. The fact that the content was built using XY Plotter or Trend or the Excel Add-In – or whether a corporate IT developer went in and wrote custom code back in the Incuity server to go and produce that particular rich display is completely transparent. The companion applications in Incuity all provide for publishing content directly to the Portal, and end users do not need to have these applications on their machines to view these reports. Even Excel reports can be viewed in a browser without installing Excel on his machine, thus making accessing pertinent information even easier - from anywhere that a browser can operate. Installing Incuity Clients Under the main menu item Tools->Desktop Applications, there is an option to Install Incuity Clients. Users who will be creating content for the Portal in Excel, for example, can run this program to install the Office Add-In on their machine. See Client Installation for more information. 3 Incuity Portal Basic Trends The Incuity Portal provides zero-touch deployment of the Basic Trend or XY Plotter applications. This means that users can run these applications and create Trend or XY Plot definitions using a browser - without installing these applications on their desktop machines.* Furthermore, reports that are created with these applications can be published and made available to other Portal users from the Reports menu item. The Basic Trend and Basic XY Plotter options off the Trends menu, shown above, open these applications inside the Portal. Defined Trends and XY Plots offer an opportunity to open Trends and Plots that exist in the Model but as definition files - they have not been published as reports. These Trends and Plots can be opened and viewed, but only their time periods can be updated; the tags and other settings remain static. To learn more about these applications, see the Trend and XY Plotter documentation. *These capabilities do require the installation of the .Net Framework, however. Users who do not have the .Net Framework installed on their machines will not see the Trends option in the main Portal menu, and Trend (and XYPlotter) reports will display as JPEG images rather than applications. The Home Page alerts the user when the framework is not present, and provides a link that will trigger installation on the user's machine. Adding Content to the Portal Customize, Personalize, and add Pages to the Portal Customizing the Portal refers to designing and maintaining the common elements of the Portal, such as Company news, announcements and press releases. Customization allows authorized users to edit the Portal Menu bar, add new folders and shared pages, change graphics, and themes. Only users with appropriate rights can edit this content; non-authorized users will not even see the Settings options in a shared page - they will only see these options in custom pages that they have developed under "My Incuity". Personalizing provides the ability for any user to create personal pages within the Portal that he constructs as needed. For instance, a shift operator may want to 4 Incuity Portal create a custom report page with end-of-shift information, combining several different reports into one view that quickly provides insight into the state of affairs as they apply to him. These pages are developed under the "My Incuity" menu item. Design Mode All Portal pages are designed and maintained in a similar manner. If a page can be changed, clicking on the Customize or Personalize button at the top of the page will switch the page into design mode. Design mode exclusively controls three major features of the web page: • add a new web part • delete an existing web part • drag and drop web parts to new locations on the page. Other capabilities such as adjusting settings, closing, or minimizing web parts can be accomplished without specifically being in design mode. While in design mode, the Customize/Personalize button toggles to Normal Display, which when clicked, will return the page to display mode. Next to this control is the Reset button. The purpose of the Reset button - which requires confirmation before continuing - is to remove any of the personalization that has been applied to the original page configuration. Most of the time the original configuration is a blank page, so clicking Reset resets back to a blank page with the empty zones on it. (An exception to this is the site Home Page which can have parts added to it. Clicking Reset on the Home Page will delete any newly added content, but leave (or restore) the original Graphic and Rich Text part in its original configuration.) In design mode, the page is divided into labeled web part zones. Each zone can contain one or more web parts, and can be expanded, contracted, and even closed independently of the other zones. Parts are added to the page using the Add Web Parts to this Page control. This control includes a Previously Closed Parts section 5 Incuity Portal which allows you to reintroduce any web parts you may have closed. A closed web part can be reopened and will retain any settings. Deleting a web part removes it from the page, but any web part can be added back into a page. The part will have to be configured just as any new web part would be. When adding web parts to zones it is useful to understand that certain web parts display better when placed in specific zones. You can adjust the display size of the web part using pixels or percentage, as described in Web Part Configuration, but some parts are more suited to specific zones. Click here for recommendations. Recommendations for Zone Choices Although you can technically put any part in any zone, the reality of the situation is that – depending on what you want to display - you will probably want to stick to either a one-column, two-column or three column display per page. Excel reports. These really only display well in a single-column format (“Top Zone”), especially if the Action Bar is displayed as it normally is. Optimal use is really one part per page. The reports can be stacked one on top of the other in a page, however, and the height of each set to a specific amount. Trend/XYPlotter reports. If the Action Bar will be displayed to permit modifying parameters, the recommendation is for a single-column display as with Excel. However, without the Action Bar, these also look pretty good in a two-column (“Left/Right Zone”) format. You can stack here as well. Defined Trend/XYplotter parts. These work equally well in one or twocolumn formats. Three-column format seems viable for simple trends if the Model Browser and Toolbar are suppressed for all three visible trends. Dashboards. The use of vector graphics by Flash and the subsequent automatic “scaling” of the dashboard to any size part give a nice appearance in any zone; but how well it looks in progressively smaller parts depends greatly on the complexity of the given dashboard. However, given the general idea behind a dashboard, the ability to display as many as possible on a given page is highly desirable. The maximum useable recommendation is six on a page – three across and two down. This is the primary reason for the threecolumn zone format. But no other parts –with the possible exception of the Rich Text part – are going to work well in three-column format. Rich text parts. Since you can edit all the content directly, Rich Text can basically work in any zone. It does tend to require a lot of tweaking of both the content and the settings to get three columns to display just right. External Source. You can set the height and width of the “virtual window” that the external content will display in; but for most external sources, you probably want the single-part full-page format, since that is what most external sources are often designed for. In some cases – Google comes to mind – you can actually get a nice display in half a page or even smaller. 6 Incuity Portal A page in Design Mode: When a page is in design mode, you can see the labeled zones. To the right is the Add Web Parts to this Page control. Listed under Optional Parts are all of the web parts that can be added to the page. You can add more than one of any type of web part - that is, you can have two (or more) areas that contain Rich Text, for example. You can also add more than one web part to a zone, and web parts, once added to the page, can be dragged to new locations using their title bar. The drop-down box at the bottom of the Add Web Parts to this Page box determines where to place the selected Optional Part. All web parts share the Part Configuration dialog. This portion of the Settings mode helps you to determine such characteristics as Title and Border style for the web part. You can also configure the web part to display at a certain size using pixels or percentage. Web parts fall into the following categories. Adding or modifying parts works the same in each category. Published reports Defined Trend and XY Plotter content Rich Text External content Database Query 7 Incuity Portal Common Web Part Settings General Aspects of web parts When web parts are first added to a page they share several characteristics and capabilities: Selected Zone for the web part. This only shows during page development. Title bar of the web part. The title bar can be turned off in a finished page. Tool bar for the web part. Displays tool tips when hovered over. Opens Settings mode for part configuration Minimizes the web part leaving only the title bar Closes the web part - it can be reopened via the Previously Closed Parts dialog and will retain its configuration settings Deletes the added web part. The web part can be re-added, but will need to be re-configured. Opens Text Editor for the Rich Text web part The Action Bar. This optional space is used to display items such as the Model Folder name, Report names and drop down lists where applicable, Full Screen buttons, etc. Certain web parts, like Rich Text, do not include an Action Bar. Full Screen checkbox. Applies to Report web parts. Content space. This is where the reports are generated, external sources are hosted, html text is displayed, etc. 8 Incuity Portal Part Configuration Options When in Settings mode, all web parts share some basic configuration options. The Part Configuration dialog is part of the Settings dialog for each web part. While in Settings Mode, you can use the drop-down arrow on the part Title Bar to select Cancel as an alternative to Save and Close. Framing Options Default: Provides no framing but does maintain the Chrome with the Part Title. TitleAndBorder: Provides a frame around the web part, including the Chrome. None: Provides no framing and no Chrome. Without the Chrome other users cannot change the Settings.* TitleOnly: Same as default. BorderOnly: Provides a frame around the web part, and does NOT include the Chrome. Without the Chrome other users cannot change the Settings.* *Choosing this option will require the page to be in Design Mode to do any further configuration. Height and Width Height and width properties can generally be set using either number of pixels (px) value or a 1-100 percentage (%) value. In cases where the part does not fully support both options, the non-supported functionality will be hidden or disabled. 9 Incuity Portal Add Web Parts to this Page control This control opens in the Optional Parts view and can toggle between Optional Parts and Previously Closed Parts. To add a web part, click the appropriate check box for the part, select the Zone for the new part and click Add. 10 Incuity Portal Add (or view) Previously Closed Web Part The Add Web Parts to this Page control opens in the Optional Parts view and can toggle between Optional Parts and Previously Closed Parts. The part added will retain it's previous settings and configuration. To add a Previously Closed Part, click on Previously Closed Parts and the view will change, as seen at left. Add the Previously Closed Part in the same way that you added an Optional Part. Configuring Portal Report Web Parts Portal Report web parts include the following types of reports: • Excel Reports • Trend Reports • XY Plotter Reports • Dashboards (note about adding Dashboard Parts Clients browsing to the Portal who wish to view and interact with dashboards will need Macromedia Flash Player. This will be automatically detected and the user prompted to install Flash Player if required. ) 11 Incuity Portal • All Published Reports (any combination of the above within the same web part) Below is a new Portal Report web part. The Runtime Control Chart report has been selected to illustrate the different web part elements. The Modify Parameters link toggles with the Hide Parameters link. When Modify Parameters is clicked, the Report Parameters control area is displayed and the control toggles to Hide Parameters, as shown below. If a report can be modified, the parameters will be exposed here. Use the Report Name drop-down box to select the report to use in the web part. In the example below, the web part being added is a Published Trend Report, as seen in the title bar. The drop-down box is filtered on Published Trend Reports. The reports listed in the drop-down box represent all Trend Reports in the Model. Once selected, you can immediately Generate the report, Modify the report Parameters, or operate on Settings and other aspects of the web part. 12 Incuity Portal Generating a Report After choosing a Published Report and selecting Generate, the report will generate with the default parameters with which it was created. If no default parameters were provided, the Modify Parameters dialog will open automatically. Modify Parameters The Modify Parameters selection toggles with Hide Parameters. Modifying parameters of a Published Trend Report web part works exactly like Modifying Parameters of a Published Report in the Portal Reports section of the Portal. (You can use the browser's back button to return to this page after viewing the above link.) 13 Incuity Portal Report Web Part Settings Report Web Parts can contain one or more reports. Report Collections Report collections can be used as a personal organizational feature. Some organizations maintain large collections of reports, numbering perhaps in the thousands. Although Model folders work well for general organization of company reports – by product line, department, time period, or otherwise - all reports in the folders are exposed (visible and modifiable) to all users. Report collections are virtual and are kept in the Portal’s personalization database on a per user basis. A user who has a special interest in only a handful of reports can set up a single page (and perhaps bookmark it) such that the drop-down list of reports shows only those reports they want to reference. Since collections can draw from reports from anywhere in the Model, extensive personal “re-organization” can occur without cluttering the Model with the personal variations. It is possible for an Administrator to set up a Shared Menu report page that employs a collection: this collection will be visible to all users rather than a single user. The primary difference between a collection and selecting a folder from which to draw content is that the collection is static. Any new content published into the folder does not automatically get added to the report collection list shown in the report part. However, report collections for a web part can be edited to add or remove reports. When "In Model folder" is selected as the source for a web part and a specific Model folder is selected, new reports added to that folder will automatically be enrolled in the web part. It is easy to create a report collection. Launch the Report Collection Editor by clicking on the "Convert to Collection" link after either choosing to locate reports "Anywhere in the model" or "In model folder". These options provide somewhat of a shortcut to filtering reports as needed. Choosing "Anywhere in the model" will put all reports into the new collection; choosing "In model folder" will place all reports in the selected folder into the collection. The collection can be edited immediately or subsequently as needed. 14 Incuity Portal Report Rotation Report collections are a natural organization for content rotation. After creating a collection, select "Rotate" in the Auto-Update section of the Report Configuration dialog. Use the drop-down box to elect a time period for rotating to the next report. A collection is not required for rotation. You can rotate through a folder as well, or even every report in the model. Be sure to elect "Rotate" and select the time period between rotations. Selecting "Refresh" will not rotate reports, it will only refresh the first report at the selected interval. Once you have Save and Close the Report Configuration, you will need to Generate the first report and "Start" the rotation on the Action Bar. Configuring Portal Reports Report Type: The Report Type defaults to the web part type that you added, but it can be changed. This choice modifies which reports will be displayed in the Report Name field. Located: This element determines where the report for this web part is to be found. Each option includes a Collection component which provides a way to create a list of reports to use if report Rotation is enabled. Anywhere in the model When selected, the Report Name drop-down list will display all reports in the model that match the selected Report Type. This is the same as viewing the report off the Incuity main Reports menu. Use Convert to Collection to create a collection based on reports anywhere in the Model. The collection will only apply to this web part. In model folder When selected, the drop-down box will contain Model folders that contain reports matching the selected Report Type. Users then select the specific 15 Incuity Portal report folder they want to focus on. Use Convert to Collection to create a collection based on reports in this folder. The collection will only apply to this web part. In a user-specified collection When selected, the user can build a custom collection of reports which can have a mixture of Report Types, such as Trend and Excel and Dashboard. This collection is only used by the current web part being designed. Click Edit Collection to launch the Report Collection Editor to build the list. This choice is useful when used in conjunction with the AutoUpdate/Rotate capability described below. Report Name: Name of the selected report. This name appears in the Action Bar when Show Action Bar is checked. By updating the Part Title name in the Part Configuration section of this dialog, the report name will show in the Title Bar. Display: Show Action Bar: Displays the control that contains the Report list, and the Generate, Modify Parameters and Full Screen Mode options. See example Show Model Folder in Action Bar: Displays the folder path from the Model in the Action Bar. See example Show Report List in Action Bar: Enables the Report Name drop-down box which displays a list of available reports. See example Show Parameters: Displays the web part with the Parameter List open, enabling modification of report parameters. See example Generate when first Displayed: Causes the report to generate and run upon page being opened. Auto-Update: Refresh: Allows setting a periodic refresh for the displayed report. Rotate: When checked, enables the rotation - a refresh and display - of all reports associated with the web part. See Configuring Report Rotation After configuration of the Published Report and web part settings, click Save and Close. Using the Report Collection Editor The Report Collection Editor shown below has been opened using the Convert to option after selecting the "In Model folder" location using the Extruder.Published Reports folder. Three reports are in the collection, and are shown under Current Items on the right. Report items from anywhere within the Model can be added and removed from the collection list using the arrow buttons. Collection 16 Incuity Portal The Recall button will remove existing reports and create a list based on the last collection displayed in the Editor. The Show button positions the highlight in the Available Items list on the folder that contains the report. The Create Variation button allows the user to add the same report to the collection multiple times, requiring only the creation of a unique name for each occurrence of the report. This facilitates rotating through the same report while displaying data for different items. For instance, one Pump report could rotate showing the status for each Pump on a line. Save and Close the dialog when the list is complete. Show Action Bar: Displays the control that contains the Report Name, Generate, Modify Parameters and Full Screen Mode options. If unchecked in the Settings dialog, these controls are not displayed. Action Bar displayed: 17 Incuity Portal Action Bar not displayed: *note Use or non-use of the Action Bar can affect the display width of web parts. For many reports, the display is most effective when published as a Top Zone web part, as opposed to left, right, or column web parts. Show Model Folder in Action Bar: Displays the folder path from the Model in the Action Bar 18 Incuity Portal Without the Model Folder option: Show Report List in Action Bar: Enables the Report Name drop-down box which displays a list of available reports. 19 Incuity Portal Show Parameters: Displays the web part with the Parameter List open, enabling modification of report parameters. Configuring Report Rotation The reports in a report web part rotation can be identified by looking in the Report Name drop-down list displayed in the Action Bar. Add multiple reports to the list by using the Located: section of the Report Configuration dialog, described above. If Located = Anywhere in the model, the list of reports could be very long. Streamline the list by selecting In model folder or In a user-specified collection. By specifying In a user-specified collection, you can create a custom list of specific reports to display, and these reports can be of any published Report Types. (ie. Excel, dashboard, Trend, etc.) Display Options choices are important when creating a rotating web part. Show Action Bar: The Action Bar displays the control that contains the Report list, and the Generate, Modify Parameters and Full Screen Mode options. See example When unchecked, the Model Folder list and Report List, described below, will also not display even if they are checked. 20 Incuity Portal Furthermore, other options that may be important to your display are also hidden. These include the Generate and Modify Parameters actions, and display in Full Screen check box. Another option you will not see is the Auto-Rotate control that allows you to re-configure the refresh rate time period between new report displays. Show Model Folder in Action Bar: Displays the folder path from the Model in the Action Bar. See example Show Report List in Action Bar: Enables the Report Name drop-down box which displays the list of reports in the rotation. See example Show Parameters: Displays the web part with the Parameter List open, enabling modification of report parameters. See example Even if unchecked, this control will automatically open for any reports you have added to the rotation that do not have default parameters provided. With all options checked, your display will look like this: Configuring Defined Trend/XY Plotter Web Parts When initially added to the page, the Defined Trend or XY Plotter web part will present an empty control similar to that available in the Portal's Basic Trend page. Users can open an existing Trend/XY definition file, or create a new definition while configuring this web part. A newly created definition must be saved to the Model before it can be displayed on a personalized web page. Adding the Defined Trend web part When you first add a Defined Trend or XY Plotter web part to a page, the web part will open with the modified Trend or XY Plotter control. Open the Settings mode using the down-arrow at the right of the Title-bar: 21 Incuity Portal Configuring and Modifying the Defined Trend There are two sections to configuring any web part: configuring the contents of the web part; in this case, a Trend definition, and configuring the part itself; it's title, size, framing, etc. All web parts use the part configuration. See Web Part Configuration for detailed information. There are three aspects to configuring the Trend definition: Control Type The web part can host three types of Control: • Trend - for displaying a Trend definition • XY Plotter - for displaying an XY Plotter definition • TimeBar only - for displaying the TimeBar only. This option can be used to display a TimeBar at the top of a web page, for example, which is the Master control for 22 Incuity Portal all of the Trend definitions on a page. See Also: Configuring and Modifying the Action Bar, below. Definition File If the Control type is either Trend or XY Plotter, the Definition File will be filtered to display all defined Trend or XY Plotter files in the Model. A Trend control requires a pre-defined Trend definition, and the same is true for the XY Plotter control. If no definition files exist, you can create a new definition file on the fly. Click to see how. If the Control type is TimeBar only, a Definition File is not asked for. Quick Config The Quick Config drop-down box offers 5 options for configuring Trend displays. The choices are shortcuts to pre-configured, common, design options, but you can always choose Custom and specify all options yourself. Typical (show me) Defined Trend with "Typical" settings: • Shows Action Bar 23 Incuity Portal • Uses drop-down list of definitions • Uses the web TimeBar • Hides all sub-components of the Trend control (Model Browser, Toolbar) • Does not use Synchronization Synchronized (show me) Synchronized Trends: same as Typical, adding page Synchronization • Same as Typical, but with Page Synchonization Minimal (show me) Minimal: Uses page Synchronization but does not show the Action Bar: 24 Incuity Portal • Same as Synchronized, but without the web Action Bar MinMax (show me) MinMax: Uses page Synchronization but does not show the Action Bar. Includes a Full Screen icon option: • Same as Minimal, but includes a Full Page icon option. Basic (show me) Basic Trend is the full Trend control as seen on the "Basic Trend" page on the main menu of the Portal. It really displays best in a larger area such as the Top Zone: 25 Incuity Portal • The same as the "Basic Trend" web page: full Trend control with all subcomponents • No Action Bar • No Synchronization Custom • Any variation of the above Configuring and Modifying the Action Bar The Action Bar is a space immediately above the Trend control. It is used to host two key components of a Trend web part: 1. a Definition name control. 2. a web-version of the "Time Bar" control which normally displays in the Trend or XY Plotter window. The Definition name control has three options: • can provide a drop-down list of ALL Trend (or XY) Definitions in the Model. • can be read-only, in which case the name of the current Trend is simply displayed. • can be hidden. Hidden is useful when displaying many Trends on the same page. Below is an example of the Action Bar with a read-only Definition file name and a configurable Time Bar control: The Time Bar control provides a host of capabilities for configuring Trends on a custom page. These settings are stored in a personalization database for each user and are persisted from session to session. These capabilities include: 1. "Freeze Time": The time period selected in the web Time Bar is persisted and re-used instantly when the selection in the Definition list changes. Simply changing the Trend Definition selection loads the new definition and applies the time period with no further clicks. This allows the user to find an interesting Time Period and cycle through all available Trend (or XY) definitions to see what they reveal in that time period. 26 Incuity Portal 2. Shared "Freeze Time" between multiple parts on the same or different pages: The web Time Bar includes two special purpose buttons: Store and Recall. Store causes a time period change to not only execute, but to be made available on a global basis to other subscriber part on the same or different pages. Recall will retrieve the last stored global value and immediately apply it to the current display. You can think of Store and Recall as behaving much like the memory store/recall feature on a calculator - you can Store a primary time period you are working with, deviate temporarily to explore some other time period, the Recall the original time period when you are done. 3. Automatic Recall: Individual "Defined Trend" and "Defined XY Plot" web parts can be configured (using the typical "Settings" dialog) to always Recall the last stored time period each time the page is displayed. (This will occur even if the Action Bar has been configured to be hidden.) You can have as many Trend/XY Plots on a page as you want, and as many pages as you want. They can all be configured to change time periods upon any change in the global Stored time period - a change perhaps made by a single "Master" part. 4. Time-only periods: The web Time Bar allows you to specify a Time-of-Day for both Start and End without indicating a date (the date is always the current date). Since the time period is persisted across all browser sessions, this allows you to configure a part to always display the current date's info for a shift or other specific time range. 5. "Back" and "Forward" options for Absolute periods: When displaying an absolute time period, the Time Bar drop-down list also includes a variety of options such as "Back 1 hour", "Back 2 weeks", "Forward 20 minutes", etc. You can think of this as allowing a repetitive re-anchoring of an absolute period. For example, say you are looking at a Trend displaying data for a 1 hour period today from 4-5pm. One of the options in the Time Bar drop down will be "Back 1 day". You select it, and click Apply. Now the Trend id displaying 45pm from yesterday. You click Apply again, and you go back another day, etc., etc., as much as you like. You can change the jump amount at any time, and there are forward options as well as backwards options. And, of course, you can also switch from the definition being displayed, at any time, without effecting the jump. You can easily "hunt" this way for trends occurring during specific Time Periods. The new "Trend Hunter" page in the Incuity Portal is pre-configured and fixed with the options that facilitate this. Tips and Tricks for configuring Defined Trends You can configure a Defined Trend web part in many ways, and build pages consisting of several Trends that correspond with one another. Some techniques include the following: • You can configure the part to simply show a fixed Definition name, rather than a selectable list; or elect to show neither. 27 Incuity Portal • You can configure the part to show the Action bar, but use the windows version (the embedded version) of the Time Bar instead. If the part is configured to hide both the web and windows Time Bar, the time period will display read-only in the Part Title instead. • If the list is shown, there is a “(none)” option which puts you temporarily in a fully-enabled “Basic Trend” mode – so you can create and save new definitions. • There is a “Definition Period” option in the Time Bar drop-down which will bypass its use, deferring to whatever is saved (or defaulted) in the Definition itself. • When the absolute period text-boxes are displayed, you can jump the cursor to Start and highlight the value there with ALT-S. You can use ALT-E for End. Drop-down calendar controls are also available for both. • There is a “Last (Other Duration)” option in the Time Bar drop-down that will prompt you to enter an alternative, specific duration, if none of the preconfigured choices suit you. You can access the duration text-box that is subsequently displayed with ALT-D. After configuration of the Defined Trend and web part settings, click Save and Close. Configuring External Sources When you first add an External Source web part to a page, the web part will in Settings mode. You will need to provide the URL for the external source you wish displayed. Part Configuration for External Sources is the same as for all web parts: see Web Part Configuration. After entering the source URL and setting Part Configuration options, click Save and Close at the bottom of the form. Configuring a Database Query Web Part The Database Query web part allows you to build pages with embedded database queries. Unlike the queries that display when using the Portal Queries menu item, 28 Incuity Portal web part queries can be linked or unlinked to their data source, and they can contain parameters. Portal Administrators can build shared Portal pages that utilize queries which are both - or either - unlinked or parameterized, and then publish the pages for wide consumption. As shared Portal pages, the queries would only be editable by Portal Administrators. The recommended steps for building such query pages are as follows: 1. Create a new shared or personal page using one of the Menu editors 2. Add a Database Query web part to that page 3. Access the Setting dialog of that part 4. Select the desired query; configure the parameters as required 5. If desired, the query can be optionally configured to generate upon viewing of the page. (Generate upon load). The queries accessible in the Portal are created in Incuity Manager - or any of the Incuity Client applications - and are immediately available to the Portal. To learn how to create database queries see Creating Database Queries. See also Known Issues about Database Queries The ASP.Net DataGrid used in the Database Query web part does not support the use of Variant datatypes. When the datagrid binds to datasets containing variants, the variant column will simply be excluded from the grid. The work around is to cast the variant column to a String datatype such as VarChar or a Char in the actual Query Item when it is created. A sample MSSQL Server casting statement would look like this: Cast(Value as VarChar(256)) or Select TagName, DataTime, Cast(Value as VarChar(256)) From QA_History Where DateTime>='{0}' and DateTime ,<='{1}' . Incuity recognises two categories of database queries: • Linked Query - a query that is permanently linked to a specific database connector • Unlinked Query - a query which can be associated with different database connectors Unlinked queries can be employed when a user has multiple databases that have a similar or identical data structure, thereby allowing reuse of SQL queries. When you first Add a database query web part to a page, the part opens with the Action Bar showing, allowing you to select a query from the drop-down box. You can immediately Generate the query, or open the Part Settings dialog of the web part. 29 Incuity Portal NOTE: Database Queries that contain parameters or are unlinked, thus necessitating selection of a connector, require configuration and will not show up in the Query Name drop down list. Open the Part Settings dialog to select these queries. Using the Part Settings control to configure a Query Open the Settings dialog by clicking the Settings icon: Linked Queries will automatically deploy their associated data source connector and the Connector text box will become disabled. The SQL of the query will show in the Query SQL text box. Below you can see a Linked Query is selected. Entering Parameters for Queries If the selected query contains parameters, the Query Configuration will look like this: 30 Incuity Portal Notice the following: 1. The Connector name is disabled: if this were not a Linked Query (if the Query radio button was selected) a connector for this basic Query Item would need to be selected. The drop down box would become enabled. 2. The Query SQL displays the parameters in curly braces {} 3. You must provide the parameter list, separated by semi-colons ; In this example, only one parameter is required. Because the parameter in the SQL statement is formatted with single quotation marks around it, simple text is all that is required for substitution: Tip: If you check the Generate when first Displayed checkbox, the query will be executed and displayed upon the web page being browsed to. After Saving and Closing the Settings dialog, the results will be something like this: Part Configuration is similar for all web parts. 31 Incuity Portal Adding HTML Web Parts HTML web parts are capable of rich displays of text, images, flash and other media. The drop-down boxes for Links, Code Snippets and Images can contain custom items for use throughout an organization. See Adding Custom List Items to the Editor. When you first add an Html text web part to a page, the web part will be created with the HTML Editor open. The HTML Editor is a capable WYSIWYG tool for directly editing HTML content for a web page. Html text is a very versatile web part and works well when place in any web part zone, especially columns. Below is a newly created Html text Web Part in edit mode using the HTML Editor. The Editor behaves much like any word processing tool. Refer to Using the HTML Editor for information on this tool. The buttons at the bottom of the section are used to Save and Close your changes, Open the Settings dialog window, or to Cancel any changes. Be sure to use the Save and Close button at the bottom of the web part to save any changes. 32 Incuity Portal Once saved, click the Normal Display button at the top right of the page, and the custom page will look like this: Configuring and Modifying Html Text The HTML web part has an additional tool in the title bar for opening the HTML Editor: When the Settings mode is open for an HTML web part there is a specific dialog for configuring the display of the HTML toolbar: See Web Part Configuration to adjust other web part settings. Adding Custom List Items to the Editor Users with Portal Administrative rights can add Code Snippets, Images and Links to the Editor by editing the HTML Editor List Configuration file. This is an XML file that can be accessed using the link shown below: 33 Incuity Portal Using the HTML Editor The HTML Editor is a powerful online web based WYSIWYG HTML editor. It is a content editing tool that provides users with an intuitive, easy-to-use interface for creating and publishing web content. With the familiar word processing type interface, developers do not need to train business users in HTML syntax or the use a new tool. Only authorized persons can edit the shared content of the Portal, although users can personalize their portals by creating their own pages and adding HTML web parts to them. The HTML Editor will be immediately available to edit HTML web parts. Scroll down the image below to learn about using the HTML Editor toolbar. 34 Incuity Portal 35 Incuity Portal 36 Incuity Portal 37 Incuity Portal 38 Incuity Portal 39 Incuity Portal 40 Incuity Portal 41 Incuity Portal 42 Incuity Portal Adding Web Pages Individual users can maintain their own list of custom pages that are seen only by themselves under the My Incuity menu item. These pages can be created in three ways: • save displays created in the Portal Explorer page • create a Sample Custom Page under the My Incuity menu (these pages can be renamed by updating your Personal Menu) • create/manage pages by organizing your Personal Menu (see below) Personal Menu Configuration Configuring your Personal Menu works just like the Site Menu Configuration. You can create, move modify and delete pages and folders. The differences between the two are: Personal Menu configuration does not allow you to set a site Start Page You don't need to Publish changes to your Personal Menu: they are automatic Access the Personal Menu settings by selecting Personal Menu... under the My Incuity main menu item, or select User Preferences under the Tools menu. For more information on configuring the Personal Menu see Site Menu Configuration. 43 Incuity Portal 44 Incuity Portal Incuity Tag Manual Data Entry Open the Manual Data Entry page from the Tools->Incuity Tag: Manual Data Entry menu item. Select an Incuity Tag using the drop-down control: 45 Incuity Portal Enter the Value, Quality and Time fields. Value: The value of the tag. If the tag is discrete, the word true or false is required. Quality: Quality of the value. Time: Using the Now button for the Time Stamp will enter an immediate time. The time field is editable as required. Add Data: Once entered, a message displays at the bottom of the form showing the values that were entered. (Showing in green.) When adding values for IncuityTimeTags, the Time field represents the beginning time for the time duration. The Value field represents the end time for the time duration. NOTE: 46 Incuity Portal Portal Explorer The Portal Explorer is a great tool for quickly accessing and viewing published items. It provides a Windows-like experience of exploring a tree structure for Trends, XY Plotter graphs, Excel reports and Dashboards. Selected items can be displayed on the right side of the screen using the same techniques that one uses for building custom pages. You position the reports using zones, which are completely configurable. You can place more than one element -published items in this case - in the same zone and on the page. Once you have designed a page that you like, you can save the page to your personal menu. The Explorer Control makes it easy to build a page of reports: Personalizing the View List The View drop-down box at the top of the Explorer Control can be personalized to contain a direct reference to any folder in the tree. The View List is a personal list: new items added to this list are retained permanently for each individual user. 47 Incuity Portal The new reference is available for later use: Display Options Clear All 48 • If clicked, clears the display area immediately • If checked, clears all display areas before Displaying the next report Incuity Portal Generate - Generates the report Minimize All • If clicked, minimizes all display areas immediately • If checked, minimizes all display areas before Displaying the next report Show Parameters - If checked, will show report Parameters and give access to them so they can be changed. Zones The Incuity Portal is built on Web Parts technology allowing you to easily put multiple elements on the page. As seen below, the display area is divided into zones. You can put more than one element into a zone. Multiple elements placed within a zone are stacked vertically, with the most recently added at the top. Zones are not fixed in terms of height and width, but instead dynamically adjust to the size of the content they contain. The Zone drop down box on the Explorer Control lets you select the zone for the element you are adding. The Show/Hide next to the zone drop down box tells the page to hide the red dotted zone areas on the display area. 49 Incuity Portal Minimized Report Below is an example of a Minimized report in the Left Zone. The drop down arrow at the right controls Restoring (generating the report), Closing the web part, or Deleting it all together. Show Parameters The following web part was Displayed with the Show Parameters check box checked. The controls to change the Tag Parameters, Time Period Parameters, Generate, Hide, and show in Full Screen Mode are the same as those used in the main Reports section of the Portal. See how that works. Save Display As Once you have created a page that you want to keep, you can save the page. By default this page will become the first page in your Personal Menu. All personal 50 Incuity Portal pages are stored under My Incuity on the main menu. (This menu name may be customized by an Incuity Administrator.) Content Viewer The Portal Content Viewer provides a tree-view structure with single-click access to any Incuity "content" in the Model. This content includes Excel reports, Trend & XY Plotter reports, Dashboards, Trend & XY Plotter definitions, and scheduled report content in HTML format. The content type is identified by it's icon in the tree; the only non-content items in the tree are Folders. All Incuity content is presented in a Model Browser tree-view, shown in the left pane. Only paths in the Model which contain content are displayed in the tree. Content which can be displayed is shown as a hyperlink node in the tree; clicking it will automatically display the content in the pane on the right of the page. The splitter bar separating the panes can be expanded and collapsed to provide optimum viewing of content. The Incuity Portal can host multiple Content Viewer menus so that content can be organized for optimum access. Each menu can be "anchored" at a specific folder in the model to make finding related content easier. Configuring the Content Viewer, creating useful menu structures and scheduling reports for display in the Viewer is usually performed by a Portal Administrator. Content Viewer Appearance features 51 Incuity Portal • The tree runs in a collapsible splitter pane on the left side of the page. It can be fully collapsed with a single click, or expanded/contracted via drag & drop. When collapsed, it can be re-expanded back to its last position with a single click. • All content is displayed in the pane on the right side of the page. The content dynamically resizes to the current page size. • Reports displayed in the Viewer are "personalized"; the page will retain all onDemand report parameters modified for each report on a per user basis. This means that after a user has modified a report's parameters, the modifications persist even after the user has left the page or closed the browser, and will be utilized the next time the user accesses the report in the Content Viewer (Note that this is per page - the personalized modifications are not shared between multiple instances of Content Viewer, nor with any of the "Published Report" pages). Published Reports The following examples explain use of the published Portal Reports. When interacting with published reports, keep in mind that any changes you make to parameters or layout will automatically be saved for you in a personal configuration file and these changes will persist across browser sessions. Furthermore, because of the personal configuration file, you will find that if you open two copies of the Incuity portal and run different reports of the same type (e.g. Excel reports) in each, the browsers will synch up when one of the browsers is Refreshed and display the same report. This is because the reports are operating from the same personalization file. You can prevent this personalization sharing by tweaking the URL slightly in one of the browsers in a meaningless way. For example, changing the displayed Url in one of the browsers to PortalReport.aspx?type=excel&1 (i.e. adding '&1' to the end) will cause the personalization to be stored differently and the two browsers to operate independently. The steps for displaying a report are: 1. Navigate, Select and Generate a report from the Report Name drop down list 2. Modify the Parameters of the Report, if the report was built with external parameters that can be changed. 3. Change the Time Period for a given report 4. Interact with the Report, including: 1. Running the Report in Full Screen mode 2. Use controls to change the report layout 3. Print the report 52 Incuity Portal Navigate, Select and Generate a Report Navigate to the Published Trend Reports: You always know where you are in the Portal by referring to the location builder, circled in blue, below. Having filtered on Published Trend Reports, select a report from the drop down list. Generate the report: NOTE: The Incuity Portal cannot render reports written with Office 2007 if the Server is not also running Office 2007. Learn more. Office Excel 2007 reports cannot be published to an Incuity Server with Office 2003. With Office 2007, Microsoft has changed the Excel file format. If a client publishes an Office 2007 format to an Incuity Server running Office 2003, the report will not publish and will generate the error "Unable to retrieve 53 Incuity Portal generated Report". If a client has Office 2007 and the Incuity Server is not running Office 2007, the client can publish the report in the "old" Excel format. This is accomplished by first saving the file in Office 2003 format, and then publishing the report to the Portal. The best course of action is to install Office 2007 on the server. Modifying Parameters of a Published Report You can Modify the Parameters of a report before or after Generating the report. These modifications are only saved in a Personalization file, and not permanently saved on the Incuity server. The types of items that can be changed in the report are listed in the External Parameters box. Examples of items that can be changed include Tag Parameters, Time Periods, and Strings. The parameter list varies with the published report. In most cases, you can change parameters by using the Collection Editor, which opens when you click on the underscored parameter, or by directly editing the parameter. Direct editing works with parameters like dates and strings. 54 Incuity Portal The Collection Parameter Editor is used to change parameters. Navigate the Available Items tree to find items for your report. Use the arrows to add and remove items from the Current Items list. • The double arrows will add or remove all items, checked or not. • The single arrows will add or remove any number of checked items. 55 Incuity Portal It is not necessary to check items that are to be included in your report. The checkbox is used for adding and removing items from the Current Items list only. Select Save and Close. Change the Time Period Parameter for a Report A Time Period is essentially a special class of external parameter. Anytime a report is published with a Time Period parameter, the TimeBar will display in the report parameters panel when using the Modify Parameters action. Since Trend and XY Plotter reports are generated with embedded TimeBars, this feature pertains to published Excel reports and Dashboards. The display of the TimeBar will depend on the Time Period item type specified when the report was built. You always have to click Save to write the change to report before Generating. Time Period types include: Absolute - provides a Start Time and End Time textbox Relative - provides a drop-down box of pre-selected relative time periods Last (other duration) - a subset of Relative for specifying a relative period such as the last seven minutes A combination of the Absolute and Relative. When used, the TimeBar will have text boxes for Start Time, End Time and Relative Time. Absolute When the Time Period published with the report is Absolute, the report expects a Start Date and an End Date. Alt-S and Alt-E will set the focus to the start and end 56 Incuity Portal date textboxes respectively. Use the arrows to access a drop-down calendar. Click save to keep the Time Period before Generating. Relative When the Time Period published with the report is Relative a drop-down box of relative Time Periods is provided. Click save to keep the Time Period before Generating. Last (other duration) lets you specify a specific period relative to the current time. It is one of the choices in the Relative drop-down box. Click save to keep the Time Period before Generating. 57 Incuity Portal Interacting with a Published Report You can essentially "play around" with published reports by modifying them in several ways. By right-clicking on the report surface, you have access to the many controls that you can use in the source application: Trends and XY Plotter reports can have Application Properties changed, shapes and background images can be added, time periods can be added, etc. The tag list at the bottom of the plot can be re-sized or closed to provide more space. If you check the Full Screen Window box before generating your report, the new report will open in a new, full screen window with all of the features mentioned above. You can print the report from this window, but it still cannot be saved. If you are uncertain as to what you can do inside your report, refer to the documentation for source application: Trend, XY Plotter, Excel Add-In. 58 Incuity Portal Queries Database-Linked Queries The Incuity Portal is able to execute queries that have been created and saved in the Incuity Model. These queries can only be: • database-linked queries • queries that do NOT contain parameters Queries that are not linked or contain parameters require configuration prior to generation. A parameterized query is any query with at least a “{0}” parameter placeholder embedded within it. See also Database-linked queries appear in a drop down list when the Database-Linked Query menu is opened. The queries are read-only, but the order of data in the columns can be changed by clicking on the column names. Select a query and click Generate: 59 Incuity Portal Portal Administration Customizing the Portal refers to designing and maintaining the common elements of the Portal, such as Company news, announcements and press releases. Customization allows qualified users to edit and maintain shared Portal content including the Portal Menu bar, the addition of folders, pages, graphics, and themes. Only users with appropriate rights can edit this content. Individual users can personalize their portals using many of the same techniques as those who customize the portal, but user personalizations are visible only to that user and his settings are stored with their user profile in the Incuity database. Customization settings are stored in a shared location and thus are available to anyone browsing to the Portal. The Incuity Portal can only be customized by persons who are authorized Portal Administrators. All persons who are in the Incuity Administrators group are automatically Portal Administrators. Other users can be designated Portal Administrators by editing the PortalAdministrators key in the AppSettings.config file. See Advanced Application Settings. Portal Administrators have the authority to manage the shared content of the Portal. This content includes: Site Menu configuration (shared menu items) Site Appearance configuration (site theme and appearance) Shared page configuration (adding or configuring parts on shared pages) External File integration (extending the Portal application) Configuring the Content Viewer Advanced Configuration can be accomplished via the Remote File Access menu: Application Settings Site Shared Menu HTML Editor List Configuration 60 Incuity Portal Site Menu Configuration The Shared Site Menu Configuration gives authorized users the tools to customize the Portal menu. The existing menu configuration is always visible, and new pages and folders are added below the highlighted item in the existing menu. All menu changes are stored temporarily, visible only to the user making the changes. The user can see and test the menu changes prior to making them visible to everyone. Publishing makes the changes permanent and visible to everyone. If the user closes his browser prior to Publishing, the temporary changes are discarded. The user can also do this without closing the browser by clicking Reset Changes. See also: Advanced Menu Configuration Create Page Allows you to create a new shared page on the Site. Two types of pages can be added to the Portal: external pages and internal pages. The format for specifying the link to the url for these pages is subtly different: • External Pages: preface the link with http:// • Internal Pages: the Portal will search for these pages within the Portal Application root folder on the Incuity Server machine. You can preface the file directory and/or name using the tilde as shown: ~/ 61 Incuity Portal Create Page Create Page with link New Page Title: Title, visible in the Portal menu. Open the page as a pop-up window: Select if the page should open a new window when opened. Link: Click to enter an external link. The pane will expand and provide space for input, as shown at right: Specify External Link URL: Specify an external link using the format: http://www.externalLink.com Include Portal header when displayed: Includes the Portal header and menu in the pop-up window. Click Add to confirm. Create a Folder Allows you to create a new shared folder on the Site. New Folder Title: Name of new folder. Click Add to confirm. 62 Incuity Portal Move Allows you to move a shared page or folder on the Site. Highlight the page(or folder) you want to move before clicking the Move button... - that item will appear in the Moving field in the Move Page dialog: Highlight the menu item before or after which the Moving item should appear, select the appropriate radio button and click Modify to confirm. 63 Incuity Portal The item is in the new location. Remember to click Publish Changes to keep the change. Modify Allows you to modify a shared page or folder name on the Site. Highlight the page (or folder) you want to modify before clicking the Modify button... 64 Incuity Portal Make modifications and click Modify to confirm. Rename page to: Enter new page name. Open the page as a pop-up window: Check if the page should open as a separate browser window. Delete Allows you to delete a shared page or folder on the Site. Highlight the page (or folder) you want to delete before clicking the Delete button... 65 Incuity Portal Confirm removal by clicking Remove. Set Start Page Allows you to determine which page the web site should open with. Highlight the page you want to become the Start Page before clicking the Set Start Page button... 66 Incuity Portal Confirm your choice of Start Page by clicking Set. Reset Changes Allows you to revert to the site configuration as it was before the last time Publish Changes was invoked. This allows you to experiment with changes in the menu system before committing them. See Publishing Changes, below. 67 Incuity Portal Publish Changes All menu changes are stored temporarily visible only to the changing user. Thus the changing user can see and test the menu changes prior to making them visible to everyone. Publishing makes the changes permanent and visible to everyone. If the changing user closes his browser prior to Publishing, the temporary changes are discarded. The changing user can also do this without closing the browser by clicking Reset Changes. Site Appearance Configuration Site appearance configuration allows you to edit site theme source files in order to: Use themes as deployed by Windows Change the Home Page graphic Change the Logo image, size and link (e.g. clicking the Logo will open the Home page) Adjust the Portal style sheet You cannot change the default Incuity theme. In order to customize the default theme, you must first copy it to a new theme. Begin by opening Options->Site Configuration->Appearance Configuration. Create your own theme by copying the existing Incuity theme by selecting Copy to New Theme. Enter a name for the new theme and click Create. After creating the theme, your new theme will appear in Select a Site Theme box; click Modify this Theme. The Modify Theme dialog will open: Now click Open File Manager. 68 Incuity Portal The Theme File Manager will open. Listed are files that the site uses to manage various elements of the site. To change a setting, highlight it and click Edit. Items you can change include the Accent Panel, Details Panel, Home Graphic, Site Logo and Style Sheet. Change the Color of the Accent Panel The Accent Panel is a part of the theme definition of the site. The accent panel is the space on the portal screen below the solid line that separates the Company Logo and navigation path: 69 Incuity Portal To change the color of the Accent Panel, navigate to the Theme File Manager. Open the AccentPanel.skin file and Edit the BackColor variable: Open Tools->Administration->Site Appearance Configuration. Click Modify This Theme (You cannot modify the Incuity Theme; it must be Copied to a New Theme first.) Click Open File Manager. The Theme File Manager opens. Change the Color of the Details Panel The Details Panel is a part of the theme definition of the site. The accent panel is the space on the portal screen below the solid line that separates the Company Logo and navigation path: 70 Incuity Portal To change the color of the Details Panel, navigate to the Theme File Manager. Open the DetailsPanel.skin file and Edit the BackColor variable: Open Tools->Administration->Site Appearance Configuration. Click Modify This Theme (You cannot modify the Incuity Theme; it must be Copied to a New Theme first.) Click Open File Manager. The Theme File Manager opens. 71 Incuity Portal Change Home Page graphic To change the Home Page graphic, navigate to the Theme File Manager. Open the HomeGraphicImage.skin. file. The File Editor will open and allow you to edit the height, width and image URL of the graphic. Open Tools->Administration->Site Appearance Configuration. Click Modify This Theme (You cannot modify the Incuity Theme; it must be Copied to a New Theme first.) Click Open File Manager. The Theme File Manager opens. You can edit the height, width and image URL of the Home Page graphic: 72 Incuity Portal Change or Configure the Site Logo To change or configure the site logo navigate to the Theme File Manager. Open Tools->Administration->Site Appearance Configuration. Click Modify This Theme (You cannot modify the Incuity Theme; it must be Copied to a New Theme first.) Click Open File Manager. The Theme File Manager opens. Change the Logo Image graphic by selecting to Edit LogoImage.skin. The File Editor will open and allow you to edit the image URL of the logo. 73 Incuity Portal You can edit the text displayed when a user hovers over the logo by adding the AlternateText parameter: Change the URL destination when the Logo is clicked by editing LogoLink.skin: 74 Incuity Portal Change the Portal Style Sheet Editing the style sheet allows changes to text and table formatting, fonts, menu colors, etc. To change the style sheet, navigate to the Theme File Manager, and Edit the StyleSheet.css. The MenuStyle.css can be edited in the same manner. Open Tools->Administration->Site Appearance Configuration. Click Modify This Theme (You cannot modify the Incuity Theme; it must be Copied to a New Theme first.) Click Open File Manager. The Theme File Manager opens. Adding Shared Pages Administrators can add new menu items to the site, and new shared pages which can be seen by all Portal users. Use the Tools->Administration->Shared Site Menu Configuration link to open and manage the site structure. Add folders and pages as needed, then navigate to the new pages to build them. A new page will open in design mode; after adding parts switch to Normal Display to view the results. 75 Incuity Portal External Source File Integration Use the menu selection Tools->Administration->External File Integration to manage External files: Overview External Source File Integration allows you to add, edit, delete, view and rename external files. This function operates on both text and image files with subtle variations (e.g. you cannot edit image files.) The files that are uploaded are saved into the root application directory of the Incuity Portal. The interface toggles between the External File Manager and the Portal Image Manager. Typically, the external source files that the portal can render will be in either .aspx, aspx.cs, or .xml format. The External File Manager 76 Incuity Portal The Portal Image Manager Edit an External Source File Highlight the file and click Edit. The File Text editor will open: 77 Incuity Portal Rename an External Source File Highlight the file and click Rename. Make changes and click Rename. Delete an External Source File Highlight the file and click Delete. Confirm deletion by clicking Remove. Upload an External Source File Use the Browse... button to open Windows Explorer and browse for the file to upload. You can rename the file if desired. Click Upload. The file will be loaded into the root application directory of the Incuity Portal. 78 Incuity Portal Create a New External Source File Type a file name with extension and click Create. Edit the new file using the Edit function in the External File Manger dialog. Configuring the Content Viewer Introduction The Content Viewer is a tool for helping users locate reports, trends, plots and dashboards that are stored in the Incuity model. With the Content Viewer, content that has been stored together in a logical location in the model can now be located easily by browsing to the same location, or folder name, in the Viewer. The Content Viewer provides a tree-view of the Incuity Model, but only displays Incuity "content" in the nodes. The content type is identified by it's icon in the tree; the only noncontent items in the tree are Folders. To further organize model content, the Content Viewer can be customized to display a subset of model items, and can also exclude folders. These configurations are controlled with URL parameters set when the Content Viewer is configured. Although the Content Viewer can display saved Trends, Plots and Dashboards, the primary content type is an Excel report. When an Excel report is published to the model, the user has the choice of creating a Dynamic or a Static report. Dynamic reports are also referred to as on-demand reports, templates, or report templates. A dynamic report type will save all functions in the workbook and execute them against current data when the report is generated. On-demand reports often have parameters associated with them that can be changed by the report consumer. Static report types essentially mimic the Excel Convert to Values operation before publishing. When the report is opened subsequently, there is no new update of data values. In the context of the Portal, these reports are also referred to as static HTML reports. Scheduled reports are in some ways a hybrid between dynamic and static reports. Incuity does not yet offer scheduled execution of report templates out of the box. However, it is still possible to create an Excel report, publish it to the Portal, and then schedule the report via a Windows task or SQL Agent job. These reports can 79 Incuity Portal then be stored in a location on the Incuity Server machine, and accessed by users browsing to the Content Viewer on the Incuity Portal. The following describes how to configure the Content Viewer to display Incuity content. To use the Incuity Report Automation utility to create and run scheduled reports, see Report Automation. Content Viewer Display Features The Content Viewer page can display the following types of content: • On-Demand reports, including Excel reports, Trend reports, XY Plotter reports, and Dashboards. Each available report will appear as a click-able hyperlink in the Browser pane tree-view; clicking the hyperlink will cause the report to be generated and displayed in Content pane on the right. Generation will use the most recent parameter modifications made by the user to that report, or the default parameters if no modifications have been made. If there are parameters without defaults, they are prompted for in the usual way. • Saved trend or plot definitions. Each available saved definition will appear as a click-able hyperlink in the Browser pane tree-view; clicking the hyperlink will cause the definition file to be loaded directly in the content pane. (no need to publish first as a report). • Scheduled/static Html report content. Each On-Demand report in the model can potentially have static Html content associated with it. To be visible in the Content Viewer, this Html content MUST be placed in the Incuity portal using a very specific file structure. The structure is simple - one folder for each node in the report item FQN, with the high-level folder (usually "MyEnterprise") being located directly in the IncuityPortal application folder. This is illustrated in the screen print below; compare the file structure with the placement of the "Extruder Comparison" report in the Content Viewer screen print. In general, the required scheduled report output structure expression is: \\ ... \ \ < any user specified pattern > 80 Incuity Portal Required Scheduled report output file structure. So for example, the screen print shows that for the model report Item MyEnterprise.Incuity Samples.Extruder.Published Reports.Extruder Comparison1, the static report output is assumed to have the file path/pattern of: c:\inetPub\wwwRoot\IncuityPortal\MyEnterprise\Incuity Samples\Extruder\Published Reports\ExtruderComparison1\*.htm*. (There will also be a \*_files folder, which is created during publication that accompanies each .htm or .html file found.) If only a single static Html report instance is found for a given report, then the OnDemand "template" report item is NOT shown in the browser; just the static report is shown. However, if multiple instances are found, then the OnDemand template item is shown in addition to all the static reports generated from that item. When scheduled/static content is found for a given report, it is assumed that the report is long-running and should not be available for OnDemand generation. Therefore the OnDemand template item will be non-clickable even when it is visible. It serves only to hold the report description in it's tooltip, and optionally include the description parenthetically after the name. 81 Incuity Portal Configuration Features and URL Parameters The Content Viewer page has many configuration options for display. These are set via Url parameters as described below. You may have as many differently-configured Content Viewer pages as are needed in a single Portal; it is usually convenient to assign these configured Url's to different menu items, using the Portal Site Menu Item "Link" capability. Here is an example of a configured Url. Note that all url parameters need not be present, as each has a default value that is in effect when one is not explicitly specified. URL Parameters • left=integerpx|% Left pane size defaults to “25%”, but can be set via url configuration to a wider or narrower size-in-pixels (px) or percentage (%). • expand=integer The tree fully-expands by default, but can be set via url configuration by indicating the number of levels to expand from the top. • pub=any|static|ondemand The tree can by filtered for a publication type, meaning either ondemand, static, or both. • desc=true|false All tree items have the description (if non-blank) as a tooltip; report items can also have the description appended to the name as well. The default is true. • exclude=folder name,folder name,... Folders can be excluded from the browser by specifying one or more folder names (the short name, not the FQN) to exclude. The default is to exclude folders with the short name of "Sandbox". Note this may have the effect of excluding multiple folders, as many may have the same short name of Sandbox. • anchor=fqn The tree can be limited by to a subset of itself, by setting an anchor point FQN. The default is "MyEnterprise". • flatten=starting string Flattened is intended primarily to hide folders used only for Scheduled report generation. By default, a folder with a Name of “_Sched” is a marker that indicates that it, and all folders underneath it are to be hidden and flattened – all contained reports in the child folders underneath it are to be displayed as children of it’s parent. However, it is also possible to override this default by using this Url parameter, and thereby flatten other types of folders (with a common prefix) or a specific folder (by specifying the entire name). Only one flatten starting string can be specified per Url. NOTE about using both anchor and flatten. The flatten behavior is tweaked slightly for cases where both an anchor and flatten string have been specified; if the flatten string corresponds to the last node in the given anchor name, then all folders within the anchor 82 Incuity Portal folder are flattened, rather than the anchor folder itself. This is illustrated in the image below, which uses a url of ContentViewer.aspx?anchor=MyEnterprise&flatten=MyEnterprise to show a flat list of all content in MyEnterprise. Using anchor and flatten to show contents of MyEnterprise: • fqn=content item fully-qualified name. The content viewer can be set to display a particular item in the content pane automatically when first loaded. If the content item also appears in the browser, it will be selected so that the tree is sync'ed with the content displayed. Note that the content item will still be displayed even if the corresponding item is NOT shown in the tree (due to anchoring, or exclusion, for example); in that case, no current selection is indicated. • url=url string. The content viewer can be set to display the output of a given url in the content pane automatically when first loaded. If the url given is for a static report item that also appears in the browser, it will be selected so that the tree is sync'ed with the content displayed. Note that the output from the url will still be displayed even if the corresponding url is NOT available in the tree; in that case, no current selection is indicated. This makes this parameter also suitable for pointing to an initial description or explanatory page of some sort, to be displayed when the Content Viewer is first opened. 83 Incuity Portal Performance Considerations By default, the Content Viewer will search the entire Model for content to appear in the browser pane whenever the page is first loaded. In some organizations with large models, this may cause an unacceptable delay in the time before the page first appears. This can be mitigated somewhat by using these approaches: use the anchor=fqn configuration parameter to show only one specific branch of the model. It may make sense to have several ContentViewer pages, all configured to show a different branch. use the expand=integer configuration parameter to limit how many levels of the Browser tree are initially shown expanded. The default is 99 levels - i.e., fullyexpanded. While complete, this is relatively slow, because the data for every level must be retrieved for display. On the other hand, setting the level to 0 will be very fast, as only the highest level item in the model is initially shown, the trade-off is that it will take correspondingly more time to expand each level "on demand". Judicious use of these two parameters, perhaps in conjunction with multiple Content Viewer pages to break down the Model into reasonable segments, are the best way to improve slow performance. Related AppSettings In addition to Url configuration, it is also possible to change the "global" default values for Exclude and Flatten by altering them in the Portal application settings (see Tools->Administration->Configuration File Remote Access->Application Settings). The respective setting values are shown below. 84 Incuity Portal Incuity Log Files Location Portal Administrators can see the Incuity Log file locations by selecting Tools>Administration->Log File Locations from the main menu. Reverting the Portal to Default Settings Reverting the Portal to manufactured settings can be done by manually editing the AppSettings.config file for the Portal. This can only be done by Portal Administrators. The menu option (Tools > Administration > Configuration File Remote Access > Application Settings) allows direct access to these settings, as shown below. 85 Incuity Portal To revert to manufactured settings, the DefaultHomeContentTemplate, and/or DefaultSharedMenuMap key values should be updated to reflect the defaults indicated in the comments as shown in the image above. In the case of a menu change, it is necessary for the Administrator to visit the Tools > Administration > Shared Site Menu Configuration page and click “Reset Defaults” in order for the change to be visible. Show me. Visit Tools > Administration > Shared Site Menu Configuration page and click “Reset Defaults” 86 Incuity Portal TIP: If any changes to the Home Page occurred before resetting the defaults, eg. the Customize button was used and Home Page text was changed, it may be necessary to go back to the Home Page after making the above changes in the Config file, open the Customize feature on the Home Page, and the use the Reset button to fully restore the manufactured Home Page defaults. Show me. You may need to use the Reset button on the Home Page after editing the AppSettings.config file. 87 Incuity Portal Advanced Portal Topics Serving up Custom Query Grids Using the Incuity Portal “GetQuery.aspx” page This page serves up the Incuity Query grid view control in a non-branded page context; i.e, without the Portal common elements such as Header, Logo, Menu bar, etc. Content is delivered without margins, paddings, or intrinsic spacings. It is up to the consuming client to ensure appropriate presentation. All configuration is done via Url. There are a number of querystring parameters available which provide this, as shown below. Basic Url: http://[server name]/[portal name]/GetQuery.aspx Optional Params: qfqn = [fqn of saved query item] OR qid = [uniqueId of saved query item] (Note: a qfqn or qid param is required for output if the Action Bar is not to be shown. The item identified must either be of type Core.Db.LinkedQuery or Core.Db.Query (non-linked). Alternatively, when action bar is shown, the ShowList=true param can provide for dynamic user selection. Note however that Core.Db.Query items can not be shown in the list, as they require specification of a connector item). cfqn = [fqn of saved connector item] OR cid = [uniqueId of saved connector item] 88 Incuity Portal (Note: a cfqn or cid param is required for query items of type Core.Db.Query – i.e, non-linked. The item identified must be of type Core.Db.SqlProvider) Parameters = Run = [true | false ] (default is false) ShowActionBar = [true | false ] ShowList = [true | false ] (default is true) (default is true when showing the action bar) ShowAutoRefresh = [true | false ] bar) (default is true when showing the action Examples: http://vm10/IncuityPortal/GetQuery.aspx?qfqn=MyEnterprise.LinkedQuery2&run=tru e Display a linked query, non-parameterized. Run upon display. Serving up Custom Trend Controls Using the Incuity Portal “GetTrend.aspx” page (v2.5) This page serves up the Incuity Trend/XyPlotter control in a non-branded page context; i.e, without the Portal common elements such as Header, Logo, Menu bar, etc. Content is delivered without margins, paddings, or intrinsic spacings. It is up to the consuming client to ensure appropriate presentation. All configuration is done via Url. There are a number of querystring parameters available which provide this, as shown below. Basic Url: http://[server name]/[portal name]/GetTrend.aspx Optional Params: Type= [trend | xyplotter] Tdf= [fqn of saved Trend Definition file] Width = [ int ] Height = [ int ] Tags = [comma-separated list of Item FQN’s (Tags or items that contain them) ] Start = [ culture-specific UTC (GMT) date/time string] (e.g., for en-US: MM-DD-YYYY HH:MM:SS AM | PM) OR “REL” for relative time period (relative-to-now) 89 Incuity Portal End = [ culture-specific UTC (GMT) date/time string] OR one of h=hours, m=minutes, s=seconds. Ex: +5m() [+NNd() ] d is Only valid if start=REL. ShowNSExplorer = [ true | false ] (default is true) ShowToolbar = [true | false] (default is true) CollapseTagList = [true | false ] (default is true) Examples: http://vm10/IncuityPortal/GetTrend.aspx?tdf=MyEnterprise.Trend+Def+1&ShowTool bar=false&ShowNSExplorer=false&CollapseTagList=true Displays the trend definition file, without Model Browser, Toolbar, or Tag List. Serving up Custom Reports Using the Incuity Portal “GetReport.aspx” page This page serves up Published Report content & functionality in a non-branded page context; i.e, without the Portal common elements such as Header, Logo, Menu bar, etc. Content is delivered without margins, paddings, or intrinsic spacings. It is up to the consuming client to ensure appropriate presentation. All configuration is done via Url. There are a number of querystring parameters available which provide this, as shown below. Basic Url: http://[server name]/[portal name]/GetReport.aspx Optional Params: Type= [all | excel | trend | xyplotter | dashboard] Default is “all”. Fqn=[fqn OR uniqueID of Report Template item] NOTE: Rid=[uniqueId of Report Template item] is deprecated but remains available for backwards compatibility Folder=[fqn OR uniqueID of Folder item] NOTE: If both Folder and FQN are specified, the specified report must be a child of the specifed folder, or the FQN parameter is ignored. Width = [ int ] % OR [int ] px (default is 100%) NOTE: This parameters can also be referred to as DisplayWidth for backwards compatibility Height = [ int ] % OR [int ] px (default is 100%) NOTE: This parameters can also be referred to as DisplayHeight for backwards compatibility Run = [ true | false ] ShowActionBar = [ true | false ] 90 Incuity Portal ShowFolder = [true | false] bar. Specify whether to show folder name in action ShowList = [true | false] ShowParams = [true | false] ShowFullScreen = [true | false] Static = [true | false ] (only really meaningful for trend / xy; shows jpeg ) Examples: Show a report selection dropdown of all published Excel reports: GetReport.aspx?type=excel Show a report selection dropdown of all published reports (of any type) contained in a specific model folder: GetReport.aspx?folder=MyEnterprise.MyFolder Show a report selection dropdown of only dashboards contained in a specific model folder: GetReport.aspx?type=dashboard&folder=MyEnterprise.MyFolder Show a specific repor,t identified by fully-qualified name, generating automatically upon display: GetReport.aspx?fqn=MyEnterprise.MyReport&run=true Report Parameters: Starting with version 2.4, it is now possible to pass updates to external parameters via Url. In general, all parameters will have a value consisting of one or more item fullyqualified names; multiple names should be separated by commas. Alternatively, the item uniqueID (an integer) can be substituted for the name; this becomes mandatory if the item name in question contains a comma. Specification of the parameter can be done in one of two ways: • by referring to the external parameter name explicitly in the url; ie., the Url parameter name matches the external parameter name: GetReport.aspx?fqn=MyEnterprise.AnalogTagReport&run=true &AnAnalogTag=MyEnterprise.InSql80Namespace.SysTimeSec GetReport.aspx?fqn=MyEnterprise.MultipleAnalogTagsReport&run=true &SomeAnalogTags=MyEnterprise.InSql80Namespace.VectorX,MyEn terprise.InSql80Namespace.VectorY • by using a generic reference of “param”, in which case the item specified will be examined to determine its Item Type. The first external parameter specified for the report that is found to have that type will be implicitly assumed to be the desired parameter. In the event a report has multiple 91 Incuity Portal parameters of the same type, the explicit technique must be utilized to ensure correctness. GetReport.aspx?fqn=MyEnterprise.AnalogTagReport&run=true ¶m=MyEnterprise.InSql80Namespace.SysTimeSec Multiple parameters can be specified within the “param” value, separated by commas. Each will be individually typed and assigned to an implicit external parameters. For example, a report may have two external parameters, one of type Core.AnalogTag, and one of type Core.TimePeriod; both could be specified in one param statement, as in the following: GetReport.aspx?fqn=MyEnterprise.TimeBasedAnalogTagReport&run=true ¶m=MyEnterprise.PumpSpeed,MyEnterprise.LastBatchTimePeriod Like FQN and Folders, all report parameters can be specified using either the parameter item’s fully-qualified name or its uniqueId number; as in GetReport.aspx?fqn=2312&run=true¶m=2342, 2352 String Parameters If a report has an external parameter of type Core.String, it is possible to dynamically create the string item via the Url. To do this, pass the string with enclosing quotation marks, as in: GetReport.aspx?fqn=MyEnterprise.MyReport&run=true&MyStringParam=”This is a string I want to pass to my report.” Strings can also be passed in, or as part of, an implicit Url “param” just like other parameters. In either case, the string thus passed must not contain either commas or quotation marks of its own. If the string must contain these characters, a Core.String item must be created in advance and then passed into the report via it’s item fully-qualified name or uniqueId. TimePeriod Parameters If a report has an external parameter that is a Core.TimePeriod, it is possible to dynamically create the TimePeriod item using “start" and “end” Url parameters. Both relative and absolute periods can be specified. For relative periods, the start parameter should specify “REL”, and the end should specify an integer followed by a period indicator, as shown below. Only relative-tonow specification is supported. (m=minutes, s=seconds, h=hours, d=days) GetReport.aspx?fqn=MyEnterprise.TestTimeParams&run=true&start=REL&end =5m Absolute periods must be specified as UTC (not local time). The should be formatted according to the culture used by the browser submitting the request (shown in enUS). 92 Incuity Portal GetReport.aspx? fqn=MyEnterprise.TestTimeParams&run=true&start=9-12006 12:00 AM&end=9-2-2006 2:00 PM In either case, both “start”and “end” must be specified as a pair (the order of listing is not important) to create a valid TimePeriod if either is missing or invalid, the TimePeriod is not created. If a single pair is created, it will be matched to an external parameter using the “implicit” technique discussed above – i.e., it will be assumed to be for the first TimePeriod external parameter found. Multiple TimePeriods In the case where a report has multiple external TimePeriod parameters, or a single parameter that excepts multiple TimePeriods, a variation of the above technique can be used to correctly specify them. In short, each period should be identified by an integer that suffixes the parameter name; for example, start1 and end1, start2 and end2, start3 and end3, and so on. Each of these pairs creates a corresponding “period”, identified as period1, period2, period3, etc. That period identifier can be used in conjunction with either the explicit or implicit techniques discussed above. For example, the following syntax might be used to create multiple time periods for a single parameter (implicitly specified) that takes two relative timeperiods: GetReport.aspx?fqn=MyEnterprise.TestRelTimeParams&run=true¶m=period1,pe riod2&start1=REL&end1=5m&start2=REL&end2=10m Whereas the following syntax might be used in the case where there are two explicit TimePeriods named MyAbsParam and MyRelParam: GetReport.aspx?fqn=MyEnterprise.TestMixedTimeParams&run=true&MyAbsParam=p eriod2&MyRelParam=period1&start1=REL&end1=5m&start2=9-1-2006 12:00 AM&end2=9-2-2006 2:00 PM Branded Corollary: PortalReport.aspx As mentioned in the opening paragraph, GetReport.aspx is a non-branded page that does not include Portal common elements such as the menu. PortalReport.aspx is the branded corollary to the GetReport.aspx, and uses all the same parameters in the same way described above. Advanced Portal Configuration Advanced Portal Menu Configuration Many basic functions pertaining to extension and/or modification of the Portal’s Shared Site Menu can be accomplished using the Shared Site Menu Configuration page. These functions include creating pages, renaming them, moving them around, and specification of a Url for linking external pages, as well as a few others. 93 Incuity Portal In addition to this, the Incuity Portal exposes a page for Portal Administrators under the menu option Tools > Administration > Configuration File Remote Access > Shared Site Menu. This page allows a knowledgeable administrator to take advantage of advanced configuration features that are not available through the standard configuration page. An administrator clicking on this option is given access the raw xml file that is used to store configuration information for the Portal’s shared site menu. These settings include everything but the personalized menus stored for each user under “My Incuity”, as illustrated below. Note that any changes to the menu via the xml file will only be noticed after navigating to a different Portal page. The xml file shows that the menu structure is represented as a series of nested “incuityMenuNodes” that should be fairly easy to recognize. The nodes are sequenced top-to-bottom in the same way as the menu is represented left-to-right. A nesting of nodes corresponds to a nesting of sub-menu items. Re-sequencing the nodes or changing the nesting levels in the file will be reflected in the menu subsequently generated. The more advanced configuration options, however, are specified through the use of incuityMenuNode attributes. Some, but not all, are present in the default Menu configuration file; there are many which are not present there that may be very useful in particular customer scenarios. Knowledge and use of these attributes will, in general, enable a much more sophisticated level of menu customization. A brief description of each available attribute is listed below: 94 Incuity Portal Available “incuityMenuNode” Attributes title The Text that will appear in the menu for the item, as well as the navigation path that appears in the Portal header. url The url of the page to be displayed. If no url attribute is present, the node is assumed to be a “folder” node. startPage True or false. Indicates the page in the menu that is to be displayed by default. Only one node should indicate true. fixedUrl True or false. If true, the Url will not be displayed for modification in the Menu configuration “link” editor. popup True or false. If true, the page will open in a new window rather than replacing the existing window. adminRoleRequired True or false. If true, the page will be visible only to Portal Administrators. appKeyEnabler Specifies an Application Setting by key name. The setting for the key specified must have a value of “true”, or the page will not be displayed. Multiple keys may be specified in a comma-separated fashion; all must be true for display. sessionKeyEnabler Specifies an ASP.NET Session variable by key name. The setting for the key specified must have a value of “true”, or the page will not be displayed. Multiple keys may be specified in a comma-separated fashion; all must be true for display. authUser Specifies the name(s) of users authorized to see the item. Multiple names may be specified in a comma-separated fashion. Format of the name should match that shown in the Current User Info dialog. tooltip A tooltip may be optionally specified, and will be displayed when the menu item is hovered with the mouse. clientsidecommand May be used to specify a javascript command or function that will be executed client side when the menu item is clicked. enabled True or false. If false, the menu item will display but will perform no function. 95 Incuity Portal lookid Available for system integrators looking to create a custom menu format. Reference the ComponentArt menu documentation for more information. subgrouporientation Available for system integrators looking to create a custom menu format. Reference the ComponentArt menu documentation for more information. subgroupexpanddirection Available for system integrators looking to create a custom menu format. Reference the ComponentArt menu documentation for more information. subgroupitemspacing Available for system integrators looking to create a custom menu format. Reference the ComponentArt menu documentation for more information. subgroupheight Available for system integrators looking to create a custom menu format. Reference the ComponentArt menu documentation for more information. subgroupwidth Available for system integrators looking to create a custom menu format. Reference the ComponentArt menu documentation for more information. subgroupexpandoffsety Available for system integrators looking to create a custom menu format. Reference the ComponentArt menu documentation for more information. subgroupexpandoffsetx Available for system integrators looking to create a custom menu format. Reference the ComponentArt menu documentation for more information. subgroupcssclass Available for system integrators looking to create a custom menu format. Reference the ComponentArt menu documentation for more information. Example of subgroup menu attribute, and subsequent scrolling of menu items2 The following menu Node specifies subgrouping of menu items and some basic formatting: 96 Incuity Portal Example of automatic scrolling of menu items (always enabled; no attribution necessary) Menu groups with more items than will fit on a page are automatically generated with scroll icons at the top and/or bottom of the list, as necessary. About the “look Id” Attribute An ItemLook encapsulates or "packages" appearance and behaviour characteristics for Menu items. It is also a way of separating data from its presentation. ItemLook properties include the icons that appear on the left and right ends of the item, the space around labels, and the style sheet classes used for regular, hover and active states. 97 Incuity Portal After you create and configure an ItemLook, you can point menu or node items to it using a look Id menu attribute, so that the items immediately take on all of the ItemLook's design elements. To update the characteristics of a set of items, you only need to configure the ItemLook that the items reference. Default configuration of IncuityPortal v2.4 menu component (~/UserControls/CustomMenu.ascx) Advanced HTML Editor Configuration Portal Administrators can directly access the configuration file for the HTML Editor to pre-configure the various drop-down boxes with specific items. Editable content includes: 98 Incuity Portal • Styles and Fonts • Internal and External links • Code Snippets, which can insert reports, Trends, and other web-type "parts" and • Images The xml file as configured when Incuity is installed provides examples of how to edit the file to accomplish these customizations. Furthermore, the HTML Editor comes with a number of dictionary files to support the Spell check feature. Supported languages are: en-US, en-CA, en-AU, en-GB, en-UK, es-ES, es-MX, de-DE, it-IT, and fr-FR. The dictionaries are loaded automatically based on the local culture settings. Advanced Application Settings Administrators can directly edit the Portal Application Settings configuration file (AppSettings.config)as needed. The file itself provides documentation on how the various settings work and how to change them. Of note are settings for the following: • Removing the Demo menu item • Enabling Remote Configuration of the config files, allowing access to these files from a machine other than the Incuity Server • Enabling Incuity Classic Reporting Web Site integration • Enabling iQuery integration - useful for InSQL users only • Designating additional Portal Administrators (other than members of the Incuity Administrators group) by editing the PortalAdministrators key • Disabling Print and File Save capabilities using the EnableControlFileAccess key. If false, will disable file system access from the Portal Trend & XyPlotter controls. Note that there may still be a possibility of file access as some printer drivers allow printing to file. If this is unacceptable, the printer driver itself may need to be disabled. 99