Web Extensions V1200 Programming Guide En

(1)

ProTopas/Web-Extensions V 1.2/00

ProTopas/HTML-Dialog V 1.2/00

Programming Guide

(2)

Copyright and Trademarks

Delivery subject to availability; right of technical modifications reserved.

(3)

Introduction

Selecting the product version

Web-Extensions/ExtraLink

Web-Extensions/ClassicLink

Web-Extensions/HyperLink

Components and system requirements

Designing the user interface

Controls

Web Graphical Service components

(4)

(5)

Input checks

Displaying external pages

Scripting

Control of the ADA Service

Customer Relationship Marketing

Installation

Configuration

Parameters

Tools

(6)

(7)

Glossary

Documentation

Figures

(8)

Introduction

This manual describes the individual Steps that are needed to develop a self-service application using the ProTopas/Web-Extensions or ProTopas/HTML-Dialog.

ProTopas/Web-Extensions or ProTopas/HTML-Dialog allow you to use Internet pages in all ProTopas applications. This means that all ProTopas products can be converted from traditional interfaces to Internet pages without additional programming. You also have almost unlimited options regarding the integration of multimedia objects.

ProTopas/Web-Extensions is able to incorporate new online solution modules, like 1-to-1 marketing solutions, to display product information from the Internet or even to incorporate Internet applications.

ProTopas/HTML-Dialog is the offline version of the ProTopas/Web-Extensions. With ProTopas/HTML-Dialog all Internet pages have to be installed locally on the self-service device. The access is restricted to the file system, so no Pages from any Internet server can be loaded. ProTopas/HTML-Dialog may be used as a lowcost version for using locally installed user interfaces in form of Internet pages. Thus, all Internet technologies may be used, without using any online access. Because the technologies are the same in ProTopas/Web-Extensions or ProTopas/HTML-Dialog, in the rest of the documentation only the product name ProTopas/Web-Extensions is used. If there is any restriction, it is stated separately by using the following icon:

Not available for ProTopas/HTML-Dialog

ProTopas/Web-Extensions is a runtime system which makes it possible for the ProTopas solutions to use all the features offered by Internet technology. The software components are not limited to solutions for a single type of device, and can instead be used for all types of self-service device solutions. Thus, a uniform corporate design can be achieved on all types of device with a minimum amount of effort.

The self-service customer interface is presented in a standard Web browser. Interface elements (graphics, text, buttons, etc.) and multimedia components (sound, video, animations) can be stored locally on the self-service device itself, or centrally on an intranet server (only with ProTopas/Web-Extensions). It is possible to create graphical elements using standard formats and commercially

(21)

Introduction

available tools. Optional access to the interface elements via an Encrypted PIN Pad (EPP) allows the user to input numbers via an EPP and to select functions using the softkeys at the side of the screen.

Modifications can be made to the interface during runtime using standard Microsoft products, e.g. FrontPage, and changes can be called up immediately on the self-service system. This guarantees that you are able to react promptly to the ever-changing requirements of the market.

The basis for integration of new services like 1-to-1 marketing via the Internet on self-service systems is provided by ProTopas/Web-Exten-sions. The incorporation of marketing and sales structures as well as a customer database enables the customer to be addressed directly using standard Internet pages. The interaction between the self-service system and the customer can be implemented using touch-screen technology, softkeys and the EPP (Encrpted PIN Pad). The ProTopas/Web-Extensions controls can be assigned either to softkeys or to EPP keys and can thus trigger a visible reaction on screen.

Targeted access to current information and offers from the Internet is a decisive factor for future customer loyalty strategies. By opening up their terminals in the direction of the Internet, the banks in their role as self-service system installers can introduce additional services to their range including:

z car sales, z insurance sales, z travel services and z ticket sales

and thus open up new delivery channels.

The availability of a central Web server in the provider’s network allows you to increase the types of possible access. During a trans-action it will be possible to access both data from the host and documents and Internet pages located on the intranet server. If required, it may also be possible to download and display current pages from the Internet.

The use of standard products, standard protocols and basic Microsoft technolo-gies offers the following additional advantages:

(22)

Introduction Take care © S ie m ens Ni x d o rf I n fo rm a ti o ns s y s te m e A G 199 5 P fad : d :\ P ro T o pas \W e b -E x tens io n s \D oc u\ B o o k \E in le it un g. fm

z centralized modification of the self-service application z creation of reusable modules

z use of commercially available basic components z assembly of dialog Steps from predefined components z independence of a single central product manufacturer

Take care

ProTopas/Web-Extensions provide a runtime environment for using Internet technology in self-service systems. This enviroment allows the developer to incorporate third party products to provide high sophisticated user interfaces. However, it is not possible for the quality assurance team to test all third party products together with the ProTopas/Web-Extensions. This has to be done in each project, which is using a third party product. It has to be checked before such a component is used, that it is qualified for running in self-service environ-ments (application is running 24 hours a day, 7 days a week; application is never closed; etc.). If an error occurs in Internet pages which contain a third party product, it has to be tested in the project, whether the third party product may cause the error, before reporting the bug to the development team of the ProTopas/Web-Extensions. Please keep in mind, that you will be charged for support, if a reported error is not found in the ProTopas/Web-Extensions themselves, but in the third party product.

There is a knowledge base available in the intranet of Wincor Nixdorf or a printed list of this knowledge base for those who have no intranet access available from the support team, where solutions of known issues and hints linked up with the ProTopas/Web-Extensions are reported.

