Flow Design Application Properties

The Properties view shows application properties when no objects in the Flow Design page are selected.

General

Property Description
Module name The name of the module.
Module version The version of the module.
Module description Enter a description for the module.
Module display name Enter the name that appears on the Hybrid App when it is viewed on the client.
Delete message after processing If this option is selected, server-initiated Hybrid App messages are removed from the device Inbox after they have been processed. A message is considered to have been processed if the corresponding Hybrid App application is closed as a result of an asynchronous submit menu item being activated.
Mark message as processed after processing If this option is selected, server-initiated Hybrid App messages are marked as processed in the device Inbox (indicated by a green check mark over the original icon) after they have been processed. A message is considered to have been processed if the corresponding Hybrid App application is closed as a result of an asynchronous submit menu item being activated.
Client icon Select the icon that appears on the client.
Credentials cache key Specify a key to use for the credential starting point. If you do not enter anything, each Hybrid App will have a different credentials key. If there is more than one Hybrid App with the same credentials key, then all of those Hybrid Apps can share the same credentials so that authentication for each Hybrid App does not have to be separately defined.
Note: If you import a Hybrid App project built from a previous version of SAP Mobile WorkSpace - Hybrid App Package Development into version 2.3 SP04, the validation error
The credentials cache key should not be set, 
because there is no credential request defined.
may display. To resolve this problem, uncheck the Credentials cache key checkbox in the Flow Design properties view of the Hybrid App Designer.

If a credential screen is not included for the current Hybrid App, then you will not encounter this issue. If the old project contains a credential screen, there is no error during migration.

Requires activation key Specify a key to use for activation. If you do not enter anything, each Hybrid App will have a different activation key, which means that each Hybrid App will have to be activated separately. If you specify an activation key, then when you activate one Hybrid App, all the other Hybrid Apps sharing the specified activation key are automatically activated.
Shared storage key Specify a storage key to share storage between Hybrid App packages. This storage key is passed to the manifest.xml file used by the container.
Maximum message length Specify in bytes. Default: 1048576.
Recoverable error retry timeout Maximum time, in seconds, to retry sending a request after a recoverable error. A retry attempt is made after a retry time interval, which is set by default to 900 seconds. The only recoverable HTTP client error codes are 409 and 503.  
Unrecoverable error retry timeout Maximum time, in seconds, to retry sending a request after an unrecoverable error. A retry attempt is made after a retry time interval, which is set by default to 259200 seconds (three days).
Request new HTTP headers on 412 response error Specifies that when the back end throws a 412 response error, the client send new HTTP headers.
Request new credentials on 401 error code Specifies that when authentication fails, the application prompt the user to reenter credentials.

Keys

The Keys page lets you view and configure properties for keys that are associated with an application. You can sort on any property in the table by clicking its column heading.

Property Description
Key name The name of the associated key.
Type The data type of the associated key, for example, string.
Data binding The data source (if any) to which the key is bound.

The view provides buttons to perform these operations on keys:

Custom Icons

Device users choose your deployed Hybrid App by clicking its icon. Instead of the built-in Hybrid App icons that are provided by default, you can provide custom icons. Typically an icon includes a pair of images, representing an initial and a processed workflow status.

Custom icon images should be 32x32 pixels, and one of these types: BMP, PNG, JPG, or GIF.

Any custom icons that you include in your generated package are used instead of the built-in icons. However, if the container cannot load the icon file based on the custom icon settings (for example, if both the normal and processed icon files are not found in the package), it displays a built-in icon.

The Add and Edit buttons open the Custom Icons dialog, where you define your custom icons. Specify each custom icon using a unique combination of name, width, height, and image type.

Property Description
Icon name An identifier for a pair of custom icons.
Image files The initial (unprocessed) and processed images. The Custom Icons dialog requires you specify an existing image file, of a supported type, from the current project.
Type The image type, based on the extension of the specified image file name.
Height The height of the icon image, in pixels.
Width The width of the icon image, in pixels.

Rulers & Grid

These properties enable you to customize the default layout of the Flow Design page in the Designer.

