KB44999: How Deferred Inbox works with File-based, DB-based and Hybrid History List

Background:
 

• Deferred Inbox is introduced in need of the Asynchronous Execution feature for iPad. Currently on iPad when user runs a document, he/she will see “Running” icon blocking the screen and can do nothing else except patiently wait until the job is done and binary is transferred back to client. With Asynchronous Execution on iPad, user now has an option to add this running job into temporary inbox, also called Deferred Inbox, and navigates to somewhere else like folder browsing, or run another document. While the job added to Deferred Inbox keeps running and once done, stores the result in the Deferred Inbox, makes it ready for user to view later.

 
Refer to Technical Document below for more details of the Deferred Inbox.
KB44193: What is "Deferred Inbox" in MicroStrategy Intelligence Server 9.3.0 and later?
 

• There are three types of History List storage: File-based, DB-based and Hybrid.

 
Prior to Strategy 9.x, a user's history list could only be stored in a file format. In Strategy 9.x, a new functionality has been added to history list management called "Database Based History List"
 
Refer to Technical Document below for more details of the Database based History List.
KB20506: New Feature in MicroStrategy 9.x: Database Based History List
 
Hybrid History List repository is an extension of Database History List, where the Inbox messages are stored in the database and the Inbox content i.e., results are stored as files on a disk location (as in the case of file based History List).
 
Refer to Technical Document below for more details of the Hybrid History List.
KB44171: What is Hybrid History List repository in MicroStrategy Intelligence Server 9.3.0 and later
 
 
Permanent Storage of Deferred Inbox
 
Deferred Inbox’s permanent storage is put on file system regardless server is using DB-based, file-based or hybrid History List storage type. However, depends on History List storage type, deferred inbox’s permanent storage locates at different folder path.
 

• File-based History List

Deferred Inbox files are put in a subfolder “DeferredInbox” of History List folder.
For centralized configuration, the path is:
 \\Machine\Inbox\NodeName\DeferredInbox
For localized configuration,
 Local path is:
 \\localhost\Inbox\ServDef\DeferredInbox
 And foreign path is:
 \\Machine\ClusterInBox\DeferredInbox
 

• DB-based History List

On DB-based configuration, working set message’s results are stored in the TmpPool folder. Deferred Inbox files are located in a subfolder of TmpPool folder, named DeferredInbox. The TmpPool folder should be shared as “ClusterInBox” for cluster environment. So each node uses this path to locate Deferred Inbox on foreign node:
 \\Machine\ClusterInBox\DeferredInbox
 

• Hybrid History List

A subfolder is created automatically in the shared folder for Hybrid History List storage as “\DeferredInbox\UserID\NodeName”. Deferred Inbox files created on certain server node will be placed in a subfolder matching the server name.
 \\Machine\HybridInbox\DeferredInbox\UserID\NodeName
 
 
Deferred inbox data structure
 
The file name format is similar to the inbox file for File-based History List. Index file format is “UserID-D-DeviceID-StartDate”. Result file format is same as File-based History List, “UserID-R-StartDate-MessageID”. Note that DeviceID is the UDID for an iPad device which has length of 40 characters, the rest of IDs are GUID which has length of 32 characters. Here is an example:

• Index file

54F3D26011D2896560009A8E67019608-D-B19DEDCC11D4E0EFC000EB9495D0F44FD5847A70-2012-3-7

• Result file

54F3D26011D2896560009A8E67019608-R-2012-3-7-692744E54816586094CAA384455C8911.strm
 
 
Migration between File-based, DB-based and Hybrid Storage Type
 
 
Since Deferred Inbox files locates in different file system folder in these three storage types, it is necessary to move the Deferred Inbox files when we migration between different History List storage types.
 
The History List configuration wizard moves the Deferred Inbox files to different folder in three cases:

• File-based->DB-based

 Inbox\DeferredInbox\ -> TmpPool\DeferredInbox\

• File-based ->Hybrid

 Inbox\DeferredInbox\ -> Hybrid\DeferredInbox\UserID\NodeName\

• DB-based ->Hybrid

 TmpPool\DeferredInbox\ -> Hybrid\DeferredInbox\UserID\NodeName\