Device Preferences: Home Screen Settings in iOS

The tables below provide a list of home screen settings that affect the mobile application.

The top level node in Preferences.xml is the <dp node, which has two child nodes—<cnf for the configuration and <cld for the cloud configuration. The top level node for home screen settings is the <hsc child node under <cnf.

Parent Element Child Element 1 Child Element 2	Parent Element Attributes	Description	Data Type	Default Value
<dp <cnf <cld		Device preference (available only on the client)
<cnf <gnl <cty <hsc <lnk		Represents the configuration
<cld		Represents the cloud configuration (available only on the client)
<hsc <rs <fd <cst		This node contains the settings that appear on the "Home Screen" tab in the administration interface
	tp	Home screen type	Integer enumeration 1 = HomeScreenTypeDefault 2 = HomeScreenTypeCustom 3 = HomeScreenTypeResultSet 4 = HomeScreenTypeFolder	1 [HomeScreenTypeDefault]
<rs <oi <sobs> <pb		Represents the ResultSet choice
<oi		Represents a first-class metadata object
	pid	Project ID	String	" "
	did	DSSID of object	String	" "
	t	Object type	Integer enumeration -1 = ObjectTypeUnknown 1 = ObjectTypeCustomGroup 1 = ObjectTypeFilter 3 = ObjectTypReportDefinition 4 = ObjectTypeMetric 8 = ObjectTypeFolder 10 = ObjectTypePrompt 12 = ObjectTypeAttribute 14 = ObjectTypeDimension 21 = ObjectTypeAttributeForm 39 = ObjectTypeSearch 47 = ObjectTypeConsolidation 55 = ObjectTypeDocumentDefinition 67 = ObjectTypeExternalLink 68 = ObjectTypeExternalObject	-1 [ObjectTypeUnknown]
	st	Object subtype (from DSSXMLObjectSubType)	Integer enumeration -1 = ObjectSubTypeUnknown 0x100 = ObjectSubTypeFilter 0x103 = ObjectSubTypeSegment 0x300 = ObjectSubTypereportGrid 0x301 = ObjectSubTypeReportGraph 0x306 = ObjectSubTypeReportGridAndGraph 0x308 = ObjectSubTypeReportCube 0x400 = ObjectSubTypeMetric 0x800 = ObjectSubTypeFolder 0xC00 = ObjectSubTypeAttribute 0x1500 = ObjectSubTypeAttributeForm 0x3701 = ObjectSubTypeReportWeritingDocument 0x4301 = ObjectSubTypeExternalLink 0x4400 = ObjectSubTypeExternalObject	-1 [ObjectSubTypeUnknown]
	n	Object name	String	" "
	ab	Abbreviation	String	" "
	pt	Path	String	" "
	fid	Parent folder ID	String	" "
<sobs> <sob>		Pre-cache supporting object list
<sob>		Pre-cache supporting object
	tp	Pre-cache supporting object type	Integer enumeration -1 = PreCacheSupportingObjectTypeUnknown 1 = PreCacheSupportingObjectTypeFolder 2 = PreCacheSupportingObjectTypeResultSet	-1 [PreCacheSupportingObjectTypeUnknown]
<fd <oi		Represents the folder choice
	csp	Check subscription	Boolean	true
	pcc	Pre-cached content	Boolean	false
<oi		Represents a first-class metadata object
<rs <oi <pcf <pb		Represent the ResultSet choice
	pcc	Pre-cached content	Boolean	false
<oi		Represents a first-class metadata object
<pcf <oi		Pre-cached folder
<oi		Represents a first-class metadata object
<pb		Progress bar format settings
	iv	Progress bar is visible	Boolean	false
	clr	Progress bar color value	Color	0xdddddd
	pos	Progress bar position value	Integer enumeration 1 = ProgressBarPositionLeft 2 = ProgressBarPositionRight	1 [ProgressBarPositionLeft]
	opa	Progress bar opacity value	Float (from 0 to 1.0)	1.0f
<fd		Represents the folder choice
<cst <fmt <btns		Custom home screen settings
<fmt <bkg <ttl> <btn <btnl <vw		Format settings
<bkg <fll <img>		Background settings
	tp	Background type	Integer enumeration -1 = HomeScreenBGTypeUnknown 1 = HomeScreenBGTypeFill 2 = HomeScreenBGTypeGradient	1 [HomeScreenBGTypeFill]
<fll <gr		Represents a fill
	tp	Fill type	Integer enumeration 0 = FillTypeSolidColor 1 = FillTypeTransparent 2 = FillTypeGradient	0 [FillTypeSolidColor]
	clr	Color for solid type	Color	nil
