Preconfigure Library Mobile for iOS

Starting in MicroStrategy Library 2021 Update 4, there’s a new feature to design and create custom applications for unique Library viewing experiences based on user or user group requirements. This feature is configured through Workstation. For applications generated in this new feature, the iOS SDK can be preconfigured as shown below.

Preconfigure an existing configuration

1. Create .json file named Preferences.json, following the template below and using the input connectivity shown. MicroStrategy supports multiple embedded servers.

   Copy

   {
       "id": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
       "version": 0,
       "connectivity": {
           "webServers": [{
                   "requestType": 1,
                   "host": "test1.microstrategy.com",
                   "port": 443,
                   "path": "MicroStrategyLibrary",
                   "alias": "AQ DEP"
               },
               {
                   "requestType": 1,
                   "host": "test2.microstrategy.com",
                   "port": 443,
                   "path": "MicroStrategyLibrary",
                   "alias": "AQ Mirror 2"
               },
               {
                   "requestType": 1,
                   "host": "test3.microstrategy.com",
                   "port": 443,
                   "path": "MicroStrategyLibrary",
                   "alias": "Tutorial"
               }
           ]
       }
   }

2. Navigate to MicroStrategy Library and iPad and import the .json file there.

   

Upgrade SDK Preferences

Admins can build a new SDK version with a different "version". The end users would normally have to do a new install to adopt this change. If that is not possible, you can instead set OverrideExistingPreferences to YES in MicroStrategyLibrary > Custom > MSTRCustomizations.plist.

We support backwards compatibility, so you can still use the process detailed further below for Library server versions prior to 2021 (11.3), if desired.

Preconfigure an existing configuration

1. Open the Mobile Configuration section of the Library Admin page.

2. Choose the configuration you want to use and click the Share icon.



3. Click Download to download the JSON file.



4. Rename the JSON file to Preferences.json.
5. Navigate to MicroStrategy Library > iPad and import the JSON file there.

Here is a sample Preferences.json file:

{
   "id":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
   "name":"Mobile configuration",
   "description":"",
   "schemaVersion":1,
   "version":0,
   "updateSource":{
      "requestType":1,
      "host":"test.microstrategy.com",
      "port":443,
      "path":"MicroStrategyLibrary"
   },
   "connectivity":{
      "webServers":[
         {
            "requestType":1,
            "host":"test.microstrategy.com",
            "port":443,
            "path":"MicroStrategyLibrary"
         }
      ]
   },
   "general":{
      "disableAdvancedSettings":false,
      "disablePreferences":false,
      "networkTimeout":180,
      "cacheClearMode":1,
      "clearCacheOnLogout":false,
      "maxLogSize":500,
      "logLevel":12,
      "updateInterval":-1
   },
   "homeScreen":{
      "mode":1,
      "homeDocument":{
         "url":"https://test.microstrategy.com/MicroStrategyLibrary/app/XXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXX/share",
         "icons":[
            "notifications",
            "options"
         ],
         "toolbarMode":0
      }
   }
}

Preconfigure multiple servers

If you want to preconfigure multiple servers, add the additional server manually, using the existing JSON file. See the JSON file below for an example.

{
   "id":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
   "name":"Mobile configuration",
   "description":"",
   "schemaVersion":1,
   "version":1,
   "updateSource":{
      "requestType":1,
      "host":"test.microstrategy.com",
      "port":443,
      "path":"MicroStrategyLibrary"
   },
   "connectivity":{
      "webServers":[
         {
            "requestType":1,
            "host":"test.microstrategy.com",
            "port":443,
            "path":"MicroStrategyLibrary"
         },
         {
            "requestType":0,
            "host":"test2.microstrategy.com",
            "port":8080,
            "path":"MicroStrategyLibrary"
         }
      ]
   },
   "general":{
      "disableAdvancedSettings":false,
      "disablePreferences":false,
      "networkTimeout":180,
      "cacheClearMode":1,
      "clearCacheOnLogout":false,
      "maxLogSize":500,
      "logLevel":12,
      "updateInterval":-1
   },
   "homeScreen":{
      "mode":0,
      "homeDocument":{}
   }
}

Upgrade SDK preferences

An admin may build a new SDK version with a different "id" or "version". The end user would normally have to do a new install to adopt this change. If that is not possible, you can instead set OverrideExistingPreferences to YES in MicroStrategyLibrary > Custom > MSTRCustomizations.plist.

1. Open the MicroStrategy Library Mobile sample project in Xcode.
2. Navigate to MicroStrategyLibrary > iPad and open Preferences.xml.

3. Update the following parameters in the <ws> node:

   Parameter	Value
   nm	Name of MicroStrategy Library Mobile server
   pt	Path to MicroStrategy Library Mobile server
   po	Port for MicroStrategy Library Mobile server
   rt	Request type 0 = HTTP 1 = HTTPS

   Sample code is shown below:

   Copy

   <ws nm="mobileLibrary.myCompany.com" po="443" pt="MicroStrategyLibrary" rt="1" >
     ...
   </ws>

   You can preconfigure more than one server, or remove all the servers that you don't need. To add more servers, simply include additional <ws> nodes.

4. Compile the app.