IncludeInProcessAll (Property)

Applies To:

(CubeQuery)QuerySection object, OLAPQuerySection object, QuerySection object

Description:

When read, this property indicates whether the section is included when a Process All operation is performed (value = true). If the value is false then the section is not included any Process All operations. When this property is set, a value of true ncludes the section in future Process All operations, and a value of false excludes the section from future Process All operations.

When a job is published or scheduled, all queries are listed in the Connecting to Data Sources section in order by the ordinal value of the ProcessSequence Number (Property), regardless of the setting for the IncludeInProcessAll (Property). Queries with the IncludeInProcessAll (Property) set to true are not listed in the Query Connections and Processing section. When the script is generated for the job, the processing actions is in ProcessSequenceNumber order, excluding queries where the IncludeInProcessAll (Property) is false.

When scheduling/running a job, if a query has IncludeInProcessAll (Property) set to false, but it is used in other queries as a derived table, and the excluded query has variable limits, its parameters are requested for each query that uses it. For example, Query 1 is excluded from the processing order, but Query 2 and Query 3 use it as a derived table. When collected parameters for Query 2 and Query 3, Query 1 should be included. Different parameter values could be selected for each of these queries.

When a custom process order is selected from the Process Custom dialog, all queries belonging to a given node of the processing tree (Queries, OLAPQueries, and Imported Files being the nodes) are arranged in order by the ordinal value of ProcessSequenceNumber (Property), regardless of the setting of IncludeInProcessAll (Property). Queries that are checked in that dialog are processed in ProcessSequenceNumber order, regardless of the Query type.

For example, assume a document with Query2, OLAPQuery1, authorsout.csv, Query1, and OLAPQuery2, are assigned sequence numbers 1 to 5. They appear in the tree as Query2 and Query1, in that order under Queries, and OLAPQuery1 and OLAPQuery2 under the OLAP Queries branch, and authorsout.csv under Imported Files. If users checked and five and press OK, this processing order is used:

If a Query section has the IncludeInProcessAll (Property) set to false, clicking the Process button when viewing that section or any of its dependent sections, or executing the Process (Method) associated with that section still processes that query.

When a Query section is duplicated, the new section gets the next highest ProcessSequenceNumber, and it appears last in the Query Processing Order dialog list box if it is opened immediately following the duplicate section action. The IncludeInProcessAll (Property) Boolean value is inherited from the source section during duplication.

Action:

Read-write, Boolean

Example 1:

This example shows how to display the number of queries in theInteractive Reporting document file(.bqy) in an Alert box, set the processing the Query section to the second position in the Query Processing Order dialog, includes the Query section in a Process All command, and then executes the Process All command for the document:

Alert("Number of Query Sections "   +  ActiveDocument.Sections.QueryCount)
ActiveDocument.Sections["Query"].ProcessSequenceNum = 2
ActiveDocument.Sections["Query"].IncludeInProcessAll = true
ActiveDocument.ProcessAll()

Example 2:

This example show how to read and set a section in a Process All operation:

if (Sections[“Query”].IncludeInProcessAll == true) {
    // the OLAP query is included in the process all operation
} else {
    // Include the OLAP query in the process all operation
    Sections[“Query”].IncludeInProcessAll = true;
}