Programming Web Client

Transcription

1 Programming Web Client

2 Copyright 01 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International, Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

3 Table of Contents 1 Listener... Display of the Workflow Inbox... Web Client Components... Portal Integration....1 Search and Display of Documents "portal.zul" Filter Viewerclass Default Values for Index Fields Configuration of the Service Component.... Access to the Workflow Inbox.... Archiving New Documents "archiver.zul"..... Events

4 Programming Web Client 1 Listener ZK provides different listener to which an application responds to certain events : DesktopCleanup Desktopinit SessionCleanup Sessioninit WebAppCleanup WebAppinit The SAPERION Web Client implements own listener for these events: NGDesktopCleanup NGDesktopInit NGSessionCleanup NGSessionInit NGWebAppCleanup NGWebAppInit If additional actions should be processed at an event, an own listener can be implemented. The newly generated listener must be an extension of the respective Web Client listener. i Please note that in the method to be implemented the method of the Web Client listener must be called up. The newly generated listener can be registered in the "zk.xml"-file. Display of the Workflow Inbox For the display of the Workflow inbox in the Web Client (Business Cases) with differentiated folders "Resubmission" and "Inbox" you need to add the below stated filter string for "getinbox": public enum Filter { /** default - no filter. */ NONE("(HOLDDATE = NULL or HOLDDATE < current_timestamp())"), /** */ DUE_TASKS("(ESCALATIONID > 1)"), /** */ REMINDERS("(HOLDDATE >= current_timestamp() and HOLDDATE <> NULL)"),

5 Web Client Components /** */ DELEGATED_TASKS("(OWNERID = %ID%)"), // and USERID <> %ID%)"), /** */ COMPLETED_TASKS("(LASTUSERID = %ID%)"); Web Client Components This chapter offers an overview of all Web Clients components. Because all components are derivatives of different standard ZK components, the usual ZK parameters and events are available for all components. Further parameters and events - if available - are listed to the components. i A detailed list of available methods can be found in the JavaDoc of the Web Client. For this, the name of the class of the component is stated. Normally, all components are controlled via events. In order to intervene in the current event process event listener can be registered on the components. Events received by components can also be identified by means of the JavaDoc of the Web Client due to the reason that for each event a method with the same name is existing. For example, an event named "onlogon" would be treated by a method "onlogon". The ZK framework ensures that registered event listeners are notified before the respective on-method is requested. Web Client Components Component spnservice [com.saperion.ngc.service.serviceview] Hidden service component which assumes function such as login and logout and also the logging. viewer [com.saperion.ngc.viewer.documentviewimpl] Serves for the display of documents. The viewer component contains the actual viewer as stand-alone internal component. You can define the viewer to be used in the "web.xml". mashup [com.saperion.ngc.iform.mashup.formmashup] The mashup serves for the integration of external web applications such as Google maps or XING. logging Serves for display of log entries on the interface. [com.saperion.ngc.logging.logviewimpl] navigation [com.saperion.ngc.navigation.navigationviewimpl] Represents the navigation tree and enables operations on folder level such as adding or removing folders, archiving and subordinating documents or starting applications. resultset [com.saperion.ngc.resultset.resultsetviewimpl] Represents the result of a query in a list and offers functions for working with the found elements. Furthermore the component contains UI elements for turning through pages of the result list and filter client based. spntoolbar [com.saperion.ngc.toolbar.saperiontoolbarview] The toolbar contains a freely selected name for an application, the name of the currently logged-in user, a dropdown box for the language selection and the logout button. tabview [com.saperion.ngc.maintab.maintabviewimpl] The tab view component serves for the display of multiple forms or different elements in tabs.

6 Component iform [com.saperion.ngc.iform.intelligentformviewimpl] The iform is the equivalent of the form in Rich Client. By means of other components the content of the form is represented in the iform as defined in the Form Designer of the Rich Client. The iform can also be embedded in another iform. iformlabel [com.saperion.ngc.iform.label.formlabel] Represents a text of a form. iformbutton [com.saperion.ngc.iform.button.formbutton] Represents a button in a form. itextfield [com.saperion.ngc.iform.field.textfield] Represents a text entry field in a form. itristatefield [com.saperion.ngc.iform.field.tristatefield] Represents entry fields for the three values "none", "all" and "some" in a form. icheckboxfield [com.saperion.ngc.iform.field.checkboxfield] Represents an entry field for "yes" and "no" in a form. idatefield [com.saperion.ngc.iform.field.datefield] Represents a date entry field in a form. ifloatfield [com.saperion.ngc.iform.field.floatfield] Represents a floating-point entry field in a form. iintfield [com.saperion.ngc.iform.field.intfield] Represents an integer entry field in a form. ilookuptextfield [com.saperion.ngc.iform.field.lookuptextfield] Represents a text entry field with a lookup table in a form. itimefield [com.saperion.ngc.iform.field.timefield] Represents a time entry field in a form. Portal Integration The SAPERION Web Client can be integrated into portals and further websites. For this purpose the files "portal.zul" and "archiver.zul" are provided along with the SAPERION installation CD. The file "portal.zul" offers the facility to open a certain mask and to start a search with pre-defined parameters. By means of the file "archiver.zul" new files can be archived. The registration for SAPERION backend is processed via the normal login mask of the Web Client or via Single-Sign-On if this feature is configured. In this chapter you will learn about how to embed the Web Client in your portal resp. your website..1 Search and Display of Documents "portal.zul" The control for the file "portal.zul" is done with the following URL-parameters: "portal.zul" Parameter mask Name of the query mask to be opened (without.qbe extension) doquery If this parameter exists (without value) an automatic query will be started. filter When "doquery" is used, you can add the "filter" parameter to filter for specific values in fields. More details can be found in the next section.

7 Portal Integration 5 Parameter selectsingleresult If this parameters exists (without value) the found document will be automatically selected. In cases multiple documents are found this parameter has no effect. viewerclass With this parameter you define which viewer is used in the mask. For this purpose enter the full qualified class name of the viewer implementation. Important: Upper and lower case spelling must be considered. Filter You can use the optional "filter" parameter in the URL to define additional values for the search. Please note the following: The filter parameter must follow a "&" in the URL. For each field, a field name/value pair can be stated. Field name and value are separated by "=". Multiple pairs are separated by ";". Fields that define a lower or upper limit for the search are identified by [0] or [1], respectively. Entries with floating-point numbers must be entered with periods, not commas. The URL format using the filter parameter could then be: Example: portal.zul?mask=examplev7_q&doquery&filter=ex7_docnr[0]=;ex7_docnr[1]=;ex7_docname=.%0og With the above URL, the form "examplev7_q" is opened. Upon opening, a search is started for the field EX7_DOCNR (lower limit) = "", the field EX7_DOCNR (upper limit) = "" and the field EX7_DOCNAME = ". OG". Viewerclass For the optional parameter "viewerclass" following values are available: Viewerclass Value com.saperion.ngc.viewer.simple.simpleviewerimpl Place holder which only display a download link for the document. com.saperion.ngc.viewer.virtualviewer.clientserver.csvirtualviewerapplet Implementation of the provided Snowbound Virtual Viewer (default value). Default Values for Index Fields For default values of index fields certain formats for values must be considered: Floating-point numbers: Decimal separator is a point (Example: 17.) Date: ISO-801 format (Example: T18::.000Z)

8 Multiple values for multi-value fields are separated by ";". If a field contains a value with semicolon, it can be masked by a second semicolon (Example: "A;;single;;value" leads to "A;single;value". 1;; specifies the three values 1, and ). For fulltext fields the database dependent syntax of the fulltext search function must be used. For example, an expression with space must be set in quotation marks. Further details are described in the documentation of the database. Configuration of the Service Component You have further configuration possibilities in the "portal.zul". You are allowed to switch off the message "Do you want to move to this page?" when the user is moving to another page. <spnservice logoffwarningdisabled="true";/> If it is required that the user remains at the same page after logging off, set the following entry: <spnservice redirectafterlogoffdisabled="true";/>. Access to the Workflow Inbox With the file "portal.zul" it is also possible to access the workflow inbox of users. For this purpose an own parameter is available: Workflow Inbox Parameters Parameter openinbox Opens the inbox of the currently logged in user. Except the parameter "mask" all above mentioned parameters are available (see chapter "portal.zul"). It is possible to set default values for the fields in the mask of the workflow inbox. Example When a user clicks the above stated example URL and has been authenticated, the mask for the workflow inbox will be loaded. The field "subject" is set by default with the value "Invoice" and a search is started. i. Currently it is not possible to access group and substitute boxes by means of "portal.zul". Archiving New Documents "archiver.zul" The file "archiver.zul" is controlled via http-post request. In this POST request used index mask, document content and also its metadata (when pre-defined) are transmitted.

9 Portal Integration 7 Default values for index fields can be transmitted as additional parameters in the POST request. For this, respectively the field name and the required value are linked. Following parameters are pre-defined: Pre-defined Parameters in "archiver.zul" Parameter ngc_archivemask Name of the index mask (without.qbe extension) ngc_archivedocument Contains the content of the document. ngc_workflowdefinition Optional: The name of the workflow definition which should be started on the new document after successful archiving. ngc_workflowactor Optional: Name of the first user for the workflow definition. By means of the optional parameters "ngc_workflowdefinition" and "ngc_workflowactor" a workflow can be started automatically on the new document after successful archiving. State the name of the workflow definition here. If the definition does not contain any recipients, you can define one by means of the parameter "ngc_workflowactor". Events The "archiver.zul" file enables also to react to certain events: Events Event onarchivercancel Will be initiated when the user clicks the [Cancel] button in the form. onarchivererror Will be initiated when the archiver is not able to archive the document. It should be noted that only errors that occur in the archiver are handled. These are e.g., false request parameter or insufficient user rights. System errors while archiving are already intercepted by the error handling of the Web Client components. The event contains the error message in its "data" field. onarchiversuccess Will be initiated after a document has been archived. The event contains values as list of FieldResultBeans in its "data" field which are entered in the index fields. In the prepared event listeners in the ".zul"-file on any events can be reacted separately. In the provided example implementation the user is shown respectively one message. After confirmation he will be logged off from the system and forwarded to a test site.