Customer Portal. PacketShaper 11.7

Transcription

1 Customer Portal PacketShaper 11.7

2 Legal Notice Copyright 2016 Symantec Corp. All rights reserved. Symantec, the Symantec Logo, the Checkmark Logo, Blue Coat, and the Blue Coat logo are trademarks or registered trademarks of Symantec Corp. or its affiliates in the U.S. and other countries. Other names may be trademarks of their respective owners. This document is provided for informational purposes only and is not intended as advertising. All warranties relating to the information in this document, either express or implied, are disclaimed to the maximum extent allowed by law. The information in this document is subject to change without notice. THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. SYMANTEC CORPORATION SHALL NOT BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE INFORMATION CONTAINED IN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE. SYMANTEC CORPORATION PRODUCTS, TECHNICAL SERVICES, AND ANY OTHER TECHNICAL DATA REFERENCED IN THIS DOCUMENT ARE SUBJECT TO U.S. EXPORT CONTROL AND SANCTIONS LAWS, REGULATIONS AND REQUIREMENTS, AND MAY BE SUBJECT TO EXPORT OR IMPORT REGULATIONS IN OTHER COUNTRIES. YOU AGREE TO COMPLY STRICTLY WITH THESE LAWS, REGULATIONS AND REQUIREMENTS, AND ACKNOWLEDGE THAT YOU HAVE THE RESPONSIBILITY TO OBTAIN ANY LICENSES, PERMITS OR OTHER APPROVALS THAT MAY BE REQUIRED IN ORDER TO EXPORT, RE-EXPORT, TRANSFER IN COUNTRY OR IMPORT AFTER DELIVERY TO YOU. Symantec Corporation 350 Ellis Street Mountain View, CA /11/2016

3 Customer Portal Customer Portal Overview The customer portal feature offers service providers the ability to design custom network and application status pages that can be viewed by their customers. Customer portals allow for providers to offer customized, limited, branded sets of PacketShaper information to their end users information such as throughput, response times, and other metrics collected by PacketShaper, as well as statistics that indicate whether Service Level Agreements (SLAs) are being followed. Unique user accounts and directories are created for each customer account. The service provider can either create a single HTML page that has customized data for each portal user, or create an individual HTML page for each customer. The maximum number of portal pages you can create is limited by the maximum number of classes your unit supports. For example, PS-S500's maximum number of classes is 10,000, so you can create up to 10,000 different portal pages. Follow these steps to configure and use the customer portal feature: 1. Create user accounts, and optionally configure individual or global message-of-the-day settings. See " Create Customer Portal Accounts" on page Assign an IP address to the customer portal. See "Assign a Customer Portal Address" on page Download sample files from Blue Coat to use as templates in designing your own login and portal pages. See " Download Sample Portal Files" on page Customize the customer login screen. See " Customize the Login Screen" on page Design custom HTML pages to display the desired statistics for the users of the customer portal. See " Design Customer Portal Pages" on page 12. 3

4 Customer Portal Feature 6. Log into the customer portal. See " Log Into the Customer Portal" on page 24. If you want customers to use RADIUS authentication when logging into the portal, you need to configure a RADIUS authentication server. 4

5 Customer Portal Create Customer Portal Accounts To set up your customer portal accounts, you need to define each customer's login name, password, home directory, and an optional message that appears on the customer's portal page. To add a customer: 1. Click the Setup tab. 2. From the Choose Setup Page list, choose Customer Portal Administration. The Customer Portal screen appears. 3. Click add customer. The Add Customer page appears. 5

6 Customer Portal Feature 4. Enter the customer's information: Field Name Password Confirm Password Directory Message of the Day Description The login name the customer will use; up to 32 characters long, use numbers, letters and underscores spaces are not allowed. If you are using RADIUS or TACACS+ authentication, this name must match the user name entered in the RADIUS/TACACS+ server. The password for the customer account. If you are using RADIUS or TACACS+ authentication, you do not specify a password here the customer portal will use the password specified for this user in the RADIUS/TACACS+ server. Type the same password a second time The name for the customer home directory to be created in the path 9.258/customer/, maximum 8 alphanumeric characters. If you want multiple customers to access the same portal page, specify the same directory name for all of these users (for example, 9.258/customer/master). Select System message to use the system-wide message or select Custom and then enter a text message, up to 128 characters. This custom message can be displayed on the customer home page. (See also Set a System-Wide Message.) 5. Click add customer. The Add Customer screen creates a home directory for each customer you configure, but these directories are initially empty. You must create an individual INDEX.HTM file and place it in the home directory of each customer. Or, if multiple customers will be accessing the same portal page, place the INDEX.HTM file in the master directory specified for these customers. See Design Customer Portal Pages. 6

7 Customer Portal Set a System-Wide Message The message of the day is a text string that appears on the customer portal pages. The system-wide message is used for any customer accounts that do not have a custom message configured. To set a system-wide message: 1. Click the Setup tab. 2. From the Choose Setup Page list, choose customer portal administration. The Customer Portal screen appears. 3. In the Customer Portal Administration screen, click in the System-wide message of the day field. 4. Type the text message, up to 128 characters. The following characters are not allowed: ";\ & ' If you use the carriage return or Enter buttons on your keyboard to create multiple lines of text, make sure that each line has a printing character. 5. Click apply changes. 7

8 Customer Portal Feature Assign a Customer Portal Address You can assign an IP address to the customer portal, allowing customers to directly display the customer portal login page using this address instead of the URL. To assign a portal address: 1. Click the Setup tab. 2. From the Choose Setup Page list, choose customer portal administration. The Customer Portal screen appears. 3. In the Customer Portal Administration section, click in the Portal IP Address field and type the IP address you want to assign to the customer portal. The address should not be the same as the management IP address. 4. Click in the Portal Net Mask field and type the subnet mask for the network where the unit resides. 5. Click apply changes. 8

