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

KB227588: Creating a Security Filter Programmatically Using the MicroStrategy Web SDK


Community Admin

• Strategy


Java sample demonstrating how to programmatically create a security filter using the MicroStrategy Web SDK Java API.

Summary
Strategy Security Filters are normally created in Strategy Developer. However, an administrator may want to do this automatically using the Strategy Web API. 

ka04W000000Ofg7QAC_0EM440000002GOT.jpeg

 
Example
This can be done using Strategy Web SDK. The following standalone code demonstrates this:


public class CreateSecurityFilterWithWebObjects {
    public static WebIServerSession sessionInfo;
    public static final String filterName = "New SecurityFilter for User Manager Demo";
    public static final String iServerName = "localhost";
    public static final String projectName = "Strategy Tutorial";
    public static final String adminLoginName = "administrator";
    public static final String adminLoginPasswd = "";

    public static void main(String[] args) {
        sessionInfo = getServerSession(iServerName, projectName, adminLoginName, adminLoginPasswd);
		
        WebObjectSource source = sessionInfo.getFactory().getObjectSource();
        WebMDSecurityFilter sFilter = (WebMDSecurityFilter)source.getNewObject(EnumDSSXMLObjectTypes.DssXmlTypeMDSecurityFilter);

        try {
            WebExpression exp = sFilter.getExpression();
            exp.createNode("Category@DESC in(\"Books\")");
			
            WebNode n2 = exp.createOperatorNode(
                    EnumDSSXMLExpressionType.DssXmlFilterBranchQual,
                    EnumDSSXMLFunction.DssXmlFunctionOr);
					
            exp.createNode("Region@DESC in(\"Central\")", n2);
            exp.createNode("Category@DESC in(\"Movies\")", n2);
            exp.createNode("Country@DESC in(\"Spain\")");

            String folderID = source.getFolderID(EnumDSSXMLFolderNames.DssXmlFolderNameSystemMDSecurityFilters);

            // Get a folder object using the folder where sec filters are stored
            WebFolder folder = (WebFolder) source.getObject(folderID, EnumDSSXMLObjectTypes.DssXmlTypeFolder);

            // Create a new security filter
            source.saveAs(sFilter, filterName, folder, true);

        } catch (WebObjectsException webObjEx) {
            System.out.println("Error fetching object definition or fetching elements from an attribute: " + webObjEx.getMessage());

        }
    }

    public static WebIServerSession getServerSession(String serverName, String Project, String loginName, String password) {
        WebIServerSession sessionInfo = null;
        try {
            WebObjectsFactory woFact = WebObjectsFactory.getInstance();
            sessionInfo = woFact.getIServerSession();
            sessionInfo.setServerName(serverName);
            sessionInfo.setProjectName(Project);
            sessionInfo.setLogin(loginName);
            sessionInfo.setPassword(password);
            sessionInfo.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);

            // Create a new session
            sessionInfo.getSessionID();

        } catch (WebObjectsException ex) {
            System.out.println("Error creating a session");
        }
        return sessionInfo;
    }
}

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:

May 10, 2017

Last Updated:

November 21, 2017