MicroStrategy Customizations Properties File in iOS

The MicroStrategy customizations properties file, MSTRCustomizations.plist, provides key:value pairs that let you customize values related to prompt management, the navigation bar, and other MicroStrategy functionality.

MSTRCustomizations.plist is included in the DMG, but it must be added to the MicroStrategyMobile Xcode project manually, as follows:

Open the MicroStrategyMobile project in Xcode.
Right-click MicroStrategyMobile and choose Add Files to "MicroStrategyMobile".
In Finder, navigate to MicroStrategyMobile -> Custom.
Select MSTRCustomizations.plist.
Under Add to targets, select the check box for MicroStrategyMobileIPad, MicroStrategyMobileIPhone, or both.
Click Add. The file now appears underMicroStrategyMobile -> Custom.

The MSTRCustomizations.plist properties file in the DMG includes a basic set of key:value pairs. In addition, you can add other key:value pairs.

The table below lists and explains the basic set of key value pairs that are included in the properties file in the DMG. The key names shown in the table are for both iPhone and iPad.

Key

Description

Type

Values

BackgroundDataTransferCacheCheckOption

This property is enforced only during 'Background Download mode'. It dictates how the app responds after:

Receipt of a push notification sent from the Intelligence Server via APNS
Being provided with a fetch opportunity by the system as part of the 'Background application refresh' feature

Integer

Possible values:

0: Light cache check

1: Heavy cache check

2: No cache check

If any other value is provided, a light cache check is performed.

Default = 0

DynamicUpdateVectorIcon

A flag that indicates whether to generate a new image when the icon font file is modified, instead of reading from the cache

Boolean

Possible values: YES or NO

Default = NO

InfoWindowSettings: AlwaysRenderContentImmediately

A flag that indicates when to render InfoWindow panels

By default, an InfoWindow panel is rendered only if a user opens it, by tapping on an object that has been configured to trigger an InfoWindow. The area on the screen where the InfoWindow content is displayed remains blank while the InfoWindow panel is being rendered. You can use this property to preload the InfoWindow content and avoid having the user see a blank screen.

If this property is set to YES, the InfoWindow panel is rendered when the document is rendered. When a user taps the screen, the content in the InfoWindow is displayed right away.
If this property is set to NO (the default), the InfoWindow panel is not rendered until a user taps the screen. When the InfoWindow opens, it remains blank until the content is loaded.

This property can be used to provide a better user experience because the user does not see a blank screen or have to wait for the InfoWindow content to be displayed. However, there may be an impact on performance, depending on how many InfoWindow panels there are in the application. This property setting applies to all InfoWindow panels in the application.

Boolean

Possible values: YES or NO

Default = NO

InfoWindowSettings: EnablePartialScreenIW

A flag that indicates whether to allow an InfoWindow to display in a partial screen.

Boolean

Possible values: YES or NO

Default = NO

OverrideExistingPreferences

A flag that indicates whether to overwrite the existing preferences in the document store on a device with the bundled preferences in the MicroStrategy Mobile app, when a new version of the app is installed on the device. This flag takes effect only if:

UsesBundledPreferences is set to YES, and
The configuration ID of the bundled preferences in the app is different from the configuration ID of the existing preferences in the document store on the device.

In this case, changes are made to the preferences in the document store on the device via MSTRAppContext.

Boolean

Possible values: YES or NO

Default value: NO

PersistSelection

A flag that indicates whether the selections applied to a document are kept until the next time the document is opened.

Boolean

Possible values: YES or NO

Default value: NO

PhotoUploaderDefaultQuality

The value of this parameter determines the picture quality of photos that are displayed by the app using the Photo Uploader widget. The better the picture quality, the higher the resolution and the less loss of detail in the photo.

The quality and size of the photo, together with the color depth, determine the size (in KBs) of the image file that is uploaded.

Picture Quality Setting	Picture Size Setting	Picture Size (pixels)	Image File Size (KBs)
Low	Small	320 x 240	5 - 10
Medium	Small	320 x 240	10 - 20
High	Small	320 x 240	50 -100
Low	Medium	640 x 480	20 - 30
Medium	Medium	640 x 480	60 - 80
High	Medium	640 x 480	100 - 350

There is no way to estimate the size of the image file for Large or Actual picture size settings. There is no limit on pixels for these settings, so the image file size can be very large or very small.

String

Possible values:

Low
Medium
High

Default value: Low

PhotoUploaderDefaultSize

.
The value of this parameter determines the size (in pixels) of photos that are displayed by the app using the Photo Uploader widget.