<gr		Represents a gradient
	sclr	Starting gradient color, as RGB value in base 10 format	Color	nil
	eclr	Ending gradient color, as RGB value in base 10 format	Color	nil
<img		Represents an image
	src	Image source as a URL	String	" "
<ttl <cap> <img		Title bar settings
	tp	Title bar type	Integer enumeration 1 = HomeScreenTitleBarTypeRegular 2 = HomeScreenTitleBarTypeImage	1 [HomeScreenTitleBarTypeRegular]
<cap>		Caption
	txt	Caption text	String	" "
<btn <fnt <brd <fll		Button settings
	stl	Style	Integer enumeration 1 = HomeScreenButtonStyleNone 2 = HomeScreenButtonStyleFlat 3 = HomeScreenButtonStyleGlass	3 [HomeScreenButtonStyleGlass]
<fnt		Button font settings
	clr	RGB value as an integer in base 10 format	Color	nil
<brd		Represents the button border
	clr	RGB value as an integer in base 10 format	Color	nil
<fll		Represents the button fill
<btnl		Represents the button layout
	rc	Row count	Integer	0
	cc	Column count	Integer	0
<vw		Indicates which views/screens are accessible
	rpt	Reports view is enabled	Boolean	true
	rct	Recent view is enabled	Boolean	true
	stg	Settings is accessible	Boolean	true
	hlp	Help is accessible	Boolean	true
	cld	Cloud is accessible	Boolean	true
	rsm	Recent Shared folder is enabled	Boolean	true
	cle	Cloud is enabled	Boolean	false
<btns <btn		List of buttons to include on the Home screen
<btn <act> <cap> <dsc <icn		Settings for one button
<act> <fd <rs		Represents the button's action
	tp	Action type	Integer enumeration -1 = HomeScreenBtnActionTypeUnknown 1 = HomeScreenBtnActionTypeFolder 2 = HomeScreenBtnActionTypeResultSet 3 = HomeScreenBtnActionTypeReports 4 = HomeScreenBtnActionTypeSettings 5 = HomeScreenBtnActionTypeSharedLibrary 6 = HomeScreenBtnActionTypeHelp 7 = HomeScreenBtnActionTypeCloudPersonal	5 [HomeScreenBtnActionTypeSharedLibrary]
<cap>		Represents the button caption
	txt	Button caption text	String	" "
<dsc		Represents the button description
	txt	Button description text	String	" "
<icn <img		Button icon settings
	tp	Icon type	Integer enumeration 1 = IconTypeDefault 2 = IconTypeImage	1 [IconTypeDefault]

Parent Element

Child Element 1
Child Element 2

Parent Element Attributes

Description

Data Type

Default Value

<dp

<cnf
<cld

Device preference (available only on the client)

<cnf

Represents the configuration

<cld

Represents the cloud configuration (available only on the client)

<hsc

<rs
<fd
<cst

This node contains the settings that appear on the "Home Screen" tab in the administration interface

Home screen type

Integer enumeration

1 = HomeScreenTypeDefault

2 = HomeScreenTypeCustom

3 = HomeScreenTypeResultSet

4 = HomeScreenTypeFolder

1 [HomeScreenTypeDefault]

<rs

<oi
<sobs>
<pb

Represents the ResultSet choice

<oi

Represents a first-class metadata object

pid

Project ID

String

" "

did

DSSID of object

String

" "

Object type

Integer enumeration

-1 = ObjectTypeUnknown

1 = ObjectTypeCustomGroup

1 = ObjectTypeFilter

3 = ObjectTypReportDefinition

4 = ObjectTypeMetric

8 = ObjectTypeFolder

10 = ObjectTypePrompt

12 = ObjectTypeAttribute

14 = ObjectTypeDimension

21 = ObjectTypeAttributeForm

39 = ObjectTypeSearch

47 = ObjectTypeConsolidation

55 = ObjectTypeDocumentDefinition

67 = ObjectTypeExternalLink

68 = ObjectTypeExternalObject

-1 [ObjectTypeUnknown]

Object subtype (from DSSXMLObjectSubType)

Integer enumeration

-1 = ObjectSubTypeUnknown

0x100 = ObjectSubTypeFilter

0x103 = ObjectSubTypeSegment

0x300 = ObjectSubTypereportGrid

0x301 = ObjectSubTypeReportGraph

0x306 = ObjectSubTypeReportGridAndGraph

0x308 = ObjectSubTypeReportCube

0x400 = ObjectSubTypeMetric

0x800 = ObjectSubTypeFolder

0xC00 = ObjectSubTypeAttribute

0x1500 = ObjectSubTypeAttributeForm

