Excel Add-In for SAP BusinessObjects BI

Build 25.0.9434

RefreshDocument

Refreshes a Web Intelligence document by filling the refresh parameters if needed and running the query.

Input

Name Type Required Description
DocumentID String True The identifier of the document to refresh.
DataProviderScope String False If set to accessible, a document can be refreshed even if one or more of the data providers is not accessible.

The allowed values are all, accessible.

ListOfValuesInfo Bool False Specifies if the lists of values are computed and displayed.

The default value is true.

Refresh Bool False To avoid a data refresh at the end of the parameter workflow.

The default value is true.

Strict Bool False To be used with VariantIds. If set to true, an error message is returned if the variant contents and the document parameters do not match, or if the cardinality of the answer in a variant is incorrect or the data type of the answer in a variant is incorrect.

The default value is false.

VariantIds String False The list of variant identifiers separated with a comma that you can use to answer the prompt parameters of the document. The order of variants in the list is important. A value provided by a variant or the request body can overwrite the one provided by another variant. The last value is used to answer the parameter.
Parameters String False The parameters to be used to run the document refresh.

Result Set Columns

Name Type Description
Success Boolean Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details String Details of execution failure. NULL if success=true.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434