New since release 1.1/25

1.1/25:

z Use of Format FW: The ProTopas Format FW may be used to format Web Bot Variables. There is a new format string, which has to be used here. (see also section ’SNI_PC_VARIABLE WebBot’ on page 285)

(23)

New since release 1.1/25 Introduction

z Navigation monitor: The Web Graphical Service gives the possibility to control a navigation to another page with the help of a configuration in the Allow List. The Column 8– OPTIONAL can be used to specify the keyword WXmonitor and WXmarketingmode (see also section ’Monitoring of navigation to another page’ on page 301)

z New control ActiveRegistry: This Control is used for scripting only. It is useful for getting REG_DWORD or REG_SZ Parameter values into variables for scripting (see also section ’ActiveRegistry Control’ on page 491).

z New control WXPTBridge: This control gives access to all ProTopas Frame-works. It must be used in the Virtual Keyboard instance, when it is used as Marketing window for the access to the EPP Framework. However it may be used to access all other frameworks as well (see also section ’WXPTBridge’ on page 385).

z New function Key CONFIRMALL: This value may be used for a special input handling. The customer may fill all edit fields by using the touch screen or the <Tab>, <Cursor up> or <Cursor down> key. After pressing this button all checks of all input fields will be started. When everything is okay, the Web Graphical Service will navigate to the page configured in this key (see also section ’Special input confirmation handling’ on page 418).

z With help of the new parameter SetInputFocusNext the cursor is set to the field with the next higher field ID in multiple input pages (see also section ’Field sequence control’ on page 416).

z The parameter WorkAroundNoShell (see also section ’Workaround-NoShell’ on page 617) has to be set to 1, if the Web-Extensions are installed in a ProTect environment, otherwise no Popup window will close properly. z The <Cursor up> and <Cursor down> keys act like <Tab> and <Back Tab>

now (see also section ’Special input confirmation handling’ on page 418). z Masked edit is possible for the PCEdit control now (see also section

’Masked edit for standard edit control’ on page 145).

