Bookshelf v8.0: User Properties for Siebel Service Handheld Applications

Use this property to specify the field on which you want to implement the Alpha Tab Search feature.


Values:	Fields available in your application.
Parent Object Type:	List applet.
Usage:	Select the field from the drop-down list. For example, if you specify the Account Name field as the AlphaTab Names Search, the alpha search is applied to the Account Name field in the business component for the list applet, and the list applet displays an alpha tab search bar.
Note:	You can configure as many AlphaTab Named Search properties as you require, but you can define only one for each list applet.

AutoPopupField User Property

Use this property to configure a view so that a pop-up list for a particular field automatically opens when the user opens the view.


Values:	Fields available in your application.
Parent Object Type:	View.
Usage:	If the field is in a list applet, set the AutoPopupField property of the view to the Business Component field name. If the field is in a form applet, set the AutoPopupField property of the view to the name of the control.

BarcodeNewRecord User Property

Use this property to specify the behavior you require for new record creation when a scan is performed.


Values:	Y or N.
Parent Object Type:	Applet.
Usage:	If you specify Y, when the user performs a parseable scan, a new record is created for the scan, and that record is populated with the values parsed from the barcode. If you specify N, when the user performs a nonparseable scan, a new record is not created for the scan, but the active field is populated with the barcode number.

BC Read Only Field User Property

For information about this user property, see Siebel Developer's Reference and Configuring Siebel Business Applications.

BorderStyle User Property

BrowserPath User Property

Use this property to specify the application to start when the user taps a URL or attachment in the application. By default, when users tap a URL or attachment, the item is displayed in Pocket Internet Explorer.


Values:	String.
Parent Object Type:	Application.
Usage:	The default value for this property makes attachments and URLs open in Pocket Internet Explorer.

ConfirmAccept User Property

Use this property to specify whether to display a confirmation message after the user taps the Accept button on the signature control.


Values:	Y or N.
Parent Object Type:	Signature control applet.
Usage:	Set this property to Y to display a confirmation message after the user taps the Accept button. Set this property to N to display no confirmation message.

DefaultViewType User Property


Values:	Tabbed or Traditional.
Default Value:	Traditional
Parent Object Type:	Application.
Usage:	If set to Tabbed, the first applet in the frame array of a view definition is treated as the parent applet. The parent applet is displayed when users navigate to this view. All other applets in the view are treated as child applets and appear on the tab bar of the parent applet. A parent context bar also appears at the top of the view. If set to Traditional, the application displays the applets in the traditional two-applet view. To switch between the two applets, choose View > Toggle. In portrait orientation, the default tabbed applet behavior for the application, when not explicitly specified, is Traditional. You can change the default tabbed applet behavior to Tabbed, if required. In landscape orientation and square screens, the default tabbed applet behavior for the application is Tabbed, and you cannot change this value to Traditional.
Note:	This user property can be overridden by the view-level user property ViewType. For more information about the ViewType user property, see ViewType User Property.

Disable Second Applet User Property

Use this property when you configure a tree applet to suppress the dynamically created second applet so that only a single applet is displayed.


Values:	TRUE or FALSE.
Default Value:	FALSE
Parent Object Type:	View.
Usage:	If set to TRUE, the second dynamic applet is not displayed. If set to FALSE, only a single applet is displayed.

DisableAlphaTabGroups User Property


Values:	TRUE or FALSE.
Parent Object Type:	Applet.
Usage:	If set to TRUE, the alpha tabs are displayed in ungrouped format. If set to FALSE, the alpha tabs are displayed in grouped format.

DisableParentBar User Property

Use this property to specify not to display the parent context bar in a view that displays multiple applets in tabbed applet mode. You might use this property if a view contains applets that are not linked in a parent-child relationship


Values:	TRUE or FALSE.
Parent Object Type:	View.
Usage:	If set to TRUE, the parent context bar is not displayed. When a user selects an applet, the tab of the applet is highlighted, but no parent context bar is displayed. If set to FALSE, the parent context bar is displayed.

EncryptKey User Property

Use this property to specify the default key to use when encrypting signatures. If you do not specify a value for this property, an internal mechanism is used to generate the encryption key.


