Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSScriptServer3 Interface Reference

Inherits IDSSScriptServer2.

Inherited by IDSSScriptServer4.

List of all members.


Detailed Description

The IDSSScriptServer3 interface is used to support the client to send a batch report/document execution request to a server and to poll the results from a server.

This interface is exposed from Script Server, a 3-tier client-side DSS component, which can be gotten from a 3-tier session object. It is derived from IDSSScriptServer and IDSSScriptServer2. The user should have DssPrivilegesUseServerAdmin privilege and Write access right on the Server to use the methods of this interface.


Public Member Functions

HRESULT GetRequestResultInInstances ([in] Int32 JobID,[in, defaultvalue(0)] Int32 Flag,[out, optional] Int32 *pNumberOfRemainingItems,[out, optional] Int32 *pNumberOfItems,[out, optional] VARIANT *pResultIDs,[out, optional] VARIANT *pResultCodes,[out, optional] VARIANT *pInstances,[out, optional] VARIANT *pErrorMessages)
HRESULT SendBatchExecutionRequest ([in] BSTR ID,[in] Int32 NumberOfItems,[in] VARIANT *pResultIDs,[in, optional] VARIANT *pUserIDs,[in, optional] VARIANT *pUserIDIndexes,[in, optional] VARIANT *pResolutionXMLs,[in, optional] VARIANT *pResolutionXMLIndexes,[in, optional] VARIANT *pFilterXMLs,[in, optional] VARIANT *pFilterXMLIndexes,[in, optional] BSTR GraphViewSettingXML,[in, defaultvalue(0)] Int32 Locale,[in, defaultvalue(0)] Int32 Flag,[in, defaultvalue(0)] Int32 Actions,[in, defaultvalue(0)] Int32 ExecutionFlags,[out, retval] Int32 *pJobID)
 Send a report/document batch execution request to the server.


Member Function Documentation

HRESULT IDSSScriptServer3::GetRequestResultInInstances [in] Int32  JobID,
[in, defaultvalue(0)] Int32  Flag,
[out, optional] Int32 *  pNumberOfRemainingItems,
[out, optional] Int32 *  pNumberOfItems,
[out, optional] VARIANT *  pResultIDs,
[out, optional] VARIANT *  pResultCodes,
[out, optional] VARIANT *  pInstances,
[out, optional] VARIANT *  pErrorMessages
 

HRESULT IDSSScriptServer3::SendBatchExecutionRequest [in] BSTR  ID,
[in] Int32  NumberOfItems,
[in] VARIANT *  pResultIDs,
[in, optional] VARIANT *  pUserIDs,
[in, optional] VARIANT *  pUserIDIndexes,
[in, optional] VARIANT *  pResolutionXMLs,
[in, optional] VARIANT *  pResolutionXMLIndexes,
[in, optional] VARIANT *  pFilterXMLs,
[in, optional] VARIANT *  pFilterXMLIndexes,
[in, optional] BSTR  GraphViewSettingXML,
[in, defaultvalue(0)] Int32  Locale,
[in, defaultvalue(0)] Int32  Flag,
[in, defaultvalue(0)] Int32  Actions,
[in, defaultvalue(0)] Int32  ExecutionFlags,
[out, retval] Int32 *  pJobID
 

Send a report/document batch execution request to the server.

This method is used to send a batch report/document execution request to a server. If it succeeds, a JobID will be returned, which is used to poll the results of this request, or to monitor the job, or to cancel the job. If it fails, an error will be returned.

A request includes
  • ID, which indicate the report or the document
  • GraphViewSettingXML (optional), which contains the graph settings such as GraphStartRow, GraphStartCol, GraphMaxRows, GraphMaxCols, GraphHeigh, GraphWidth, GraphMajorType, GraphMinorType. The default values for these settings are 1 (GraphStartRow), 1 (GraphStartCol), all rows (GraphMaxRows), all columns (GraphMaxCols), DssXmlMajorGraphTypeVerticalBar (GraphMajorType), and DssXmlVAreaMinorTypeAbsolute (GraphMinorType).
  • Locale (optinal), which indicates the locale used for this request. 0 means using the one of the logged in user.
  • Flag (optional), which provides additional information, such as whether graphic results are required. It is a bit-wise-long-value flag.
  • Actions, which provides the action flags of report execution or document execution.
  • ExecutionFlags, which provides the report/document execution flags.
  • List of request items, each includes
  • ResultID, which is used to identify this request item,
  • UserID, which indicates the User
  • ResolutionXML, which indicates the Broadcaster personalization
  • FilterXML, which indicates the Broadcaster security
Where, UserID, ResolutionXML, or FilterXML is optional. NULL BSTR will be used to indicate that no value is provided.
Since there are many duplicates in UserIDs, ResolutionXMLs, FilterXMLs, the sender may choice to provide no-duplicate UserIDs, ResolutionXMLs, FilterXMLs with long-value index arrays that are used to specify which user, or resolution, or filter is associated with the request item. If the index array (e.g. the index array for ResolutionXMLs) is not provided, the corresponding one (e.g. ResolutionXMLs) is treated as one-to-one relationship with the request item.
None.
Parameters:
ID The GUID of the report
NumberOfItems The long-value count of items in this request
pResultIDs a SAFEARRAY of BSTRs that contain GUIDs of ResultIDs
pUserIDs a SAFEARRAY of BSTRs that contain GUIDs of Users
pUserIDIndexes a SAFEARRAY of longs that contain the indexes to pUserIDs, which indicates which user is associated with this request item (0 indicates that no special user is associated with this request item)
pResolutionXMLs a SAFEARRAY of BSTRs that contain XMLs of the resolutions
pResolutionXMLIndexes a SAFEARRAY of longs that contain the indexes to pResolutionXMLs, which indicates which resolution is associated with this request item (0 indicates that no resolution is associated with this request item)
pFilterXMLs a SAFEARRAY of BSTRs that contain XMLs of the filters
pFilterXMLIndexes a SAFEARRAY of longs that contain the indexes to pFilterXMLs, which indicates which filter is associated with this request item (0 indicates that no filter is associated with this request item)
GraphViewSettingXML The XML contains the settings of the graph
Locale The locale used for this request.
Flag a long value flag will be used to provides additional requirement. It is a bit-wise enumeration type. The current available value includes:
Actions The bit-wise long value that provides the actions of report execution or document execution. For the lists of available enumeration values, please refer "IDSSReportSource.doc" and "IDSSDocumentSource.doc"
ExecutionFlags The bit-wise long value that provides the report or document execution flags. For the lists of available enumeration values, please refer "IDSSReportSource.doc" and "IDSSDocumentSource.doc"
pJobID The pointer to a long value that indicates the job ID for this request
Returns:
Usual COM result code:
  • S_OK
  • E_INVALIDARG No request items, or invalid report ID, or invalid flag, or invalid SAFEARRAYs
  • E_POINTER The memory of pJobID is not allocated before calling this method.
  • AUTHEN_E_USER_NO_PRIV The user does not have DssPrivilegesUseServerAdmin privilege.
  • MSI_COMMANDPERMISSION_ERROR The user does not have Write access right on the Server.
  • SCRSVR_E_CLOSED The Script Server is closed.


Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.