z To show an ampersand it is necessary to write two ampersands into the text of a visual control. If this text is filled by a variable it might not be possible to have two ampersands. So there is a property to prevent this (see also section ’Show an ampersand (&) in Caption of a control’ on page 194). z The caret (Input cursor) can be hidden now (see also section ’Hide the caret

(24)

Introduction New since release 1.1/25 © S ie m ens Ni x d o rf I n fo rm a ti o ns s y s te m e A G 199 5 P fad : d :\ P ro T o pas \W e b -E x tens io n s \D oc u\ B o o k \E in le it un g. fm

z Parameter NewImmediateTimeout = 0 (see also section ’NewImmedia-teTimeout’ on page 650) is responsible for directly navigating to new page without waiting time. Maybe the waiting time caused problems in some projects using Web-Extensions/ClassicLink.

z The multilanguage feature (see also section ’Easy multilanguage support’ on page 289) is supported now. Variables with syntax

[%WX_TEXT[Index];Default%] may be used to configure the texts in all HTML pages.

z The Virtual Keyboard may be used for Marketing instances as well. New parameter Pos, Left and Top are available now as well as container properties CCVK_VAR_CONTAINER_L[0-255],

CCVK_VAR_CONTAINER_S[0-255] (see also section ’Using the Virtual Keyboard’ on page 313). The Virtual Keyboard is supervised by watchdog functionality now.

z Edit control may be used for EPP input as well now. EPP control is not necessary any longer and will not be maintained any longer (see also section ’Edit control (PIN input) - General 1 page’ on page 139). With the Edit control scheme support for EPP input is now available.

z Icons are supported by schemes now for Button, Edit and List control. 1.1/26:

z The cursor position in PCEdit Control can be set to each character in script by use of the function SetSelection(short sStart, short

sEnd)(see also section ’Edit control:’ on page 468).

z The Virtual Keyboard got a lot of new functions to show or hide, minimize or maximize this browser instance (see also section ’Using the Virtual Keyboard’ on page 313). A new offline event CCVK_VK_OFFLINE is fired, when an problem occurs in this browser (see also section

’CCVK_VK_OFFLINE event’ on page 319). Parameter MAXonStart (see also section ’MAXonStart’ on page 603), MINonEnd (see also section ’MINonEnd’ on page 603) are new.

z The handling of the HTML flow support has been enhanced. Now there are two files written. One will be overridden when the other has been filled up (see also section ’Logging the flow of the HTML pages’ on page 320).

(25)

z The parameter WorkaroundWhitePopup (see also section ’Workaround-WhitePopUp’ on page 618) may be set to show the windows opened by in a

new window when the page is completely loaded. This will remove any white

background to be shown, which may flicker.

z A new batch file WebAnalysisTrace.cmd for setting the analysis trace of the Web-Extensions is available in C:\ProTopas\Bin.

1.1/27:

z The handling for Subroutines has been enhanced. Now it is possible to create subroutines without opening it in a new window. By setting a prefix WN_TFN_FLAT_SELF into the link to the first subroutine page the navigation takes place in the content frame, but the subroutines may still be finished by a navigation to close.htm (see also section ’Creating sub routines without opening a new Window’ on page 274).

z Contents ATM Control will throw an error now, when there is an

Immedia-teTimeout configured, but EPP Keys is not set to No Input. These pages

should be changed, because this is time consuming and needless. z For the Virtual Keyboard the parameter WindowPlacement (see also

section ’WindowPlacement’ on page 603) is new. There are new interfaces for logging into trace and error log (see also section ’Using the Virtual Keyboard’ on page 313).

z Parameter OfflineMonitorTimer (see also section ’OfflineMonitorTimer’ on page 622) must be set to supervise the navigation to the offline page, when the navigation to an application page is supervised but can not be performed (see also section ’Supervising the monitoring to the first offline page’ on page 303).

1.1/28:

z Parameter CursorEnable (see also section ’CursorEnable’ on page 604) specifies, if the cursor shall be visible or not during a virtual keyboard session.

z Parameter AutomaticEPPConfigForAllButtons (see also section ’AutomaticEPPConfigForAllButtons’ on page 650) specifies, that all button viewstates (not only those of the function keys) shall be checked for activation to CEN/XFS EPP Service.

(26)

Introduction New since release 1.1/25 © S ie m ens Ni x d o rf I n fo rm a ti o ns s y s te m e A G 199 5 P fad : d :\ P ro T o pas \W e b -E x tens io n s \D oc u\ B o o k \E in le it un g. fm 1.1/29:

z If you are working with a EPP keyboard only it is possible to restrict the number of characters to be entered by writing the keyword

WX_INPUT_FLAG_CHECKMAXCHARONEPP into the property

Additional-Features of the edit control (see section ’Check max. chars for EPP

keyboard’).

z It is possible now to pass parameter to generated temp files like prot://server/object.ext?parameter=abc and to request them by calling window.location.search in script. Output would be ’?parameter’ in this case. 1.1/30:

z The SpinEdit Control is not supported and not included any longer. z The function Log() (see also section ’Log’ on page 399) and the callback

event PTCallback() (see also section ’PTCallback’ on page 405)are new in the WXPTBridge control.

z There are new keywords in the AllowList at the optional column called WNvikey:START and WNvikey:END (see also section ’Structure of the AllowList’ on page 294)

z The additional parameter MarketingAllowFocus allows to give the focus to other windows even when the Virtual keyboard is active (see "MarketingAl-lowFocus" on page 606 in the Parameters chapter).

1.1/32:

z The default contents of all paramter containing the font family have been changed from Arial (Truetype) to Arial.

z The parameter AllowMarketingFocus allows to set the focus manually even during SOP Sessions, etc. (see also section ’Parameter MarketingAllow-Focus’ on page 320)

z The HTML Dialog Control has been enhanced to record all active popup windows during the runtime of a application (see also section ’HTML Dialog Control Version 2242’ on page 311).

z The DoDialog() call for a Classic Link application may be supervised by a timer now (see also section ’DoDialog() Safety features’ on page 36). z A new property of the Contents STD/ATM Control may be used to check the

initialization status of the control. (see also section ’Contents STD/ATM control:’ on page 465)

(27)

z The ActiveDataDictionary Control gets a new property to suppress error loggings. This may be useful for pages with properties whose values are ’property not set’ (see also section ’Active DataDictionary Control’ on page 478).

1.1/33:

z There has been a change in the behaviour of the PcButton Step after. It is not possible any longer to press another button, if the first button runs a step after. To reactivate the old behaviour, please set the following undocu-mented DWORD-parameter: ActiveX\PCContents\General\StepAfter-Control with contents 0.

1.1/34:

z There is a new parameter MAX_WEBEXTENSION_MEMORY_GROWTH (see "MAX_WEBEXTENSION_MEMORY_GROWTH" on page 689 in the Parameters chapter) of the HTML Dialog Control. It’s a successor of Parameter MAX_MEMORY_USE. Now it is possible to configure the max growth of the Web Graphical service, until it is restarted, i.e. a value of 30 means it may grow 30 MB until restart See also chapter ’HTML Dialog Control Version 2243’ on page 311.

z The parameter ROOTPATH (see "RootPath" on page 620 in the Parameters chapter) can use the keyword ATM_PATH_NOLANG to prevent the Web Graphical Service from changing the directory, when using the WX_TEXT variables in all pages for multilanguge support (see "New multilanguage handling" on page 37 in the Parameters chapter).

1.1/35:

z The ChangeLanguage() Function of the Web Graphical Service may use the input parameter 999 now. With this function call only the ADA language settings are updated, but no directory, WX_TEXT or format change is done (see also section ’CCDialogFW.ChangeLanguage’ on page 353).

1.1/37:

z It is possible to replace variables in HTML Text with syntax [# name of PC variable ; formatting of PC variable; default value of PC variable #] directly. A WebBot is not longer necessary (see also section ’SNI_PC_VARIABLE WebBot’ on page 284).

(28)

Introduction New since release 1.1/25 © S ie m ens Ni x d o rf I n fo rm a ti o ns s y s te m e A G 199 5 P fad : d :\ P ro T o pas \W e b -E x tens io n s \D oc u\ B o o k \E in le it un g. fm

z WX_TEXT placeholders can now contain variables, either in the HTML Pge in the WX_TEXT tag (as index or as default value) or in the registry in the constant texts (see also section ’Using variables instead of constants in WX_TEXT’ on page 291).

z It is possible to have floating transparencies in PNG Graphics. In former versions it was only possible to have one color for transparencies, so floating was not possibe (see also section ’Screen resolution and colour depth’ on page 60).

z The Web Graphical Service can be resized by creating a few registry parameter with the coordinates of the position and size (see also section ’Resizing the Web Graphical Service on a PC’ on page 321).

z The Active Data Dictionary Control got a restricted buffer size of 4096 Bytes for setting and getting strings from Data Dictionary values now. This has been done for performance reasons. If a bigger Buffer size may be necessary, it is possible to set a BufferSize property in the control (see also section ’Adapting the maximum buffer size’ on page 491).

z The input of an edit control may be automatically deleted now after the input correction message has been shown by setting a new property in the edit control (see also section ’Delete the content after customer error in edit control’ on page 147).

z It was not possible to delete the content of an edit field by setting the input variable to an empty string. With new parameter DeleteInputFieldsWith-EmptyString (see "DeleteInputFieldsWithDeleteInputFieldsWith-EmptyString" on page 650 in the Parameters chapter) it is possible now.

z Shadowing effect of a button, Edit Control and List Control capture: It is possible to use two layer with identical text and different colours to create a shadowing effect of the font (see also section ’Shadowing effect of control capture’ on page 195).

1.2/00:

z A new functionality for Marketing integration has been added. Now the virtual keyboard is not used any longer for marketing issues. With this feature a new Marketing Contents Control is introduced, which has to be used in the Marketing Browser Instance only. See also chapter ’Customer Relationship Marketing’ on page 515.

z Internet Explorer 7.x may be used together with the Web-Extensions right now.

(29)

Target groups for this manual Introduction

Target groups for this manual

This manual targets project managers and members of development teams, as well as marketing staff, in case the design of self-service user interfaces is involved. It describes how to implement multimedia user interface requirements and the underlying application modules.

Members of the development team should have the following skills:

z Familiarity with ProTopas in order to recognize relationships between the individual ProTopas modules

z C/C++ knowledge in order to implement application modules z HTML know-how to develop Internet user interfaces

z Basic skills in handling Microsoft FrontPage

Structure of the manual

The chapter "Selecting the product version" describes the range of uses for ProTopas/Web-Extensions. In this context, we refer to different architectures. The chapter "Web-Extensions/ExtraLink" deals with the use of the first of three possible architectures.

The chapter "Web-Extensions/ClassicLink" describes the characteristics of the second architecture.

The chapter "Web-Extensions/HyperLink" shows the differences of the third architecture.

The chapter "Components and system requirements" outlines the functionality of ProTopas/Web-Extensions. It presents modules for the user interface and the application layer, followed by a description of the hardware and software environment requirements.

The chapter "Designing the user interface" gives tips and options for imple-menting an easy-to-use user interface. It also looks at the user interface elements, referred to as controls from now on, that have been developed especially for ProTopas/Web-Extensions.

(30)

Introduction Structure of the manual © S ie m ens Ni x d o rf I n fo rm a ti o ns s y s te m e A G 199 5 P fad : d :\ P ro T o pas \W e b -E x tens io n s \D oc u\ B o o k \E in le it un g. fm

The chapter "Controls" follows immediately, and describes the configuration options for ProTopas/Web-Extensions controls in order to implement the user interface described above. This is followed by a section on closing a browser window that has been opened with these controls.

The modules for presenting the user interface and the browser components are referred to as the Web Graphical Service. The chapter "Web Graphical Service components" deals with the individual modules. This is followed by a

programming reference for the Dialog Framework.

The WXPTBrigde is introduced in the next chapter. It may be used to access ProTopas frameworks for the pages directly in script.

A separate chapter is dedicated to "Input checks" in ProTopas/Web-Extensions. It explains the functions and the handling of inputs. A programming reference closes this chapter.

Some parameterization steps are needed to display HTML pages from outside the ProTopas/Web-Extensions application. The chapter "Displaying external pages" describes configuration options, and restrictions on loading HTML pages that are external to the product.

Scripts can be called to design the contents of a page more flexibly. A chapter "Scripting" describes the scripting interfaces of the ProTopas/Web-Extensions controls, as well as the control interfaces to access data from ProTopas modules.

An introduction of the ADA features in the ProTopas/Web-Extensions follows. The configuration of the Text-To-Speech possibilities in the ProTopas/Web-Extensions is content of this chapter.

The chapter Customer Relationship Management contains information about the ProTopas/Web-Extensions solution in displaying marketing pages together with the application. The speciality here is the possibility of an interaction with the application but a separation of the flow of marketing pages.

A chapter "Installation" describes the handling required to install the ProTopas/Web-Extensions correctly on a system upon which the ProTopas/Manager has previously been installed.

The "Configuration" chapter explains the configurations which are performed automatically by the installation program in order to improve knowledge of necessary changes during a manual installation of the ProTopas/Web-Exten-sions.

The chapter "Parameters" contains a detailed list of all ProTopas/Web-Exten-sions parameters.

(31)

Typographical conventions Introduction

The manual closes with various lists: Abbreviations, glossary, documentation, figures and index.

The interface descriptions are provided as a programming reference.

Typographical conventions

References to manuals

Times New Roman, italics and bold

System messages, examples and source code Courier

Parameters Italics and bold

Properties (parameters for the controls)

Italics

Variable names, HTML page names CAPITALS

Function keys and selection buttons <In angled brackets>

Path, directory, file and menu names, screen elements

Courier and italics

Pictograms

This pictogram indicates warnings and hints that can lead to problems if not observed.

(32)

Introduction Typographical conventions © S ie m ens Ni x d o rf I n fo rm a ti o ns s y s te m e A G 199 5 P fad : d :\ P ro T o pas \W e b -E x tens io n s \D oc u\ B o o k \E in le it un g. fm

This pictogram indicates references

This pictogram indicates tips and tricks

This pictogram indicates registry entries

This pictogram indicates chapters which describe configurations for the architecture Web-Extensions/ClassicLink

This pictogram indicates chapters which describe configurations for the architecture Web-Extensions/HyperLink

This pictogram indicates chapters which describe configurations for the architecture Web-Extensions/ExtraLink

This pictogram indicates enhancements from Version 1.1/2x up to now.

This pictogram indicates that this issue is not available for ProTopas/HTML-Dialog.

(33)

(34)

Selecting the product version Web-Extensions/ExtraLink © S ie m en s N ix d orf I n fo rm a ti o ns s y s tem e A G 19 95 P fa d : d :\ P ro T opas \W eb-E x te n s io ns \D oc u\ B o o k \A us pr ae gun g. fm

Selecting the product version

The ProTopas/Web-Extensions can be installed in different environments. They can be used to extend existing solutions based on traditional interfaces as well as to adapt existing interfaces to the use of Internet pages without having to make adjustments to the application itself. In the case of traditional applications, the application itself assumes control. ProTopas provides the Script Framework, which enables individual transaction modules are concatenated via parameter-ization. A different version of ProTopas/Web-Extensions permits control to be assumed by links in Internet pages. In this case, the ProTopas Script

Framework is not required.

This chapter describes the three product versions, underlining the advantages of each. The ProTopas/Web-Extensions contain the requisite modules for all versions. The differences are described in separate sections in this chapter.

Web-Extensions/ExtraLink

In the event of coexistence with traditional user interfaces, the aim is to integrate the ProTopas/Web-Extensions to enable existing applica-tions to integrate Internet applicaapplica-tions as additional transaction Steps. The customer himself determines what contents the Internet pages will display. The possibilities range from simple product infor-mation to interactive Internet applications. However, if the self-service hardware is to be used for inputs, the controls of the ProTopas/Web-Extensions must be used as they permit allocation to softkeys and the Encrypted Pin Pad (EPP).

This is normally achieved by extending the menu. Selection of a new function activates the Web Graphical Service of ProTopas/Web-Extensions and moves it to the foreground. However, this is only a viable option with interfaces which offer an option for switching the interface to the foreground. The ProTopas Graphical Service modules for ProCash, ProPrint and the High Level Graphical Service CCDialog all support this.

At this point, it is necessary to make extensions to the traditional application. The start page which is to be loaded by the Web-Extensions must be activated. The interface of the ProTopas/Web-Extensions must be switched to the foreground. The traditional application waits for the Web transaction to end, evaluates the return code and can then continue with the existing transaction.

(35)

Web-Extensions/ClassicLink Selecting the product version

Fig. 1: Web-Extensions/ExtraLink

Web-Extensions/ClassicLink

This version of the ProTopas/Web-Extensions permits the interface of an existing application can be changed into Internet pages without any extra programming work. This has the advantage that it is easier to integrate multi-media components and Internet applications.

This is possible without programming work in ProTopas-Steps for all applica-tions which are based on the ProTopas High Level GS CCDialog. The other applications have to modify the interface which loads the user interface. The ProTopas High Level GS uses dialog names as a basic unit for structuring the interface. These dialog names form the page names during creation of the Internet pages. At the same time, it means that each configured dialog must be converted to an equivalent Internet page. Some features of the ProTopas High Level GS, such as configuration via macros, cannot be implemented 1:1 in Internet pages. Such places will either require script programming or an extension to the application in order to achieve the same results.

Web-Extensions/ExtraLink:

Technical View

Traditional User Interface for existing Applications Use of Internet pages for

- 1-to-1 Marketing - Personalization - Advertisement - ...

OKAbbruchDruckenHilfe

Í Î Restart EPP CDM IDCU Printer Dialog Host Transaction Script FW Service

Í Î

Dialog

(36)

Selecting the product version Web-Extensions/HyperLink © S ie m en s N ix d orf I n fo rm a ti o ns s y s tem e A G 19 95 P fa d : d :\ P ro T opas \W eb-E x te n s io ns \D oc u\ B o o k \A us pr ae gun g. fm

In this product version, the ProTopas/Web-Extensions are programmed in such a way that the interfaces are identical to those of the ProTopas High Level GS. Correspondingly, changes to the configuration will enable the application to operate with Internet pages once these have been created.

Extensions in the form of display of product information or complete Internet solutions will also operate in this version of the product. However, it will be necessary to make extensions to the application in order to call the new Internet pages via the interface and to evaluate the return codes.

Fig. 2: Web-Extensions/ClassicLink

Web-Extensions/HyperLink

This product version comes closer to the process involved in a pure Internet solution as it operates with links to workflow processing. However, the appli-cation is still positioned locally on the self-service device and not on the Internet server. application programmers have the opportunity to access the application on each Internet page and to initiate control of the hardware or address of the server/host. The responses from the application can, in turn, effect a link to a new Internet page.

Use of Internet pages for - Existing application - 1-to-1 Marketing - Personalization - Advertisement - ...

Second Dialog not applicable

Web-Extensions/ClassicLink:

Technical View

Í Î Restart EPP CDM IDCU Printer Host Transaction Script FW Service _Dialog

Í Î

(37)

Web-Extensions/HyperLink Selecting the product version

On the other hand, each button can effect a link to a new Internet page. It is thus extremely simple to provide product information with this version. If the self-service hardware is to be used for input, the controls of the ProTopas/Web-Extensions should be used since these controls can be used to make assign-ments to softkeys and to the EPP keypad.

The integration of Internet solutions is easiest to implement with this archi-tecture as it only requires the appropriate links to be placed on the Internet pages. The application itself is not affected by this Step.

If the self-service hardware is to be used from within an Internet solution (e.g. for printouts or to request insertion of a card), this product version can be used to address the appropriate hardware. Return codes issued by the hardware are presented as links to new Internet pages. Unsuccessful printing may therefore display an error message page, whereas successful printing branches to document removal.

Fig. 3: Web-Extensions/HyperLink

Use of Internet pages for - Application - 1-to-1 Marketing - Personalization - Advertisement - ... Workflow processing consists of links to Internet pages Second Dialog and Script FW not applicable

Web-Extensions/HyperLink:

Technical View

Restart EPP IDCU CDM Printer Dialog Host Transaction Script FW

Í Î

Service _Dialog

Í Î

(38)

Selecting the product version Areas of use for the product versions © S ie m en s N ix d orf I n fo rm a ti o ns s y s tem e A G 19 95 P fa d : d :\ P ro T opas \W eb-E x te n s io ns \D oc u\ B o o k \A us pr ae gun g. fm

Areas of use for the product versions

The question arises as to which product version is most suitable for which appli-cation. This question does not apply to Web-Extensions/ExtraLink. This version is always used when Internet solutions are to be added to existing applications. The technology on which the extension is based also makes use of the other two versions. Either the interface of the dialog FW is used to enable each page of the Internet solution to be called from the application or the dialog FW interface is used to display the first Internet page only, which then switches automatically and transfers to the architecture Web-Extensions/HyperLink. If the interface of an application that has been created with the ProTopas High Level Graphical Service is to be converted to Internet pages, the version Web-Extensions/ClassicLink must be selected. This always applies if application modules already exist and are to be reused. These application modules normally also control the user interface by invoking an interface function. appli-cations which do not use the ProTopas High Level Graphical Service but which are to be converted to Internet pages can implement the ProTopas High Level Graphical Service via a simple method. applications with a high percentage of HW accesses or emulations which are largely operated via the host interface should also use this architecture.

If an application is being newly created or if only a few application modules are available, Internet pages can be linked to workflow processing. In this case, it is very simple to integrate Internet solutions. This architecture should therefore be given preference if several Internet solutions are being integrated. The same applies to application modules whose content is highly informative, i.e. which only consist of Internet pages with links to other Internet pages.

Similarities and differences

The product versions described in this chapter mainly use the same modules. Even if workflow processing is sometimes driven by the application and sometimes by the Internet pages, the two architectures only differ in one control. The Contents Std control is used for control from the Internet pages. Parame-terization enables an application Step to be activated. For each of the possible 20 return codes a link to another Internet page can be specified. The Contents ATM control, which is used for the Web-Extensions/ClassicLink, has a far simpler design. In this case, it is only the page timeout that will normally need to be specified.

(39)

Similarities and differences Selecting the product version

The component of the Graphical Service, CCDialog.exe, is identical in all versions. All controls, apart from the two Contents controls, are used in both architectures. The Web-Extensions/ExtraLink version does not have its own control, as it uses the other two versions.

The handling of input fields, input checks and list boxes is identical in all archi-tectures. In the case of Web-Extensions/ClassicLink there are no menu buttons, as each button in this architecture responds to the interface with a return code, while menu buttons are configured for links to Internet pages.

The method for calling external Internet pages differs in the two architectures. In the case of Web-Extensions/HyperLink, it is only necessary to configure a link in a menu button or selection button. With Web-Extensions/ClassicLink, an extension must be made to the Transaction Framework in order to load the first external page (see also section ’Loading external Internet pages’ on page 32). Configuration of the Restart Manager is identical in all architectures (see also section ’Restart Manager configuration of Web GS’ on page 584).

The chapters that follow contain many references to differences between the architectures. The pictograms below indicate the sections containing archi-tecture-specific configurations or features. All other chapters apply to all the architectures.

This pictogram indicates chapters which describe configurations for the architecture Web-Extensions/ExtraLink

This pictogram indicates chapters which describe configurations for the architecture Web-Extensions/ClassicLink

This pictogram indicates chapters which describe configurations for the architecture Web-Extensions/HyperLink

(40)

Web-Extensions/ExtraLink © S iem e n s N ix dor f In fo rm at io n s s y s te m e A G 1 995 P fad: d: \P ro T opa s \Web -E x te ns ions \D o c u \B o ok \T ra d it io nel lS ta rt e n .f m

Web-Extensions/ExtraLink

This chapter describes how Internet solutions or simple Internet pages are called from an application that was developed with ProTo-pas modules. It is necessary to make extensions to the application modules in order to switch the interface of the Web Graphical Service to the foreground and to load the first Internet page.

Let us start one Step earlier: For performance reasons, the Web Graphical Service must be started together with the application or, preferably, prior to the application so that the Standard Graphical Ser-vice overlays the Web Graphical SerSer-vice. This is necessary so that the Web Graphical Service is initialized and ready to accept the inter-face functions.

To load the Web Graphical Service and to keep it in the background the Startpage must not contain any of the ProTopas/Web-Extensions Controls. Nor-mally in an Web-Extensions/ClassicLink or Web-Extensions/HyperLink archi-tecture the Startpage must contain the Contents STD/ATM Control. In this case, if the Standard Graphical Service should display the startup sequence, the startpage can contain any background, but none of the controls. To advice the Web Graphical Service not to wait for loading the Startpage additionally the fol-lowing parameter has to be set to ’1’.

HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\ ProTopas/CurrentVersion/ÁctiveX/

GraphicalService/ PCView

DontWaitForPCContentsOnOpen = 0x00000001 This Parameter must be activated on Extensions/ClassicLink or Web-Extensions/ExtraLink!

Restart manager configuration

To work with Standard Graphical Service and Web Graphical Service, which both have the same framework name CCDialog, Web Graphical Service has to get another Framework name. In addition to the Standard Graphical Service, the Web Graphical Service must be started seperately in the Restart Manager section. As an input parameter, the new name of the Web Graphical Service has to be added:

(41)

Web-Extensions/ExtraLink HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\ ProTopas/CurrentVersion/CCOPEN/ RESTART/ application1 CCDialog=C:\PROTOPAS\BIN\CCDialog.EXE,4,0,6,,, WebDialog

Web Graphical Service registers itself with this new name in ProTopas. This means, that all frameworks, which base on Web Graphical Service have to be started later than Web Graphical Service in the Restart manager section. Those frameworks are at least HTML Dialog Control, Check Framework and Transac-tion Framework. So it is the best to split up the applicaTransac-tion Parameter in application1 and application2, where application1 keeps all the parameters from application without HTML Dialog Control, Transaction Framework Pre-sentation Framework and Standard Dialog Framework, which keeps

application2. application1 may be started before Web Grafical Service and application2 after. HKEY_LOCAL_MACHINE/SOFTWARE/Wincor Nixdorf/ ProTopas/CurrentVersion/CCOPEN/ RESTART application1 application= C:\PROTOPAS\BIN\FwLoadPm.EXE,4,1,21,,,CCPresFW CCDialog CCTransactionFW HTMLDialogControl HKEY_LOCAL_MACHINE/SOFTWARE/Wincor Nixdorf/ ProTopas/CurrentVersion/CCOPEN/ RESTART application1 Programs=CCBase,CCBaseCtrl,application1, CCDialog,Appl_Check, application2,CCStart Data Dictionary configuration

The next problem is, that all Data Dictionary entries, which were registered for CCDialog have to be changed to WebDialog (name of the input parameter for CCDialog.exe). This may be done by calling

\ProTopas\Bin\CCRcConv \ProTopas\Conf\DatadictEx-traLink -t DataDict -b -U

(42)

Changing the Transaction Framework

Inlude additionally the PCDialog.xpp and add a Proxy for WebDialog Class definition in the .hpp header file:

...

#include PCDialog.xpp #include CCDialog.xpp ...

private:

PCDialog myWebDialog; // proxy of Web Dialog CCDialog myDialog; // proxy of Std Dialog ...

Implementation in the .cpp program file: ...

// open the dialog frameworks myWebDialog.Open();

myDialog.Open(); ...

Two functions have been created for the switch to the foreground and, subse-quently, back to the background (see also section ’CCDialogFW.Activate’ on page 339).

z Activate(): Switches the Web Graphical Service to the foreground z Deactivate(): Switches the Web Graphic Service to the background. At the point in the application at which the Internet pages are to be called, the call first switches the Web Graphical Service to the foreground and then loads the Internet start page:

Implementation in the .cpp program file: ...

// Call ChangeLanguage to bring Web Dialog into a // mode, that it loads the next Internet page into // full screen mode and needs no content control // at next page

myWebDialog.ChangeLanguage(CurrentLanguage);

// Deactivate Std Dialog myDialog.Deactivate(); // Bring Web Dialog to top

(43)

Web-Extensions/ExtraLink

myWebDialog.Activate();

// Load Internet Startpage

rc = myWebDialog.DoDialog(’Start’); ...

This program section then waits until the Web Graphical Service responds with a return code. Meanwhile, the Web Graphical Service is active and it is not the self-service application that is responsible for handling the dialogs but usually a Web server. Following the return of the Web Graphical Service this is deacti-vated and the Standard Graphical Service again moved to the foreground. Implementation in the .cpp program file:

...

// Deactivate Web Dialog for SOP Requests myWebDialog.Deactivate();

// Bring Std Dialog to top myDialog.Activate();

// Check the returncode if (rc != CCDIALOG_ERROR) {

// Proceed in your code

rc = myDialog.DoDialog(’Menu’) ...

} ...

The Internet page Start.htm does not contain a control but only a script which calls the first page of the Internet solution.

Syntax of the HTML page script:

On the last page of the Internet application, workflow processing must be returned to the application. Like the start, this is also executed in the script, by navigating to an Internet page consisting of a certain syntax:

(44)

Syntax for sending return codes to the application

Identification that navigation is not taking place but that a return code is being sent to the application:

PCEvt:RC=n (n = 0 to -7, cf. description of return codes in the CCDi-alog.xpp)

The handling described above permits external Internet pages to be displayed. In addition, the Internet pages that are to be loaded must be declared to the Web Graphical Service (see also section ’AllowList’ on page 292).

Configuration of the start page

Originally the start page has to contain a Contents ATM Control, otherwise the Web Graphical Service does not return from the Open() function (see also sec-tion ’Starting the Web Graphical Service’ on page 303). In the Web-Exten-sions/ExtraLink architecture, it is often not possible to have a Contents ATM Control on the start page, because the Web Graphical Service will be switched to foreground when the Contents ATM Control is activated. Normally it should wait for activation in the background. So the parameter DontWaitForPCCon-tentsOnOpen (see also section ’DontWaitForPCConDontWaitForPCCon-tentsOnOpen’ on page 621) has to be set to 1. In this case no Contents ATM Control must be present at the start page.

Activating first page in Web-Extensions/HyperLink after Activate() If the main application is programmed in Web-Extensions/HyperLink architec-ture, and the second application is a Web-Extensions/ClassicLink application with web interface, and both applications shall not base on each other, there may be a problem to reactivate the Web-Extensions/HyperLink application at the end of the other. For this reasons, there is a parameter, which starts the first page after Activate() function call from Web-Extensions/ClassicLink appli-cation. This parameter is

(45)

Web-Extensions/ExtraLink HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf\ ProTopas/CurrentVersion/ÁctiveX/ GraphicalService/ PCView ActivatePageURL = C:\ProTopas\Web\English\restart.htm In this page the Contents STD Control may start the next Step, so the Web-Extensions/HyperLink application may continue.

Configuration of the High Level GS to work with SNIKEYCODES = 0 As mentioned in chapter Configuration of the softkeys (see page 586), the Parameter SniKeyCodes has to be set to 0. The High Level Graphical Service needs a special configuration to work with this setting. In the \ProTo-pas\Conf directory you will find a SetupHlgsKeys.cmd job, which is updating the Keys configuration for the High Level GS. Please update the con-figuration for the High Level GS, if you want to use it toghether with the Web GS.

(46)

Web-Extensions/ClassicLink Value of a softkey © S ie m en s N ix d orf I n fo rm a ti ons s y s tem e A G 19 95 P fa d : d :\ P ro T opas \W eb-E x te n s io ns \D o c u \B o o k \A us ta us c h Ob erf lae c h e. fm

Web-Extensions/ClassicLink

In this product version, the dialogs that were created for the ProTopas High Level Graphical Service are converted to Internet pages. In the best scenario, it is not necessary to make any changes to the corre-sponding application. This chapter refers to some of the special features of dialog conversion.

A dialog normally consists of numerous parameters which describe the appearance of a screen mask. When converting these to Internet pages, it is preferable to note the contents of the masks during runtime and subsequently to use an Internet page creation tool such as Microsoft’s FrontPage to implement them manually. An automatic conversion tool does not exist. The implementation rules of the High Level Graphical Service applies to appli-cations which are to be newly created and which require the ProTopas Script FW to control workflow processing, as described in the application Development Tutorial in the chapters Adding a Graphical User Interface and Adding Customer Input. Besides, this manual contains an extract from the

programming interface of the High Level Graphical Service - only the part which is identical to the Web Graphical Service (see also section ’Dialog Framework’ on page 322). The differences between the two Graphical Services are dealt with in the following chapters.

The Contents ATM control is used in this architecture. The Contents STD control is not applied here. All other controls are used together with all WebExtension architectures.

Value of a softkey

Special attention must be given to the meaning of softkeys, since the values of the softkeys must be identical in the High Level Graphical Service and in the Web Graphical Service. Dialog elements of the type FUNCTION_INPUT must therefore be considered for dialogs with softkeys. These parameters are used to define which value - in the form of a string - each softkey returns to the appli-cation. The application queries these values using the function GetInput-String() (see also section ’CCDialogFW.GetInputString’ on page 335).

(47)

Input fields Web-Extensions/ClassicLink

The Web Graphical Service provides the same function in order to inform the application of the value of a softkey that is pressed. It is only the parameter-ization that differs. Initially, all values which are found for the Web Graphical Service in the different dialogs of the High Level Graphical Service under the Registry key

HKEY_LOCAL_MACHINE/SOFTWARE/Wincor Nixdorf/ ProTopas/CurrentVersion/ActiveX/

PCButton Selection

Readable name of Selection Button Value

must be input on the development system for the Web interface. The entries under Readable name of Selection Button are listed during creation of Button Control (see also section ’Button control - General 2 page for selection buttons’ on page 91), when the button type Selection button is chosen. It then only remains to position the right button on the right Internet page for the designer.

Example: For an amount selection of 100.-, 200.-, 300.- and 400.- the application needs to know, which values has been pressed. The appropriate Step expects the values 100, 200, 300, 400. If another person than the Step programmer himself is creating the amount selection page, this other person must normally know, which values he has to assign to the button. It is much more easy for the designer of the page to have Readable names of Selection Buttons, instead of dealing with program values. So in the example the readable names in the registry will be Amount 100, Amount 200, Amount 300 and Amount 400. Because of this matter, all necessary Selection Buttons and their values have to be set into the registry before the designer of the page starts his job. When he creates the buttons he only selects from the readable names, not from the values.

Input fields

Input data for both Graphical Services is read out using the same function as the softkey values. However, the Web Graphical Service is much more powerful in handling inputs than the High Level Graphical Service. Not simply because it is simpler to handle several input fields on one page but also because the inputs are directly checked and correction messages for the customer supported. Support is also provided for a context-sensitive help for each input field, with radio buttons representing an exception as input field in this case (see also section ’Edit control - General 2 page’ on page 126).