Values:	Integer, between 1 and 99999999.
Parent Object Type:	Signature control applet.
Usage:	Enter the encryption key you require as the value for this property.

Explorer Applet Size User Property

Use this property when you configure a tree applet to specify how much space you want the tree applet to occupy.


Values:	Integer, between 1 and 100.
Default Value:	50
Parent Object Type:	View.
Usage:	Enter the percentage of space that you want the tree applet to occupy.

Field Read Only Field fieldname User Property

For information about this user property, see Siebel Developer's Reference and Configuring Siebel Business Applications.

FormUI User Property

Form UI is a technique of applet design that enables Siebel Handheld application developers to create applets that are larger than normal form applets. For more information about Form UI applets, see Configuring Form UI Applets for the Siebel Handheld Client.


Values:	TRUE or FALSE.
Parent Object Type:	Applet.
Usage:	If set to TRUE, makes the applet a form UI applet. If set to FALSE, makes the applet a normal applet.

HandheldInsertFailMode User Property


Values:	NoFail or FailOnError.
Default Value:	NoFail
Parent Object Type:	Business component.
Usage:	If you specify NoFail, insert failures are logged and synchronization continues. If you specify FailOnError, insert failures are logged and synchronization terminates.

HandheldSyncPickMode User Property


Values:	Fieldname_1\|Mode_1, Fieldname_2\|Mode_2 ... Fieldname_n\|Mode_n
Parent Object Type:	Business component.
Usage:	Specify the field name and the mode for each field for which you want to specify this property. Specify one of the following modes: NoFail FailOnError If set to NoFail, enables Extended Pick processing for the specified field. If set to FailOnError, disables Extended Pick processing for the specified field.
Note:	The setting on the business component takes precedence over the setting defined in the Settings view tab on the Administration - Mobile screen > Application Administration view. You can use the business component setting to nullify the global application of Extended Pick. Conversely, you can enable Extended Pick processing on specific business components if the setting in the Settings view tab has disabled the functionality.

InkColor User Property


Values:	Hexadecimal value from 0x000000 to 0xFFFFFF.
Parent Object Type:	Signature control applet.
Usage:	The six hexadecimal digits in the value that you specify represent the color to use. The six digits comprise three groups of two digits. Each group of two digits is the value for one of the colors: blue, green, and red, in that order. For example, the value 0xFF0000 represents the color blue.

InkWidth User Property

Use this property to specify the width of the line that is created in the signature control applet.

MaximumFooterLines User Property


Values:	Integer.
Parent Object Type:	Signature control applet.
Usage:	Specify the height as the number of text lines. If the footer text exceeds this number, the user can use the pen to scroll vertically. The footer display control does not display a scroll bar.

MaximumHeaderLines User Property


Values:	Integer.
Parent Object Type:	Signature control applet.
Usage:	Specify the height as the number of text lines. If the header text exceeds this number, the user can use the pen to scroll vertically. The header display control does not display a scroll bar.

On Field Update Set n User Property

OrderAccessControl User Property

Use this property to set access control for fields in the Orders business component.


Values:	TRUE or FALSE.
Parent Object Type:	Orders business component.
Usage:	If set to TRUE, all fields in the business component, except the Status field are set to read-only for all users, except the user who created the order.

OverrideDefaultApplet User Property

Use this property to override the default behavior to give focus to an applet. This user property is typically used with the GotoViewNewRecord method.


Values:	0 or 1.
Parent Object Type:	Control.
Usage:	If set to 0, gives the focus to the parent applet. If set to 1, gives the focus to the child applet.

OverridePopupVisibilityn User Property

Use this property to specify fields that override the business component Popup Visibility Type setting in an applet. Use this property when the visibility you require for a field differs from the Popup Visibility Type of the business component, and you do not want to change the Popup Visibility Type of the business component. For more information about visibility types, see Designating Visibility.


Values:	Business_Component_Field, Visibility_Type
Parent Object Type:	Applet control or column.
Usage:	The name of the OverridePopupVisibility parameter must be unique, so you must append a unique number to the name of the parameter for any other items, for example, OverridePopupVisibility1, OverridePopupVisibility2, and so on. Assign a value to this property that contains the name of the business component field, followed by a comma, and then the visibility type you require for the field. Table 18 summarizes popup visibility types and the corresponding visibility codes.

