public interface

IDSSXMLDocumentServer

com.microstrategy.webapi.IDSSXMLDocumentServer

Class Overview

This interface provides the functionality for applications to execute and manipulate a document. This includes execution of an XML document by document ID, methods to get an XML document execution result, refresh a document, retrieve document prompt answer, execute dynamic document, and answer an XML document prompt.

Summary

Constants
int DEFAULT_AnswerPrompt_executionFlags Default executionFlags parameter for AnswerPrompt method
int DEFAULT_AnswerPrompt_resultFlags Default resultFlags parameter for AnswerPrompt method
String DEFAULT_AnswerPrompt_styleXSL Default styleXSL parameter for AnswerPrompt method
String DEFAULT_ExecuteDynamicDoc_contentSetting Default contentSetting parameter for ExecuteDynamicDoc method
int DEFAULT_ExecuteDynamicDoc_executionFlags Default executionFlags parameter for ExecuteDynamicDoc method
String DEFAULT_ExecuteDynamicDoc_promptAnswer Default promptAnswer parameter for ExecuteDynamicDoc method
int DEFAULT_ExecuteDynamicDoc_resultFlags Default resultFlags parameter for ExecuteDynamicDoc method
String DEFAULT_ExecuteDynamicDoc_styleXSL Default styleXSL parameter for ExecuteDynamicDoc method
int DEFAULT_Execute_executionFlags Default executionFlags parameter for Execute method
String DEFAULT_Execute_promptAnswer Default promptAnswer parameter for Execute method
int DEFAULT_Execute_resultFlags Default resultFlags parameter for Execute method
String DEFAULT_Execute_styleXSL Default styleXSL parameter for Execute method
int DEFAULT_GetExecutionResults_resultFlags Default resultFlags parameter for GetExecutionResults method
String DEFAULT_GetExecutionResults_styleXSL Default styleXSL parameter for GetExecutionResults method
int DEFAULT_Refresh_executionFlags Default executionFlags parameter for Refresh method
String DEFAULT_Refresh_promptAnswer Default promptAnswer parameter for Refresh method
int DEFAULT_Refresh_resultFlags Default resultFlags parameter for Refresh method
String DEFAULT_Refresh_styleXSL Default styleXSL parameter for Refresh method
String MOBILE_PROPERTY_APP_ID
String MOBILE_PROPERTY_DEVICE_TOKEN
String MOBILE_PROPERTY_ENCRYPT
String MOBILE_PROPERTY_TOKEN_TYPE
Public Methods
abstract String AnswerPrompt(String sessionID, String messageID, String promptAnswer, int executionFlags, int resultFlags, String styleXSL, IntWrapper status)
Answers a prompt in a document object.
abstract void Drill(String sessionID, String messageID, String drillTransformation, int stateID, int drillOption, StringWrapper drillMsgID)
This method performs drill operations on a document.
abstract String Execute(String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, String subscriptionId, String bookmarkID)
abstract String Execute(String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status)
abstract String Execute(String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, String subscriptionId)
Execute an XML document by XML document ID.@return
abstract String Execute(String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo)
abstract String Execute(String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey, int dossierFlags)
abstract String Execute(String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, StringWrapper messageID, IntWrapper status)
Execute an XML document by XML document ID.
abstract String Execute(String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey)
abstract String Execute(String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey, int dossierFlags, boolean isDossier)
abstract String Execute(String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String styleXSL, StringWrapper messageID, IntWrapper status)
Execute an XML document by XML document ID.
abstract byte[] ExportDashboard(String sessionID, String docID, IntWrapper iwStatus)
abstract String GetCacheInfoJsonResult(String sessionID, String messageID, int resultFlags, int detailFlags, int stateID, String extendableParameter, IntWrapper iwStatus)
THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
abstract String GetDocumentDatasetElements(String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int flags, int blockBegin, int blockCount, String controlKey)
abstract String GetDocumentDatasetElements(String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int flags, int blockBegin, int blockCount)
Gets the elements XML from dataset.
abstract String GetDocumentDatasetElements(String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int blockBegin, int blockCount)
Gets the elements XML from dataset.
abstract String GetDocumentDatasetElements(String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int flags, int blockBegin, int blockCount, String controlKey, String templateKey, String rawInput)
abstract String GetDocumentDatasetElements(String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int flags, int blockBegin, int blockCount, String controlKey, String templateKey, String rawInput, boolean useBrowseForm)
abstract String GetDocumentDatasetElements(String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int flags, int blockBegin, int blockCount, String controlKey, String templateKey, String rawInput, boolean useBrowseForm, String objectCurrentConditionXML)
Gets the elements XML from dataset.@return
abstract IDSSXMLObjectServer.StringFormatAndErrorData GetDocumentShortcutInfos(String masterSessionId, Map<String, ProjectIdAndShortcutIds> projectIdAndShortcutIdsMap, int dossierShortcutInfoFlag)
Gets shortcut information for multiple shortcut objects across projects.@return
abstract String GetExecutionResults(String sessionID, String messageID, int resultFlags, String styleXSL, IntWrapper status)
Returns the execution status for a currently running job.
abstract IResultsAsStream GetExecutionResultsAsStream(String sessionID, String messageID, int resultFlags, int stateID, String extendableParameter)
Obtains the execution results for a document as IResultsAsStream object.
abstract String GetExecutionResultsEx(String sessionID, String messageID, int resultFlags, int stateID, String extendableParameter, IntWrapper status)
Obtains the execution results for a document in XML format.
abstract byte[] GetExecutionResultsInBinary(String sessionID, String messageID, int resultFlags, int stateID, String extendableParameter, IntWrapper iwStatus)
This method is deprecated. This method is deprecated. Use the overloading method with detailFlags instead.
abstract byte[] GetExecutionResultsInBinary(String sessionID, String messageID, int resultFlags, int detailFlags, int stateID, Integer mbs, HashMap<String, String> mobileProps, String extendableParameter, IntWrapper iwStatus)
Obtains the results/data of the document in binary format.
abstract byte[] GetExecutionResultsInBinary(String sessionID, String messageID, int resultFlags, int detailFlags, int stateID, Integer mbs, String extendableParameter, IntWrapper iwStatus)
Obtains the results/data of the document in binary format.
abstract byte[][] GetExportFormatData(String sessionID, String messageID, int exportFormat, int stateID, String extParams, IntWrapper iwStatus)
Returns formatted output for exporting a document and the cache id.
abstract byte[] GetFormatData(String sessionID, String messageID, int format, int stateID, String extendableParameter, IntWrapper iwStatus)
Returns formatted output for exporting a document.
abstract String GetJsonResults(String sessionID, String messageID, int resultFlags, int detailFalgs, int stateID, String extendableParameter, IntWrapper status, int mode)
THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
abstract String GetJsonResults(String sessionID, String messageID, int resultFlags, int detailFalgs, int stateID, String extendableParameter, IntWrapper status)
abstract String GetPromptAnswer(String sessionID, String messageID)
Retrieves the prompt answer for the given Message ID.
abstract String GetPromptAnswerEx(String sessionID, String messageID, String extendableParameter)
Retrieves the prompt answer for the given Message ID.
abstract boolean HasPromptAnswer(String sessionID, String messageID, StringWrapper promptAnswer)
Returns whether the document(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.
abstract boolean HasPromptAnswerEx(String sessionID, String messageID, StringWrapper promptAnswer, String extendableParameter)
Returns whether the document(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.
abstract String ImportAsyncDashboard(String sessionID, InputStream data, long fileLength, String folderID, String dashboardName, String dashboardDescription, IntWrapper status)
abstract String ImportDashboard(String sessionID, InputStream data, long fileLength, String folderID, IntWrapper status)
abstract byte[] LoadGraph(String sessionID, String messageID, int stateID, String templateKey, int graphSliceIdentifier, String windowSetting, int graphImgType, String graphProp, IntWrapper iwStatus)
Returns a graph that is contained within a document.
abstract void LoadGraph(String sessionID, String messageID, int stateID, String nodeKey, int slicedWindowID, String windowSetting, int graphImgType, String graphProp, IContentConsumer consumer)
Obtains graph data from backend and steams it to provided content consumer.
abstract byte[][] LoadGraphData(String sessionID, String messageID, int stateID, String templateKey, int graphSliceIdentifier, String windowSetting, int graphImgType, String graphProp, IntWrapper iwStatus)
abstract String ReBuildDocument(String sessionID, String messageID, int executionFlags, int resultFlags, String documentManipulations, int stateID, String windowSetting, String extParam, StringWrapper msgID, IntWrapper status)
This method will submit a set of manipulations on a document.
abstract String Refresh(String sessionID, String messageID, int executionFlags, int resultFlags, String promptAnswer, String deltaXML, String extParam, String styleXSL, IntWrapper status)
Refreshs an already executed document.
abstract String Refresh(String sessionID, String messageID, int executionFlags, int resultFlags, String promptAnswer, String deltaXML, String styleXSL, IntWrapper status)
Refreshs an already executed document.
abstract String Refresh(String sessionID, String messageID, int executionFlags, int resultFlags, String promptAnswer, String styleXSL, IntWrapper status)
Refreshs an already executed document.
abstract String Refresh(String sessionID, String messageID, int stateID, int executionFlags, int resultFlags, String promptAnswer, String deltaXML, String extParam, String styleXSL, IntWrapper status)
abstract void ResumeImportAsyncDashboard(String sessionID, String messageID, String dashboardName)
abstract String SaveAs(String sessionID, String messageID, String folderID, String documentName, String documentDesc, int flags, int stateID, String reportSaveAsOptions, IntWrapper status)
abstract String SaveAs(String sessionID, String messageID, String folderID, String documentName, String documentDesc, int flags, int stateID)
Saves the given document instance to metadata.
abstract String SaveAs(String sessionID, String messageID, String folderID, String documentName, String documentDesc, int flags, int stateID, String reportSaveAsOptions)
Saves the given document instance to metadata.
abstract String SaveAs(String sessionID, String messageID, String folderID, String documentName, String documentDesc, int flags, int stateID, String reportSaveAsOptions, IntWrapper status, int requestTimeout)
Saves the given document instance to metadata.
abstract String SaveAsSegment(String sessionID, String messageID, String folderID, String segmentName, String segmentDesc, int flags, String nodeKey)
Create a segment from a document instance
abstract String SaveAsTheme(String sessionID, String messageID, String folderID, String themeName, String themeDesc, int flags, int stateID)
Saves the given theme instance to metadata.
abstract String SaveDerivedElements(String sessionID, String messageID, String unitKey, String attId, String folderId, String name, String description, boolean overwrite, IntWrapper status)
abstract void SendBinaryData(String sessionID, String messageID, int format, int stateID, String extendableParameter, IContentConsumer consumer)
abstract void SendExecutionResultsInBinary(String sessionID, String messageID, int resultFlags, int detailFlags, int stateID, Integer mbs, HashMap<String, String> mobileProps, String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)
Obtains the results/data of the document in binary format.
abstract void SendExecutionResultsInBinary(String sessionID, String messageID, int resultFlags, int stateID, String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)
This method is deprecated. This method is deprecated. Use the overloading method with detailFlags instead.
abstract void SendExecutionResultsInBinary(String sessionID, String messageID, int resultFlags, int detailFlags, int stateID, Integer mbs, String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)
Obtains the results/data of the document in binary format.
abstract String checkImageExist(String sessionID, String messageID, String shaValue)
check whether the image has been stored in MD or in current instance
abstract String getBaseGraphProperties(String sessionID, String projectID)
get base graph properties.
abstract String getDocumentInstanceShortcutInfo(String sessionID, String messageId, int dossierShortcutInfoFlag)
Gets the shortcut information associated with an instanceId (messageId) of a document.
abstract String getDocumentInstanceShortcutInfo(String sessionID, String messageId)
Gets the shortcut information associated with an instanceId (messageId) of a document@return
abstract String getDocumentLinksValidationInfo(String sessionID, String messageID, int action, String extendableParameter)
get validation info for document level attribute links
abstract String getDocumentShortcutInfo(String sessionID, String objectId)
Gets the shortcut information by the shortcut objectId@return
abstract String getDocumentShortcutInfo(String sessionID, String objectId, int dossierShortcutInfoFlag)
Gets the shortcut information by the shortcut objectId.
abstract String getDossierShortcutCacheInfoJsonResult(String sessionID, int cacheType, String shortcutId)
Get the cache info include definition cache and data cache for a dossier shortcut Internal used only@return
abstract String getDossierShortcutCacheInfoJsonResult(String sessionID, int cacheType, String shortcutId, Integer resultFlags, Integer detailFlags, String bookmarkId)
Get the cache info include definition cache and data cache for a dossier shortcut Internal used only@return
abstract byte[] getDossierShortcutCachesInBinary(String sessionID, String cacheId)
Gets the dossier shortcut cache binary by cache id, only support one cache id in 11.1 THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
abstract String getElementFromGraph(String sessionID, String messageID, String nodeKey, String sliceID, int x, int y, String dpi)
get elements from graph in document
abstract String getMSTRPredictedFileSize(String sessionID, String objectID)
Gets the predicted MSTR file size of a report or a document
abstract String getManifest(String sessionID, String messageID, String datasetId, Boolean useJson)
get manifest of the document, returns a list of objects used in the document@return
abstract String importImageToDocument(String sessionID, String messageID, String binaryID, int blockCount, int blockIndex, int blockSize, String treeType, String nodeKey, String fieldKey, String fieldName, String imgName, int index, long fileSize, String imgID, String hashCode, int isEdit, InputStream data)
import image to document

Constants

public static final int DEFAULT_AnswerPrompt_executionFlags

Default executionFlags parameter for AnswerPrompt method

Constant Value: 0 (0x00000000)

public static final int DEFAULT_AnswerPrompt_resultFlags

Default resultFlags parameter for AnswerPrompt method

Constant Value: 0 (0x00000000)

public static final String DEFAULT_AnswerPrompt_styleXSL

Default styleXSL parameter for AnswerPrompt method

Constant Value: ""

public static final String DEFAULT_ExecuteDynamicDoc_contentSetting

Default contentSetting parameter for ExecuteDynamicDoc method

Constant Value: ""

public static final int DEFAULT_ExecuteDynamicDoc_executionFlags

Default executionFlags parameter for ExecuteDynamicDoc method

Constant Value: 0 (0x00000000)

public static final String DEFAULT_ExecuteDynamicDoc_promptAnswer

Default promptAnswer parameter for ExecuteDynamicDoc method

Constant Value: ""

public static final int DEFAULT_ExecuteDynamicDoc_resultFlags

Default resultFlags parameter for ExecuteDynamicDoc method

Constant Value: 0 (0x00000000)

public static final String DEFAULT_ExecuteDynamicDoc_styleXSL

Default styleXSL parameter for ExecuteDynamicDoc method

Constant Value: ""

public static final int DEFAULT_Execute_executionFlags

Default executionFlags parameter for Execute method

Constant Value: 0 (0x00000000)

public static final String DEFAULT_Execute_promptAnswer

Default promptAnswer parameter for Execute method

Constant Value: ""

public static final int DEFAULT_Execute_resultFlags

Default resultFlags parameter for Execute method

Constant Value: 0 (0x00000000)

public static final String DEFAULT_Execute_styleXSL

Default styleXSL parameter for Execute method

Constant Value: ""

public static final int DEFAULT_GetExecutionResults_resultFlags

Default resultFlags parameter for GetExecutionResults method

Constant Value: 0 (0x00000000)

public static final String DEFAULT_GetExecutionResults_styleXSL

Default styleXSL parameter for GetExecutionResults method

Constant Value: ""

public static final int DEFAULT_Refresh_executionFlags

Default executionFlags parameter for Refresh method

Constant Value: 0 (0x00000000)

public static final String DEFAULT_Refresh_promptAnswer

Default promptAnswer parameter for Refresh method

Constant Value: ""

public static final int DEFAULT_Refresh_resultFlags

Default resultFlags parameter for Refresh method

Constant Value: 0 (0x00000000)

public static final String DEFAULT_Refresh_styleXSL

Default styleXSL parameter for Refresh method

Constant Value: ""

public static final String MOBILE_PROPERTY_APP_ID

Constant Value: "mobile_app_id"

public static final String MOBILE_PROPERTY_DEVICE_TOKEN

Constant Value: "device_token"

public static final String MOBILE_PROPERTY_ENCRYPT

Constant Value: "encrypt"

public static final String MOBILE_PROPERTY_TOKEN_TYPE

Constant Value: "token_type"

Public Methods

public abstract String AnswerPrompt (String sessionID, String messageID, String promptAnswer, int executionFlags, int resultFlags, String styleXSL, IntWrapper status)

Answers a prompt in a document object.

This function applies the promptAnswer to the XML document prompt and continues the XML document execution. The caller should call GetExecutionResults to retrieve the result of the execution.

There may be more prompts to answer after the promptAnswer is applied to the XML document, due to either the inclusion of prompts in the prompt answer, or the incomplete answering of the prompts in this document. When calling GetExecutionResults, the status DssXmlStatusPromptXML denotes the above, and the new promptXML is returned in the result of that function.

See the Execute method for more on document execution, and execution status.

Parameters
sessionID A valid Session ID.
messageID The message ID of the instance of the document.
promptAnswer XML that answers the prompt question XML.
executionFlags EnumDSSXMLDocExecutionFlags - Flags to use when executing the document. [Default=0]
resultFlags EnumDSSXMLDocResultFlags - Flags relating to the result of the execution. [Default=0]
styleXSL XSL for the document style. [Default=""]
status Output Parameter - IntWrapper containing EnumDSSXMLStatus - Holds the status of the execution after answering the prompt.
Returns
  • XML String that represents results, if the report is ready. If not, it will be null.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void Drill (String sessionID, String messageID, String drillTransformation, int stateID, int drillOption, StringWrapper drillMsgID)

This method performs drill operations on a document.

This function performs a drill action defined by the drillTransformation parameter. The drillTransformation is with respect to the document results that the user is seeing right now. These could be the end result of a few manipulations such as pivot, sort and group-by on the original document Instance. These document manipulations are recorded in the Inbox and the drilling is done on a Document Instance that has all these transformations applied to it. The input messageID indicates the document you want to drill on. A new message needs to be created for the drill result and the ID for this new message will be returned. The user can specify if the drill needs to be performed within the document or out side of the document. If the user requrest the drill to be performed within the document then this message ID resulting from the drill commad is a document message ID and if the user requests the drill to be performed outside the document the resulting message ID is a report message ID. The input drillOption will specify if the user needs to drill within or out of the document. This function will never return a result directly. GetExecutionResults has to be called with the new message ID, to retrieve the drill results.

Refer to the remarks of IDSSXMLDocumentServer.GetExecutionResults for details of the stateID parameter. The drill will be applied on the report state identified by the stateID when it is present. By default, the drill will be on the final state of the report.

Parameters
sessionID A valid Session ID.
messageID Message ID corresponding to the document to be drilled.
drillTransformation XML that defines the drill action
stateID An ID to identify the report manipulation state. [Default=-1]
drillOption Return Parameter - The message ID resulting from the drill operation.
drillMsgID Return Parameter - The message ID resulting from the drill operation.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String Execute (String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, String subscriptionId, String bookmarkID)

Throws
MSTRWebAPIException

public abstract String Execute (String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status)

Throws
MSTRWebAPIException

public abstract String Execute (String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, String subscriptionId)

Execute an XML document by XML document ID.@return

Parameters
sessionID A valid session ID.
documentID The object ID of the document to execute.
executionFlags specifies options for the execution of the document. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlags. [Default=0]
resultFlags Flags to apply to the result of the execution. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocResultFlags. [Default=0]
promptAnswer Pre-answer for prompting. This is used if it is known that the document has a prompt in it, and the answer XML is already known. [Default=""]
extParam indicates any applicable extendable parameters
styleXSL XSL for the document style. [Default=""]
messageID Output Parameter - The job ID of the request. This is needed when checking the status of the document execution.
status Output Parameter The current status of the request. Value comes from EnumDSSXMLStatus.
nodeKey set target node key if there is a topMsgID, mainly created for dossier
isDossier For Dossier. Generates object_id tag instead of doc_id to enable search for dossier shortcut
subscriptionId The subscription id when the execution originates from a subscription
Throws
MSTRWebAPIException

public abstract String Execute (String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo)

Throws
MSTRWebAPIException

public abstract String Execute (String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey, int dossierFlags)

Throws
MSTRWebAPIException

public abstract String Execute (String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, StringWrapper messageID, IntWrapper status)

Execute an XML document by XML document ID.

ExecutionFlag is a value from the enumeration EnumDSSXMLDocExecutionFlags. You need to set it to DssXmlDocExecutionHTML to get the HTML returned. If an error happens while the XML document is being executed, an error message will be returned in the executionResults. Otherwise an inbox message ID will be returned in the messageID output parameter. You need to use GetExecutionResults to retrieve the results.

With promptAnswer , the caller can provide answers to prompts in the document before running it.

The status of the function call indicates the execution status. See the flags section for details.

Parameters
sessionID A valid session ID.
documentID The object ID of the document to execute.
executionFlags specifies options for the execution of the document. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlags. [Default=0]
resultFlags Flags to apply to the result of the execution. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocResultFlags. [Default=0]
promptAnswer Pre-answer for prompting. This is used if it is known that the document has a prompt in it, and the answer XML is already known. [Default=""]
extParam indicates any applicable extendable parameters
styleXSL XSL for the document style. [Default=""]
messageID Output Parameter - The job ID of the request. This is needed when checking the status of the document execution.
status Output Parameter The current status of the request. Value comes from EnumDSSXMLStatus.
Returns
  • If the document is ready upon returning, this will be an XML String representing the document. If not, this will be null.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String Execute (String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey)

Throws
MSTRWebAPIException

public abstract String Execute (String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String extParam, String styleXSL, String delta, StringWrapper messageID, IntWrapper status, String topMsgID, String nodeKey, int dossierFlags, boolean isDossier)

Throws
MSTRWebAPIException

public abstract String Execute (String sessionID, String documentID, int executionFlags, int resultFlags, String promptAnswer, String styleXSL, StringWrapper messageID, IntWrapper status)

Execute an XML document by XML document ID.

ExecutionFlag is a value from the enumeration EnumDSSXMLDocExecutionFlags. You need to set it to DssXmlDocExecutionHTML to get the HTML returned. If an error happens while the XML document is being executed, an error message will be returned in the executionResults. Otherwise an inbox message ID will be returned in the messageID output parameter. You need to use GetExecutionResults to retrieve the results.

With promptAnswer , the caller can provide answers to prompts in the document before running it.

The status of the function call indicates the execution status. See the flags section for details.

Parameters
sessionID A valid session ID.
documentID The object ID of the document to execute.
executionFlags specifies options for the execution of the document. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlags. [Default=0]
resultFlags Flags to apply to the result of the execution. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocResultFlags. [Default=0]
promptAnswer Pre-answer for prompting. This is used if it is known that the document has a prompt in it, and the answer XML is already known. [Default=""]
styleXSL XSL for the document style. [Default=""]
messageID Output Parameter - The job ID of the request. This is needed when checking the status of the document execution.
status Output Parameter The current status of the request. Value comes from EnumDSSXMLStatus.
Returns
  • If the document is ready upon returning, this will be an XML String representing the document. If not, this will be null.
Throws
MSTRWebAPIException Signals an error condition.

public abstract byte[] ExportDashboard (String sessionID, String docID, IntWrapper iwStatus)

Throws
MSTRWebAPIException

public abstract String GetCacheInfoJsonResult (String sessionID, String messageID, int resultFlags, int detailFlags, int stateID, String extendableParameter, IntWrapper iwStatus)

THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT. Obtains the cache info json string of the document in json format.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
resultFlags The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
detailFlags The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
stateID The state ID of the document instance.
extendableParameter An XML string containing additional options.
iwStatus The status of the document instance, from EnumDSSXMLStatus.
Returns
  • The byte array representing the binary data of the document
Throws
MSTRWebAPIException Thrown if an error occurs.
IllegalArgumentException Thrown if resultFlag doesn't include DssBinaryContextFlexCacheInfoOnly.

public abstract String GetDocumentDatasetElements (String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int flags, int blockBegin, int blockCount, String controlKey)

Throws
MSTRWebAPIException

public abstract String GetDocumentDatasetElements (String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int flags, int blockBegin, int blockCount)

Gets the elements XML from dataset.

Parameters
sessionID A valid Session ID
messageID The message ID of the document instance.
datasetID The id of the dataset where the elements from.
objectID The object for which to retrieve elements.
type The type of the object.
filter Filter to apply to browse action. [default=""].
flags Flags to use when element browsing. This value comes from EnumDSSXMLGetElementsFlags.
blockBegin The starting element (used for incremental fetch). [default=1]
blockCount Number of elements to retrieve (used for incremental fetch). [default=-1]
Returns
  • XML String representing the requested elements.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetDocumentDatasetElements (String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int blockBegin, int blockCount)

Gets the elements XML from dataset.

Parameters
sessionID A valid Session ID
messageID The message ID of the document instance.
datasetID The id of the dataset where the elements from.
objectID The object for which to retrieve elements.
type The type of the object.
filter Filter to apply to browse action. [default=""]
blockBegin The starting element (used for incremental fetch). [default=1]
blockCount Number of elements to retrieve (used for incremental fetch). [default=-1]
Returns
  • XML String representing the requested elements.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetDocumentDatasetElements (String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int flags, int blockBegin, int blockCount, String controlKey, String templateKey, String rawInput)

Throws
MSTRWebAPIException

public abstract String GetDocumentDatasetElements (String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int flags, int blockBegin, int blockCount, String controlKey, String templateKey, String rawInput, boolean useBrowseForm)

Throws
MSTRWebAPIException

public abstract String GetDocumentDatasetElements (String sessionID, String messageID, String datasetID, String objectID, int type, String filter, int flags, int blockBegin, int blockCount, String controlKey, String templateKey, String rawInput, boolean useBrowseForm, String objectCurrentConditionXML)

Gets the elements XML from dataset.@return

Parameters
sessionID A valid Session ID
messageID The message ID of the document instance.
datasetID The id of the dataset where the elements from.
objectID The object for which to retrieve elements.
type The type of the object.
filter Filter to apply to browse action. [default=""].
flags Flags to use when element browsing. This value comes from EnumDSSXMLGetElementsFlags.
blockBegin The starting element (used for incremental fetch). [default=1]
blockCount Number of elements to retrieve (used for incremental fetch). [default=-1]
objectCurrentConditionXML Object Current condition XML -added for populating target filter based on current filter selection without changing I-server state [default ""]
Returns
  • XML String representing the requested elements.
Throws
MSTRWebAPIException

public abstract IDSSXMLObjectServer.StringFormatAndErrorData GetDocumentShortcutInfos (String masterSessionId, Map<String, ProjectIdAndShortcutIds> projectIdAndShortcutIdsMap, int dossierShortcutInfoFlag)

Gets shortcut information for multiple shortcut objects across projects.@return

Parameters
projectIdAndShortcutIdsMap a map containing poroject id and ProjectIdAndShortcutIds pairs, each ProjectIdAndShortcutIds contains a projectId and one or more shortcut objectIds within that project
dossierShortcutInfoFlag flag to specify what additional information needs to be returned. For more information, please refer to EnumDSSXMLDossierShortcutInfoFlag.
Throws
MSTRWebAPIException

public abstract String GetExecutionResults (String sessionID, String messageID, int resultFlags, String styleXSL, IntWrapper status)

Returns the execution status for a currently running job. Will also return the XML corresponding to the document if it is ready.

This method is used to pull the document execution results with the message ID returned by Execute method. This is usually put in a loop until one of the following happens:

  • status = EnumDSSXMLStatus.DssXmlStatusErrMsgXML
  • status = EnumDSSXMLStatus.DssXmlStatusResult
  • status = EnumDSSXMLStatus.DssXmlStatusPromptXML
You should put a delay in the loop to prevent the server being pulled too frequently.

Parameters
sessionID A valid Session ID.
messageID A valid message/job ID.
resultFlags EnumDSSXMLResultFlags - Describe how result is to be presented. [Default=0]
styleXSL XSL for the document style. [Default=""]
status - EnumDSSXMLStatus - Contains the current status of the document.
Returns
  • XML String that corresponds to the document XML, if the document is ready.
Throws
MSTRWebAPIException Signals an error condition.

public abstract IResultsAsStream GetExecutionResultsAsStream (String sessionID, String messageID, int resultFlags, int stateID, String extendableParameter)

Obtains the execution results for a document as IResultsAsStream object.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
resultFlags The result flags for the retrieval, from EnumDSSXMLDocResultFlags.
stateID The state ID of the instance whose results are to be returned.
extendableParameter An XML parameter with additional information that modifies the output being returned.
Returns
  • Results as stream object
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetExecutionResultsEx (String sessionID, String messageID, int resultFlags, int stateID, String extendableParameter, IntWrapper status)

Obtains the execution results for a document in XML format.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
resultFlags The result flags for the retrieval, from EnumDSSXMLDocResultFlags.
stateID The state ID of the instance whose results are to be returned.
extendableParameter An XML parameter with additional information that modifies the output being returned.
status The status of the document, from EnumDSSXMLStatus.
Returns
  • An XML string describing the document, if results are obtainable.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract byte[] GetExecutionResultsInBinary (String sessionID, String messageID, int resultFlags, int stateID, String extendableParameter, IntWrapper iwStatus)

This method is deprecated.
This method is deprecated. Use the overloading method with detailFlags instead.

Obtains the results/data of the document in binary format. Currently this is used to retrieve the data for the flex model in binary format. Note that the parameters like resultFlags and extendableParameter are currently not used and have been added for future use. Hence this method will always return the flex data in binary format at present.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
resultFlags The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
stateID The state ID of the document instance.
extendableParameter An XML string containing additional options.
iwStatus The status of the document instance, from EnumDSSXMLStatus.
Returns
  • The byte array representing the binary data of the document
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract byte[] GetExecutionResultsInBinary (String sessionID, String messageID, int resultFlags, int detailFlags, int stateID, Integer mbs, HashMap<String, String> mobileProps, String extendableParameter, IntWrapper iwStatus)

Obtains the results/data of the document in binary format.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
resultFlags The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
detailFlags The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
stateID The state ID of the document instance.
mbs Maximum binary size (optional).
mobileProps A collection of mobile properties that need to be passed to backend. Expected properties are MOBILE_PROPERTY_ENCRYPT, MOBILE_PROPERTY_DEVICE_TOKEN, MOBILE_PROPERTY_APP_ID or MOBILE_PROPERTY_TOKEN_TYPE
extendableParameter An XML string containing additional options.
iwStatus The status of the document instance, from EnumDSSXMLStatus.
Returns
  • The byte array representing the binary data of the document
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract byte[] GetExecutionResultsInBinary (String sessionID, String messageID, int resultFlags, int detailFlags, int stateID, Integer mbs, String extendableParameter, IntWrapper iwStatus)

Obtains the results/data of the document in binary format.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
resultFlags The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
detailFlags The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
stateID The state ID of the document instance.
mbs Maximum binary size (optional).
extendableParameter An XML string containing additional options.
iwStatus The status of the document instance, from EnumDSSXMLStatus.
Returns
  • The byte array representing the binary data of the document
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract byte[][] GetExportFormatData (String sessionID, String messageID, int exportFormat, int stateID, String extParams, IntWrapper iwStatus)

Returns formatted output for exporting a document and the cache id.

Parameters
sessionID A valid Session ID.
messageID The message ID of the document instance.
stateID The state ID of the document instance.
iwStatus The status of the document instance, from EnumDSSXMLStatus.
Returns
  • A 2D byte array containing the data requested + cache id. This will be absent or present based on the status of the operation.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract byte[] GetFormatData (String sessionID, String messageID, int format, int stateID, String extendableParameter, IntWrapper iwStatus)

Returns formatted output for exporting a document.

Parameters
sessionID A valid Session ID.
messageID The message ID of the document instance.
format The format of the return value, from EnumDSSXMLExportFormat.
stateID The state ID of the document instance.
extendableParameter An XML string containing additional options.
iwStatus The status of the document instance, from EnumDSSXMLStatus.
Returns
  • A byte array containing the data requested. This will be absent or present based on the status of the operation.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetJsonResults (String sessionID, String messageID, int resultFlags, int detailFalgs, int stateID, String extendableParameter, IntWrapper status, int mode)

THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.

Throws
MSTRWebAPIException

public abstract String GetJsonResults (String sessionID, String messageID, int resultFlags, int detailFalgs, int stateID, String extendableParameter, IntWrapper status)

Throws
MSTRWebAPIException

public abstract String GetPromptAnswer (String sessionID, String messageID)

Retrieves the prompt answer for the given Message ID.

If the report identified by the given message ID contains no prompt or the prompt has not been answered, this method will return an empty string. Otherwise, the latest prompt answered will be returned.

Parameters
sessionID A valid Session ID.
messageID A valid message/job ID.
Returns
  • XML corresponding to the prompt answer.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetPromptAnswerEx (String sessionID, String messageID, String extendableParameter)

Retrieves the prompt answer for the given Message ID.

If the report identified by the given message ID contains no prompt or the prompt has not been answered, this method will return an empty string. Otherwise, the latest prompt answered will be returned.

Parameters
sessionID A valid Session ID.
messageID A valid message/job ID.
extendableParameter The extendable parameter value.
Returns
  • XML corresponding to the prompt answer.
Throws
MSTRWebAPIException Signals an error condition.

public abstract boolean HasPromptAnswer (String sessionID, String messageID, StringWrapper promptAnswer)

Returns whether the document(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.

If the document identified by the given message ID contains no prompt or if the prompt has not been answered, this method will return false and will also return return an null string inside promptAnswer. Otherwise, the latest prompt answered will be returned.

Parameters
sessionID A valid Session ID.
messageID A valid message/job ID.
promptAnswer The prompt answer will be returned in this variable.
Returns
  • boolean indicating whether the document is prompted or not. XML corresponding to the prompt answer as a function argument.
Throws
MSTRWebAPIException Signals an error condition.

public abstract boolean HasPromptAnswerEx (String sessionID, String messageID, StringWrapper promptAnswer, String extendableParameter)

Returns whether the document(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.

If the document identified by the given message ID contains no prompt or if the prompt has not been answered, this method will return false and will also return return an null string inside promptAnswer. Otherwise, the latest prompt answered will be returned.

Parameters
sessionID A valid Session ID.
messageID A valid message/job ID.
promptAnswer The prompt answer will be returned in this variable.
extendableParameter The extendable parameter value.
Returns
  • boolean indicating whether the document is prompted or not. XML corresponding to the prompt answer as a function argument.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String ImportAsyncDashboard (String sessionID, InputStream data, long fileLength, String folderID, String dashboardName, String dashboardDescription, IntWrapper status)

Throws
MSTRWebAPIException

public abstract String ImportDashboard (String sessionID, InputStream data, long fileLength, String folderID, IntWrapper status)

Throws
MSTRWebAPIException

public abstract byte[] LoadGraph (String sessionID, String messageID, int stateID, String templateKey, int graphSliceIdentifier, String windowSetting, int graphImgType, String graphProp, IntWrapper iwStatus)

Returns a graph that is contained within a document.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
stateID The state ID of the document instance.
templateKey A value which tells the template in the document whose graph is being retrieved.
graphSliceIdentifier A value which identifies the slice of the graph to retrieve.
windowSetting An XML string telling the window of data to show in the graph returned.
graphImgType The image type of the graph, from EnumDSSXMLGraphImgTypes.
graphProp Properties that modify the graph shown.
iwStatus The status of the operation, from EnumDSSXMLStatus.
Returns
  • A byte array containing the graph requested.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract void LoadGraph (String sessionID, String messageID, int stateID, String nodeKey, int slicedWindowID, String windowSetting, int graphImgType, String graphProp, IContentConsumer consumer)

Obtains graph data from backend and steams it to provided content consumer.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
stateID The state ID of the document instance.
nodeKey A value which tells the template in the document whose graph is being retrieved.
slicedWindowID A value which identifies the slice of the graph to retrieve.
windowSetting An XML string telling the window of data to show in the graph returned.
graphImgType The image type of the graph, from EnumDSSXMLGraphImgTypes.
graphProp Properties that modify the graph shown.
consumer A content consumer for graph data
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract byte[][] LoadGraphData (String sessionID, String messageID, int stateID, String templateKey, int graphSliceIdentifier, String windowSetting, int graphImgType, String graphProp, IntWrapper iwStatus)

Throws
MSTRWebAPIException

public abstract String ReBuildDocument (String sessionID, String messageID, int executionFlags, int resultFlags, String documentManipulations, int stateID, String windowSetting, String extParam, StringWrapper msgID, IntWrapper status)

This method will submit a set of manipulations on a document.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
executionFlags The execution flags to use, from EnumDSSXMLExecutionFlags.
resultFlags The result flags to use, from EnumDSSXMLResultFlags.
documentManipulations An XML string describing the manipulations to be done.
stateID The state ID of the document instance being manipulated.
windowSetting The window setting for the new document instance.
extParam An XML string of additional information that will modify the result of the rebuild call.
msgID A StringWrapper object which will contain the message ID after this operation. Note that if the message ID is the same after this operation as it was before, then the results can be obtained by incrementing the state ID.
status The status of the job on the server after calling this method, from EnumDSSXMLStatus.
Returns
  • The result of this operation. Note that generally it is necessary to call GetExecutionResults to get the resulting document.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String Refresh (String sessionID, String messageID, int executionFlags, int resultFlags, String promptAnswer, String deltaXML, String extParam, String styleXSL, IntWrapper status)

Refreshs an already executed document.

Parameters
sessionID A valid Session ID.
messageID The message/job ID of the execution instance to refresh
executionFlags EnumDSSXMLDocExecutionFlags - Flags used in the execution of the document. [Default=0]
resultFlags EnumDSSXMLDocResultFlags - Flags used in the manipulation of the result. [Default=0]
promptAnswer Pre-answer for any prompts in the document. [Default=0]
deltaXML The delta xml representing the changes that need to be applied while refreshing
extParam An XML string of additional information that will modify the result of the rebuild call.
styleXSL XSL for the document style. [Default=0]
status Output Parameter - EnumDSSXMLStatus - After execution, will contain the current status of the submitted request.
Returns
  • XML String corresponding to the result XML, if the status is that the document is finished executing.

    This method re-executes the document identified by the given message ID. This does not mean re-execute the document against the warehouse. It is up to the server to decide whether a cache should be used. If the server hits a cache, this method will return the cached data.

Throws
MSTRWebAPIException Signals an error condition.

public abstract String Refresh (String sessionID, String messageID, int executionFlags, int resultFlags, String promptAnswer, String deltaXML, String styleXSL, IntWrapper status)

Refreshs an already executed document.

Parameters
sessionID A valid Session ID.
messageID The message/job ID of the execution instance to refresh
executionFlags EnumDSSXMLDocExecutionFlags - Flags used in the execution of the document. [Default=0]
resultFlags EnumDSSXMLDocResultFlags - Flags used in the manipulation of the result. [Default=0]
promptAnswer Pre-answer for any prompts in the document. [Default=0]
deltaXML The delta xml representing the changes that need to be applied while refreshing
styleXSL XSL for the document style. [Default=0]
status Output Parameter - EnumDSSXMLStatus - After execution, will contain the current status of the submitted request.
Returns
  • XML String corresponding to the result XML, if the status is that the document is finished executing.

    This method re-executes the document identified by the given message ID. This does not mean re-execute the document against the warehouse. It is up to the server to decide whether a cache should be used. If the server hits a cache, this method will return the cached data.

Throws
MSTRWebAPIException Signals an error condition.

public abstract String Refresh (String sessionID, String messageID, int executionFlags, int resultFlags, String promptAnswer, String styleXSL, IntWrapper status)

Refreshs an already executed document.

Parameters
sessionID A valid Session ID.
messageID The message/job ID of the execution instance to refresh
executionFlags EnumDSSXMLDocExecutionFlags - Flags used in the execution of the document. [Default=0]
resultFlags EnumDSSXMLDocResultFlags - Flags used in the manipulation of the result. [Default=0]
promptAnswer Pre-answer for any prompts in the document. [Default=0]
styleXSL XSL for the document style. [Default=0]
status Output Parameter - EnumDSSXMLStatus - After execution, will contain the current status of the submitted request.
Returns
  • XML String corresponding to the result XML, if the status is that the document is finished executing.

    This method re-executes the document identified by the given message ID. This does not mean re-execute the document against the warehouse. It is up to the server to decide whether a cache should be used. If the server hits a cache, this method will return the cached data.

Throws
MSTRWebAPIException Signals an error condition.

public abstract String Refresh (String sessionID, String messageID, int stateID, int executionFlags, int resultFlags, String promptAnswer, String deltaXML, String extParam, String styleXSL, IntWrapper status)

Throws
MSTRWebAPIException

public abstract void ResumeImportAsyncDashboard (String sessionID, String messageID, String dashboardName)

Throws
MSTRWebAPIException

public abstract String SaveAs (String sessionID, String messageID, String folderID, String documentName, String documentDesc, int flags, int stateID, String reportSaveAsOptions, IntWrapper status)

Throws
MSTRWebAPIException

public abstract String SaveAs (String sessionID, String messageID, String folderID, String documentName, String documentDesc, int flags, int stateID)

Saves the given document instance to metadata.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
folderID The ID of the folder to save the document to.
documentName The name to save the document as.
documentDesc The description of the document.
flags Flags which modify the behavior of the call, from EnumDSSXMLDocSaveAsFlags.
stateID The ID of the state of the document to save.
Returns
  • Object ID of the new documented created.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String SaveAs (String sessionID, String messageID, String folderID, String documentName, String documentDesc, int flags, int stateID, String reportSaveAsOptions)

Saves the given document instance to metadata.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
folderID The ID of the folder to save the document to.
documentName The name to save the document as.
documentDesc The description of the document.
flags Flags which modify the behavior of the call, from EnumDSSXMLDocSaveAsFlags.
stateID The ID of the state of the document to save.
reportSaveAsOptions The xml delta of the report SaveAs options for datasets within document.
Returns
  • Object ID of the new document created.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String SaveAs (String sessionID, String messageID, String folderID, String documentName, String documentDesc, int flags, int stateID, String reportSaveAsOptions, IntWrapper status, int requestTimeout)

Saves the given document instance to metadata.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
folderID The ID of the folder to save the document to.
documentName The name to save the document as.
documentDesc The description of the document.
flags Flags which modify the behavior of the call, from EnumDSSXMLDocSaveAsFlags.
stateID The ID of the state of the document to save.
reportSaveAsOptions The xml delta of the report SaveAs options for datasets within document.
status - EnumDSSXMLStatus - Contains the current status of the document.
requestTimeout Timeout in milliseconds for the xml command
Returns
  • Object ID of the new document created.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String SaveAsSegment (String sessionID, String messageID, String folderID, String segmentName, String segmentDesc, int flags, String nodeKey)

Create a segment from a document instance

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
folderID The ID of the folder to save the Segment to.
segmentName The name of the new segment.
segmentDesc The description of the new segment.
flags Flags which modify the behavior of the call.
nodeKey Optional. If it's assigned, the segment would be create from the subtree rooted by this node. Otherwise the segment would be created from the root of the document.
Returns
  • New Created Segment Object ID.
Throws
MSTRWebAPIException

public abstract String SaveAsTheme (String sessionID, String messageID, String folderID, String themeName, String themeDesc, int flags, int stateID)

Saves the given theme instance to metadata.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
folderID The ID of the folder to save the theme to.
themeName The name to save the theme as.
themeDesc The description of the theme.
flags Flags which modify the behavior of the call, from EnumDSSXMLDocSaveAsFlags.
stateID The ID of the state of the document to save.
Returns
  • Object ID of the new document theme created.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String SaveDerivedElements (String sessionID, String messageID, String unitKey, String attId, String folderId, String name, String description, boolean overwrite, IntWrapper status)

Throws
MSTRWebAPIException

public abstract void SendBinaryData (String sessionID, String messageID, int format, int stateID, String extendableParameter, IContentConsumer consumer)

Throws
MSTRWebAPIException

public abstract void SendExecutionResultsInBinary (String sessionID, String messageID, int resultFlags, int detailFlags, int stateID, Integer mbs, HashMap<String, String> mobileProps, String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)

Obtains the results/data of the document in binary format. Currently this is used to retrieve the data for the flex model in binary format. Note that the parameters like resultFlags and extendableParameter are currently not used and have been added for future use. Hence this method will always return the flex data in binary format at present.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
resultFlags The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
detailFlags The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
stateID The state ID of the document instance.
mbs Maximum binary size (optional).
mobileProps A collection of mobile properties that need to be passed to backend. Expected properties are MOBILE_PROPERTY_ENCRYPT, MOBILE_PROPERTY_DEVICE_TOKEN, MOBILE_PROPERTY_APP_ID or MOBILE_PROPERTY_TOKEN_TYPE
extendableParameter An XML string containing additional options.
iwStatus The status of the document instance, from EnumDSSXMLStatus.
consumer A IContentConsumer object which consumes the binary data that is generated by the intelligence server
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract void SendExecutionResultsInBinary (String sessionID, String messageID, int resultFlags, int stateID, String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)

This method is deprecated.
This method is deprecated. Use the overloading method with detailFlags instead.

Obtains the results/data of the document in binary format. Currently this is used to retrieve the data for the flex model in binary format. Note that the parameters like resultFlags and extendableParameter are currently not used and have been added for future use. Hence this method will always return the flex data in binary format at present.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
resultFlags The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
stateID The state ID of the document instance.
extendableParameter An XML string containing additional options.
iwStatus The status of the document instance, from EnumDSSXMLStatus.
consumer A IContentConsumer object which consumes the binary data that is generated by the intelligence server
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract void SendExecutionResultsInBinary (String sessionID, String messageID, int resultFlags, int detailFlags, int stateID, Integer mbs, String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)

Obtains the results/data of the document in binary format. Currently this is used to retrieve the data for the flex model in binary format. Note that the parameters like resultFlags and extendableParameter are currently not used and have been added for future use. Hence this method will always return the flex data in binary format at present.

Parameters
sessionID A valid session ID.
messageID The message ID of the document instance.
resultFlags The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
detailFlags The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
stateID The state ID of the document instance.
mbs Maximum binary size (optional).
extendableParameter An XML string containing additional options.
iwStatus The status of the document instance, from EnumDSSXMLStatus.
consumer A IContentConsumer object which consumes the binary data that is generated by the intelligence server
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String checkImageExist (String sessionID, String messageID, String shaValue)

check whether the image has been stored in MD or in current instance

Parameters
sessionID A valid Session ID
messageID A valid message ID
shaValue the SHA result of image binary stream
Returns
  • If the image exists, return the id of the image. else return a string with all zero
Throws
MSTRWebAPIException

public abstract String getBaseGraphProperties (String sessionID, String projectID)

get base graph properties.

Parameters
sessionID A valid session ID.
projectID project dss id.
Returns
  • properties with JSON format.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String getDocumentInstanceShortcutInfo (String sessionID, String messageId, int dossierShortcutInfoFlag)

Gets the shortcut information associated with an instanceId (messageId) of a document. A flag can be used to specify additional information to be returned in the result.@return

Parameters
messageId server message ID. I-Server will get shortcut from server message. If the server message contains a document instance, and the document instance is created because of running a shortcut, then client can use the mid to get shortcut info
dossierShortcutInfoFlag flag to specify what additional information needs to be returned. For more information, please refer to EnumDSSXMLDossierShortcutInfoFlag.
Throws
MSTRWebAPIException

public abstract String getDocumentInstanceShortcutInfo (String sessionID, String messageId)

Gets the shortcut information associated with an instanceId (messageId) of a document@return

Parameters
messageId server message ID. I-Server will get shortcut from server message. If the server message contains a document instance, and the document instance is created because of running a shortcut, then client can use the mid to get shortcut info
Throws
MSTRWebAPIException

public abstract String getDocumentLinksValidationInfo (String sessionID, String messageID, int action, String extendableParameter)

get validation info for document level attribute links

Parameters
sessionID A valid Session ID.
messageID A valid message/job ID.
extendableParameter The extendable parameter value.
Returns
  • validation info with JSON format.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String getDocumentShortcutInfo (String sessionID, String objectId)

Gets the shortcut information by the shortcut objectId@return

Parameters
objectId document shortcut's object ID. I-Server will find the corresponding shortcut from MD.
Throws
MSTRWebAPIException

public abstract String getDocumentShortcutInfo (String sessionID, String objectId, int dossierShortcutInfoFlag)

Gets the shortcut information by the shortcut objectId. A flag can be used to specify additional information to be returned in the result.@return

Parameters
objectId document shortcut's object ID. I-Server will find the corresponding shortcut from MD.
dossierShortcutInfoFlag flag to specify what additional information needs to be returned. For more information, please refer to EnumDSSXMLDossierShortcutInfoFlag.
Throws
MSTRWebAPIException

public abstract String getDossierShortcutCacheInfoJsonResult (String sessionID, int cacheType, String shortcutId)

Get the cache info include definition cache and data cache for a dossier shortcut Internal used only@return

Parameters
sessionID project session id
cacheType EnumDSSExportFormat - Flag to indicate export format. Now only support DssExportFormatFlash = 7
shortcutId dossier shortcut id
Throws
MSTRWebAPIException
MSTRWebAPIException

public abstract String getDossierShortcutCacheInfoJsonResult (String sessionID, int cacheType, String shortcutId, Integer resultFlags, Integer detailFlags, String bookmarkId)

Get the cache info include definition cache and data cache for a dossier shortcut Internal used only@return

Parameters
sessionID project session id
cacheType EnumDSSExportFormat - Flag to indicate export format. Now only support DssExportFormatFlash = 7
shortcutId dossier shortcut id
resultFlags result flags
detailFlags detail flags
bookmarkId bookmark id
Throws
MSTRWebAPIException

public abstract byte[] getDossierShortcutCachesInBinary (String sessionID, String cacheId)

Gets the dossier shortcut cache binary by cache id, only support one cache id in 11.1 THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.@return

Throws
MSTRWebAPIException

public abstract String getElementFromGraph (String sessionID, String messageID, String nodeKey, String sliceID, int x, int y, String dpi)

get elements from graph in document

Parameters
sessionID A valid Session ID.
messageID A valid message ID.
nodeKey node key
sliceID slice ID
x position X
y position Y
dpi DPI
Returns
  • the elements clicked in the graph
Throws
MSTRWebAPIException

public abstract String getMSTRPredictedFileSize (String sessionID, String objectID)

Gets the predicted MSTR file size of a report or a document

Parameters
objectID objectID of a document or a report
Returns
  • a json String e.g.{"mstr_size":0,"IsSetting":false}, the "mstr_size" is the predicted MSTR file size calculated by the i-Server. "IsSetting" indicates if the "mstr_size" is obtained by returning the value of 'MicroStrategy .(mstr) file size(MB)' set on the developer directly. If IsSetting is true meaning that the value of "mstr_size" was returned based on the value of 'MicroStrategy .(mstr) file size(MB)' set on developer; if IsSetting is false meaning that the value of "mstr_size" was calculated for a given document or report by the i-Server.
Throws
MSTRWebAPIException

public abstract String getManifest (String sessionID, String messageID, String datasetId, Boolean useJson)

get manifest of the document, returns a list of objects used in the document@return

Throws
MSTRWebAPIException

public abstract String importImageToDocument (String sessionID, String messageID, String binaryID, int blockCount, int blockIndex, int blockSize, String treeType, String nodeKey, String fieldKey, String fieldName, String imgName, int index, long fileSize, String imgID, String hashCode, int isEdit, InputStream data)

import image to document

Parameters
sessionID A valid Session ID
messageID A valid message ID
binaryID the ID of binary of image if it is too large, and need to be partitioned.
blockCount the number of blocks of the image if it is too large, and need to be partitioned.
blockIndex the index of block of the image if it is too large, and need to be partitioned.
blockSize the size of the block of the image if it is too large, and need to be partitioned.
treeType tree type
nodeKey node key
fieldKey field key
fieldName field name
imgName image name
index the index of the field in field group
fileSize size of the image
isEdit the flag that indicate edit current node or add a new node(1 edit, 0 add)
data the binary stream of the image/block
Returns
  • the ID of binary of image if it is too large, and need to be partitioned
Throws
MSTRWebAPIException