SAP xMII Training Labs Table of Contents Lab 1 – Creating a Web Page .................................................................. 3 Lab 2 – Images and Image Maps ............................................................. 11 Lab 3 – Tables .................................................................................. 17 Lab 4 – Frames ................................................................................. 21 Lab 5 – Forms ................................................................................... 25 Lab 6 – Style Sheets ........................................................................... 35 Lab 7 – SAP xMII Installation Guide ......................................................... 39 Lab 8 – Getting Connected ................................................................... 69 Lab 9a – Building Queries Using the Template Editor .................................. 75 Lab 9b – Building Displays Using the Template Editor.................................. 91 Lab 9c – Using the Dynamic Page Generator ............................................ 119 Lab 10a – Web Page Design ................................................................. 123 Lab 10b – Web Page Design (on your own) .............................................. 127 Lab 11a – Scripting with xMII ............................................................... 129 Lab 11b – More Scripting with xMII ........................................................ 137 Lab 11c – Still More Scripting with xMII .................................................. 143 Lab 12a – Personalization - Setting Up Roles ........................................... 147 Lab 12b – Personalization - Setting Up Users ........................................... 149 Lab 12c – Personalization – Assign Users to Roles...................................... 151 Lab 13 – Editing the Style Sheets .......................................................... 153 Lab 14 – Security.............................................................................. 155 Lab 15 – Personalization – Navigation Editor............................................ 157 Lab 16 – Data Manipulation / Inline Transform ......................................... 163 Lab 17 – xMII Reports ........................................................................ 171 Lab 18 – iCommand........................................................................... 181 ©2006 SAP Americas. All Rights Reserved. These materials may not be reproduced without the express written permission of SAP.
©2006 SAP Americas. All Rights Reserved.
Page 1
SAP xMII Training Rev 08/06
©2006 SAP Americas. All Rights Reserved. These materials may not be reproduced without the express written permission of SAP Americas.
©2006 SAP Americas. All Rights Reserved.
Page 2
SAP xMII Training
Lab 1 – Creating a Web Page Purpose This lab provides the student an introduction to some basic web page design concepts. Students will use Microsoft FrontPage 2003 to create web page content and edit the properties of each.
Topics Covered This lab will cover … •
Page (Document) Sections
•
HTML Tag Syntax
•
Changing Properties (font types/colors, background colors, etc.)
Procedure 1. Start Microsoft FrontPage – the instructor will be able to guide you to its location on the training computer. 2. We’ll begin by creating a template page that we’ll use for creating additional pages. Templates allow you to maintain the consistency of web pages on a web site. If a new page isn’t already opened, from the icon bar menu, select the new page icon.
©2006 SAP Americas. All Rights Reserved.
Page 3
SAP xMII Training FrontPage should look like this:
3. Click on File and choose “Open Site”. 4. In the Site Name text box enter \\\Training (check with the trainer for the ). 5. Create a folder to save all the webpages that you create.
©2006 SAP Americas. All Rights Reserved.
Page 4
SAP xMII Training
6. You should note 4 tabs at the bottom of your new page – labeled Design, Split, Code and Preview. Select the Code tab and review the code that was entered by FrontPage. Notice the HTML tags prefixed with the tag. The page editor inserted these entries into the page source. Since they are contained in the header section of the page between the and tags, this information is not actually displayed on the page. tags contain information regarding the web editing software, language, and web site theme that are applied to the web page. The text in between the and tags makes up a string that is displayed at the top of the clients web browser. We will customize the title on every new page that we create in this Lab. Enter an interesting title for your template page.
©2006 SAP Americas. All Rights Reserved.
Page 5
SAP xMII Training 7. Since we will be using this page as a template for the other pages we will create, we will define the properties (e.g. fonts, colors, etc.) that we want. In the tag: - Add a background color to the page by including the bgcolor parameter. - Setup the font properties for the text within the body of the page by adding the tag with the parameters (face, color, size) you want. Don’t forget the closing tag.
©2006 SAP Americas. All Rights Reserved.
Page 6
SAP xMII Training 8. Switch back to the Design tab and view the effects of the changes to your web page.
9. Now right-click on the page (in Normal view). In the pop-up window, select Page Properties… This will allow you to set some more document defaults within the Template page. Review the tabs and the properties in each. You will note the Page Properties is an easy place to change the title, background color, fonts, etc.
©2006 SAP Americas. All Rights Reserved.
Page 7
SAP xMII Training
10. Let’s save this as our template page. From the File menu, select Save As… and enter a File name: BasePage.htm. Save all work in the Training folder that you created.
**Note: To view our BasePage.htm, open the browser (Internet Explorer) and type: http:///training//BasePage.htm
©2006 SAP Americas. All Rights Reserved.
Page 8
SAP xMII Training
11. Now let’s create our other web pages from the BasePage.htm template. We’ll start with a page that will be the header for our web site. Modify the BasePage.htm by changing the text (example: “My SAP xMII Page”), background color, fonts, etc. Use your imagination. When you are done making your changes to the header page, Save As Header.htm.
HINT:
When saving the page, use the Change title… button to modify the Page title.
12. Repeat the above step to create additional pages for the Table of Contents (TOC.htm) and two new base pages (Page1.htm and Page2.htm).
©2006 SAP Americas. All Rights Reserved.
Page 9
SAP xMII Training
©2006 SAP Americas. All Rights Reserved.
Page 10
SAP xMII Training
Lab 2 – Images and Image Maps Purpose This lab will introduce the student to the basics of adding web graphics to a web page. We will investigate images (graphics) and image maps (hotspots or hyperlink regions) that can be used as part of a web site navigation system.
Topics Covered This lab will cover … •
Adding web images or graphics
•
Image pathing and sizing
•
Creating / Editing Image Maps
Procedure 1. We’ll begin by inserting a graphic ‘divider’ to separate the web pages header information from the rest of the page. Open the Header.htm page and place the cursor at the bottom of the page. From the Insert menu, select the Picture\Clip Art option. Select Go to view the clip art currently installed on your server.
©2006 SAP Americas. All Rights Reserved.
Page 11
SAP xMII Training 2. Search through the available “border” clipart images and find one that you like. Click on the image and select Insert to add it into your web page document.
3. Switch to the CODE tab and note the syntax of the tag we just added. You should see something similar to the following… The src parameter contains the image file path. Because we have not yet saved our page, the image file is currently stored in a temporary file location. When we save the page, you will be prompted to specify another file storage location. We will save the file and note the new image later in this lab. You should also note the height and width parameters. By default, these parameters are set in pixels, resulting in a fixed image size, however they can also be set as a percentage of the page, resulting in an image size relative to the size of the page. 4. Modify the width parameter of your image to 90%. To see the effect of the new setting, switch to the Preview tab and resize the width of your web page. As you resize you should see the width of the image scale with the page. This functionality is useful when developing sites for multiple resolutions.
©2006 SAP Americas. All Rights Reserved.
Page 12
SAP xMII Training
5. Now Save the Header.htm page. You will be prompted to save the embedded image to a location on the server. The location where you save the file will determine the final path setting for the image (ie: src parameter). The image path is saved relative to the source HTML page.
Example 1: If you save the image in the same folder as the HTML page, the image tag should look like this… Since the image file is in the same folder as the HTML page, no additional path information is required in the src parameter.
©2006 SAP Americas. All Rights Reserved.
Page 13
SAP xMII Training
Example 2: If you chose to store the image file in an alternate location, the image tag should look something like this… Since the image file in this example was not stored in the same location as the HTML page, additional path information was included in the src parameter. The path defines the location of the image file relative to the HTML page. In this example, the image file named j157996.gif is stored up one folder level (represented by ..) from the Header.htm page, in the /images folder. 6. Next we’re going to add another image that we will use to navigate our web site. Open the TOC.htm page. From the Insert menu, select Picture\From File…., navigate to the Training folder and select the LinkMenu.gif file. Click OK.
7. We’ll add a few “hotspots” or “hyperlink regions” to the LinkMenu image for navigation. To do this, select the LinkMenu image. From the View menu, select Toolbars\Pictures to display the Picture Toolbar…
Hotspot Tools
©2006 SAP Americas. All Rights Reserved.
Page 14
SAP xMII Training 8. Select the Rectangular Hotspot tool and draw a rectangle around the “Link 1” text on the LinkMenu image. After drawing the rectangle, a dialog box will popup allowing you to enter a Hyperlink URL. Select the Page1.htm file from your training folder that you created earlier and click OK.
9. Switch to the Code tab and review the and the tags. You should see something that looks like this… The map tag can contain several area tags. The area tags contain the actual hotspot link information. The area tag includes parameters for the linked page (href), the shape of the hotspot, and the coordinates (cords) for the hotspot “touch” region. The coordinates are defined in X1, Y1, X2, Y2 sequence and use the top left corner of the image as the origin. The tag was also updated to include a new usemap parameter that references the tag that was just created.
©2006 SAP Americas. All Rights Reserved.
Page 15
SAP xMII Training
10. Switch back to Normal view and add another rectangular hotspot region around “Link 2”. Create a hyperlink to Page2.htm. In the HTML view, you should note a new area tag has been added after the existing area tag, but before the tag. The final HTML code should look something like this… Save your TOC.htm page. 11. Open Page1.htm and enter any information that you want to be shown. Experiment with the formatting tools located on the toolbars. 12. Open Page2.htm and enter information regarding the author of the web site, credits to the instructor, etc…
©2006 SAP Americas. All Rights Reserved.
Page 16
SAP xMII Training
Lab 3 – Tables Purpose Tables can be used to organize the layout of web pages. In this lab the student will learn how to add tables and become familiar with defining spacing, borders, background images, and hyper-linking cells.
Topics Covered This lab will cover the following topics… •
Table creation
•
Cell text justification
•
Table/Cell backgrounds
•
Hyper-Linking cells
Procedure 1. Open the Header.htm page and switch to the Normal view.
2. First, we’ll create a table that we’ll use for organizing the text in our title. Place the cursor in front of the title information on the page. From the Table menu, select Insert\Table…
©2006 SAP Americas. All Rights Reserved.
Page 17
SAP xMII Training 3. Create a 1 row by 2 column table and click OK to insert the table and close the dialog. The page should look similar to the following…
Switching to the Code tab, you will see the tag can contain many (table row) and (table data) tags. The number of pairs determine the number of rows in the table and the number of pairs determine the number of columns in the row. The information between the and the tags defines the cell contents. By default, FrontPage inserts as a placeholder for the cell data. 4. Switch back to the Design view to modify the cell contents. Highlight and cut the title text on your page, then paste it in the first cell of the table. Add some additional text in the second cell.
©2006 SAP Americas. All Rights Reserved.
Page 18
SAP xMII Training
5. You can change the settings of the entire table or of each individual cell by right-clicking and selecting either Table Properties… or Cell Properties… from the popup menu. This will display the dialog box…
HINT: Setting the Border Size to “0” will eliminate the appearance of the border so only the text will be displayed in the browser.
6. Open Page1.htm and add a 1-row x 2-column table at the top of the page. In the left cell, type the text “To TOC”. In the right cell type the text “To Page 2”. ©2006 SAP Americas. All Rights Reserved.
Page 19
SAP xMII Training 7. Next, we’ll create hyperlinks to both the TOC.htm and Page2.htm page. To create the hyperlink, highlight the appropriate text in the cell. From the Insert menu, select Hyperlink… to display the hyperlink dialog box, and then select the appropriate page you wish to hyperlink to. Click OK to complete.
8. Open up Page2.htm and repeat the table creation and hyperlink procedure (make sure you change the text in the right cell to “To Page 1”). **Hint: To change hyperlink color: from File menu choose properties, then choose the Background tab.
©2006 SAP Americas. All Rights Reserved.
Page 20
SAP xMII Training Lab 4 – Frames Purpose The student will explore the use of Frames in a web page. Frames can be used to organize the layout of your web site. A Frames page divides the browser window into different sections (e.g. frames), each of which can display it’s own page. We will create the ‘Home’ page for the web site.
Topics Covered This lab will cover the following topics… •
Creating a Frames page
•
Frame syntax
•
Creating Hyperlinks to target frames
•
Procedure 1. First we’ll create the Frames page. From the File menu, select New > Page…. to open the New page dialog box. Select the More page templates option, then Frames Pages tab (note the variety of templates you can choose from). Click on the Banner and Contents page and then click OK to create the new Frames page.
©2006 SAP Americas. All Rights Reserved.
Page 21
SAP xMII Training Your new page should look like this…
2. Next we’ll need to Set Initial Page… for each frame section. In the Banner Frame (top section), click the Set Initial Page… button and set the page to the Header.htm webpage from your training folder. NOTE: The full path to the page will be shown in the URL. This will be adjusted when the page is saved much like the image file path.
©2006 SAP Americas. All Rights Reserved.
Page 22
SAP xMII Training 3. Repeat this step to set the Contents Frame (left frame) initial page to TOC.htm and the Target Frame (right frame) initial page to Page1.htm. After setting the initial pages, the page should look something like this…
4. Before we save our file, let’s review the HTML code generated for the frames pages. Switch to the Frames Page Code tab. It should look like this… This page uses frames, but your browser doesn't support them. Note the frame name and target parameter values. These will be important when creating hyperlinks.
©2006 SAP Americas. All Rights Reserved.
Page 23
SAP xMII Training 5. Now we can save the page as Main.htm in the your training folder. 6. Switch back to the Frames Page HTML view and note the modified paths to the initial HTML pages (defined in the src parameter). This page uses frames, but your browser doesn't support them.
©2006 SAP Americas. All Rights Reserved.
Page 24
SAP xMII Training Lab 5 – Forms Purpose The purpose of this lab is to introduce the basics of gathering information from a Form and submitting the data to a server.
Topics Covered This lab will cover the following topics… •
Html Forms
•
Html Form Elements
•
Basic JAVA Applets
•
Referencing objects on the web page
•
Gather information from a user and submitting it to the web server.
Procedure 1. Create a new page using the File/New Page… select a normal page and save it as OrderEntry.htm. 2. Using the Front Page tools, we will build an Order Entry screen that will ultimately look like this:
©2006 SAP Americas. All Rights Reserved.
Page 25
SAP xMII Training Insert a form on the new web page.
Right click on the form, choose “Form Properties” and set the following properties.
To align the elements on the form we will create a table 9 rows x 2 columns: (insert this table within the form, after the buttons).
©2006 SAP Americas. All Rights Reserved.
Page 26
SAP xMII Training
Begin building the Order Entry screen by entering the static text descriptions outlined above in the appropriate cells of the table that was just created. •
Order entry Lab Example
•
Order Date
•
Description
•
Quantity
•
Ship From
•
Horsham (Next to Radio button)
•
Exton (Next to Radio button)
©2006 SAP Americas. All Rights Reserved.
Page 27
SAP xMII Training Using the FrontPage Insert Menu we will add the following Html elements to the form.
One “Submit” and one “Reset” Push Button should have been created when the form was inserted…. Submit Button (Push Button) Select (click) and drag the Submit button to the appropriate cell. Double click the Submit button and configure the Push Button Properties as follows...
Reset Button (Push Button) The Reset Push Button is not used for this example. Single click it and press the delete key.
©2006 SAP Americas. All Rights Reserved.
Page 28
SAP xMII Training Select Element (Drop-Down Menu) Insert one Select Element Æ “Insert/Form/Drop-Down Menu” Double click the Select Element and configure these Drop-Down Menu Properties….
Text Element (One-Line Text Box) Insert a One-Line Text Box Æ “Insert/Form/ One-Line Text Box” Double click the Text Element and configure these Text Box Properties...
©2006 SAP Americas. All Rights Reserved.
Page 29
SAP xMII Training Radio Element (Radio Button) Insert (2) two Radio Elements Æ “Insert/Form/ Radio Button” Double click each Radio Element and configure these Radio Button Properties...
Text Area Element (Scrolling Text Box) Insert (1) one Text Area Element Æ “Insert/Form/Scrolling Text Box” Double click the Text Area Element and configure these Scrolling Text Box Properties...
©2006 SAP Americas. All Rights Reserved.
Page 30
SAP xMII Training
iCalendar The calendar control we will build into the page is a Java applet provided with CMS. To add the iCalendar applet, go to the Normal view and select the cell in the table where you want to put the calendar. Switch to the HTML view and add the following applet tag into the source code. (Note: Java is case sensitive) Save the OrderEntry.htm file in your training folder, and test.
©2006 SAP Americas. All Rights Reserved.
Page 31
SAP xMII Training
Sample: HTML Generated New Page 1 Order Entry Lab Example Order Date Description Product A Product B Product C Product D ©2006 SAP Americas. All Rights Reserved.
Page 32
SAP xMII Training Price Ship From Horsham Exton Enter Comments Here
©2006 SAP Americas. All Rights Reserved.
Page 33
SAP xMII Training
©2006 SAP Americas. All Rights Reserved.
Page 34
SAP xMII Training
Lab 6 – Style Sheets Purpose The student is introduced to the basics of applying Style Sheets to a web page. We will modify the OrderEntry.htm page font size and color by applying a basic style sheet.
Topics Covered This lab will cover the following topics… •
Creating a new style sheet
•
Reviewing style sheet HTML tags ( and )
•
Linking a style sheet to a HTML page
•
Applying style sheet classes in an HTML page
Procedure 1. First, we’ll create a new style sheet. From the File menu, select New… In the popup toolbar choose More page templates, go to the Style Sheet tab, select the Normal Style Sheet template, and select OK.
©2006 SAP Americas. All Rights Reserved.
Page 35
SAP xMII Training Next, we’ll add a tag to define the font information. Add the following tag and {classes} to the new style sheet. Type code right on the page. p {font face="BankGothic Md BT"} p.blue {font face="BankGothic Md BT"; font-size:10pt; color="#0000FF"; font style="bold"} p.red {font face="Verdana"; font-size:15pt; color="#800000"; font style="bold"} p.ucase {font face="BankGothic Md BT";text-transform:uppercase}
Save the page as style.css in the /Training/ folder on your web server, and then close the file. 2. Now we can link a page to the newly created style sheet and apply the styles to our text. Open the OrderEntry.htm we created in the previous lab. From the Format menu, select Style Sheet Links...
©2006 SAP Americas. All Rights Reserved.
Page 36
SAP xMII Training In the Link Style Sheet window, click the Add button and select style.css from your training folder. Click OK.
3. To apply the style sheet ‘classes’, highlight the “Order Entry Lab Example” text in the OrderEntry.htm page. From the drop-down menu on the FrontPage toolbar, set the class to Normal.red. You should notice that the text color did not change. That is because we are still in Normal view. Go to the Preview tab to view the color change.
Continue to apply the classes to the other text on the page as follows…
©2006 SAP Americas. All Rights Reserved.
Page 37
SAP xMII Training
Text
Class
“Order Date”
Normal.Blue
“Description”
Normal.Blue
“Quantity”
Normal.Blue
“Ship From”
Normal.Blue
“Horsham”
Normal.ucase
“Exton”
Normal.ucase
4. Let’s review the new HTML code in our page. You will note a link to the style sheet was added to the heading of OrderEntry.htm similar to this…
You should also note how the tags for the text have been modified to reflect the classes we applied… Order Date
5. Additional Resources for changing or embedding different font styles within a web page can be found at : www.microsoft.com/typography/web/embedding/weft
The syntax for embedding fonts into a web-browser would look something like this… @font-face{font-family:”Nueva Roman”; src:url(nuevar).eot)}
©2006 SAP Americas. All Rights Reserved.
Page 38
SAP xMII Training
Lab 7 – SAP xMII Installation Guide Introduction One of the key benefits of the SAP xApp Manufacturing Integration and Intelligence (SAP xMII) is its ultra-thin client architecture that requires zero client administration. SAP xMII clients require a standard Web browser only which minimizes installation and management. No SAP xMII software needs to be installed on any of the client systems. Setup and installation of SAP xMII is performed entirely on your Web server. The client browser does require that a Java Runtime Environment (JRE) plugin to be installed in order to use the full set of user interface objects. The supported JRE for a client machine is version 1.4.2 from Sun Microsystems, Inc.® (the latest release of 1.4.2 is recommended for the client). Note: It is not recommended that the server application be installed on a server with a JSDK/JRE version greater than 1.4.2_07. This SAP xMII installation is optimized to support Microsoft® Internet Information Services (IIS) on Microsoft Windows® 2003; however, Microsoft Windows® 2000 Server may also be used. Support for any nonWindows platforms and/or support for any servlet engine other than that supplied with the product requires special licensing arrangements. There is no end user support for these other platforms. SPC data analysis requires a database to be installed and configured. The recommended configuration is to install Microsoft SQL Server directly on the Web server. Note: You do not need a database if you are not using SPC data analysis. The core SAP xMII functionality stores its configuration data in operating system files. The SPC data analysis option benefits from a high performance CPU. SAP xMII includes an add-in for Microsoft FrontPage® and one for Macromedia® Dreamweaver® that enables the use of these tools as a unified development environment for your SAP xMII application. Refer to the Installing the FrontPage Add-In section of this topic for more information. If you are using Macromedia® Dreamweaver®, refer to the Installing the Dreamweaver Add-In section of this topic for more information.
©2006 SAP Americas. All Rights Reserved.
Page 39
SAP xMII Training System Requirements Prior to installing SAP xMII, you must ensure that your server meets the following minimum requirements: For 1For 11-100 10 Concurrent Concurrent Users
For 101-500 Concurrent Users
For 501+ Concurrent Users
Processor
1.8 GHz or faster
1.8 GHz or faster; dual processor recommended
dual processor, 1.8 GHz or faster
dual processor, 1.8 GHz or faster
RAM
See Web Server Documentation
See Web Server Documentation
See Web Server Documentation
See Web Server Documentation
(512 MB minimum recommended)
(1024 MB minimum (4096 MBytes minimum recommended) recommended)
(8192 MBytes minimum recommended)
Windows 2003 Server
Windows 2003 Server
Windows 2003 Server
Windows 2003 Server
-or-
-or-
-or-
-or-
Windows 2000 Professional with Service Pack 4 or greater
Windows 2000 Windows 2000 Windows 2000 Server with Service Server with Service Server with Service Pack 4 or greater Pack 4 or greater Pack 4 or greater
IIS 6.x or 5.x
IIS 6.x or 5.x
Users
Operating System
Web Server Software
IIS 6.x or 5.x
IIS 6.x or 5.x
Java Virtual Machine Sun JSDK 1.4.2_07
Sun JSDK 1.4.2_07 Sun JSDK 1.4.2_07 Sun JSDK 1.4.2_07
File System
NTFS
NTFS
NTFS
NTFS
The required system resources vary based on your applications; however, for sizing purposes, an estimated 2-4 MB per simultaneously connected user can be used. Virtually any Web browser, including Microsoft Internet Explorer, Netscape® Navigator, Netscape® Communicator, Opera®, and Mozilla® Firefox®, can be used with SAP xMII. We recommend that you use the most recent versions of these products. As stated above, the client should have the Sun JRE plug-in installed to the browser. The Sun® Java Runtime Environment (JRE) must be installed on the server prior to the SAP xMII installation (It is recommended that you download and install the full JSDK, instructions can be found below). Note: Turn off the Java automatic update mechanism via the Java Plug-in Control Panel. It is strongly recommended, although not required by SAP xMII, that the local volume where you are installing SAP xMII be formatted with the NTFS file system. This will enable a high degree of security control over your Web page content via direct integration with the Windows NT or Windows 2000 and IIS security and authentication subsystems. If you will be using the SAP xMII FrontPage add-in, you must be running Microsoft FrontPage 2000 and must have the FrontPage 2000 server extensions installed on your Web server. Refer to the FrontPage section for detailed instructions on how to install these products.
©2006 SAP Americas. All Rights Reserved.
Page 40
SAP xMII Training System Installation Prerequisites You will need to obtain a license file in order to run SAP xMII. You may request a license file at http://support.lighthammer.com, or through
[email protected]. See the license manager section of the help for more information. The Sun JSDK 1.4.2_07 must also be downloaded and installed on the server prior to installing SAP xMII. You can download the JSDK directly from http://java.sun.com/products/archive/j2se/1.4.2_07/index.html. Press on the "Download J2SDK" link on this page, save it to disk, and install the JSDK. A link to this site is also available on the xMIIInstall.htm on the root directory of the installation media (see below step by step instructions for more information).
Windows NT You must install a Web server prior to installing SAP xMII. Microsoft Web Server 4.0 is available as a free add-on to Windows NT Server or Workstation as part of the Windows NT 4.0 Option Pack. You can download the option pack or get it on CD-ROM from your local Microsoft reseller. If you are installing SAP xMII on an Windows NT Server system, you will install IIS 4.0. If you are installing SAP xMII on a Windows NT Workstation machine, you will install Personal Web Server (PWS) 4.0. Detailed information on installing IIS is provided with the Windows NT Option Pack. During the NT Option Pack installation it is important to select the Custom installation option and verify that the following components are selected for install: •
Internet Information Server (IIS)
•
Internet Service Manager
If you will be using ODBC data sources, it is suggested that you obtain the latest Microsoft Data Access Components from the Microsoft Data Access Web site and install them on your Web server. Note that these are not required to access Microsoft SQL Server or Oracle, as SAP xMII will install direct, high-performance drivers for these databases. If you are running Windows NT 4.0 and Internet Explorer 4.x on your Web server, it is recommended that you update certain system files before installing SAP xMII. It is advised that you run a Windows Update and install all recommended updates before proceeding. Note: Installation of IIS may cause the removal or overwrite of some of the Windows NT Service Pack components. It is recommended that you reinstall Service Pack 6a or greater on NT systems, prior to proceeding to the installation of the SAP xMII application. ©2006 SAP Americas. All Rights Reserved.
Page 41
SAP xMII Training Windows 2000 If you are installing SAP xMII on an MS Windows 2000 Server system, you will install IIS 5.0. If you are installing SAP xMII on an MS Windows 2000 Professional system, then you will install Personal Web Server (PWS) version 5.0. Microsoft Windows 2000 will typically install the IIS 5.0 components you will need to run SAP xMII. The Microsoft Web servers for Windows 2000 systems are available as part of the installation process of the operating system. If you already have the operating system installed, without the Web server, you may run the additional setup required by choosing "Add/Remove Windows Components" after starting the Add/Remove Programs service available within Control Panel (Internet Information Services (IIS) is the required component). If you will be using ODBC data sources, it is suggested that you obtain the latest Microsoft Data Access Components from the Microsoft Data Access Web site and install them on your Web server. Note that these are not required to access Microsoft SQL Server or Oracle, as SAP xMII will install direct, high-performance drivers for these databases. Note: Installation of IIS may overwrite or cause the removal of some of the Windows 2000 service pack components. It is recommended that you reinstall Service Pack 4 or greater on Windows 2000 systems, prior to proceeding to the installation of the SAP xMII application.
Windows 2003 By default, Windows 2003 Server has certain locked capabilities that must be changed after SAP xMII installation in order for SAP xMII to run. You must create a virtual directory in IIS with the proper privileges so that the servlet engine will run. Complete the Additional Steps for Windows 2003 section after the Step-by-step Installation.
Windows XP Professional Microsoft Windows XP Professional is not a supported server platform for production environments. It should be used for demonstrations and limited evaluations only. If you are installing SAP xMII on a Microsoft Windows XP Professional system, you will install IIS 5.1. IIS is not installed by default with the operating system. You will have to go to the Add/Remove Windows Components section and choose to install it. Select the World Wide Web Service and press Details, then check the Scripts Virtual Directory.
©2006 SAP Americas. All Rights Reserved.
Page 42
SAP xMII Training •
When installing IIS, you MUST do a custom install and choose to install the Scripts Virtual Directory. Without this virtual directory SAP xMII WILL NOT run. Additionally, if you have installed any Windows XP Service Packs, it will be necessary to reinstall them after adding IIS.
•
If you are using SQL Server 2000, you should have Windows XP service pack 2 and SQL Server 2000 service pack 3 installed.
Step-by-step Installation Note: If an error occurs during the install, please review the install logs for more information.
1. Make sure you are logged on to the server machine with an Administrator account. 2. If you are running Windows NT, stop the Web server and IIS via the Control Panel's Services applet. If you are running Windows 2000 or Windows 2003, stop the Web server and IIS via Start | Programs | Administrative Tools | Services by stopping the IIS Admin Service. This process automatically stops dependent services such as the World Wide Web Publishing service, FTP service, and SMTP service. 3. If you have physical CD media, insert the SAP xMII CD into your CD-ROM drive. Auto-run opens the SAP xMII Installation page in your default browser. If you downloaded the software from the SAP Service Marketplace, extract the downloaded archive to a local directory and then open the xMIIInstall.htm page in the chosen directory. Note: If you are using physical media and auto-run fails, you can open the xMIIInstall.htm page from the CD root to install SAP xMII. A link to the Sun Java 2 SDK installation is also available on this page if you did not yet download and install it. Once the JSDK is installed, you can run SETUP.EXE directly from the install folder.
©2006 SAP Americas. All Rights Reserved.
Page 43
SAP xMII Training 4. If you already installed the Sun JSDK 1.4.2_07 on the server, continue to step 5. OR If the Sun JSDK 1.4.2_07 is not installed, download the JSDK directly from http://java.sun.com/products/archive/j2se/1.4.2_07/index.html. Cl ick the "Download J2SDK" link, save the file to disk, and run the setup from the local disk. OR If a prior version of the Sun JDK or JRE is installed, uninstall the JDK/JRE and all references to Sun Java products including the following: •
Java 2 Runtime Environment (JRE)
•
Java 2 Software Development Kit (SDK)
•
Residual folders and files under the root directory (i.e., C:\jdk1.3.1_01) or under \Program Files\Java
•
Registry entries (via Start | Run, enter Regedit in the Open field, select HKEY_LOCAL_MACHINE\SOFTWARE, and delete the JavaSoft folder and all its sub-directories)
Then install the Sun JSDK 1.4.2_07. 5. Select the SAP xMII 11.5 installation link. The InstallShield Wizard for SAP xMII window appears. If you did not stop the IIS Admin service, the following window appears. Click the Yes button to stop the service. Click the No button to exit the install.
To continue, click the Next button. You may click the Cancel button at any time during the process in order to stop the installation. 6. The License Agreement window appears. Please read the license agreement carefully. If you accept the license agreement, click the Yes button to continue the SAP xMII installation. OR If you do not accept the license agreement, click the No button. The setup stops and InstallShield Wizard closes.
©2006 SAP Americas. All Rights Reserved.
Page 44
SAP xMII Training 7. The Choose Destination Location window appears and prompts you to select a destination folder where the setup will install the SAP xMII application. The default destination folder is usually acceptable, although it is recommended that you install the Lighthammer directory to the same drive on which you installed IIS. The Lighthammer directory should be installed on the root of the drive you select. You should not install it at locations such as Program Files, etc. Click the Next button to continue the installation.
©2006 SAP Americas. All Rights Reserved.
Page 45
SAP xMII Training 8. Another window appears and prompts you to choose a destination location for the Web root directory for the Web server. The default location for Microsoft IIS is C:\InetPub\wwwroot and is usually acceptable. If you moved your default Web root, indicate it here. Click the Next button to continue the installation.
9. If you are upgrading from a version prior to version 11.0, the following window appears. Click the Yes button to continue the installation as an upgrade. Click the No button to exit the installation. If you are not upgrading a version prior to 11.0, skip to step 10.
©2006 SAP Americas. All Rights Reserved.
Page 46
SAP xMII Training 10.Confirm the location of your Illuminator directory. The correct location should default.
11.If your previous version was installed with the ServletExec ISAPI filter, it must be uninstalled in order to continue with your current installation. To correctly uninstall the ISAPI filter, the SAP xMII install must reinstall the ISAPI filter. Follow the ISAPI filter install instructions and accept all defaults. If your previous install did not include the ISAPI filter, you may skip to step 13.
©2006 SAP Americas. All Rights Reserved.
Page 47
SAP xMII Training 12.Once the ISAPI install completes, you must uninstall it. Click the OK button to uninstall the ISAPI filter.
Click Yes to uninstall ServletExec ISAPI
Click the Yes button to stop the IIS Admin service. Click the Yes button to delete the ServletExec ISAPI install directory.
After the ISAPI uninstall is complete, install ServletExec Application Server. 13.A window appears noting that the ServletExec Application Server (AS) install is about to be launched. Please make special note of the instructions on this dialog before proceeding with the AS installation.
©2006 SAP Americas. All Rights Reserved.
Page 48
SAP xMII Training 14.Select the AS instance option button when you are asked what type of installation you wish to perform.
©2006 SAP Americas. All Rights Reserved.
Page 49
SAP xMII Training 15.Select a folder for the Application Server installation. It is suggested that you install to the same root drive that you chose for SAP xMII. Click the Browse button, and enter the following: :\ServletExec AS. See below.
©2006 SAP Americas. All Rights Reserved.
Page 50
SAP xMII Training 16.When the AS install is launched, you are asked to select an AS instance name for SAP xMII. Type "LHCMS" over the default name.
©2006 SAP Americas. All Rights Reserved.
Page 51
SAP xMII Training 17.Choose IIS as the Web server.
©2006 SAP Americas. All Rights Reserved.
Page 52
SAP xMII Training 18.If the Scripts Virtual Directory does not exist, the following window appears.
19.Enter a port number for the Application Server. Note: This is an internal port only, and IIS will continue to run on port 80. All SAP xMII content will still be accessed through port 80. In order for the application to operate properly, other applications should not be using the port number you enter.
©2006 SAP Americas. All Rights Reserved.
Page 53
SAP xMII Training
If you want to change this port number at a later time, see Changing the Application Server Port Number. After you confirm the selections you made above, you can select a password for the ServletExec admin account or you can leave the password blank. Then, click the Yes button to install ServletExec AS as an NT service.
20.You do not need to view the ServletExec install log or the readme file. When the ServletExec install is complete, it will open an Explorer window. Close this window.
©2006 SAP Americas. All Rights Reserved.
Page 54
SAP xMII Training 21.When the Servlet Exec AS installation is complete, the SAP xMII installation asks for the AS installation location so that the SAP xMII webapp files can be copied to the correct location. The file transfer may take a few minutes. The default location should be the correct location.
©2006 SAP Americas. All Rights Reserved.
Page 55
SAP xMII Training 22.Select an option button for the amount of RAM that you wish to designate to SAP xMII via ServletExec AS.
Note: Once the installation is complete and SAP xMII is operating properly on ServletExec Application Server, it is no longer necessary to restart IIS in order to restart the SAP xMII application. Simply go to the Services console, and restart the ServletExec- service. That process will reload SAP xMII.
©2006 SAP Americas. All Rights Reserved.
Page 56
SAP xMII Training 23.Enter the fully qualified machine name (e.g., MACHINE_NAME.Domain.com) of the machine on which you are installing SAP xMII. It is required to identify the location of the security server in a multiple domain and/or third-party single signon scenario. If you are not implementing across domains or using third-party single sign-on, the machine name (without the domain name) is sufficient.
©2006 SAP Americas. All Rights Reserved.
Page 57
SAP xMII Training 24.Enter the anonymous IIS user account (e.g., IUSR_Machine_Name) of the machine on which you are installing SAP xMII. The anonymous IIS user account is used to set permissions on SAP xMII install directories.
The installation begins copying files and installing. If an error occurs, the InstallShield stops and the setup does not continue. 25.If you are upgrading from a previous version, the following window appears. Click the Yes button to run the 11.5 migration tool. The migration tool upgrades your system configurations from your previous version to the current. If you click No, you can run the migration from the Start menu after the installation.
©2006 SAP Americas. All Rights Reserved.
Page 58
SAP xMII Training 26.Click the OK button to run the system migration. When the migration is complete, click the Cancel button to close the window.
27.If you are upgrading from a version prior to 11.0, the following window appears. Click the Yes button to run the security migration. The security migration does not have an interface like the system migration. A DOS window appears; close it to run the security migration. If you are upgrading from 11.0 or 11.0.1, the security migration window does not appear since there is no migration from those versions. If you choose not to run the security migration at this time, you can run it from the Start menu.
©2006 SAP Americas. All Rights Reserved.
Page 59
SAP xMII Training 28.If this is a new installation, once all files have been copied, the following window appears. Click the OK button to choose a template. If this is an upgrade, this step is skipped and your existing default template styles remain.
©2006 SAP Americas. All Rights Reserved.
Page 60
SAP xMII Training 29.After clicking the OK button, the three template style choices are displayed. As the previous window notes, all three are installed on your machine, but only one is used as the default template style.
Click Next to make your template selection.
©2006 SAP Americas. All Rights Reserved.
Page 61
SAP xMII Training
30.The SAP xMII installation is complete. Click the Finish button to close the InstallShield Wizard. 31.After the installation is complete but before using SAP xMII, stop the IIS Admin Service and then restart the Web server. There are two methods for stopping/starting the IIS Admin Service and World Wide Web Publishing Service. From the Start menu, select Programs | Lighthammer | Illuminator and either the Stop IIS or Start IIS batch file options. OR In Windows NT, open the Windows Control Panel and select the Services option, or in Windows 2000, choose Start | Programs | Administrative Tools | Services. Highlight the IIS Admin and click the Stop button to stop this service and all dependent services. Then restart the World Wide Web Publishing Service (and any other necessary Web services such as FTP or SMTP) which automatically restarts the IIS Admin Service. In Windows 2000, all Web services can also be managed through Start | Programs | Administrative Tools | Internet Services Manager. 32.Before accessing SAP xMII you need to set up your license. To do this, copy your lhcms.lic license file into the C:\Lighthammer\License directory and then restart your ServletExec-{InstanceName} NT service in the Windows Services window.
©2006 SAP Americas. All Rights Reserved.
Page 62
SAP xMII Training Note: It usually takes several minutes to restart the application instance, so you will not be able to access the application until it is finished.
Additional Steps for Windows 2003 Complete the following steps to allow the servlet engine to run as a recognized Web service extension. 1. Select the Web Service Extensions folder. 2. Click the Add a new Web service extension link. The New Web Service Extension window appears. 3. Enter ServletExec as the new Web service name.
4. Browse to the C:\Inetpub\Scripts location and select ServletExec_Adapter.dll as the required file.
©2006 SAP Americas. All Rights Reserved.
Page 63
SAP xMII Training
5. Select the Set extension status to Allowed check box. 6. Click the OK button.
Installing the FrontPage Add-in The SAP xMII add-in for Microsoft FrontPage 2000 and Microsoft FrontPage 2002 is installed in the \Lighthammer\Illuminator\Wizards directory on the drive on which you installed the SAP xMII application. In order to use the add-in, it must be installed on each PC that will be running FrontPage. On computers other than the Web server, a Web package installation is available on the SAP xMII Web server: http:///Lighthammer/WizardInstall/IlluminatorWizard.exe. You can save the file locally and run it, or you can select Open and run it directly from the Web server. Note: Windows 2003 Server requires the FrontPage 2002 Server extensions. Once the file is installed (the default is :\Lighthammer\Illuminator\Wizards), open FrontPage. Select the /Tools/Add-Ins menu option. If you already had a previous version of the Add-in installed (prior to Illuminator 9.5) highlight the SAP xMII Wizard selection and press the Remove button. If this is a new install, skip to the enable step below.
©2006 SAP Americas. All Rights Reserved.
Page 64
SAP xMII Training To enable the new add-in, click the Add button, and browse to the location where the Illum95FPWizard.dll file resides (default is :\Lighthammer\Illuminator\Wizards). After clicking the OK button, you should see the SAP xMII add-in installed as shown in the following dialog:
The add-in is automatically loaded each time FrontPage is started. The add-in includes the SAP xMII Object, the Script Assistant, and links to the SAP xMII Template Editor and the System Administration Editor.
Installing the Dreamweaver Add-in The SAP xMII add-in for Macromedia Dreamweaver is installed in the \Lighthammer\Illuminator\Wizards directory on the drive on which you installed the SAP xMII products. NOTE: In order to use the add-in, this file must be installed on each PC that will be running Dreamweaver. On computers other than the Web server, a Web package installation is available from the SAP xMII Web server: http:///Lighthammer/WizardInstall/IlluminatorWizard.exe Use the following steps to enable the Dreamweaver add-in: 1. Copy the C:\Lighthammer\Illuminator\Wizards\IllumDWWizard.dll file to your local installation of the Dreamweaver MX program, JSExtensions directory (the default is C:\Program Files\Macromedia\Dreamweaver MX\Configuration\JSExtensions). 2. Copy the C:\Lighthammer\Illuminator\Wizards\Illuminator Object.htm file to C:\Program Files\Macromedia\Dreamweaver MX\Configuration\Commands. 3. Copy the C:\Lighthammer\Illuminator\Wizards\Illuminator Script Assistant.htm file to C:\Program Files\Macromedia\Dreamweaver MX\Configuration\Commands.
©2006 SAP Americas. All Rights Reserved.
Page 65
SAP xMII Training You should then be able to go into Dreamweaver and find the links at the bottom of the Command menu. If selecting SAP xMII Object does not display the plug-in, open a command prompt and type "cd\Lighthammer\Illuminator\Wizards" to navigate to the folder where the DLLs are located. Then type "regsvr32 IllumDWWizardGUI.dll" which should register the dll. Dreamweaver should then prompt you for the SAP xMII server name or internet protocol (IP) address (it defaults to localhost) when calling up the plug-in; this is similar to the standalone version of the plug-in. You can then configure Dreamweaver for editing SAP xMII Report pages (.irpt).
Initialization By default, SAP xMII starts up (initializes) when the NT Service starts up. There is a time delay for the initialization in order for various system services to start up as before SAP xMII initializes. It is important that the timing is correct. The default delay is 30 seconds. This can easily be changed if it is causing problems. A symptom of this problem is a class not found error in the Servlet Exec logs, because not all systems were initialized before SAP xMII was started, causing some paths to be incorrect. Until the delay time is complete, it is recommended that you do not attempt to query SAP xMII. This includes accessing the SAP xMII main menu. Keep in mind that the delay is in addition to the delay caused by the NT Service start up time. See the Server Logging section to see how to access the Servlet Exec Logs. See the section on SAP xMII Initialization in the system configuration guide for more information on this topic.
Time Synchronization of Servers and Clients In order for SAP xMII to operate correctly, the system clocks on the Web server, data servers, and client browsers should be maintained in reasonably close synchronization. In the case where other applications on the Web server prevent the enabling of automatic daylight savings time adjustment, you must configure the time zone to use the option that does not include the auto adjust checkbox [e.g., use the (GMT-05:00) Bogota, Lima, Quito time zone instead of the (GMT-05:00) Eastern Time (US & Canada) time zone].
Installation Log Files There are three installation logs created when installing SAP xMII. If you experience problems during your installation or have questions about installation locations, you can review these log files. •
SAP_xMII_Install_date_time.log is an overall general log file for the installation located in the Lighthammer\Logs directory.
©2006 SAP Americas. All Rights Reserved.
Page 66
SAP xMII Training •
CMSServicesInstall_date_time.log contains details relating to the installation of your SAP xMII services and is located in the Lighthammer\Logs directory.
•
xMIISecurityInstall_date_time.log contains details relating to the installation of Security Manager and is located in the Lighthammer\Logs directory.
©2006 SAP Americas. All Rights Reserved.
Page 67
SAP xMII Training
©2006 SAP Americas. All Rights Reserved.
Page 68
SAP xMII Training
Lab 8 – Getting Connected Purpose The student will learn how to connect to various data sources and verify their connection status through the configuration of the SAP xMII Connectors and Servers. Data sources will include: Microsoft SQL, InSQL, AlarmSuite, PI (via UDS) and Virtual SQL.
Topics Covered This lab will cover … •
xMII Administration Menu
•
Connectors: Types, Configuration
•
Adding/Configuring/Editing servers
•
Verifying Connector / Server status
Procedure To access the SAP xMII Administration Menu, in your browser navigate to
http:///Lighthammer/ NOTE: Your instructor will provide you with the server name and your login credentials After you login your screen should look similar to this …
©2006 SAP Americas. All Rights Reserved.
Page 69
SAP xMII Training **The Instructor will perform the next steps to connect to a series of data sources. Please be aware that any changes to configuration settings on the server affect the entire class. 1. To Configure our Servers (connections), under Data Services select Data Servers. 2. Uncheck the “Show Only Enabled Servers” box to show all the default Servers. 3. Select InSQLOleDB and verify that the URL value (in the Server Parameters box) is correctly entered: a. Edit the proper nodename of the InSQLOleDB server used in the training class by highlighting the ServerURL line in the Server Parameters window and making the appropriate changes . By default, the nodename listed is localhost, which represents the local machine. Since InSQL is may not be running on the local machine you need to point to the correct server - verify the IP address with the instructor. b. Verify the TCP/IP port. (Note: The configured InSQLOleDB port is typically 1433). c. Verify the database name for InSQL Server is Runtime. The database name for the InSQL connectors will always be Runtime. d. Click the “Enabled” checkbox.
©2006 SAP Americas. All Rights Reserved.
Page 70
SAP xMII Training 4. For our next server select MSSQL_Database in the ‘Servers’ list, click COPY. Enter PlasticResin for the server name. 5. Now edit the URL nodename to (or which is the default) and the database name to PlasticResin. Verify the port is set for 1433 (MS SQL Server). Since there is a PlasticResin database running on the local computer the nodename can be localhost. Click OK.
6. Click the “Enabled” checkbox 7. Similarly, create a new MSSQL connection. Select MSSQL_Database in the ‘Servers’ list, click COPY. Enter Alarms for the server name. Verify the nodename is pointing at the proper server, and the database name is AlarmSuite. Click the “Enabled” checkbox. See next page.
©2006 SAP Americas. All Rights Reserved.
Page 71
SAP xMII Training
8. Now edit the URL nodename to (or which is the default) and the database name to PlasticResin. Verify the port is set for 1433 (MS SQL Server). Since there is a PlasticResin database running on the local computer the nodename can be localhost. Click OK.
9. Click the “Enabled” checkbox. 10. After configuring the Servers, click the Save button. After saving, select the Status button to verify whether or not you have connected to your data sources.
See next page:
©2006 SAP Americas. All Rights Reserved.
Page 72
SAP xMII Training
A value of ‘1’ in the Connections Available column indicates that the server configuration is complete and a successful connection to the data source has been made. A value of ‘0’ in the Connections Available column indicates there is either a problem in the configuration or the specified data source is not available.
©2006 SAP Americas. All Rights Reserved.
Page 73
SAP xMII Training
©2006 SAP Americas. All Rights Reserved.
Page 74
SAP xMII Training
Lab 9a – Building Queries Using the Template Editor Purpose The purpose of this lab is to introduce the basics for creating and customizing data queries using the SAP xMII Template Editor.
Topics Covered This lab will cover the following topics… •
Tag Queries
•
SQL Queries
Procedure First, we will create a series of Query Templates that will be used to extract data for the Java Applets. From the SAP xMII CMS Menu, under Data Services click the Query Templates icon.
©2006 SAP Americas. All Rights Reserved.
Page 75
SAP xMII Training CREATING A ‘TAG’ QUERY 1. Current Mode: a. Select the ‘New’ button,
then select Tag Query from the Template Type drop-down menu. Select OK.
©2006 SAP Americas. All Rights Reserved.
Page 76
SAP xMII Training
b. In the Data Source tab, select InSQLOLEDB Server and Current Mode.
c. Switch to the Tag Query Details tab. Note the Available Tags list. d. Use the Tag Selection Mask field to limit the Available Tags listed to only those you wish to view. In the example below, enter %speed and select the Apply button. This will limit the tags in the Available Tags field to only those tags that include ‘speed’ in their tagname. e. Use the >>, >, >’ buttons to select the desired Tables and Columns).
©2006 SAP Americas. All Rights Reserved.
Page 81
SAP xMII Training
d. In the Sort Expression: field, add PlasticBottleBatchData.OrderNo ASC. (HINT: select ‘OrderNo’ from the Available Columns: field and use the Paste button to the left of the Sort Expression: field – then select the ASC button to the right of the Sort Expression: field)
e. Use the Test button to verify that the proper data is returned. f. Save the template in your training folder as BatchListQuery.
©2006 SAP Americas. All Rights Reserved.
Page 82
SAP xMII Training
g. Using the same Data Source settings, we’ll create a new SQL Query. From the Available Tables: select two tables; Sublot and Lot. h. Select the appropriate columns from each of the tables (see below). Use the > button to move the selected columns and use the Up and Down buttons to order the columns as below. The Selected Columns should be in the following order: Sublot.LotID Lot.MaterialName Sublot.Location Sublot.QueuedQty Lot.HoldStatus Lot.QuarantineStatus **Note: To populate expression boxes, highlight an ‘Available Table’ and an ‘Available Column’ and click the ‘Paste’ button next to the expression box you would like to populate. i. In the Join Expression: field, add Lot.LotID=Sublot.LotID. j. In the Filter Expression: field, add Lot.LotID LIKE ‘[Param.1]’ k. In the Sort Expression: field, sort on SubLot.LotID. l. On the Parameters tab, enter a % (percent sign) in the Parameter Value: field and click Set
m. Use the Test button to verify the proper data is returned. n. Save the template in your training folder as LotListQuery. o. Create a new SQL Query using the same PlasticResin data source and Query Mode. p. Select the PlasticBottleTrendData table and the Operator column. ©2006 SAP Americas. All Rights Reserved.
Page 83
SAP xMII Training q. In the Filter Expression field, enter: PlasticBottleTrendData.BatchNo LIKE ‘[Param.1]’ . r. On the Parameters tab, enter a % (percent sign) in the Parameter Value: field and click Set s. Use the test button to verify that the proper data is returned. t. Save the template in your Training folder as OperatorScoreboardQuery.
**Note - Parameters (used in the Filter Expression) provide an alternative to changing other SQL, Alarm, or XML properties at runtime and provide a cleaner mechanism for changing query behaviors dynamically based on filtering or other criteria.
©2006 SAP Americas. All Rights Reserved.
Page 84
SAP xMII Training Create a new SQL Query using the same PlasticResin Data Source and Query Mode. Select the PlasticBottleTrendData table and select all columns (use the ‘>>’ button to move all the column names). u. Click the Date Range tab and set the Start Date: 08/01/2003 06:45:00 and the End Date: 08/01/2003 20:45:00. v. Under the SQL Query Details tab In Available Columns: highlight the DateTime column. Select the Set button next to the Date Column: field. w. In the Filter Expression field, enter: BatchNo LIKE '[Param.1]'. x. On the Parameters tab, enter a % (percent sign) in the Parameter Value: field and click Set y. Click Test to verify the proper data is returned. Notice the Date-Time parameters are passed into the SQL Statement. z. Save the template in your training folder as BatchTrendQuery.
©2006 SAP Americas. All Rights Reserved.
Page 85
SAP xMII Training
aa. Create a new SQL Query using the same PlasticResin Data Source and Query Mode. Under the SQL Details Tab select the KPIData and KPIConfig tables. bb. Select all Columns from both tables (use the ‘>>’ button to move all the column names). cc. In the Join Expression: field, add KPIData.KPIName=KPIConfig.KPIName (this will join the tables on the KPIName). dd. In the Filter Expression: field, add KPIConfig.KPIName =’Yield’ (this will cause the query to return only yield data).
ee. Save the template in your training folder as KPIQuery.
©2006 SAP Americas. All Rights Reserved.
Page 86
SAP xMII Training 2. Fixed Query Mode: a. Create a new SQL Query using the same PlasticResin server, but change the Mode to FixedQuery. b. In the Fixed Query tab, enter the following SQL Statement: Select BatchID, Color, MeltingPt, ChipsPerGram, OrderNo, BatchStart, BatchEnd, LotID from PlasticBottleBatchData order by OrderNo
c. Test and Save the template in your Training folder as BatchListFixedQuery.
©2006 SAP Americas. All Rights Reserved.
Page 87
SAP xMII Training
d. Once again create a new SQL Query with the PlasticResin server, Mode = FixedQuery. e. Enter the following SQL Statement: (Hint: Try highlighting the table name and column that you want to insert and click the ‘Paste’ button next to the ‘Available Columns’ window – this will insert the table name and column. To just insert the table name, highlight the table name and click the ‘Paste’ button next to the ‘Available Tables’ window) Select PlasticBottleTrendData.DateTime, PlasticBottleTrendData.BatchNo, PlasticBottleTrendData.Pressure, PlasticBottleTrendData.Temperature, PlasticBottleTrendData.MixSpeed, PlasticBottleTrendData.Operator from PlasticBottleTrendData Where (PlasticBottleTrendData.DateTime >= [SD] AND PlasticBottleTrendData.DateTime > “ button. n. In the Sort Expression field, enter LastEvent DESC Verify your settings are correct via the screen shot on the next page:
©2006 SAP Americas. All Rights Reserved.
Page 89
SAP xMII Training
o. Test and Save the query in your training folder as AlarmQuery .
©2006 SAP Americas. All Rights Reserved.
Page 90
SAP xMII Training
Lab 9b – Building Displays Using the Template Editor Purpose The purpose of this lab is to introduce the basics of the using the Visualization Services for creating and customizing display templates used for visualizing the data queried.
Topics Covered This lab will cover the following topics… •
Display Template Editor
•
iCharts, iGrids, iBrowsers, and iTicker display applets
Procedure iChart Display Templates The iChart display template can be used to create many different charts including: - Line
- Floating Bar
- Regression
- Pie
- Stacked Bar
- XY Regression
- Polar
- Event Horizon
- XY
- Group Bar
- Strip Chart
- Radar
- Bar
- Variability Bar
- Gauge
- Waterfall
- Custom
- Horizontal Bar
- Horizontal Group Bar
We will begin by creating a new iChart Display template using the Line display mode. iChart Display Templates a. From the SAP xMII Admin Menu, under Visualization Services click the Display Templates icon. b. Select the ‘New’ button, then iChart from the Template Type drop-down menu. Select OK. c. In the Chart Type: drop-down box, select Line. d. In the Title text box, enter iChart – Line Chart Type. e. Save the template as iChartLine in your training folder.
©2006 SAP Americas. All Rights Reserved.
Page 91
SAP xMII Training
Note: Before continuing, review the parameters available in each of the Display Template tabs (e.g. General, Legend, Xaxis, Yaxis, Pen Details, Behaviors, Data Mapping, and Refresh). After we are finished creating Display Templates, we will revisit a few samples to discuss the effect of the various parameters available. f.
In the same iChartLine template, change the Chart Type to Bar and the Chart Title to iChart – Bar Chart Type. Save the template as iChartBar.
Using the table below as a guide, create these additional Display Templates: Chart Type
Title
Save As
GroupBar
iChart – Group Bar Chart Type
iChartGroupBar
Polar
iChart – Polar Chart Type
iChartPolar
FloatingBar
iChart – Floating Bar Chart Type
iChartFloatingBar
Gauge **
iChart – Gauge Chart Type
iChartGauge
**Note: For Gauge, set both the Horizontal and Vertical Grid Line Count = ‘2’ prior to saving
©2006 SAP Americas. All Rights Reserved.
Page 92
SAP xMII Training Create a new iChart – Line for a SQL Trend: a. Select the ‘New’ button, then iChart from the Template Type drop-down menu. Select OK. General tab: b. In the Chart Type: drop-down box, select Line. c. In the Title text box, enter Profile for BATCH00018. d. Set the Title Font: to Helvetica 16 Bold Italic, Title Color: to Yellow. e. Check appropriate boxes per screen print below…
©2006 SAP Americas. All Rights Reserved.
Page 93
SAP xMII Training
Legend tab a. Set Background Color: black, Border Color: White, Selection Border Color: gray, Label Color: White, Font: Helvetica 12. b. Check Legend on Top? Box. c. Set Legend Width: 25, Legend Height: 0.
©2006 SAP Americas. All Rights Reserved.
Page 94
SAP xMII Training Pen Details tab a. In the Pen Details tab, change the Pen settings as follows: Pen #
Scale
Pen Color
1
Auto / Zero base
Yellow
2
Auto / Zero base
Cyan
3
Auto / Zero base
Red
* Make sure Global Server Scaling is unchecked
©2006 SAP Americas. All Rights Reserved.
Page 95
SAP xMII Training Data Mapping tab a. In the Value Columns: box, add Pressure,Temperature,MixSpeed (Hint: use the ‘…’ button to connect to the BatchTrendQuery, highlight a column name and click the ‘ button select the PITempQuery, InSQLTempQuery, and SimTempQuery. Choose an alias name if you want. These 3 templates should now appear in the Aggregate Query Source Templates window. You can select up to 32 templates from which to aggregate data.
©2006 SAP Americas. All Rights Reserved.
Page 200
SAP xMII Training 5. Choose the Aggregate Query Details tab. On this tab we will set a “common” parameter for the 3 query templates.
6. From the Aggregate Query Source Param dropdown select Duration. The aggregate query duration is defaulted to the last 60 minutes of data (just like all queries). 7. From the Target Template dropdown we can choose *. This means we want to do this for all the source queries. 8. From the Target Param dropdown select Duration. Click the Add button. This will set the duration parameter in all the source queries to whatever the Duration is set to in the aggregate query.
9. Test your query. 10. Display the data on a line chart. Put the applet on a webpage.
©2006 SAP Americas. All Rights Reserved.
Page 201
SAP xMII Training
©2006 SAP Americas. All Rights Reserved.
Page 202
SAP xMII Training
Exercise F - Metrics and Monitoring Purpose The purpose of this lab is to explore xMII’s Active Portal features.
Topics Covered This lab will cover the following topics… •
Creating datasets.
•
Using the Metric Editor.
•
Running metrics with scheduled tasks.
•
Setting up monitors.
Procedure 1. Create 2 new SQL queries with the following parameters: Query 1 a. Server = Plastic Resin b. Mode = Query c. Selected Tables = KPIData d. Selected Columns = All (TimeRecorded, KPIName, KPIValue, KPISource) e. Save AS KPIQuery1 Query 2 – Same as query 1 with the following additions: a. Filter Expression = KPIData.KPIName LIKE ‘[Param.1]’ AND KPIData.KPISource LIKE ‘[Param.2]’ b. Parameter 1 = % c. Parameter 2 = % d. Save AS KPIParamQuery 2. From the following URL: http://localhost/Lighthammer/Menu.jsp, select Metric/AlertServices > Catagories icon.
©2006 SAP Americas. All Rights Reserved.
Page 203
SAP xMII Training 3. Create a new category called Training by entering a category name and description and clicking the ‘Add New’ button.
4. Back to the Metric/Alert Services Menu, choose ‘Datasets’. - Datasets are query templates plus parameters 5. Click the ‘…’ button to select a query source. 6. Find our KPIParamQuery in the training folder and choose it. 7. In the “name – value” pairs box scroll down, choose Param.1 and click the ‘Set Query Parameter 1’ button. Scroll down more and pick Param.2 and click the ‘Set Query Parameter 2’ button. Close the window.
©2006 SAP Americas. All Rights Reserved.
Page 204
SAP xMII Training 8. Change the ‘Query Parameter’ value for Param.1 to OEE and the ‘Query Parameter’ value for Param.2 to Line1. 9. Name the Dataset Line1OEE, Description = “OEE calculation for Line 1”. 10. Click ’Add New’.
©2006 SAP Americas. All Rights Reserved.
Page 205
SAP xMII Training
©2006 SAP Americas. All Rights Reserved.
Page 206
SAP xMII Training Creating Metrics 1. Now we will create Metrics, from the Metric/Alert Services Menu, select ‘Metrics’.
2. Choose the “Training” category, leave the following parameters at their default values: Range Limits, Active?, Historize?. Set the Scan Group to 15 min role to Administrators. 3. Source Type is Query Template, click the ‘…’ button on the Source Item ID line to choose our query template.
©2006 SAP Americas. All Rights Reserved.
Page 207
SAP xMII Training 4. Find the InlineQuery in the Training folder, and click the ‘Load Sample Data’ button.
5. Our first metric will just be the line 1 speed. Click the L1Speed column, L1Speed should appear in our expression window. Close the Metric Configuration Window.
©2006 SAP Americas. All Rights Reserved.
Page 208
SAP xMII Training 6. Enter the Metric Name: L1Speed and Description: Line 1 Speed and click the ‘Add New’ button. 7. Refresh the Metrics page, and choose the Training category, create the next metric using the same query template, leave the following parameters at their default values: Range Limits, Active?, Historize?. Set the role to Administrators and Scan Group to 15min. 8. For this metric we will calculate an average for the 4 line speeds. In the Metric Configuration Window create the expression:
Close the window 9. Name the metric AvgSpeed, Description: Average Line Speed. 10. Click the ‘Add New’ button. 11. For our 3rd metric, refresh the Metric Editor page, and choose the Training category (you should see the 2 metrics we already created). Leave the following parameters at their default values: Range Limits, Active?, Historize. Set the Scan Group to 15min and the role to Administrators. 12. Make sure Source Type is Query Template, click the ‘…’ button on the Source Item ID line to choose the KPIQuery1 that we created. Note: this query returns a list of KPI names and values for many different locations. By using the ‘Row Match Rule’ buttons we will be able to filter this query.
©2006 SAP Americas. All Rights Reserved.
Page 209
SAP xMII Training 13. Click the KPIValue heading in the data window to enter KPIValue in the expression window. This will define our metric value.
14. The metric we want to define is the Capacity Utilization for Malibu. Scroll down in the Data Window and choose “CapacityUtilization” and click the ‘Set Row Match Rule 1’ button.
©2006 SAP Americas. All Rights Reserved.
Page 210
SAP xMII Training 15. Choose “Malibu” and click the ‘Set Row Match Rule 2’ button. Close the window.
16. Name the metric MalibuCU and give it a description. 17. Click the ‘Add New’ button. 18. For our last metric, refresh the Metric Editor page, and choose the Training category. Leave the following parameters at their default values: Range Limits, Active?, Historize?. Set the Scan Group to 15min and the role to Administrators. 19. Make sure Source Type is Dataset, click the ‘…’ button on the Source Item ID line to choose the Dataset that we created. 20. In the Metric Configuration window we should see the Dataset that we created (Line1OEE). Select the dataset and click ‘Load Sample Data’.
21. Our metric will be the KPI value, so click the KPIValue header so it appears in the expression window. Close the window. 22. Name the metric Line1OEE and give it a description. 23. Click the ‘Add New’ button.
©2006 SAP Americas. All Rights Reserved.
Page 211
SAP xMII Training Prepare to run metrics 1. Open Windows Explorer. 2. Go to C:\Lighthammer\Illuminator\ActivePortal\TaskScheduler. (done by instructor)
3. Copy and paste these 6 files into the Scheduled Tasks folder under Control Panel. 4. From the Start Menu go to Control Panel, Scheduled Tasks, right click and open in a window. 5. Right click the Active Portal Monitoring – 15MIN file and choose properties. 6. Click the ‘Set Password Button’ – the password for these computers is “Illuminator”. 7. Follow the same procedure for the ‘Alert Mailer” file.
©2006 SAP Americas. All Rights Reserved.
Page 212
SAP xMII Training Set up Monitors 1. Log into xMII (Admin/Admin). 2. Under ‘Metric/Alert Services’ choose ‘Monitors’. 3. In the Category window select Training. 4. In the metric window choose L1Speed (we will be monitoring our line 1 speed).
5. Enter a description, check Active? and Requires ACK?, match type = number, match condition = less than, match value = 1000. 6. Enter an Alert String – “The speed is {Current Value} – This is too low.” To enter {Current Value} into the string use the Alert Token drop-down.
©2006 SAP Americas. All Rights Reserved.
Page 213
SAP xMII Training
7. Click the ‘Add New’ button. 8. Login to xMII: http:///Lighthammer 9. From your navigation tree, select “My Illuminator”, then “Alert Manager”. 10. Choose Training from the category window. You should see the Line 1 Speed metric appear in the ‘Available for Subscription’ window. 11. Choose Line 1 Speed, uncheck “E-mail notification” and click the ‘Add ->’ button. 12. From your navigation tree, select “My Illuminator”, then “Alert Log”. 13. You should see your Alert messages appear (you may have to wait for your scheduled task to run prior to seeing alerts)
©2006 SAP Americas. All Rights Reserved.
Page 214
SAP xMII Training 14. We should be able to view our Line 1 Speed alert.
15. Create another alert and test.
©2006 SAP Americas. All Rights Reserved.
Page 215
SAP xMII Training
©2006 SAP Americas. All Rights Reserved.
Page 216