Property Description
Display
  • Show Ruler – Displays ruler units above and to the left of the page. Default: not shown.
  • Show Grid – Fills the page with a grid. Default: not shown.
  • Grid in Front – Displays the grid in front of screen objects. Default: the grid is in front. If unselected, the grid is behind objects.
Grid line
  • Color – A selected grid color, or a specified color code. Default: grey.
  • Style – A line style selected from the list. Default: Spaced Dot.
Measurement
  • Ruler Units – Available units: Inches (default), Centimeters, Pixels.
  • Grid Spacing – The space between grid lines, using your selected ruler units. Default: 0.125 inches, 0.318 cm, or 12 px.
Snap Automatically aligns objects that you relocate to specified locations on the screen.
  • Snap to Grid – Snaps objects to the grid lines on the canvas. Default: selected.
  • Snap to Shapes – Snaps objects to vertical and horizontal coordinates of the the edges of other objects.
Restore Defaults Sets the value of all ruler and grid properties to their default values, overwriting any customizations.

Localization

Property Description
New Launch the New Locale wizard and create a new locale file for the Hybrid App.
Update Update the currently loaded locale file.
Load Load a locale properties file to the Hybrid App Designer.
Validate Select a locale properties file and click to validate.
Edit Select the locale properties file, then click to edit the locale properties file.
Remove Select the locale properties file to remove, then click to remove.

Matching Rules

Any existing matching rules appear in the matching rules Properties view. Matching rules determine how notifications are redirected at runtime.

Property Description
New Create a new matching rule.
Delete Select a matching rule and click to delete.
Edit Select a matching rule and click to edit.

Authentication

Property Description
Use static credentials Select when the authentication field is the same for all users accessing the resource.
Use SAP Mobile Server connection profile authentication Use properties from the connection profile to supply credential data for authentication. This is similar to hard-coded credentials but the credentials are taken from the specified server connection profile instead of being specified in the Hybrid App Designer.
Use hard-coded credentials Specify a user name/password combination for authentication.
User name This field is editable only if you selected the hard-coded credentials option. Enter the user name to use for authentication.
Password This field is editable only if you selected the hard-coded credentials option. Enter the password to use for authentication.
Use certificate-based credentials Click Generate from Certificate to select a certificate file from which to generate authentication. Once you choose the certificate to use, these fields are filled in automatically.
  • Issuer – the issuer of the certificate
  • Subject – the value of the subject field in the metadata of the certificate as defined in the X.509 standard
  • Valid from – the date the certificate is valid from
  • Valid to – the date the certificate is valid to
Mobile Server domain Optionally specify the SAP Mobile Platform domain to use. If specified, a context variable is created in the application for which the initial value is set to this domain. At runtime, when determining authentication, @domain is added to the user name, thus allowing the user access to that domain.
Note: When you create a new security configuration that includes the SAPSSOTokenLoginModule, and deploy it to a new domain, if the Hybrid App uses the MBOs associated with the new security configuration, you must specify an SAP Mobile Server domain that corresponds to the domain using the security configuration. See Security for more information about security configurations.

File Order

This page lists the files to be generated, in the order they are loaded in the running application. File types are grouped into three tabs: jQuery Mobile, Custom, and Performance. These groups correspond to the three look and feel categories that are available for screen previews (described in Previewing Screens).

The control buttons enable you to add and remove files, as well as change their load order.

Note: By default, the generated package includes the makit folder for MAKit API support, and datajs-version.js OData support. If your application does not include an MAChartview control or customizations that call OData library functions, you can delete these files to reduce the size of the package.

Client Variables

Client variables store data on the server that must be saved between user sessions. They are retrieved by clients using either the native API or JavaScript API (see Manifest.xml File in Developer Guide: Hybrid Apps.

The Add, Delete, and Edit buttons enable you to create and manage client variables. The table shows the name and value of each client variable defined for your application.

A client variable is defined as a name/value pair. Both name and string are string types, and the name is case-sensitive. However, names must be unique even when they differ by case. The maximum name length in ANSI code (not Unicode) is 256. Due to a limitation on Windows Mobile platforms, the total length of all the client variables (keys and values) cannot exceed 2000 characters.