EducationSoftwareStrategy.com
StrategyCommunity

Knowledge Base

Product

Community

Knowledge Base

TopicsBrowse ArticlesDeveloper Zone

Product

Download SoftwareProduct DocumentationSecurity Hub

Education

Tutorial VideosSolution GalleryEducation courses

Community

GuidelinesGrandmastersEvents
x_social-icon_white.svglinkedin_social-icon_white.svg
Strategy logoCommunity

© Strategy Inc. All Rights Reserved.

LegalTerms of UsePrivacy Policy
  1. Home
  2. Topics

KB226318: How to Get a List of Report Services Documents That Have "Do Not Allow This Report to Be Scheduled" Option Enabled Using MicroStrategy Web SDK 9.4.1


Community Admin

• Strategy


MicroStrategy Web 9.4.1 gives users the option to control, at the document level, if a document can be scheduled. The image below shows the option in Document Properties that can be enabled to avoid a document to be scheduled.

Strategy Web 9.4.1 gives users the option to control, at the document level, if a document can be scheduled. The image below shows the option in Document Properties that can be enabled to avoid a document to be scheduled.
 

ka04W000001MKyFQAW_0EM440000002GPx.jpeg

 
Currently, the only option to check if this option is enabled is by checking the Document Properties of each document. The code below, gives the option to iterate through all the documents in a project and determine which ones have this option enabled. 
 


package com.sdk.samples.standalone;

import com.Strategy.web.beans.BeanFactory;
import com.Strategy.web.beans.RWBean;
import com.Strategy.web.beans.WebBeanException;
import com.Strategy.web.objects.WebFolder;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectSource;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.WebProperty;
import com.Strategy.web.objects.WebSearch;
import com.Strategy.web.objects.rw.RWInstance;
import com.Strategy.webapi.EnumDSSXMLApplicationType;
import com.Strategy.webapi.EnumDSSXMLObjectTypes;
import com.Strategy.webapi.EnumDSSXMLSearchDomain;
import com.Strategy.webapi.EnumDSSXMLSearchFlags;

public class ScheduleSettingsDocument {
    
    static WebObjectsFactory factory = WebObjectsFactory.getInstance();
    static WebIServerSession serverSession = factory.getIServerSession();
    public static void main(String[] args) throws WebBeanException, WebObjectsException, FileNotFoundException {
       
    serverSession.setServerName("servername");
    serverSession.setServerPort(0);
    serverSession.setProjectName("Strategy Tutorial");    
    serverSession.setLogin("administrator");
    serverSession.setPassword("");
    serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);
  
    RWBean rwb = (RWBean) BeanFactory.getInstance().newBean("RWBean"); 
    //Setting execution flag to improve performance - KB37867 
    rwb.setFlags(EnumDSSXMLExecutionFlags.DssXmlExecutionResolve); 
    rwb.setSessionInfo(serverSession); 
        
        WebObjectSource wos = factory.getObjectSource(); 
        WebSearch search = wos.getNewSearchObject(); 
        search.setAsync(false); 
        search.setDisplayName("*"); 
        search.types().add(new Integer(EnumDSSXMLObjectTypes.DssXmlTypeDocumentDefinition)); search.setSearchFlags(EnumDSSXMLSearchFlags.DssXmlSearchRootRecursive | EnumDSSXMLSearchFlags.DssXmlSearchNameWildCard); search.setDomain(EnumDSSXMLSearchDomain.DssXmlSearchDomainProject); 
        search.submit(); 
        
        WebFolder folder = search.getResults(); 
        
        for (int i = 0; i < folder.size(); i++) { 
            rwb.setObjectID(folder.get(i).getID()); 
            WebProperty property = rwb.getRWProperty("GeneralReportProperties", "CanBeScheduled"); 
            if (property != null && property.getValue().equalsIgnoreCase("0")) { 
                System.out.println("Document Name: " + folder.get(i).getDisplayName() + " Value: " + property.getValue()); 
            } 
        } 
        
        serverSession.closeSession(); } 
}

 
 
The example provided in this document is provided “as-is” and user has read the following customization warning:
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize several Strategy products and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy products or the process of customizing Strategy products, please refer to Strategy Developer Zone (https://developer.microstrategy.com).
To access the Strategy Developer Zone, you must have access to the Strategy Knowledge Base, you must have purchased the Strategy SDK, and you must be current on your Strategy maintenance agreement. If you are a US-based business and believe that you satisfy all three of these conditions but you do not have access to the Strategy Developer Zone, please contact Strategy Technical Support at support@microstrategy.com or at (703) 848-8700. If you are an international business, please contact Strategy Technical Support at the appropriate email address or phone number found at https://www.microstrategy.com/us/services/support/contact.
CUSTOMIZATION WARNING:
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.
 
 


Comment

0 comments

Details

Knowledge Article

Published:

March 31, 2017

Last Updated:

March 31, 2017