PrintForms User Property

You can implement multiple printing of forms in Siebel Handheld applications. To do this, you must add a control that invokes the PrintBatch method.

Use the PrintForms user property to specify the forms to print, the print templates, and a default number of copies of each form to print. You can specify up to 10 sets of forms, print templates, and default numbers.


Values:	form_name_1, template_filename_1, default_number_of_copies_1,form_name_2, template_filename_2, default_number_of_copies_2, ... form_name_10, template_filename_10, default_number_of_copies_10,
Parent Object Type:	Control.
Usage:	Enter the sets of forms, print templates, and default numbers that you require.
Note 1:	Do not enter a space before or after the commas. A comma must always follow the last entry.
Note 2:	All of the applets that are specified in the following print tags must be configured in the view from which the PrintBatch method is invoked: Applet List GetTotal GetCount In other words, all of the applets that are specified in these print tags, in all of the print templates that are used in the PrintBatch method, must be configured in the view. Use the GetDirect print tag to get the value of a field from a business component that is not configured in the view.
Example:	You might have forms with templates as follows: Order with Price, OrderwithPrice.txt Order without Price, OrderwithoutPrice.txt Temporary ID Card, TemporaryIDCard.txt To print one copy of the first form only, specify the following value for this property: `Order with Price,OrderwithPrice.txt,1,Order without Price,OrderwithoutPrice.txt,0,Temporary ID Card,TemporaryIDCard.txt,0,`

SHCE COM Disable User Property

Use this property to disable support for the COM feature for a Siebel Handheld application.

SHCEDailySlotHeight User Property


Values:	Integer, between 14 and 50.
Default Value:	15
Parent Object Type:	Daily calendar applet.
Usage:	No additional information.

SHCEHideNavBar User Property

Use this property to hide the navigation bar in a calendar applet or find applet.


Values:	TRUE or FALSE.
Parent Object Type:	Applet.
Usage:	If set to TRUE, hides the navigation bar. If set to FALSE, does not hide the navigation bar.

SHCEHideStatusBar User Property


Values:	TRUE or FALSE.
Parent Object Type:	Applet.
Usage:	If set to TRUE, hides the status bar. If set to FALSE, does not hide the status bar.

SHCEHideToolBar User Property


Values:	TRUE or FALSE.
Parent Object Type:	Applet.
Usage:	If set to TRUE, hides the toolbar. If set to FALSE, does not hide the toolbar.

SHCEMenuBackButton User Property

Use this property to add the Go Back button to the menu bar in a calendar applet or find applet. This property enables you to have no toolbar on the applet to save screen space, and to still have a Go Back button in the applet.


Values:	TRUE or FALSE.
Parent Object Type:	Applet.
Usage:	If set to TRUE, adds the Go Back button to the menu bar. If set to FALSE, does not add the Go Back button to the menu bar.

SHCEMenuForwardButton User Property

Use this property to add the Go Forward button to the menu bar in an applet. This property enables you to have no toolbar on the applet to save screen space, and to still have a Go Forward button in the applet.


Values:	TRUE or FALSE.
Parent Object Type:	Applet.
Usage:	If set to TRUE, adds the Go Forward button to the menu bar. If set to FALSE, does not add the Go Forward button to the menu bar.

SHCEMenuNewButton User Property

Use this property to add the New Record button to the menu bar in an applet. This property enables you to have no toolbar on the applet to save screen space, and to still have a New Record button in the applet.


Values:	TRUE or FALSE.
Parent Object Type:	Applet.
Usage:	If set to TRUE, adds the New Record button to the menu bar. If set to FALSE, does not add the New Record button to the menu bar.

ShowData User Property

Use this property to specify if the content of the signature field can be displayed. If you specify not to display signature data, the ellipses in the signature applet control are disabled.


Values:	Y or N.
Parent Object Type:	Signature field in a signature capture applet.
Usage:	Set this property to Y to allow the content of the signature field to be displayed. Set this property to N to prevent the display of signatures.

Signature User Property


Values:	Y or N.
Parent Object Type:	Signature capture applet.
Usage:	Set this property to Y to make a field a signature field. Set this property to N if you do not want a field to store signatures.

