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

KB31651: How to Obtain a List of Attribute Form Names Using the MicroStrategy Intelligence Server SDK version 9.2.0 and higher


Community Admin

• Strategy


This article provides an example of a program that allows to list the attribute's forms names

The following program is an example of how user can list the attribute's forms names.
 
Program provided was tested with Microsoft Visual Basic 2008 Express Edition.
First step that needs to be performed is to put a button on form.
The ID of the button is "Button1". An event is used with this ID.
To execute progam just click the button on the form.
Program is based on Strategy Intelligence Server API. 
Link below points to full documentation of this API.
 
https://resource.microstrategy.com/MSDZ/MSDL/900/docs/DevLib/sdk_iserver/api_ref/annotated.html
 
I


mports DSSCOMMasterLib

Public Class Form1

    Private Sub listAttributes()

        'STEP 1 : Connect to source I-Server

        Dim objServer As New DSSDataSource

        objServer.Name = "localhost" ' Servername.Text

        objServer.Type = EnumDSSDataSourceType.DssDataSourceTypeServer

        objServer.Location = "localhost" 'Servername.Text

        objServer.Mode = EnumDSSConnectionMode.DssConnectionModeServerAccess

        objServer.AuthMode = EnumDSSAuthModes.DssAuthStandard

        objServer.login = "administrator" 'Login.Text

        objServer.Passwd = "" ' Pwd.Text

        objServer.Init()

        'STEP 2: Login to source Project

        Dim objProjectList As DSSDataSourceEnumerator

        Dim objDataSource As DSSDataSource

        objProjectList = objServer.Enumerator

        'objDataSource = objProjectList.ItemByProjectName(ProjectName.Text)

        objDataSource = objProjectList.ItemByProjectName("Strategy Tutorial")

        objDataSource.Init()

        '--------------------------------------------------

        ' Create a source session object.

        'StatusBar.Panels(1).Text = "Create a session."

        Dim MySession As IDSSSession

        Dim MySource As IDSSSource

        'MySession = MyProject.CreateSession

        MySession = objDataSource.CreateSession

        MySource = _

        MySession.Component(EnumDSSComponentRole.DssRoleObjectSource)

        '--------------------------------------------------

        ' Find all attributes

        '--------------------------------------------------

        Dim MySourceFolder As IDSSFolder

        Dim MySourceReportDef As IDSSReportDefinition

        Dim ObjSearch As IDSSSearch

        '        StatusBar.Panels(1).Text = _

        '        "Searching for Report"

        '--------------------------------------------------

        ' Initialize a source search object.

        ObjSearch = MySource.NewObject(EnumDSSObjectType.DssTypeSearch)

        'ObjSearch = objDataSource.NewObject(EnumDSSObjectType.DssTypeSearch)

        'ObjSearch.NamePattern = "TestReport"

        ObjSearch.NamePattern = "Month of Year"

        ObjSearch.Types.Add(EnumDSSObjectType.DssTypeAttribute)

        MySourceFolder = ObjSearch.Execute


        For Each collectionAttributeItem As IDSSAttribute In MySourceFolder

            Dim attForms As IDSSAttributeForms

            ' Perform desired processing on each item.

            MessageBox.Show(collectionAttributeItem.Info.Name)

            attForms = collectionAttributeItem.Forms

            For Each attributeForm As IDSSAttributeForm In attForms

                MessageBox.Show(attributeForm.BaseAttributeForm.Name + " " + attributeForm.UseName)


            Next attributeForm

        Next collectionAttributeItem


    End Sub

    Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click

        listAttributes()

    End Sub


End Class

The example provided in this document is provided “as-is” to the user and assumes that the user:
 

  • Has access to the Strategy SDK documentation.
  • Has read the customization warning at the bottom of this document
  • 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.Strategy.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@Strategy.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.Strategy.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:

June 23, 2017

Last Updated:

June 23, 2017