9 Customer Portal Download Sample Portal Files Blue Coat offers sample login and customer pages you can download and customize for your own use. 1. Log in to BTO ( using your BlueTouch Online credentials. 2. Go to the Downloads tab and navigate to the PacketShaper page for your model. 3. Choose the PacketShaper software version you are using. 4. Download the portal zip file (for example, PacketShaper_11.7.1_portals.zip). 5. Extract the files to your computer for editing. 6. When you have finished editing the files, use the File Browser to upload them to the locations specified below. The customer portal zip file contains the following files: File Description The following files are different types of sample customer portal pages: ex1.htm glast24.htm A sample HTML customer page. See Design Customer Portal Pages for details on using this sample file. A sample HTML page with graphs of the preceding 24 hours network performance for: Inbound throughput Outbound throughput Inbound efficiency Outbound efficiency glast60.htm To use this file, either place a customized version in each customer's directory or put an edited version in the 9.258/customer directory for all customers to access. A sample HTML page with graphs of the preceding 60 minutes network performance for: Inbound throughput Outbound throughput Inbound efficiency Outbound efficiency To use this file, either place a customized version in each customer's directory or put an edited version in the 9.258/customer directory for all customers to access. owner1.htm A sample customer portal page that illustrates how to use the SEARCH facility in order to have one portal page serve many users. This page searches the traffic class' Owner field for the name of the logged-in portal user. notes1.htm toptalk.htm To use this file, place an edited version in the 9.258/customer/<shared> directory, where <shared> is the name of the "community" customer directory. (Note: The <shared> directory name must be specified as the directory name for each customer that will be using this portal page. See Create Customer Portal Accounts.) Similar to owner1.htm, except this page searches the Comment field. A sample HTML file that shows how to display Top Talkers and Top Listeners data in a portal page. 9

10 Customer Portal Feature File Description The following files are used for the login page: blank.gif lginbtn.gif libmd5.js login.htm Image file used by the sample login page. Place this file in the 9.258/customer directory. Image file of the login button on the sample login page. Place this file in the 9.258/customer directory. JavaScript that supplies an MD5 method (an algorithm used to create digital signatures) for the authentication procedure. Place this file in the 9.258/customer directory. Sample HTML login page. See Customize the Login Screen. If you view the sample HTML files directly in a web browser, instead of fetching them from the PacketShaper software, error messages and text bracketed by percent signs may appear. This happens because the web browser does not know how to process the special tag engine instructions in the Blue Coat sample pages. 10

11 Customer Portal Customize the Login Screen All customers accessing the customer portal see the same initial login screen. When a customer accesses the URL or a login screen appears, prompting the customer to enter a name and password. The customer then enters the preassigned login name and password. After the customer clicks the login button, the index.htm file is presented from the appropriate customer directory beneath 9.258/customer/. To design the login screen: 1. Edit the sample login page you downloaded (LOGIN.HTM). 2. Customize this page, for example by adding graphics or headers to identify the service provider. 3. Use the File Browser to upload your edited LOGIN.HTM file to the 9.258/customer directory on the PacketShaper. 11

12 Customer Portal Feature Design Customer Portal Pages To design a customer portal page: 1. Edit the sample customer page you downloaded (EX1.HTM). See " Download Sample Portal Files" on page Determine the traffic classes for which users will need to see statistics and specify these classes in the portal page. See "Select Traffic Classes for the Portal Page" on the next page. 3. Determine the measurement variables to include on the portal page. See "Measurement Variables Available to Portal Pages" on page Customize the page to display the desired statistics of the desired classes to the users of the customer portal. See "Display Statistics on the Portal Page" on page Include custom information such as the customer name and message of the day on the portal page. See "Display Custom Information on the Portal Page" on page Optional: Include graphs on the portal page. See "Include Graphs on a Portal Page" on page Optional: Link to other HTML pages. See "Link to Other HTML Pages" on page Save your customized file as INDEX.HTM. 9. Use the File Browser to upload your customized INDEX.HTM file to the customer's directory in the 9.258/customer directory on the PacketShaper for example, 9.258/customer/jones. Or, if multiple customers will be accessing the same portal page, place the INDEX.HTM file in the master directory specified for these customers. Examples Example 1 (without graphs): Let's put it all together now into a sample page designed for Farnsworths, a retailer of books, music, and videos. This sample has two basic objects: A table with aggregate throughput and efficiency data for /Inbound and /Outbound. For each entry, there is a square which is displayed as red, yellow, or green, depending on the value of the avg-bps variable. For the HTTP traffic class, a table of response times. You can view a sample page with the source code presented as readable text. See "Sample Customer Portal Page" on page 29. Example 2 (with graphs): This example shows the throughput and network efficiency for both Inbound and Outbound over the preceding 60 minute period. See "Sample Customer Portal Page with 60 Minute Graphs" on page

13 Customer Portal Select Traffic Classes for the Portal Page The service provider authoring a portal page for a particular customer must know which traffic classes are of interest to that customer. This is one of the ways that selective disclosure is implemented. Up to 20 classes can be listed on a portal page. The %PUSH% statement with the PCLASSLIST object defines the traffic classes that are to be reported on the portal page. It must appear at the beginning of the portal page. The PCLASSLIST (for portal class list) is used as follows: %PUSH (PCLASSLIST="/Inbound;/Outbound;/Inbound/HTTP;/Outbound/HTTP")% You can list up to 20 traffic classes in the %PUSH% statement; each class name must be separated by a semi-colon, and quote marks must surround the list of class names. The PCLASSLIST object is the only tag language context needed to build the portal pages, so it's worth explaining exactly what it does: For a given set of traffic classes it fetches in one pass all the measurement engine variables needed and all their date functions. Since the measurement engine data set is fairly extensive, this optimizes the performance. It computes a set of date functions on each variable, such as "last minute,""last 60 minutes," "yesterday," and "this month." It provides a set of tags to allow outputting any of this information to the HTML page. There is one PCLASSLIST object per page and the first appearance of it triggers a fetch from the measurement engine of all the data required. Subsequently there can be many more uses of the PCLASSLIST object for example, %LOOP% statements to output multiple tables, without incurring any more measurement engine overhead. Search Facility You can use a search command while fetching the list of traffic classes for a page. This allows you to have a single portal page for multiple customers and/or multiple PacketShapers. The OWNER1.HTM file that you downloaded illustrates a page that can be used for multiple customers. The search command can be used as follows: %PUSH (PCLASSLIST="SEARCH:OWNER=<search string>")% %PUSH (PCLASSLIST="SEARCH:NAME=<search string>")% %PUSH (PCLASSLIST="SEARCH:NOTES=<search string>")% The owner and notes (comments) are specified for a class in the Manage tab in the Advanced UI or with the class owner and class note commands in the CLI. <search string> may either be a literal, or the supported tag language construct: %CUSTOMER.NAME% %CUSTOMER.NAME% evaluates to the name of the logged-in portal user. For each of the three search options (Owner, Name, and Notes), the list of traffic classes is those for which the given string appears anywhere in the relevant field, case-insensitive. For example: Name Owner Notes /Inbound /Inbound/HTTP Jo Never touch! 13

14 Customer Portal Feature Name Owner Notes /Outbound Joseph Really never touch! /Outbound/HTTP Mary JO Mary JO created this Search strings behave as if bracketed by wild cards. For example, these are the results of various queries on the traffic tree shown above: Query Results OWNER=JO /Inbound, /Outbound, /Outbound/HTTP NOTES=never /Inbound, /Outbound NAME=HTTP /Inbound/HTTP, /Outbound/HTTP OWNER=Mary JO /Outbound/HTTP NOTES=touch /Inbound, /Outbound NOTES=mary /Outbound/HTTP Using the Same Portal Page on Multiple Units To use the same portal page on different units, create a customer portal page that includes a statement similar to the following: %PUSH (PCLASSLIST="SEARCH:NOTES=PortalPage")% This generic portal page can be copied to each applicable unit. For this technique to work, you add the text PortalPage in the Comment field of each class that you want to appear on the portal page for that unit. When the customer accesses the portal page, he will see a customized page that includes a list of classes that have the PortalPage comment. Using Different Portal Pages on a Unit The customer portal feature can also accommodate multiple portal pages on the same unit, in the case where multiple customers are sharing a single PacketShaper and you want each customer to have a different portal page. For example, customer A's portal page contains the following statement: %PUSH (PCLASSLIST="SEARCH:NOTES=CustomerA")% and customer B's page contains this statement: %PUSH (PCLASSLIST="SEARCH:NOTES=CustomerB")% The portal pages can be copied to the appropriate customer's directory in the 9.258/customer directory. Then, you add the text CustomerA to the Comment field of each class that is applicable to customer A, and add the CustomerB comment for classes applicable to customer B. If a class is applicable to both customers, enter CustomerA and CustomerB for the comment. When customer A accesses the customer portal, his page will list all classes with CustomerA as a comment. When customer B accesses the portal, he will see a list of all classes with CustomerB as a comment. 14

15 Customer Portal Measurement Variables Available to Portal Pages Portal pages can include measurement variables that report on throughput, response time, availability, and performance. The tables below list the PacketShaper measurement engine variables and their corresponding portal variable names. Most of the portal variables are identical to those used in the measurement engine. The only difference is that you cannot use the % sign in portal variables make sure you use -PCT instead of the % sign. For example, instead of tcp-efficiency%, use tcpefficiency-pct. Measurement Engine Variable Portal Page Variable Name app-availability% avg-bps bytes tcp-retx-bytes license-overflows network-delay-avg network-delay-msec peak-bps pkt-exchange-time-avg pkt-exchange-time-msecs pkt-exchange-time-samples round-trip-time-msecs sample-interval-msecs server-delay-avg server-delay-msec service-level% service-level-errors service-level-threshold% slow-transactions TCP-efficiency% total-delay-avg total-delay-msec total-delay-threshold total-trans APP-AVAILABILITY-PCT AVG-BPS BYTES TCP-RETX-BYTES LICENSE-OVERFLOWS NETWORK-DELAY-AVG NETWORK-DELAY-MSEC PEAK-BPS PKT-EXCHANGE-TIME-AVG PKT-EXCHANGE-TIME-MSECS PKT-EXCHANGE-TIME-SAMPLES ROUND-TRIP-TIME-MSECS SAMPLE-INTERVAL-MSECS SERVER-DELAY-AVG SERVER-DELAY-MSEC SERVICE-LEVEL-PCT SERVICE-LEVEL-ERRORS SERVICE-LEVEL-THRESHOLD-PCT SLOW-TRANSACTIONS TCP-EFFICIENCY-PCT TOTAL-DELAY-AVG TOTAL-DELAY-MSEC TOTAL-DELAY-THRESHOLD TOTAL-TRANS Variables used in portal pages do not need to be in upper case. 15

16 Customer Portal Feature Display Statistics on the Portal Page Error Detection It is important to test the status of the data to be fetched before you start. Inevitably, things can go wrong with fetching the data from the measurement engine. The tags might have specified a traffic class that no longer exists on the device, or never did; the measurement engine might not have started yet; disk errors or other problems might exist. Therefore, PacketWise provides a way for the service provider to test the results of the measurement engine fetch. If it was not successful, you can output an error message or cut the page short. %PCLASSLIST.ERRORSTATUS% gives the measurement engine's results. Here is an example of how a service provider might handle it in the HTML code: %IF (%PCLASSLIST.ERRORSTATUS%!= "")% <h3><b><div align="left"><font color="red"> Errors encountered while preparing this report:<br> %PCLASSLIST.ERRORSTATUS% <Br> The rest of your report will be rendered as well as is possible, but there may be missing sections. Please contact Technical Support with this problem. </font> </div></b></h3> %ENDIF% You also could enclose the rest of the report within an %ELSE% statement, so that it only comes out if there are no errors. The portal attempts to recover from errors and deliver some data if it can, but there are some errors from which there is no real recovery. Measurement Engine Data This section explains how you can take the data that the portal has gathered on classes, and insert it into the HTML page. Due to tag engine restrictions, the classes are not actually named but numbered. Data from the PCLASSLIST context is referenced in one of two ways: where To retrieve data from a named class such as /Inbound, /Outbound, or /Inbound/HTTP: %PCLASSLIST.NAMED[<named-class-number>.<me-var>.<date-function>]% In a %LOOP% statement, to refer to the current entry: %PCLASSLIST.CURRENT[<me-var>.<date-function>]% <named-class> a number from 0 to the number of classes minus 1 <me-var> measurement engine variables <date-function> one of the following date functions: 16

17 Customer Portal Function LAST- MINUTE LAST-15- MINUTES LAST-60- MINUTES LAST-FULL- HOUR LAST-24- HOURS LAST-7- DAYS Description Previous minute Previous 15 minutes Previous 60 minutes (for example, if the current time is 11:15, the LAST-60-MINUTES would be 10:15-11:15) Previous full hour (for example, if the current time is 11:15, the LAST-FULL-HOUR would be 10:00-11:00) From 24 hours ago to now From seven days ago to now one minute one minute one minute one hour one hour one hour TODAY From midnight to now one hour YESTERDAY Previous day, from midnight to midnight THIS- MONTH LAST- MONTH Examples: From midnight on the first day of the current month to now Previous full month one hour one hour one hour %PCLASSLIST.NAMED[0.AVG-BPS.LAST-MINUTE]% returns the value of the avg-bps variable for the last minute, for the /Inbound traffic class (which was the first class in the list, thus the 0). %PCLASSLIST.NAMED[1.TCP-EFFICIENCY-PCT.LAST-MONTH]% returns the tcp-efficiency% variable for /Outbound (the second class in the list), for the last month. %PCLASSLIST.CURRENT[SERVER-DELAY-AVG.LAST-60-MINUTES]% within a %LOOP%, returns the value of server-delay-avg for the current class, for the last 60 minutes. %PCLASSLIST.NAMED[0.AVG-BPS.TODAY]% returns the value of the avg-bps variable for the first class in your list, since midnight of the current day. Displaying Current Class Name This example illustrates a method for displaying the current class name, within a table, using a loop structure to fill the table with a row for each class: <TABLE> <TH>Class</TH> 17

18 Customer Portal Feature <TH>Bytes</TH> %LOOP(PCLASSLIST="...listofclasses...")% <TH>%PCLASSLIST.CURRENT[NAME]%</TH> <TD>%PCLASSLIST.CURRENT[BYTES.LAST-MINUTE]%</TD> %ENDLOOP% </TABLE> In the example above, the list of classes is used in the %LOOP% statement, and for each class in the list, a new row is generated in the table. %ENDLOOP% is inserted before the closing </TABLE> tag. Meta-data In addition, there can be an optional last parameter within the [ ] pair, the meta-data tag. Meta-data is data about data. The available meta-data tags are: VALUE the default; no operation SAMPLE-COUNT the number of measurement engine samples that fell into this bucket. (Useful if, for example, you had the unit on for only half of last month, so you aren't seeing a full month's worth of data) EARLIEST-TIME the earliest time stamp on the samples LATEST-TIME the latest time stamp on the samples TIME-SPAN the time, in seconds, between the earliest and latest sample found Examples: %PCLASSLIST.NAMED[0.INBOUND.AVG-BPS.LAST-MONTH.LATEST-TIME]% returns the latest sample found as a date-time string. %PCLASSLIST.NAMED[0.AVG-BPS.TODAY.TIME-SPAN]% returns the time, in seconds, between the earliest and the latest ME samples that were used to compute AVG-BPS.TODAY for the first class in the list. Meta-data may be used for a page with a link labeled "about this data" which leads to an appendix that shows how the data was derived. 18

19 Customer Portal Display Custom Information on the Portal Page To insert the customer's name in a page, use: %PCLASSLIST.CUSTOMER.NAME% To insert the message of the day anywhere on the page, use: %PCLASSLIST.CUSTOMER.MOTD% This inserts the MOTD for the currently logged-in customer. If the customer is assigned a specific Message-of-the-Day, this string will return their custom message. If a customer account is configured to use the global Message-of-the-Day, it will be returned. To insert the earliest and latest measurement engine data that was found, use: %PCLASSLIST.TIMESTAMP.START% and %PCLASSLIST.TIMESTAMP.END% Note that these tags will work only if the page has the %PUSH% statement with the PCLASSLIST object. This statement defines the traffic classes that are to be reported on the portal page, and must appear at the beginning of the portal page. If you don't want to list any classes on the portal page, you can specify an empty list. For example: <html> <body> %PUSH (PCLASSLIST="")% %PCLASSLIST.CUSTOMER.NAME% </body> </html> The above code displays the name of the logged-in portal user on the portal page. 19

20 Customer Portal Feature Include Graphs on a Portal Page The OP.MEAS.GETGRAPH command is the basic means of incorporating PacketShaper graphs into the report. Each graph has its own URL. Here is an example of how a graph could be embedded in the HTML pages: < IMG SRC=/customer/Cgi1?OP.MEAS.GETGRAPH=&MEAS.NAME=/Inbound&MEAS.TYPE=link& MEAS.PERIOD=3600&MEAS.VARLIST=avg-bps%%20 peak-bps&meas.varlistlabel=averagerate%%2cpeakrate&meas.graphtype=line > In the code above, %20 is used to represent the space character, and %2C is used for a comma. If spaces or commas are in text that is enclosed in quotes, it is not necessary to represent them using %20 or %2C. The /customer/cgi prefix is mandatory for these graphs; it tells PacketShaper to allow the OP.MEAS.GETGRAPH operation for authenticated customers. In this example, a graph is included with the following characteristics: CGI Parameter Value (in above example) MEAS.NAME MEAS.TYPE MEAS.PERIOD MEAS.VARLIST /Inbound Link (as opposed to partition or class) A period of 3600 seconds (1 hour) Two ME variables, avg-bps and peak-bps. Note that they are separated by a URL-encoded space, %20, and the % must be doubled (because % characters are normally interpreted by the tag engine). MEAS.VARLISTLABEL Two labels for the two ME variables. They are separated by a URL-encoded comma character, %2C. Again, the % must be doubled. MEAS.GRAPHTYPE A line (as opposed to bar or pie) graph The maximum number of classes that can be specified when creating a stacked chart for a customer portal is 16. Saving the Web Page These web pages can be saved using your browser's web page complete option, unless the author uses Javascript's "document.write" function to create dynamic HTML. If the author avoids JavaScript and follows a few simple rules, a report with embedded graphs can be saved, with all its graphs. Here is an example of a report with two embedded graphs, after being saved in Internet Explorer: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <!-- saved from url=(0042) --> <?xml version="1.0" encoding="utf-8"?><html lang=en xml:lang="en" xmlns=" sample</title> <META http-equiv=content-type content="text/html; charset=windows-1252"> <META content="mshtml " name=generator></head> <BODY> 20

21 Customer Portal <H1>Network performance overall, last 60 minutes </H1> <H2>Inbound </H2> <TABLE> <TBODY> <IMG src="graph sample2_files/cgi1.gif"> <IMG src="graph sample2_files/cgi2.gif"> </TBODY></TABLE></BODY></HTML> Note that the two graphs were saved in a subdirectory, Graph sample2_files, as Cgi1.gif and Cgi2.gif, and the URLs changed to link to those files instead of linking back to the server. This is the special significance of the 1 in Cgi1 above: IE uses it as a file name. In this two-file example, the two URLs started with /customer/cgi1 and /customer/cgi2. When you open this HTML file with IE, it's displayed without going back to PacketShaper. You can it after using a file compression utility such as WinZip to put all the files into a recursive Zip file. 21

22 Customer Portal Feature Link to Other HTML Pages The HTML pages in customer home directories may contain links to a very limited set of information within PacketShaper those files that have been placed in the home directory, any public files, and a CGI which generates graph images. In addition they can contain links to anywhere outside PacketShaper to the service provider's own website, for example. A public file is any file placed in the 9.258/customer directory. A typical use of this would be the GIF and JPEG files for the service provider's banner, or general information that applies to all customers. Public files can be referenced with a relative URL. An example for the portal might be: <P>Please follow these <A href="../problem.htm"> procedures </A> to report a problem </P> 22

23 Customer Portal Arithmetic Comparisons Arithmetic comparison is required for certain portal features for example, display a red symbol if one of the numbers exceeds a threshold. The > and < symbols are used by HTML, so the portal does not use those symbols in tags. Instead, it is more like Fortran: Operator Description.LT..LE..EQ..NE..GT..GE. Less than Less than or equal to Numeric equals, not necessarily the same as string equals. See below for number syntax. Numeric not equals Greater than Greater than or equal to Numeric constants are somewhat more flexible than just numbers: a rate syntax is supported as well. Entries such as "2M" and "1.24K" are accepted. The percent sign (%) is also allowed, so that comparisons on tcp-efficiency% and other percentage-based measurement engine variables can be allowed. Constants must be quoted if they contain any non-numeric characters such as "M". Arithmetic Example A single table row from the sample EX1.HTM file is shown below. In this example, IF statements are combined with arithmetic comparisons to display a red, yellow or green table cell, based on the inbound throughput. <TD> Inbound Throughput (bps) </TD> <TD align=right BGCOLOR= %IF (%PCLASSLIST.NAMED[0.AVG-BPS.LAST-MINUTE]%.GT. "2M")% "red" %ELSEIF (%PCLASSLIST.NAMED[0.AVG-BPS.LAST-MINUTE]%.GT. "1.9M")% "yellow" %ELSE% "green" %ENDIF%> </TD> 23

24 Customer Portal Feature Log Into the Customer Portal After you have created your login screen, designed your portal page, and copied these files to the proper locations on the PacketShaper, you can log into the customer portal. To log into the customer portal: 1. In a web browser, type where <PacketShaper-ip-address> is the management IP address of the PacketShaper. For example: or If you have assigned an IP address to the customer portal, type where <portal-ipaddress> is the address you assigned. For example: You will then be presented with the login screen you created. For example: 2. On the login page, enter the customer's login name and password that were specified when the customer accounts were created. (See Create Customer Portal Accounts.) 3. Click login. The customer portal page you designed is displayed. 24

25 Customer Portal Customer Portal API In addition to any valid HTML tag, the following PacketShaper-specific tags can be used on a customer portal page. Notice that all of the PacketShaper tags begin and end with percent signs. If you want to use a percent sign elsewhere on the page, you must use two of them (%%), otherwise the PacketShaper will try to interpret the percent sign as a PacketShaper tag. Customer Portal Tag %IF(<condition>)%... %ENDIF% Description Checks a condition to see if it's true. If the condition is true, one or more lines of code will be executed; if the condition is false, different lines of code will be executed. Example: %IF (%PCLASSLIST.ERRORSTATUS%!= "")% <h3>errors encountered while preparing this report:<br> %PCLASSLIST.ERRORSTATUS% <br> The rest of your report will be rendered as well as is possible, but there may be missing sections. Please contact Technical Support with this problem.</h3> %ENDIF% %LOOP%... %ENDLOOP% Repeats one or more lines of code Example: <IMG SRC- Inserts a graph generated by the PacketShaper =/customer/cgi1?op.meas.getgraph= For details, see "Include Graphs on a Portal Page" on page 20. %LOOP(PCLASSLIST- T="Inbound;Inbound/HTTP;Outbound")% %PCLASSLIST.CURRENT[NAME]% %PCLASSLIST.CURRENT[BYTES.LAST-MINUTE]% %ENDLOOP% 25

26 Customer Portal Feature Customer Portal Tag %PCLASSLIST.CURRENT[<mevar>.<date-function>]% Description Retrieves data from the current entry; used in a %LOOP% statement where <me-var> one of the measurement engine variables available to the customer portal <date-function> one of the following: LAST-MINUTE, LAST-15- MINUTES, LAST-60-MINUTES, LAST-FULL-HOUR, LAST-24- HOURS, LAST-7-DAYS, TODAY, YESTERDAY, THIS-MONTH, LAST-MONTH Example: %PCLASSLIST.CURRENT [NAME]% %PCLASSLIST.CUSTOMER.MOT- D% %PCLASSLIST.CUSTOMER.NAM- E% %PCLASSLIST.ERRORSTATUS% %PCLASSLIST.CURRENT[BYTES.LAST-MINUTE]% Display current class name; used in a %LOOP% statement Inserts the message-of-the-day text Inserts the name of the logged-in portal user Displays the measurement engine's error message when it's unable to retrieve data; can be used inside an %IF% statement to display the message only if there is an error. Example: %PCLASSLIST.NAMED[<named- class-number>.<me-var>.<date.- function>]% <h3>errors encountered while preparing this report:<br> %PCLASSLIST.ERRORSTATUS%</h3> Retrieves data from a named class where <named-class-number> the number of the class in your PCLASSLIST. Counting begins at 0; thus, the first class in your PCLASSLIST has a <named-class-number> of 0. <me-var> one of the measurement engine variables available to the customer portal <date-function> one of the following: LAST-MINUTE, LAST-15- MINUTES, LAST-60-MINUTES, LAST-FULL-HOUR, LAST-24- HOURS, LAST-7-DAYS, TODAY, YESTERDAY, THIS-MONTH, LAST-MONTH Example: %PCLASSLIST.NAMED[1.TCP-EFFICIENCY-PCT.LAST- MONTH]% 26

27 Customer Portal Customer Portal Tag %PCLASSLIST.TIMESTAMP.STA- RT% %PCLASSLIST.TIMESTAMP.EN- D% %PUSH(PCLASSLIST'"<classnames>")% Description Inserts the date and time of the beginning of the period for which measurement data was tracked Inserts the date and time of the end of the period for which measurement data was tracked Defines the traffic classes that are to be reported on the portal page. It must appear at the beginning of the portal page. You can list up to 20 traffic classes; each class name must be separated by a semicolon, and quote marks must surround the list of class names. Example: %PUSH (PCLASSLIST- T="SEARCH:NAME=<string>")% %PUSH(PCLASSLIST- ="/Inbound;/Outbound;/Inbound/HTTP;/Outbound/HTTP")% Dynamically builds a class list based on a <string> in a class' name Example: The following statement builds a class list of all the classes that have "HTTP" in the class name: %PUSH(PCLASSLIST="SEARCH:NAME=HTTP")% %PUSH (PCLASSLIST- T="SEARCH:NOTES=<string>")% For example: /Inbound/HTTP, /Outbound/HTTP. Dynamically builds a class list based on a <string> in a class' comment (notes) field Example: For each class you want to track on the customer portal page, enter the string "PortalPage" in the class' Comment field. Then use the following statement in the customer portal page: %PUSH(PCLASSLIST="SEARCH:NOTES=PortalPage")% If you entered "PortalPage" in the Comment field of the /Inbound, /Outbound, /Inbound/HTTP, /Outbound/HTTP, /Inbound/FTP, and /Outbound/FTP classes, the class list would consist of these six classes. If you want to include additional classes later, you don't need to modify the portal page; just add "PortalPage" to the comment field of these classes. 27

28 Customer Portal Feature Customer Portal Tag %PUSH (PCLASSLIST- T="SEARCH:OWNER=<string>")% Description Dynamically builds a class list based on a <string> in a class' owner field Example: A single PacketShaper tracks data for multiple customers. Each customer has a unique set of classes to measure bandwidth usage. In the class' Owner field, enter the customer's login name. Then use the following statement in the customer portal page: %PUSH(PCLASSLIST- T="SEARCH:OWNER=%CUSTOMER.NAME%")% %CUSTOMER.NAME% evaluates to the name of the logged-in portal user. Thus, when CustomerA logs into the customer portal, he will see statistics for all the classes that have CustomerA in the Owner field. When CustomerB log in, she will see statistics for the classes that have CustomerB in the Owner field. 28

29 Customer Portal Sample Customer Portal Page This is a sample HTML page for use with the Customer Portal: <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"> <html xmlns=" xml:lang="en" lang="en"> <head> <title> Customer Portal </title> %PUSH (PCLASSLIST="/Inbound;/Outbound;/Outbound/HTTP;/Outbound/POP3")% %IF (%PCLASSLIST.ERRORSTATUS%!= "")% <h3><b><div align="left"><font color="red"> Errors encountered while preparing this report:<br> %PCLASSLIST.ERRORSTATUS% <br> The rest of your report will be rendered as well as is possible, but there may be missing sections. Please contact Technical Support with this problem. </font> </div></b></h3> %ENDIF% </head> <body> <h1> <IMG SRC="logo-f.jpg" BORDER="1" ALIGN=TOP WIDTH="640" HEIGHT="75" ALT- T="Farnsworths Logo"> </h1> <h1> <center> Performance report for your subscribed applications </center> </h1> <h2> <center> Prepared for %PCLASSLIST.CUSTOMER.NAME% </center> </h2> <h3> <center> For the period ending %PCLASSLIST.TIMESTAMP.END% </center> </h3> <h4> Message of the day: %PCLASSLIST.CUSTOMER.MOTD% </h4> <h3> Aggregate Traffic Status </h3> <p> The first table shows the overall performance of your network: throughput in each direction in bits per second, and network efficiency, which is the percentage of TCP packets that are not retransmissions. </p> <p align=left> <TABLE summary="shows the aggregate traffic status" cellspacing=4> <TH> Metric </TH> <TH> Status </TH> <TH> Last minute </TH> <TH> Last 60 minutes </TH> <TH> Yesterday </TH> <TH> This month </TH> 29

30 Customer Portal Feature <TH> Last month </TH> <TD> Inbound Throughput (bps) </TD> <TD align=right BGCOLOR= %IF (%PCLASSLIST.NAMED[0.AVG-BPS.LAST-MINUTE]%.GT. "2M")% "red" %ELSEIF (%PCLASSLIST.NAMED[0.AVG-BPS.LAST-MINUTE]%.GT. "1.9M")% "yellow" %ELSE% "green" %ENDIF% > </TD> <TD align=right> %PCLASSLIST.NAMED[0.AVG-BPS.LAST-MINUTE]% </TD> <TD align=right> %PCLASSLIST.NAMED[0.AVG-BPS.LAST-60-MINUTES]% </TD> <TD align=right> %PCLASSLIST.NAMED[0.AVG-BPS.YESTERDAY]% </TD> <TD align=right> %PCLASSLIST.NAMED[0.AVG-BPS.THIS-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[0.AVG-BPS.LAST-MONTH]% </TD> <TD> Outbound Throughput (bps) </TD> <TD align=right BGCOLOR= %IF (%PCLASSLIST.NAMED[1.AVG-BPS.LAST-MINUTE]%.GT. "2M")% "red" %ELSEIF (%PCLASSLIST.NAMED[1.AVG-BPS.LAST-MINUTE]%.GT. "1.9M")% "yellow" %ELSE% "green" %ENDIF% > </TD> <TD align=right> %PCLASSLIST.NAMED[1.AVG-BPS.LAST-MINUTE]% </TD> <TD align=right> %PCLASSLIST.NAMED[1.AVG-BPS.LAST-60-MINUTES]% </TD> <TD align=right> %PCLASSLIST.NAMED[1.AVG-BPS.YESTERDAY]% </TD> <TD align=right> %PCLASSLIST.NAMED[1.AVG-BPS.THIS-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[1.AVG-BPS.LAST-MONTH]% </TD> <TD> Inbound Efficiency </TD> <TD align=right BGCOLOR= %IF (%PCLASSLIST.NAMED[0.TCP-EFFICIENCY-PCT.LAST-MINUTE]%.LT. 95)% "red" %ELSEIF (%PCLASSLIST.NAMED[0.TCP-EFFICIENCY-PCT.LAST-MINUTE]%.LT. 98)% "yellow" %ELSE% "green" 30

31 Customer Portal %ENDIF% > </TD> <TD align=right> %PCLASSLIST.NAMED[0.TCP-EFFICIENCY-PCT.LAST-MINUTE]% </TD> <TD align=right> %PCLASSLIST.NAMED[0.TCP-EFFICIENCY-PCT.LAST-60-MINUTES]% </TD> <TD align=right> %PCLASSLIST.NAMED[0.TCP-EFFICIENCY-PCT.YESTERDAY]% </TD> <TD align=right> %PCLASSLIST.NAMED[0.TCP-EFFICIENCY-PCT.THIS-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[0.TCP-EFFICIENCY-PCT.LAST-MONTH]% </TD> <TD> Outbound Efficiency </TD> <TD align=right BGCOLOR= %IF (%PCLASSLIST.NAMED[1.TCP-EFFICIENCY-PCT.LAST-MINUTE]%.LT. 95)% "red" %ELSEIF (%PCLASSLIST.NAMED[1.TCP-EFFICIENCY-PCT.LAST-MINUTE]%.LT. 98)% "yellow" %ELSE% "green" %ENDIF% > </TD> <TD align=right> %PCLASSLIST.NAMED[1.TCP-EFFICIENCY-PCT.LAST-MINUTE]% </TD> <TD align=right> %PCLASSLIST.NAMED[1.TCP-EFFICIENCY-PCT.LAST-60-MINUTES]% </TD> <TD align=right> %PCLASSLIST.NAMED[1.TCP-EFFICIENCY-PCT.YESTERDAY]% </TD> <TD align=right> %PCLASSLIST.NAMED[1.TCP-EFFICIENCY-PCT.THIS-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[1.TCP-EFFICIENCY-PCT.LAST-MONTH]% </TD> </TABLE> </p> <p> <a href="#aggregate_table_colors"> What the status colors mean </a> </p> <p align=left> <h3> Aggregate Response Time Performance for HTTP </h3> This table displays response-time measurements for the traffic class "/Outbound/HTTP", which represents your HTTP traffic. </p> <p align=left> <TABLE cellspacing=4 summary="shows the Response Time Performance"> <TH> </TH> <TH> Application <BR> Server (ms) </TH> <TH> Transport <BR> Provider <BR> Network (ms) </TH> 31

32 Customer Portal Feature <TH> Total <BR> Service <BR> Delay (ms) </TH> <TD> Last minute </TD> <TD align=right> %PCLASSLIST.NAMED[2.SERVER-DELAY-AVG.LAST-MINUTE]% </TD> <TD align=right> %PCLASSLIST.NAMED[2.PKT-EXCHANGE-TIME-AVG.LAST-MINUTE]% </TD> <TD align=right> %PCLASSLIST.NAMED[2.TOTAL-DELAY-AVG.LAST-MINUTE]% </TD> <TD> Last 60 minutes </TD> <TD align=right> %PCLASSLIST.NAMED[2.SERVER-DELAY-AVG.LAST-60-MINUTES]% </TD> <TD align=right> %PCLASSLIST.NAMED[2.PKT-EXCHANGE-TIME-AVG.LAST-60-MINUTES]% </TD> <TD align=right> %PCLASSLIST.NAMED[2.TOTAL-DELAY-AVG.LAST-60-MINUTES]% </TD> <TD> Yesterday </TD> <TD align=right> %PCLASSLIST.NAMED[2.SERVER-DELAY-AVG.YESTERDAY]% </TD> <TD align=right> %PCLASSLIST.NAMED[2.PKT-EXCHANGE-TIME-AVG.YESTERDAY]% </TD> <TD align=right> %PCLASSLIST.NAMED[2.TOTAL-DELAY-AVG.YESTERDAY]% </TD> <TD> This month </TD> <TD align=right> %PCLASSLIST.NAMED[2.SERVER-DELAY-AVG.THIS-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[2.PKT-EXCHANGE-TIME-AVG.THIS-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[2.TOTAL-DELAY-AVG.THIS-MONTH]% </TD> <TD> Last month </TD> <TD align=right> %PCLASSLIST.NAMED[2.SERVER-DELAY-AVG.LAST-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[2.PKT-EXCHANGE-TIME-AVG.LAST-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[2.TOTAL-DELAY-AVG.LAST-MONTH]% </TD> </TABLE> </p> <p align=left> <h3> Aggregate Response Time Performance for POP3 </h3> This table displays response-time measurements for the traffic class "/Outbound/POP3", which represents your traffic. </p> <p align=left> <TABLE cellspacing=4 summary="shows the Response Time Performance"> <TH> </TH> <TH> Application <BR> Server (ms) </TH> <TH> Transport <BR> Provider <BR> Network (ms) </TH> <TH> Total <BR> Service <BR> Delay (ms) </TH> 32

33 Customer Portal <TD> Last minute </TD> <TD align=right> %PCLASSLIST.NAMED[3.SERVER-DELAY-AVG.LAST-MINUTE]% </TD> <TD align=right> %PCLASSLIST.NAMED[3.PKT-EXCHANGE-TIME-AVG.LAST-MINUTE]% </TD> <TD align=right> %PCLASSLIST.NAMED[3.TOTAL-DELAY-AVG.LAST-MINUTE]% </TD> <TD> Last 60 minutes </TD> <TD align=right > %PCLASSLIST.NAMED[3.SERVER-DELAY-AVG.LAST-60-MINUTES]% </TD> <TD align=right > %PCLASSLIST.NAMED[3.PKT-EXCHANGE-TIME-AVG.LAST-60-MINUTES]% </TD> <TD align=right > %PCLASSLIST.NAMED[3.TOTAL-DELAY-AVG.LAST-60-MINUTES]% </TD> <TD> Yesterday </TD> <TD align=right > %PCLASSLIST.NAMED[3.SERVER-DELAY-AVG.YESTERDAY]% </TD> <TD align=right > %PCLASSLIST.NAMED[3.PKT-EXCHANGE-TIME-AVG.YESTERDAY]% </TD> <TD align=right > %PCLASSLIST.NAMED[3.TOTAL-DELAY-AVG.YESTERDAY]% </TD> <TD> This month </TD> <TD align=right> %PCLASSLIST.NAMED[3.SERVER-DELAY-AVG.THIS-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[3.PKT-EXCHANGE-TIME-AVG.THIS-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[3.TOTAL-DELAY-AVG.THIS-MONTH]% </TD> <TD> Last month </TD> <TD align=right> %PCLASSLIST.NAMED[3.SERVER-DELAY-AVG.LAST-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[3.PKT-EXCHANGE-TIME-AVG.LAST-MONTH]% </TD> <TD align=right> %PCLASSLIST.NAMED[3.TOTAL-DELAY-AVG.LAST-MONTH]% </TD> </TABLE> </p> <h2> <center> Appendix </center> </h2> <a name="aggregate_table_colors"> <p> Key to the status colors for the Aggregate Traffic Status table: </p> <p align=left> <table cellspacing=4> <TH> Metric </TH> <TH> Color </TH> <TH> Meaning </TH> <TD> Throughput </TD> <TD BGCOLOR="red"> </TD> 33

34 Customer Portal Feature <TD align=right> Over 2 million bps </TD> <TD> </TD> <TD BGCOLOR="yellow"> </TD> <TD align=right> 1.9 million - 2 million bps </TD> <TD> </TD> <TD BGCOLOR="green"> </TD> <TD align=right> Less than 1.9 million </TD> <TD> Network efficiency </TD> <TD BGCOLOR="red"> </TD> <TD align=right> Less than 95 percent </TD> <TD> </TD> <TD BGCOLOR="yellow"> </TD> <TD align=right> percent </TD> <TD> </TD> <TD BGCOLOR="green"> </TD> <TD align=right> Over 98 percent </TD> </table> </a> </p> </body> </html> 34

35 Customer Portal Sample Customer Portal Page with 60 Minute Graphs This is a sample Customer Portal HTML page with graphs for the preceeding 60 minutes: <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"> <html xmlns=" xml:lang="en" lang="en"> <head> <title> Graph sample </title> </head> <body> <h1> Network performance overall, last 60 minutes </h1> <h2> Inbound throughput </h2> <IMG SRC- =/customer/cgi1?op.meas.getgraph=&meas.name=/inbound&meas.type=link&meas.period=3600&meas.var bps%%20peak-bps&meas.varlistlabel=averagerate%%2cpeakrate&meas.graphtype=line> <h2> Outbound throughput </h2> <IMG SRC- =/customer/cgi2?op.meas.getgraph=&meas.name=/outbound&meas.type=link&meas.period=3600&meas.va bps%%20peak-bps&meas.varlistlabel=averagerate%%2cpeakrate&meas.graphtype=line> <h2> Inbound efficiency </h2> <IMG SRC- =/customer/cgi2?op.meas.getgraph=&meas.name=/inbound&meas.type=link&meas.period=3600&meas.var efficiency%%&meas.varlistlabel=tcp-efficiency&meas.graphtype=line> <h2> Outbound efficiency </h2> <IMG SRC- =/customer/cgi2?op.meas.getgraph=&meas.name=/outbound&meas.type=link&meas.period=3600&meas.va efficiency%%&meas.varlistlabel=tcp-efficiency&meas.graphtype=line> </body> </html> 35

36