Best Practice - Creating Forms
Copyright © 2016 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.
Table of Contents
1
Introduction .........................................................................................................
1
1.1 General Information on Creating Forms ............................................................
1
2
Creating a Query Form with an Embedded Index Form ....................................
2
2.1 Creating the Index Form to be Embedded .........................................................
2
2.2 Creating a Query Form with an Embedded Index Form ....................................
2
3
3
Creating a Query Form with Mashup ................................................................
1.1
General Information on Creating Forms
Best Practice - Creating Forms
1
Introduction
This document describes the procedure for creating forms.
The two examples provided discuss creating a form with embedded index forms and a form with a
mashup.
Embedded index forms are intended to display and directly process the existing index data from an index
form. Only changes that will take effect immediately after the change is implemented can be made to
existing index data. It is not possible to carry out an initial indexing of documents via an embedded
index form.
A proprietary form should be created as an embedded index form because it has some special
characteristics that facilitate optimal display in the SAPERION clients.
To clarify the operating principle of the panes, the embedded index mask is placed on an individual pane
that is placed behind the viewer as a tab.
With the help of mashups, web content, like Google Maps, can be displayed in SAPERION forms by
establishing a link between the content of the results list and the web content. This allows addresses in
the results list to be evaluated and displayed directly within the form in a Google Map. The mashups
use the open programming interfaces of the other application.
1.1
General Information on Creating Forms
When creating forms, SAPERION allows users to differentiate between forms that can only be used in
the Rich Client and forms that can also be used in the Web Client.
Please note the following:
+
Always create index forms for initial indexing for the rich client as it is not possible to do so via
the Web Client.
+
Forms are created for both the rich client and the Web Client by default.
As a consequence:
+
System fields are not accounted for when automatically generating forms. If you want to display
system fields, these must be added manually afterwards.
+
Panes are used in the form. Only panes with a title can be moved.
+
Panes can be stacked to create tabs. In this case, they can be resolved. Should this not be possible,
use SAPERION's tab function.
+
You can define for which clients the mask is for. Select the respective client in which the mask can be
shown by activating the according checkbox ("Web Client" or "Rich Client") in the Forms Designer.
In the SAPERION Rich Client and Web Client the application are then available in the navigation
according to your selection here.
1
2
i
2
Creating a Query Form with an Embedded Index Form
For compability reason existing masks (masks that are created before SAPERION SP1
release), are shown in both Rich Client and Web Client.
Creating a Query Form with an Embedded Index
Form
The supplied definition "examplev7" serves as the basis for the query form, which first needs to be loaded
via DESIGN ribbon > TABLES group > LOAD DEFINITION command.
2.1
Creating the Index Form to be Embedded
First create the index form to be embedded:
1.
Click DESIGN ribbon > APPLICATIONS group > CREATE INDEX FORMS command.
2.
In the form properties (OPTIONS ribbon > VIEW group > [Arrow] icon) enable the
"Horizontal scroll bar" and "Vertical scroll bar" checkboxes. This allows an embedded
index form to be fully displayed even if the space provided in the query form is too small.
3.
Create a standard form for indexing using the START ribbon > LAYOUT > GENERATE
menu option.
4.
Delete any superfluous fields.
5.
Delete the buttons that are inserted automatically. In their place, insert the [Edit], [Save]
and [Cancel] buttons.
In addition to the necessary [Edit], [Save] and [Cancel] buttons, you can add other buttons
such as [Save and next document].
Depending on the size and position of the embedded index form on the query form, the
buttons should be positioned so that they are easily accessible on the index form.
6.
Reduce the form to a suitable size.
7.
Save the index form. In this example, the form is saved under "examplev7_e".
2.2
Creating a Query Form with an Embedded Index Form
Once the index form that is to be embedded has been created, next create the query form:
1.
Click DESIGN ribbon > APPLICATIONS group > CREATE SEARCH FORM command.
2.
Create a standard form using the START ribbon > LAYOUT > GENERATE menu option.
3.
Delete unnecessary fields and add any required system fields.
4.
Generate a new pane using the START ribbon > LAYOUT > NEW AREA menu option.
5.
Drag the pane to the automatically generated "Display" pane to display both panes as tabs.
2
2.2
Creating a Query Form with an Embedded Index Form
6.
Click the title bar of the new pane and assign the pane a title using the "Text" option from
the properties. In this example, "Index data" was chosen as the title.
7.
In the START ribbon > INSERT drop-down list, select the "Form" entry and drag open a
box on the pane.
8.
Select the desired index form, in this example "examplev7_e", and click [OK].
9.
In the START ribbon > INSERT menu, enable the "Links" checkbox.
10. Draw a link from the results list to the inserted index form.
11. Save the created form.
3
Creating a Query Form with Mashup
With the help of mashups, web content, like Google Maps, can be displayed in SAPERION forms by
establishing a link between the content of the results list and the web content.
In the following example, the addresses contained in the results list are displayed in a Google Map.
i
As of Google Maps API Version 3, no licence key is required for using Google Maps in an
application.
They are based on a DDC containing address information ("STREET" includes street and street number;
"CITY" includes zip code and city).
As opposed to the previous example, here the mashup is not placed on a dedicated pane; instead, it is
placed on tabs on a pane together with the viewer.
1.
Click DESIGN ribbon > APPLICATIONS group > CREATE SEARCH FORM command.
2.
Create a standard form using the START ribbon > LAYOUT > GENERATE menu option.
3.
Delete unnecessary fields and add any required system fields.
4.
Open the "Display" pane.
5.
In the START ribbon > INSERT drop-down list, select the "Mashup" entry and drag open
a box.
6.
The "Edit Mashup" dialog box opens, which can be used to enter the HTML text of the
mashup.
7.
Enable the [HTML text] option button and enter the desired listing.
The display in Google Maps serves as an example listing for a mashup:
var map = null;
var geocoder = null;
var mashstreet = "";
var mashcity = "";
function initialize() {
3
3
Creating a Query Form with Mashup
var myLatlng = new google.maps.LatLng(51.102143,9.81445);
var myOptions = {
zoom: 4,
center: myLatlng,
mapTypeId: google.maps.MapTypeId.ROADMAP
}
map = new google.maps.Map(document.getElementById("map_canvas"), myOptions);
geocoder = new google.maps.Geocoder();
}
function showAddress() {
if ( ! geocoder ) initialize();
if (geocoder) {
var mashaddress = mashstreet + ", " + mashcity;
geocoder.geocode({'address': mashaddress}, function (results, statuscode) {
if(statuscode == google.maps.GeocoderStatus.OK) {
map.setCenter(results[0].geometry.location);
map.setZoom(15);
var marker = new google.maps.Marker({
map: map,
position: results[0].geometry.location
});
var infowindow = new google.maps.InfoWindow({
'content': mashaddress
});
infowindow.open(map, marker);
} else {
alert('Address was not found.');
}
});
} else {
alert('Geocoder is not set.');
}
}
function setValue( name, value) {
switch (name.toLowerCase()) {
case "street":
mashstreet = value;
break;
case "city":
mashcity = value;
break;
default:
break;
}
}
function execute() {
4
2.2
Creating a Query Form with an Embedded Index Form
if (mashstreet != "" && mashcity != "") {
showAddress();
}
}
</script>
</body>
</html>
The following functions are available for use with Mashups:
+
SetValue: With SetValue (String Name, String Value) users are allowed to set the index
data from the form in the Mash-Up.
+
Execute: With Execute (), an operation on the index data is executed.
i
The JavaScript methods "SetValue" and "Execute" are called
automatically by the form when the user is selecting a new results list
entry. Per results list column "SetValue" with the name of the column
and the column value of the current selection is called. After having
passed all values the "Execute" method is called automatically.
8.
Click [OK].
9.
In the START ribbon > INSERT menu enable the "Links" checkbox.
10. Draw a link from the results list to the inserted mashup.
11. Click START ribbon > LAYOUT > GROUPS command.
This will open the "Field groups" dialog box where you can create an individual group
for each generated element using the [New] button. The groups are then allocated to the
respective tabs.
12. Click START ribbon > INSERT group > TAB command.
The "Edit tab control" dialog box for creating tabs opens.
The tabs are created via the [New] button, which creates a line in the list of created tabs.
After clicking the "Text" line, you can enter the display text of the tab at this position. By
slowly double-clicking, the created field groups will be displayed to you in the group area,
from which you can then select the relevant group.
13. Once you have allocated all required elements to a tab, click [OK].
14. Save the desired form.
5