0x3701 = ObjectSubTypeReportWeritingDocument

0x4301 = ObjectSubTypeExternalLink

0x4400 = ObjectSubTypeExternalObject

-1 [ObjectSubTypeUnknown]

Object name

String

" "

Abbreviation

String

" "

Path

String

" "

fid

Parent folder ID

String

" "

<sobs>

<sob>

Pre-cache supporting object list

<sob>

Pre-cache supporting object

Pre-cache supporting object type

Integer enumeration

-1 = PreCacheSupportingObjectTypeUnknown

1 = PreCacheSupportingObjectTypeFolder

2 = PreCacheSupportingObjectTypeResultSet

-1 [PreCacheSupportingObjectTypeUnknown]

<fd

Represents the folder choice

csp

Check subscription

Boolean

true

pcc

Pre-cached content

Boolean

false

<oi

Represents a first-class metadata object

<rs

<oi
<pcf
<pb

Represent the ResultSet choice

pcc

Pre-cached content

Boolean

false

<oi

Represents a first-class metadata object

<pcf

Pre-cached folder

<oi

Represents a first-class metadata object

<pb

Progress bar format settings

Progress bar is visible

Boolean

false

clr

Progress bar color value

Color

0xdddddd

pos

Progress bar position value

Integer enumeration

1 = ProgressBarPositionLeft

2 = ProgressBarPositionRight

1 [ProgressBarPositionLeft]

opa

Progress bar opacity value

Float (from 0 to 1.0)

1.0f

<fd

Represents the folder choice

<cst

<fmt
<btns

Custom home screen settings

<fmt

<bkg
<ttl>
<btn
<btnl
<vw

Format settings

<bkg

<fll
<img>

Background settings

Background type

Integer enumeration

-1 = HomeScreenBGTypeUnknown

1 = HomeScreenBGTypeFill

2 = HomeScreenBGTypeGradient

1 [HomeScreenBGTypeFill]

<fll

Represents a fill

Fill type

Integer enumeration

0 = FillTypeSolidColor

1 = FillTypeTransparent

2 = FillTypeGradient

0 [FillTypeSolidColor]

clr

Color for solid type

Color

nil

<gr

Represents a gradient

sclr

Starting gradient color, as RGB value in base 10 format

Color

nil

eclr

Ending gradient color, as RGB value in base 10 format

Color

nil

<img

Represents an image

src

Image source as a URL

String

" "

<ttl

<cap>
<img

Title bar settings

Title bar type

Integer enumeration

1 = HomeScreenTitleBarTypeRegular

2 = HomeScreenTitleBarTypeImage

1 [HomeScreenTitleBarTypeRegular]

<cap>

Caption

txt

Caption text

String

" "

<btn

<fnt
<brd
<fll

Button settings

stl

Style

Integer enumeration

1 = HomeScreenButtonStyleNone

2 = HomeScreenButtonStyleFlat

3 = HomeScreenButtonStyleGlass

3 [HomeScreenButtonStyleGlass]

<fnt

Button font settings

clr

RGB value as an integer in base 10 format

Color

nil

<brd

Represents the button border

clr

RGB value as an integer in base 10 format

Color

nil

<fll

Represents the button fill

<btnl

Represents the button layout

Row count

Integer

Column count

Integer

<vw

Indicates which views/screens are accessible

rpt

Reports view is enabled

Boolean

true

rct

Recent view is enabled

Boolean

true

stg

Settings is accessible

Boolean

true

hlp

Help is accessible

Boolean

true

cld

Cloud is accessible

Boolean

true

rsm

Recent Shared folder is enabled

Boolean

true

cle

Cloud is enabled

Boolean

false

<btns

<btn

List of buttons to include on the Home screen

<btn

<act>
<cap>
<dsc
<icn

Settings for one button

<act>

Represents the button's action

Action type

Integer enumeration

-1 = HomeScreenBtnActionTypeUnknown

1 = HomeScreenBtnActionTypeFolder

2 = HomeScreenBtnActionTypeResultSet

3 = HomeScreenBtnActionTypeReports

4 = HomeScreenBtnActionTypeSettings

5 = HomeScreenBtnActionTypeSharedLibrary

6 = HomeScreenBtnActionTypeHelp

7 = HomeScreenBtnActionTypeCloudPersonal

5 [HomeScreenBtnActionTypeSharedLibrary]

<cap>

Represents the button caption

txt

Button caption text

String

" "

<dsc

Represents the button description

txt

Button description text

String

" "

<icn

<img

Button icon settings

Icon type

Integer enumeration

1 = IconTypeDefault

2 = IconTypeImage

1 [IconTypeDefault]