SignatureDataField User Property

Use this property to specify a destination field for the captured signature if you do not want to save the signature in the user interface field.


Values:	A field name in the current business component.
Parent Object Type:	Signature capture applet.
Usage:	Enter the name of the business component field where you want to save the signature data.

SignatureDate User Property

Use this property to specify whether to add the current date under the signature footer.


Values:	Y or N.
Parent Object Type:	Signature capture applet.
Usage:	No additional information.
Note:	The date is added in the regional default date format of the handheld device. The date is saved to the field specified in the SignatureFooterSaveField user property. For more information about this user property, see SignatureFooterSaveField User Property.

SignatureField User Property

Use this property to specify the name of the user interface field where the signature data is stored


Values:	UI field name.
Parent Object Type:	Signature button control.
Usage:	Enter the name of the field where you want to store the signature data.

SignatureFooterField User Property

Use this property to specify the field from which to copy the content for the signature footer.


Values:	A field name in the current business component.
Parent Object Type:	Signature capture applet.
Usage:	No additional information.

SignatureFooterSaveField User Property

Use this property to specify the field to which the content for the signature footer is saved.


Values:	A field name in the current business component.
Parent Object Type:	Signature capture applet.
Usage:	If the SignatureDate user property is set to Y, the date is included in the data that is saved to this field. If the SignatureTime user property is set to Y, the time is included in the data that is saved to this field.

SignatureHeaderField User Property

Use this property to specify the field from which to copy the content for the signature header.


Values:	A field name in the current business component.
Parent Object Type:	Signature capture applet.
Usage:	No additional information.

SignatureHeaderSaveField User Property

Use this property to specify the field to which the content for the signature header is saved.


Values:	A field name in the current business component.
Parent Object Type:	Signature capture applet.
Usage:	No additional information.

SignatureHeight User Property


Values:	Integer, between 1 and 200.
Parent Object Type:	Control on signature capture applet.
Usage:	Specify the height in pixels.

SignatureTime User Property

Use this property to specify whether to add the current time under the signature footer.


Values:	Y or N.
Parent Object Type:	Signature capture applet.
Usage:	No additional information.
Note:	The time is added in the time format of the handheld device. The time is saved to the field specified in the SignatureFooterSaveField user property. For more information about this user property, see SignatureFooterSaveField User Property.

SignatureWidth User Property

By default, signature controls occupy the full width of the screen on the handheld device. Use the SignatureWidth user property to set the width of a signature control.

SingleSelect User Property

Use this property to restrict to one the number of records that the user can select from a control.


Values:	TRUE or FALSE.
Parent Object Type:	Control.
Usage:	If set to TRUE, disables multiselect mode and autoselect mode, and enables the user to select one record only. If set to FALSE, enables multiselect mode and autoselect mode.

TaskUI User Property


Values:	TRUE or FALSE.
Parent Object Type:	View.
Usage:	If set to TRUE, specifies that the view contains a Siebel Task. If set to FALSE, specifies that the view is not a Siebel Task.

TriggerFindRecord User Property

UseSystemLocale User Property

Use this property if you want a Calendar applet to display the dates according to the regional date settings on the handheld device where the application is installed.


Values:	TRUE or FALSE.
Parent Object Type:	Applet.
Usage:	If set to TRUE, the applet uses the regional date settings on the handheld device to display dates on the calendar. If set to FALSE, the applet does not use the regional date settings.

View User Property

Use this property to specify the name of the view to display when a user selects the control.

ViewType User Property


Values:	Tabbed or Traditional.
Parent Object Type:	View.
Usage:	For information about the usage of this property, see DefaultViewType User Property.
Note:	ViewType overrides the DefaultViewType property in portrait orientation. In landscape orientation and on square screens, the default applet display mode is Tabbed.

WritingGuide User Property

Use this property to display information in the applet. This information provides instructions on how to create a signature on a handheld device.


Values:	Y or N.
Parent Object Type:	Signature control applet.
Usage:	Set this property to Y to display the writing guide in the applet. Set this property to N if you do not want to display the writing guide in the applet.

User Properties for Siebel Service Handheld Applications

AlphaTab Named Search User Property