The quality and size of the photo, together with the color depth, determine the size (in KBs) of the image file that is uploaded.

Picture Size Setting	Picture Size (pixels)	Picture Quality Setting	Image File Size (KBs)
Small	320 x 240	Low	5 - 10
Small	320 x 240	Medium	10 - 20
Small	320 x 240	High	50 -100
Medium	640 x 480	Low	20 - 30
Medium	640 x 480	Medium	60 - 80
Medium	640 x 480	High	100 - 350

String

Possible values:

Small (320 x 240 pixels)
Medium (640 x 480 pixels)
Large (50% of the actual size of the picture, in pixels)
Actual (Actual size of the picture, in pixels)

Default value: Medium

SecurityFramework

The name of the security framework, as well as the appID and appVersion. The string should be formatted with an ampersand (&) between the values.

VALUE NO LONGER USED

String

For example,

"MySecurityFramework&MyAppID&1.2.3"

Default value: Default

ShowCloseButtonAfterLinkDrilling

A flag that indicates whether to show the Close button on an iPhone after link drilling. This prevents a situation where there is no exit from a document if the Back button is not displayed.

Possible values: YES or NO

Default value: NO
Only show Back button

SoftwareEncryptionEnabled

A flag that indicates whether the MSTRFileManager encrypts data that is written to the device.

Boolean

Possible values: YES or NO

Default value: YES

StatsManipulation

A flag that indicates whether to log manipulations.

Possible values: YES or NO

Default value: YES

SwipeToChangeLayouts

A flag that indicates whether the swipe gesture changes layouts on an iOS device. By default, swiping does not change layouts; instead, layouts are changed by tapping the desired layout on the layout bar within the document navigation bar.

Boolean

Possible values: YES or NO

Default value: NO

TemplateMultiSelection

A flag that indicates whether multiple templates can be selected.

Boolean

Possible values: YES or NO

Default value: NO

TxNSubmitPresetValue

A flag that indicates whether previous values count as preset values to allow a transaction to be submitted when a flag has been set requiring fields to be updated in order to submit a transaction.

This flag works in conjunction with the following settings on the Configure Transactions Editor:

For grids, Submit unchanged records must be selected.
For panel stacks, Allow submission without modification must be selected.
For panel stacks, Input is required must be selected for columns that are being modified.

Boolean

Possible values: YES or NO

Default value: NO

UpdateExistingPreferences

UsesBundledPreferences is set to YES, and
The configuration ID of the bundled preferences in the app is the same as the configuration ID of the existing preferences in the document store on the device, and
The configuration counter of the bundled preferences in the app is greater than the configuration counter of the existing preferences in the document store on the device.

In this case, changes are made to the preferences in the document store on the device via MSTRAppContext.

The cntr attribute check is to prevent the configuration from being updated every time the app is restarted.

Boolean

Possible values: YES or NO

Default value: NO

UsesBundledPreferences

If this flag is set to NO, the bundled preferences in the app will not be copied to the document store on the device during the first install of the app, or be used to overwrite the existing preferences in the document store on the device during a reinstall.
If this flag is set to YES, the values of OverrideExistingPreferences and UpdateExistingPreferences determine whether the bundled preferences in the app are used to overwrite the existing preferences in the document store on the device.

Boolean

Possible values: YES or NO

Default value: YES

The table below lists and explains the additional key:value pairs that you can add to the MSTRCustomizations.plist properties file for customization. The key names shown in the table are for both iPhone and iPad.

Key	Description	Type	Values
CollaborationEnabled	A flag that indicates whether Command Center is enabled for the app	Boolean	Possible values: YES or NO Default = NO
DebugLogLevel	The existence of this parameter indicates that the log file should be written to the console and specifies the level of logging to be displayed. If the parameter is missing or set to "Off", console logging is not enabled. This parameter is intended to be used only for troubleshooting during development. It should not be enabled in a production environment because of the impact on performance.	Integer	Integer enumeration 0 = All 2 = Finest 4 = Finer 6 = Fine 8 = Config 10 = Info 12 = Warning 14 = Severe 16 = Off Default = 16
disableCacheCheck	A flag that indicates whether to enable cache checking in the document viewer	Boolean	Possible values: YES or NO Default = NO
Default Image For Failed Loading	The name of the image that should be used to replace images that fail to load at runtime This must be two PNG files—one for normal resolution and the other for high resolution. The two files should have the same name, with @2X appended to the name of the high resolution file. The two image files should be placed under Custom -> FinalBundle.bundle-> Contents -> Resources.	String	For example, FailedToLoadImage if you added the following two image files: FailedToLoadImage.png FailedToLoadImage@2X.png
DeferredExecutionEnabled	A flag that indicates whether the "Send to reports list when ready" option is enabled.	Boolean	Possible values: YES or NO Default = NO
HideCompatibilityWarning	A flag that indicates whether the Compatibility Warning should be hidden. When no flag is specified, the default behavior is to show the warning.	Boolean	Possible values: YES or NO Default = NO
IntroAnimationImage	The existence of this parameter, together with IntroAnimationType, indicates that intro animation should be used. The image file specified as the value of this parameter provides the colors for glowing globe animation and the logo for spinning logo animation.	String	For example, myIntroImage.png
IntroAnimationType	The existence of this parameter, together with IntroAnimationImage, indicates that intro animation should be used. The value of this parameter specifies the type animation that should be displayed.	Integer	Possible values: 0: None 1: Glowing globe 2: Spinning logo Default value: 0
navBarBackgroundImage	The file name of an image (in PNG format). It is tiled as needed to fill the navigation bar.	String	For example, "MyNavBarBackgroundImage.png"
navBarTint	An RGB color	String	For example, 4488ff or #4488ff
navBarTitle	A title string that is kept at the center of the navigation bar, even when navigating through MicroStrategy content. When the value for this key is empty, there is no Back button when navigating through MicroStrategy content. When a value is provided for the navBarTitleImage key, the title string is ignored.	String	For example, "Title for My Nav Bar"
navBarTitleImage	The file name of an image (in PNG format) that is kept at the center of the navigation bar, even when navigating through MicroStrategy content. When this key has a value, the image that is provided is used in place of the title string (that is, the value of the navBarTitle key).	String	For example, "MyNavBarImage.png"

Key

Description

Type

Values

CollaborationEnabled

A flag that indicates whether Command Center is enabled for the app

Boolean

Possible values: YES or NO

Default = NO

DebugLogLevel

The existence of this parameter indicates that the log file should be written to the console and specifies the level of logging to be displayed.

If the parameter is missing or set to "Off", console logging is not enabled.

This parameter is intended to be used only for troubleshooting during development. It should not be enabled in a production environment because of the impact on performance.

Integer

Integer enumeration

0 = All

2 = Finest

4 = Finer

6 = Fine

8 = Config

10 = Info

12 = Warning

14 = Severe

16 = Off

Default = 16

disableCacheCheck

A flag that indicates whether to enable cache checking in the document viewer

Boolean

Possible values: YES or NO

Default = NO

Default Image For Failed Loading

The name of the image that should be used to replace images that fail to load at runtime

This must be two PNG files—one for normal resolution and the other for high resolution. The two files should have the same name, with @2X appended to the name of the high resolution file. The two image files should be placed under Custom -> FinalBundle.bundle-> Contents -> Resources.

String

For example, FailedToLoadImage

if you added the following two image files:

FailedToLoadImage.png

FailedToLoadImage@2X.png

DeferredExecutionEnabled

A flag that indicates whether the "Send to reports list when ready" option is enabled.

Boolean

Possible values: YES or NO

Default = NO

HideCompatibilityWarning

A flag that indicates whether the Compatibility Warning should be hidden. When no flag is specified, the default behavior is to show the warning.

Boolean

Possible values: YES or NO

Default = NO

IntroAnimationImage

The existence of this parameter, together with IntroAnimationType, indicates that intro animation should be used. The image file specified as the value of this parameter provides the colors for glowing globe animation and the logo for spinning logo animation.

String

For example, myIntroImage.png

IntroAnimationType

The existence of this parameter, together with IntroAnimationImage, indicates that intro animation should be used. The value of this parameter specifies the type animation that should be displayed.

Integer

Possible values:

0: None

1: Glowing globe

2: Spinning logo

Default value: 0

navBarBackgroundImage

The file name of an image (in PNG format). It is tiled as needed to fill the navigation bar.

String

For example,

"MyNavBarBackgroundImage.png"

navBarTint

An RGB color

String

For example, 4488ff or #4488ff

navBarTitle

A title string that is kept at the center of the navigation bar, even when navigating through MicroStrategy content. When the value for this key is empty, there is no Back button when navigating through MicroStrategy content. When a value is provided for the navBarTitleImage key, the title string is ignored.

String

For example, "Title for My Nav Bar"

navBarTitleImage

The file name of an image (in PNG format) that is kept at the center of the navigation bar, even when navigating through MicroStrategy content. When this key has a value, the image that is provided is used in place of the title string (that is, the value of the navBarTitle key).

String

For example, "MyNavBarImage.png"