mstrio.project_objects package

Subpackages

Submodules

mstrio.project_objects.applications module

class mstrio.project_objects.applications.Application(connection: Connection, name: str | None = None, id: str | None = None)

Bases: Entity, CopyMixin, DeleteMixin, TranslationMixin

Python representation of a MicroStrategy Application object

class AiSettings(feedback: bool | None = None, learning: bool | None = None, disclaimer: str | None = None)

Bases: Dictable

AI settings of the application.

feedback

if True, AI assistance feedback is enabled

Type:

bool

learning

if True, AI assistance learning is enabled

Type:

bool

disclaimer

AI assistance disclaimer

Type:

str

disclaimer: str | None = None
feedback: bool | None = None
learning: bool | None = None
class AuthModes(available_modes: list[int] | None = None, default_mode: int | None = None)

Bases: Dictable

Authentication modes of the application.

available_modes

available authentication modes Possible values:

1: Standard 16: LDAP 1048576: SAML 4194304: OIDC

Type:

list[int]

default_mode

default authentication mode

Type:

int

available_modes: list[int] | None = None
default_mode: int | None = None
class EmailSettings(enabled: bool | None = None, host_portal: str | None = None, show_branding_image: bool | None = None, show_browser_button: bool | None = None, show_mobile_button: bool | None = None, show_button_description: bool | None = None, show_reminder: bool | None = None, show_sent_by: bool | None = None, sent_by_text: str | None = None, show_social_media: bool | None = None, content: mstrio.project_objects.applications.Application.EmailSettings.Content | None = None, sender: mstrio.project_objects.applications.Application.EmailSettings.Sender | None = None, branding_image: str | None = None, button: mstrio.project_objects.applications.Application.EmailSettings.Button | None = None, reminder: mstrio.project_objects.applications.Application.EmailSettings.Reminder | None = None, social_media: mstrio.project_objects.applications.Application.EmailSettings.SocialMedia | None = None)

Bases: Dictable

Email settings of the application.

enabled

whether to enable custom email settings

Type:

bool

host_portal

the host web portal in the button link

Type:

str

show_branding_image

if True, shows branding image

Type:

bool

show_browser_button

if True, shows browser button

Type:

bool

show_mobile_button

if True, shows mobile button

Type:

bool

show_button_description

if True, shows the email button description

Type:

bool

show_reminder

if True, shows reminder section

Type:

bool

show_sent_by

if True, shows sent by section

Type:

bool

sent_by_text

text in the sent by section

Type:

str

show_social_media

if True, shows social media section

Type:

bool

content

content settings

Type:

Content

sender

sender settings

Type:

Sender

branding_image

url of the branding image

Type:

str

button

button settings

Type:

Button

reminder

reminder settings

Type:

Reminder

social_media

social media settings

Type:

SocialMedia

class Button(browser_button_style: mstrio.project_objects.applications.Application.EmailSettings.Button.ButtonStyle | None = None, mobile_button_style: mstrio.project_objects.applications.Application.EmailSettings.Button.ButtonStyle | None = None, mobile_button_link_type: str | None = None, mobile_button_scheme: str | None = None, description: str | None = None)

Bases: Dictable

Button settings of the application.

browser_button_style

browser button style

Type:

ButtonStyle

mobile_button_style

mobile button style

Type:

ButtonStyle

mobile button link type Possible values:

-default -app_scheme -universal_link

Type:

str

mobile_button_scheme

mobile button scheme

Type:

str

description

button description

Type:

str

class ButtonStyle(background_color: str | None = None, font_color: str | None = None, text: str | None = None)

Bases: Dictable

Button style settings of the application.

background_color

button background color

Type:

str

font_color

button text color

Type:

str

text

button border color

Type:

str

background_color: str | None = None
font_color: str | None = None
text: str | None = None
browser_button_style: mstrio.project_objects.applications.Application.EmailSettings.Button.ButtonStyle | None = None
description: str | None = None
mobile_button_link_type: str | None = None
mobile_button_scheme: str | None = None
mobile_button_style: mstrio.project_objects.applications.Application.EmailSettings.Button.ButtonStyle | None = None
class Content(share_dossier: mstrio.project_objects.applications.Application.EmailSettings.Content.EmailDetails | None = None, share_bookmark: mstrio.project_objects.applications.Application.EmailSettings.Content.EmailDetails | None = None, share_bot: mstrio.project_objects.applications.Application.EmailSettings.Content.EmailDetails | None = None, member_added: mstrio.project_objects.applications.Application.EmailSettings.Content.EmailDetails | None = None, user_mention: mstrio.project_objects.applications.Application.EmailSettings.Content.EmailDetails | None = None)

Bases: Dictable

Content settings of the application.

share_dossier

settings for sharing a dossier

Type:

EmailDetails

share_bookmark

settings for sharing a dossier with bookmark

Type:

EmailDetails

share_bot

settings for sharing a bot

Type:

EmailDetails

member_added

settings for inviting a recipient to a discussion

Type:

EmailDetails

user_mention

settings for mentioning a recipient in a comment or discussion

Type:

EmailDetails

class EmailDetails(subject: str | None = None, body: str | None = None)

Bases: Dictable

Email details settings of the application.

subject

email subject

Type:

str

body

email body

Type:

str

body: str | None = None
subject: str | None = None
member_added: mstrio.project_objects.applications.Application.EmailSettings.Content.EmailDetails | None = None
share_bookmark: mstrio.project_objects.applications.Application.EmailSettings.Content.EmailDetails | None = None
share_bot: mstrio.project_objects.applications.Application.EmailSettings.Content.EmailDetails | None = None
share_dossier: mstrio.project_objects.applications.Application.EmailSettings.Content.EmailDetails | None = None
user_mention: mstrio.project_objects.applications.Application.EmailSettings.Content.EmailDetails | None = None
class Reminder(text: str | None = None, link_text: str | None = None)

Bases: Dictable

Reminder settings of the application.

text

reminder text

Type:

str

link_text

reminder link text

Type:

str

link_text: str | None = None
text: str | None = None
class Sender(address: str | None = None, display_name: str | None = None)

Bases: Dictable

Sender settings of the application.

address

sender email address

Type:

str

display_name

sender display name

Type:

str

address: str | None = None
display_name: str | None = None
class SocialMedia(show_facebook: bool | None = None, facebook_link: str | None = None, show_twitter: bool | None = None, twitter_link: str | None = None, show_linked_in: bool | None = None, linked_in_link: str | None = None, show_you_tube: bool | None = None, you_tube_link: str | None = None)

Bases: Dictable

Social media settings of the application.

show_facebook

whether to show the Facebook link

Type:

bool

Facebook link

Type:

str

show_twitter

whether to show the Twitter link

Type:

bool

Twitter link

Type:

str

show_linked_in

whether to show the LinkedIn link

Type:

bool

LinkedIn link

Type:

str

show_youtube

whether to show the YouTube link

Type:

bool

YouTube link

Type:

str

facebook_link: str | None = None
linked_in_link: str | None = None
show_facebook: bool | None = None
show_linked_in: bool | None = None
show_twitter: bool | None = None
show_you_tube: bool | None = None
twitter_link: str | None = None
branding_image: str | None = None
button: mstrio.project_objects.applications.Application.EmailSettings.Button | None = None
content: mstrio.project_objects.applications.Application.EmailSettings.Content | None = None
enabled: bool | None = None
host_portal: str | None = None
reminder: mstrio.project_objects.applications.Application.EmailSettings.Reminder | None = None
sender: mstrio.project_objects.applications.Application.EmailSettings.Sender | None = None
sent_by_text: str | None = None
show_branding_image: bool | None = None
show_browser_button: bool | None = None
show_button_description: bool | None = None
show_mobile_button: bool | None = None
show_reminder: bool | None = None
show_sent_by: bool | None = None
show_social_media: bool | None = None
social_media: mstrio.project_objects.applications.Application.EmailSettings.SocialMedia | None = None
class Environments(current: str | None = None, other: list[mstrio.project_objects.applications.Application.Environments.EnvironmentLink] | None = None)

Bases: Dictable

Environments of the application.

current

name of the current library environment

Type:

str

other

list of other environments

Type:

list[EnvironmentLink]

Bases: Dictable

Environment link settings of the application.

name

name of the environment

Type:

str

url

URL of the environment

Type:

str

name: str | None = None
url: str | None = None
current: str | None = None
other: list[mstrio.project_objects.applications.Application.Environments.EnvironmentLink] | None = None
class GeneralSettings(disable_advanced_settings: bool | None = None, disable_preferences: bool | None = None, network_timeout: int | None = None, cache_clear_mode: int | None = None, clear_cache_on_logout: bool | None = None, max_log_size: int | None = None, log_level: int | None = None, update_interval: int | None = None)

Bases: Dictable

General settings of the application.

disable_advanced_settings

if True, hides advanced settings menu item

Type:

bool

disable_preferences

if True, hides preferences menu item

Type:

bool

network_timeout

network timeout time in seconds

Type:

int

cache_clear_mode

cache clear mode Possible values:

1: automatic 2: on close

Type:

int

clear_cache_on_logout

if True, clears cache on logout

Type:

bool

max_log_size

maximum log size

Type:

int

log_level

log level Possible values:

0: all 10: info 12: warning 14: severe 16: off

Type:

int

update_interval

update interval in minutes

Type:

int

cache_clear_mode: int | None = None
clear_cache_on_logout: bool | None = None
disable_advanced_settings: bool | None = None
disable_preferences: bool | None = None
log_level: int | None = None
max_log_size: int | None = None
network_timeout: int | None = None
update_interval: int | None = None
class HomeSettings(mode: str | None = None, home_document: mstrio.project_objects.applications.Application.HomeSettings.HomeDocument | None = None, home_library: mstrio.project_objects.applications.Application.HomeSettings.HomeLibrary | None = None, theme: mstrio.project_objects.applications.Application.HomeSettings.Theme | None = None)

Bases: Dictable

Home Screen settings of the application.

mode

home screen mode Possible values:

-0: use Library (default) -1: use Dossier/Document -2: use Bot

Type:

str

home_document

home document settings

Type:

HomeDocument

home_library

home library settings

Type:

HomeLibrary

theme

theme settings

Type:

Theme

class HomeDocument(url: str | None = None, home_document_type: str | None = None, icons: list[str] | None = None, toolbar_mode: str | None = None, toolbar_enabled: bool | None = None)

Bases: Dictable

Home Screen as Document settings of the application.

url

URL of the document

Type:

str

home_document_type

home document type Possible values:

-dossier -document

Type:

str

icons

list of icons to be shown on the home screen toolbar Possible values:

-comments -notifications -options -table_of_contents -bookmarks -reset -filters -share -data_search -hyper_intelligence -font_size

Type:

list[str]

toolbar_mode

toolbar mode Possible values:

-0: show toolbar (default) -1: toolbar will be collapsed by default and expanded

by tapping the top right corner icon

Type:

str

toolbar_enabled

whether the toolbar is enabled

Type:

bool

home_document_type: str | None = None
icons: list[str] | None = None
toolbar_enabled: bool | None = None
toolbar_mode: str | None = None
url: str | None = None
class HomeLibrary(content_bundle_ids: list[str] | None = None, show_all_contents: bool | None = None, icons: list[str] | None = None, customized_items: mstrio.project_objects.applications.Application.HomeSettings.HomeLibrary.CustomizedItems | None = None, customized_item_properties: dict | None = None, toolbar_mode: str | None = None, sidebars: list[str] | None = None, toolbar_enabled: bool | None = None, default_groups_name: str | None = None)

Bases: Dictable

Home Screen as Library settings of the application.

content_bundle_ids

list of content bundle IDs that the application is limited to

Type:

list[str]

show_all_contents

whether to show all library contents if the content groups are specified in the application

Type:

bool

icons

list of icons to be shown on the home screen toolbar Possible values:

-comments -notifications -options -table_of_contents -bookmarks -reset -filters -share -data_search -hyper_intelligence -font_size

Type:

list[str]

customized_items

customized settings

Type:

CustomizedItems

customized_item_properties

extra properties of the items that were customized

Type:

dict

toolbar_mode

toolbar mode Possible values:

-0: show toolbar (default) -1: toolbar will be collapsed by default and expanded

by tapping the top right corner icon

Type:

str

sidebars

menus to be shown in the library sidebar Possible values:

-all -favorites -recents -default_groups -my_groups -options

Type:

list[str]

toolbar_enabled

whether the toolbar is enabled

Type:

bool

default_groups_name

customized name for default groups

Type:

str

class CustomizedItems(my_content: bool | None = None, subscriptions: bool | None = None, new_dossier: bool | None = None, edit_dossier: bool | None = None, add_library_server: bool | None = None, data_search: bool | None = None, hyper_intelligence: bool | None = None, font_size: bool | None = None, undo_and_redo: bool | None = None, insights: bool | None = None, content_discovery: bool | None = None, mobile_account_panel_user_name: bool | None = None, mobile_account_panel_preferences_my_language: bool | None = None, mobile_account_panel_preferences_my_time_zone: bool | None = None, mobile_account_panel_preferences_face_id_login: bool | None = None, mobile_account_panel_preferences_take_a_tour: bool | None = None, mobile_account_panel_preferences_refresh_view_automatically: bool | None = None, mobile_account_panel_preferences_smart_download: bool | None = None, mobile_account_panel_preferences_automatically_add_to_library: bool | None = None, mobile_account_panel_advanced_settings_app_settings: bool | None = None, mobile_account_panel_advanced_settings_security_settings: bool | None = None, mobile_account_panel_advanced_settings_logging: bool | None = None, mobile_account_panel_help_and_legal: bool | None = None, mobile_account_panel_help_and_legal_help: bool | None = None, mobile_account_panel_help_and_legal_legal: bool | None = None, mobile_account_panel_help_and_legal_report_a_problem: bool | None = None, mobile_account_panel_log_out: bool | None = None, filter_summary: bool | None = None, share_panel_share: bool | None = None, share_panel_export_to_excel: bool | None = None, share_panel_export_to_pdf: bool | None = None, share_panel_download: bool | None = None, share_panel_subscribe: bool | None = None, share_panel_annotate_and_share: bool | None = None, web_account_panel_user_name: bool | None = None, web_account_panel_my_library: bool | None = None, web_account_panel_manage_library: bool | None = None, web_account_panel_preference: bool | None = None, web_account_panel_preference_my_language: bool | None = None, web_account_panel_preference_my_time_zone: bool | None = None, web_account_panel_switch_workspace: bool | None = None, web_account_panel_take_a_tour: bool | None = None, web_account_panel_help: bool | None = None, web_account_panel_log_out: bool | None = None, mobile_downloads: bool | None = None, table_of_contents_header: bool | None = None, table_of_contents_content_info: bool | None = None, table_of_contents_chapter_and_page: bool | None = None, switch_library_server: bool | None = None, create_new_content_dossier: bool | None = None, create_new_content_report: bool | None = None, layout_tile_view: bool | None = None, layout_list_view: bool | None = None, ai_assistant: bool | None = None, share_panel_manage_access: bool | None = None, bot_window_share_panel: bool | None = None, bot_window_share_panel_share_bot: bool | None = None, bot_window_share_panel_embed_bot: bool | None = None, bot_window_share_panel_manage_access: bool | None = None, bot_window_edit_bot: bool | None = None, create_new_content_bot: bool | None = None, dashboard_view_mode: bool | None = None, content_info_content_creator: bool | None = None, content_info_timestamp: bool | None = None, content_info_description: bool | None = None, content_info_project: bool | None = None, content_info_path: bool | None = None, content_info_object_id: bool | None = None, content_info_info_window: bool | None = None, control_filter_summary: bool | None = None, hide_filter_summary: bool | None = None, sidebars_unpin: bool | None = None, table_of_contents_unpin: bool | None = None, filter_panel_unpin: bool | None = None, comments_panel_unpin: bool | None = None, ai_assistant_unpin: bool | None = None, table_of_contents_allow_close: bool | None = None, filter_panel_allow_close: bool | None = None, comments_panel_allow_close: bool | None = None, ai_assistant_allow_close: bool | None = None)

Bases: Dictable

Customized items settings of the application.

add_library_server: bool | None = None
ai_assistant: bool | None = None
ai_assistant_allow_close: bool | None = None
ai_assistant_unpin: bool | None = None
bot_window_edit_bot: bool | None = None
bot_window_share_panel: bool | None = None
bot_window_share_panel_embed_bot: bool | None = None
bot_window_share_panel_manage_access: bool | None = None
bot_window_share_panel_share_bot: bool | None = None
comments_panel_allow_close: bool | None = None
comments_panel_unpin: bool | None = None
content_discovery: bool | None = None
content_info_content_creator: bool | None = None
content_info_description: bool | None = None
content_info_info_window: bool | None = None
content_info_object_id: bool | None = None
content_info_path: bool | None = None
content_info_project: bool | None = None
content_info_timestamp: bool | None = None
control_filter_summary: bool | None = None
create_new_content_bot: bool | None = None
create_new_content_dossier: bool | None = None
create_new_content_report: bool | None = None
dashboard_view_mode: bool | None = None
edit_dossier: bool | None = None
filter_panel_allow_close: bool | None = None
filter_panel_unpin: bool | None = None
filter_summary: bool | None = None
font_size: bool | None = None
hide_filter_summary: bool | None = None
hyper_intelligence: bool | None = None
insights: bool | None = None
layout_list_view: bool | None = None
layout_tile_view: bool | None = None
mobile_account_panel_advanced_settings_app_settings: bool | None = None
mobile_account_panel_advanced_settings_logging: bool | None = None
mobile_account_panel_advanced_settings_security_settings: bool | None = None
mobile_account_panel_log_out: bool | None = None
mobile_account_panel_preferences_automatically_add_to_library: bool | None = None
mobile_account_panel_preferences_face_id_login: bool | None = None
mobile_account_panel_preferences_my_language: bool | None = None
mobile_account_panel_preferences_my_time_zone: bool | None = None
mobile_account_panel_preferences_refresh_view_automatically: bool | None = None
mobile_account_panel_preferences_smart_download: bool | None = None
mobile_account_panel_preferences_take_a_tour: bool | None = None
mobile_account_panel_user_name: bool | None = None
mobile_downloads: bool | None = None
my_content: bool | None = None
new_dossier: bool | None = None
share_panel_annotate_and_share: bool | None = None
share_panel_download: bool | None = None
share_panel_export_to_excel: bool | None = None
share_panel_export_to_pdf: bool | None = None
share_panel_manage_access: bool | None = None
share_panel_share: bool | None = None
share_panel_subscribe: bool | None = None
sidebars_unpin: bool | None = None
subscriptions: bool | None = None
switch_library_server: bool | None = None
table_of_contents_allow_close: bool | None = None
table_of_contents_chapter_and_page: bool | None = None
table_of_contents_content_info: bool | None = None
table_of_contents_header: bool | None = None
table_of_contents_unpin: bool | None = None
undo_and_redo: bool | None = None
web_account_panel_help: bool | None = None
web_account_panel_log_out: bool | None = None
web_account_panel_manage_library: bool | None = None
web_account_panel_my_library: bool | None = None
web_account_panel_preference: bool | None = None
web_account_panel_preference_my_language: bool | None = None
web_account_panel_preference_my_time_zone: bool | None = None
web_account_panel_switch_workspace: bool | None = None
web_account_panel_take_a_tour: bool | None = None
web_account_panel_user_name: bool | None = None
content_bundle_ids: list[str] | None = None
customized_item_properties: dict | None = None
customized_items: mstrio.project_objects.applications.Application.HomeSettings.HomeLibrary.CustomizedItems | None = None
default_groups_name: str | None = None
icons: list[str] | None = None
show_all_contents: bool | None = None
sidebars: list[str] | None = None
toolbar_enabled: bool | None = None
toolbar_mode: str | None = None
class Theme(logos: mstrio.project_objects.applications.Application.HomeSettings.Theme.Logos | None = None, color: mstrio.project_objects.applications.Application.HomeSettings.Theme.Color | None = None)

Bases: Dictable

Theme settings of the application.

logos

logos settings

Type:

Logos

color

color settings

Type:

Color

class Color(selected_theme: str | None = None, formatting: mstrio.project_objects.applications.Application.HomeSettings.Theme.Color.Formatting | None = None, enable_for_bots: bool | None = None)

Bases: Dictable

Color settings of the application.

selected_theme

selected theme Possible values:

-useSystemSettings -light -dark -red -green -blue -darkBlue -yellow -custom

Type:

str

formatting

formatting settings

Type:

Formatting

enable_for_bots

whether the theme is enabled for bots

Type:

bool

class Formatting(toolbar_fill: str | None = None, toolbar_color: str | None = None, sidebar_fill: str | None = None, sidebar_color: str | None = None, sidebar_active_fill: str | None = None, sidebar_active_color: str | None = None, panel_fill: str | None = None, panel_color: str | None = None, accent_fill: str | None = None, notification_badge_fill: str | None = None, button_color: str | None = None, canvas_fill: str | None = None)

Bases: Dictable

Formatting settings of the application. All color values are in hex format.

toolbar_fill

toolbar background color

Type:

str

toolbar_color

toolbar icon/text color

Type:

str

sidebar_fill

sidebar background color

Type:

str

sidebar_color

sidebar text color

Type:

str

sidebar_active_fill

active sidebar background color

Type:

str

sidebar_active_color

active sidebar text color

Type:

str

panel_fill

panel background color

Type:

str

panel_color

panel text color

Type:

str

accent_fill

accent fill color

Type:

str

notification_badge_fill

notification badge color

Type:

str

button_color

button color

Type:

str

canvas_fill

canvas background color

Type:

str

accent_fill: str | None = None
button_color: str | None = None
canvas_fill: str | None = None
notification_badge_fill: str | None = None
panel_color: str | None = None
panel_fill: str | None = None
sidebar_active_color: str | None = None
sidebar_active_fill: str | None = None
sidebar_color: str | None = None
sidebar_fill: str | None = None
toolbar_color: str | None = None
toolbar_fill: str | None = None
enable_for_bots: bool | None = None
formatting: mstrio.project_objects.applications.Application.HomeSettings.Theme.Color.Formatting | None = None
selected_theme: str | None = None
class Logos(web: mstrio.project_objects.applications.Application.HomeSettings.Theme.Logos.Logo | None = None, favicon: mstrio.project_objects.applications.Application.HomeSettings.Theme.Logos.Logo | None = None, mobile: mstrio.project_objects.applications.Application.HomeSettings.Theme.Logos.Logo | None = None)

Bases: Dictable

Logos settings of the application.

web

web logo settings

Type:

Logo

favicon

favorite icon settings

Type:

Logo

mobile

mobile logo settings

Type:

Logo

Bases: Dictable

Details of a logo.

type

type of the logo

Type:

str

value

value of the logo

Type:

str

type: str | None = None
value: str | None = None
favicon: mstrio.project_objects.applications.Application.HomeSettings.Theme.Logos.Logo | None = None
mobile: mstrio.project_objects.applications.Application.HomeSettings.Theme.Logos.Logo | None = None
web: mstrio.project_objects.applications.Application.HomeSettings.Theme.Logos.Logo | None = None
color: mstrio.project_objects.applications.Application.HomeSettings.Theme.Color | None = None
logos: mstrio.project_objects.applications.Application.HomeSettings.Theme.Logos | None = None
home_document: mstrio.project_objects.applications.Application.HomeSettings.HomeDocument | None = None
home_library: mstrio.project_objects.applications.Application.HomeSettings.HomeLibrary | None = None
mode: str | None = None
theme: mstrio.project_objects.applications.Application.HomeSettings.Theme | None = None
alter(home_screen: mstrio.project_objects.applications.Application.HomeSettings | None = None, name: str | None = None, description: str | None = None, managed: bool | None = None, general: mstrio.project_objects.applications.Application.GeneralSettings | None = None, platforms: list[str] | None = None, application_palettes: list[str] | None = None, application_default_palette: str | None = None, show_builtin_palettes: bool | None = None, is_default: bool | None = None, use_config_palettes: bool | None = None, email_settings: mstrio.project_objects.applications.Application.EmailSettings | None = None, ai_settings: mstrio.project_objects.applications.Application.AiSettings | None = None, auth_modes: mstrio.project_objects.applications.Application.AuthModes | None = None, environments: mstrio.project_objects.applications.Application.Environments | None = None, application_nuggets: list[str] | None = None) → None

Alter an application.

Parameters:

  • home_screen (Application.HomeSettings, optional) – home screen settings of the application

  • name (str, optional) – name of the application

  • description (str, optional) – description of the application

  • managed (bool, optional) – whether the application is managed

  • general (Application.GeneralSettings, optional) – general settings of the application

  • platforms (list[str], optional) –

    list of platforms for the application Available values:

    -web -mobile -desktop

  • application_palettes (list[str], optional) – list of customized application palettes

  • application_default_palette (str, optional) – default application palette

  • show_builtin_palettes (bool, optional) – whether to show built-in palettes

  • is_default (bool, optional) – whether the application configuration is default

  • use_config_palettes (bool, optional) – whether to use default configuration of palettes

  • email_settings (Application.EmailSettings, optional) – email settings of the application

  • ai_settings (Application.AiSettings, optional) – AI settings of the application

  • auth_modes (Application.AuthModes, optional) – authentication modes of the application

  • environments (Application.Environments, optional) – environments of the application

  • application_nuggets (list[str], optional) – list of application nuggets

classmethod create(connection: Connection, name: str, home_screen: HomeSettings, description: str | None = None, managed: bool | None = None, general: mstrio.project_objects.applications.Application.GeneralSettings | None = None, platforms: list[str] | None = None, application_palettes: list[str] | None = None, application_default_palette: str | None = None, show_builtin_palettes: bool | None = None, is_default: bool | None = None, use_config_palettes: bool | None = None, email_settings: mstrio.project_objects.applications.Application.EmailSettings | None = None, ai_settings: mstrio.project_objects.applications.Application.AiSettings | None = None, auth_modes: mstrio.project_objects.applications.Application.AuthModes | None = None, environments: mstrio.project_objects.applications.Application.Environments | None = None, application_nuggets: list[str] | None = None) → Application

Create a new application.

Parameters:

  • connection (Connection) – MicroStrategy connection object returned by connection.Connection()

  • name (str) – name of the application

  • home_screen (Application.HomeSettings) – home screen settings of the application

  • description (str, optional) – description of the application

  • managed (bool, optional) – whether the application is managed

  • general (Application.GeneralSettings, optional) – general settings of the application

  • platforms (list[str], optional) –

    list of platforms for the application Available values:

    -web -mobile -desktop

  • application_palettes (list[str], optional) – list of customized application palettes

  • application_default_palette (str, optional) – default application palette

  • show_builtin_palettes (bool, optional) – whether to show built-in palettes

  • is_default (bool, optional) – whether the application configuration is default

  • use_config_palettes (bool, optional) – whether to use default configuration of palettes

  • email_settings (Application.EmailSettings, optional) – email settings of the application

  • ai_settings (Application.AiSettings, optional) – AI settings of the application

  • auth_modes (Application.AuthModes, optional) – authentication modes of the application

  • environments (Application.Environments, optional) – environments of the application

  • application_nuggets (list[str], optional) – list of application nuggets

Returns:

The created Application object.

mstrio.project_objects.applications.list_applications(connection: Connection, to_dictionary: dict = False, limit: int | None = None, name: str | None = None) → list[mstrio.project_objects.applications.Application] | list[dict]

Get list of available Applications.

Parameters:

  • connection (Connection) – MicroStrategy connection object returned by connection.Connection()

  • to_dictionary (bool, optional) – if True, return Applications as a list of dicts

  • limit (int, optional) – Limit the number of elements returned

  • name (str, optional) – filter for applications with names containing this value

Returns:

List of Application objects or list of dictionaries containing application properties.

mstrio.project_objects.bots module

class mstrio.project_objects.bots.Bot(connection: Connection, name: str | None = None, id: str | None = None)

Bases: Entity, CertifyMixin, CopyMixin, DeleteMixin, MoveMixin, TranslationMixin

Python representation of a MicroStrategy Bot object

alter(name: str | None = None, description: str | None = None, abbreviation: str | None = None, folder_id: str | None = None, folder_path: str | None = None, hidden: bool | None = None, status: str | None = None, comments: str | None = None) → None

Alter the Bot.

Parameters:

  • name (str, optional) – New name for the bot

  • description (str, optional) – New description for the bot

  • abbreviation (str, optional) – New abbreviation for the bot

  • folder_id (str, optional) – ID of the folder where the bot should be moved to

  • folder_path (str, optional) – Path to the folder where the bot should be moved to, optional instead of folder ID

  • hidden (bool, optional) – Hidden status of the bot

  • status (str, optional) – Status of the bot Can be either enabled or disabled

  • comments (str, optional) – New long description for the bot

disable() → None

Disable the bot.

enable() → None

Enable the bot.

mstrio.project_objects.bots.list_bots(connection: Connection, name: str | None = None, to_dictionary: bool = False, limit: int | None = None, project_id: str | None = None, project_name: str | None = None, **filters) → list[mstrio.project_objects.bots.Bot] | list[dict]

Get a list of bots.

Parameters:

  • connection (Connection) – MicroStrategy connection object returned by ‘connection.Connection()’

  • name (str, optional) – characters that the dashboard name must contain

  • to_dictionary (bool, optional) – if True, return Bots as a list of dicts

  • limit (int, optional) – limit the number of elements returned. If None (default), all objects are returned.

  • project_id (str, optional) – Project ID

  • project_name (str, optional) – Project name

  • **filters – Available filter parameters: [‘name’, ‘id’, ‘type’, ‘subtype’, ‘date_created’, ‘date_modified’, ‘version’, ‘owner’, ‘ext_type’, ‘view_media’, ‘certified_info’]

Returns:

A list of bot objects or dictionaries.

mstrio.project_objects.content_cache module

class mstrio.project_objects.content_cache.ContentCache(connection: Connection, id: str, content_cache_dict: dict | None = None)

Bases: Cache, ContentCacheMixin

Manage content cache.

_CACHE_TYPE is a variable used by ContentCache class for cache filtering purposes.

delete(force: bool | None = None) → requests.models.Response | None

Delete content cache.

Parameters:

force (bool, optional) – If True, then no additional prompt will be shown before deleting object.

Returns:

Response object.

fetch() → None

Fetches the cache from the server, refreshing the variables to match those currently stored on the server.

classmethod from_dict(connection: Connection, caches: list[dict]) → list[mstrio.project_objects.content_cache.ContentCache]

Creates Caches from a provided dictionary.

Parameters:

  • cls (object) – Class type for objects to be created

  • connection (Connection) – MicroStrategy connection object returned by connection.Connection()

  • caches (list[dict]) – list of dictionaries the Caches will be created from

Returns:

List of Caches created from the provided dictionaries.

list_properties() → dict

List properties for content cache.

load() → bool

Load content cache.

unload() → bool

Unload content cache.

class mstrio.project_objects.content_cache.ContentCacheFormat(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: AutoName

BINARY_DATA = 'binary_data'
BINARY_DEFINITION = 'binary_definition'
CSV = 'csv'
EXCEL = 'excel'
FLASH = 'flash'
HTML = 'html'
HTML5 = 'html5'
PDF = 'pdf'
PLAIN_TEXT = 'plain_text'
TRANSACTION = 'transaction'
XML = 'xml'
class mstrio.project_objects.content_cache.ContentCacheStatus(ready: bool, processing: bool, invalid: bool, expired: bool, loaded: bool, filed: bool, dirty: bool)

Bases: Dictable

dirty: bool
expired: bool
filed: bool
invalid: bool
loaded: bool
processing: bool
ready: bool

mstrio.project_objects.content_group module

class mstrio.project_objects.content_group.ContentGroup(connection: Connection, name: str | None = None, id: str | None = None)

Bases: Entity, CopyMixin, DeleteMixin, TranslationMixin

Python representation of a MicroStrategy Content Group object

alter(name: str | None = None, color: str | None = None, opacity: int | None = None, email_enabled: bool | None = None, recipients: list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]] | None = None) → None

Alter the content group.

Parameters:

  • name (str, optional) – name of the content group

  • color (str, optional) – color of the content group, in hex format example ‘#ffe4e1’ for misty rose pink

  • opacity (int, optional) – opacity percentage of the content group expressed in an int, ranges from 0-100, default is 100

  • email_enabled (bool, optional) – if True recipients will be notified about new content in this group via email

  • recipients (list, optional) – list of recipients of the content group represented as str containing ID or the User and UserGroup class objects

classmethod create(connection: Connection, name: str, color: str, opacity: int = 100, email_enabled: bool = False, recipients: list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]] | None = None) → ContentGroup

Create a new content group.

Parameters:

  • connection (Connection) – MicroStrategy connection object returned by connection.Connection()

  • name (str) – name of the content group

  • color (str, optional) – color of the content group, in hex format example ‘#ffe4e1’ for misty rose pink

  • opacity (int, optional) – opacity percentage of the content group expressed in an int, ranges from 0-100, default is 100

  • email_enabled (bool, optional) – if True recipients will be notified about new content in this group via email, defaults to False

  • recipients (list, optional) – list of recipients of the content group represented as str containing ID or the User and UserGroup class objects

Returns:

ContentGroup object

get_contents(project_ids: list[str | mstrio.server.project.Project]) → list[mstrio.utils.entity.Entity]

Get contents of the content group.

Parameters:

project_ids (list) – list of project IDs or Projects to search for contents

Returns:

A list of content objects.

update_contents(content_to_add: list[mstrio.utils.entity.Entity] | None = None, content_to_remove: list[mstrio.utils.entity.Entity] | None = None) → None

Update contents of the content group.

Parameters:

  • content_to_add (list, optional) – list of content objects to add to the content group. Provided as a list of Entity-based objects. Supported content types: Bot, Dashboard, Document, Report

  • content_to_remove (list. optional) – list of content objects to remove from the content group. Provided as a list of Entity-based objects.

mstrio.project_objects.content_group.list_content_groups(connection: Connection, to_dictionary: bool = False, limit: int | None = None, name: str | None = None) → list[mstrio.project_objects.content_group.ContentGroup] | list[dict]

Get a list of content groups.

Parameters:

  • connection (Connection) – MicroStrategy connection object returned by ‘connection.Connection()’

  • to_dictionary (bool, optional) – if True, return Content Groups as a list of dicts

  • limit (int, optional) – limit the number of elements returned

  • name (str, optional) – filter for content groups with names containing this value

Returns:

A list of content group objects or dictionaries representing them.

mstrio.project_objects.dashboard module

class mstrio.project_objects.dashboard.ChapterPage(key: str, visualizations: list[mstrio.project_objects.dashboard.PageVisualization], name: str | None = None, selectors: list[mstrio.project_objects.dashboard.PageSelector] | None = None)

Bases: Dictable

Object that describes a Chapter Page

key

key/id of the page

Type:

string

visualizations

list of visualizations on the page

Type:

list[PageVisualization]

name

name of the page

Type:

string, optional

selectors

list of selectors on the page

Type:

list[PageSelector], optional

key: str
list_properties(camel_case=True) → dict

Lists properties of dashboard chapter page.

name: str | None = None
selectors: list[mstrio.project_objects.dashboard.PageSelector] | None = None
visualizations: list[mstrio.project_objects.dashboard.PageVisualization]
class mstrio.project_objects.dashboard.Dashboard(connection: Connection, name: str | None = None, id: str | None = None)

Bases: Document

alter(name: str | None = None, description: str | None = None, folder_id: mstrio.object_management.folder.Folder | str | None = None, hidden: bool | None = None)

Alter Dashboard name, description and/or folder id.

Parameters:

  • name (string, optional) – new name of the Dashboard

  • description (string, optional) – new description of the Dashboard

  • folder_id (string | Folder, optional) – A globally unique identifier used to distinguish between metadata objects within the same project. It is possible for two metadata objects in different projects to have the same Object Id.

  • hidden (bool, optional) – specifies whether the dashboard is hidden

list_properties() → dict

List properties for the dashboard.

publish(recipients: Optional[Union[str, User, UserGroup, list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]]]] = None)

Publish the dashboard for authenticated user. If recipients parameter is specified publishes the dashboard for the given users.

Parameters:

recipients (UserOrGroup | list[UserOrGroup], optional) – list of users or user groups to publish the dashboard to (can be a list of IDs or a list of User and UserGroup elements)

share_to(users: Union[str, User, UserGroup, list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]]])

Shares the dashboard to the listed users’ libraries.

Parameters:

users (UserOrGroup | list[UserOrGroup]) – list of users or user groups to publish the dashboard to (can be a list of IDs or a list of User and UserGroup elements).

unpublish(recipients: Optional[Union[str, User, UserGroup, list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]]]] = None)

Unpublish the dashboard for all users it was previously published to. If recipients parameter is specified unpublishes the dashboard for the given users.

Parameters:

recipients (UserOrGroup | list[UserOrGroup], optional) – list of users or user groups to publish the dashboard to (can be a list of IDs or a list of User and UserGroup elements)

class mstrio.project_objects.dashboard.DashboardChapter(key: str, pages: list[mstrio.project_objects.dashboard.ChapterPage], name: str | None = None, filters: list[dict] | None = None)

Bases: Dictable

Object that describes a Dashboard Chapter

key

key/id of the chapter

Type:

string

pages

list of the chapter pages

Type:

list[ChapterPage]

name

name of the chapter

Type:

string, optional

filters

(dict, optional): filters for the chapter

Type:

list[dict] | None

filters: list[dict] | None = None
key: str
list_properties(camel_case=True) → dict

Lists properties of dashboard chapter.

name: str | None = None
pages: list[mstrio.project_objects.dashboard.ChapterPage]
class mstrio.project_objects.dashboard.PageSelector(key: str, selector_type: str, current_selection: dict, source: dict | None = None, multi_selection_allowed: bool = False, has_all_option: bool = False, display_style: str | None = None, available_object_items: list[dict] | None = None, targets: list[dict] | None = None, name: str | None = None, summary: str | None = None)

Bases: Dictable

Object that describes a Page Selector

key

key/id of the selector

Type:

string

selector_type

type of the selector

Type:

string

current_selection

current selection of the selector

Type:

dict

source

source of the selector

Type:

dict, optional

multi_selection_allowed

whether multi selection is allowed, defaults to False

Type:

bool

has_all_option

whether the selector has all options enabled, defaults to False

Type:

bool

display_style

style of the selector display

Type:

string, optional

available_object_items

list of objects available for the selector

Type:

list[dict], optional

targets

list of targets of the selector

Type:

list[dict], optional

name

name of the selector

Type:

string, optional

summary

summary of the selector

Type:

string, optional

available_object_items: list[dict] | None = None
current_selection: dict
display_style: str | None = None
has_all_option: bool = False
key: str
list_properties(camel_case=True) → dict

Lists properties of page selector.

multi_selection_allowed: bool = False
name: str | None = None
selector_type: str
source: dict | None = None
summary: str | None = None
targets: list[dict] | None = None
class mstrio.project_objects.dashboard.PageVisualization(key: str, visualization_type: str | None = None, name: str | None = None, selector: mstrio.project_objects.dashboard.VisualizationSelector | None = None)

Bases: Dictable

Object that describes a Visualization on a Page

key

key/id of the visualization

Type:

string

visualization_type

type of the visualization

Type:

string, optional

name

name of the visualization

Type:

string, optional

selector

selector for the visualization

Type:

VisualizationSelector, optional

key: str
list_properties(camel_case=True) → dict

Lists properties of page visualization.

name: str | None = None
selector: mstrio.project_objects.dashboard.VisualizationSelector | None = None
visualization_type: str | None = None
class mstrio.project_objects.dashboard.VisualizationSelector(visualization_key: str, selector_type: str, current_selection: dict, targets: list[dict] | None = None)

Bases: Dictable

Object that describes a Visualization Selector

visualization_key

key/id of the selector

Type:

string

selector_type

type of the selector

Type:

string

current_selection

current selection of the selector

Type:

dict

targets

list of the selector’s targets

Type:

list[dict], optional

current_selection: dict
list_properties(camel_case=True) → dict

Lists properties of visualization selector.

selector_type: str
targets: list[dict] | None = None
visualization_key: str
mstrio.project_objects.dashboard.list_dashboards(connection: Connection, name: str | None = None, to_dictionary: bool = False, to_dataframe: bool = False, limit: int | None = None, project_id: str | None = None, project_name: str | None = None, **filters) → list[mstrio.project_objects.dashboard.Dashboard] | list[dict] | pandas.core.frame.DataFrame

Get all Dashboards stored on the server.

Optionally use to_dictionary or to_dataframe to choose output format. If to_dictionary is True, to_dataframe is omitted.

Parameters:

  • connection (object) – MicroStrategy connection object returned by ‘connection.Connection()’

  • name – characters that the dashboard name must contain

  • to_dictionary (bool, optional) – if True, return Dashboards as list of dicts

  • to_dataframe (bool, optional) – if True, return Dashboards as pandas DataFrame

  • limit (int) – limit the number of elements returned. If None (default), all objects are returned.

  • project_id (str, optional) – Project ID

  • project_name (str, optional) – Project name

  • **filters – Available filter parameters: [‘name’, ‘id’, ‘type’, ‘subtype’, ‘date_created’, ‘date_modified’, ‘version’, ‘acg’, ‘owner’, ‘ext_type’, ‘view_media’, ‘certified_info’, ‘project_id’]

Returns:

List of dashboards or list of dictionaries or DataFrame object

mstrio.project_objects.dashboard.list_dashboards_across_projects(connection: Connection, name: str | None = None, to_dictionary: bool = False, to_dataframe: bool = False, limit: int | None = None, **filters) → list[mstrio.project_objects.dashboard.Dashboard] | list[dict] | pandas.core.frame.DataFrame

Get all Dashboards stored on the server.

Optionally use to_dictionary or to_dataframe to choose output format. If to_dictionary is True, to_dataframe is omitted.

Parameters:

  • connection (object) – MicroStrategy connection object returned by ‘connection.Connection()’

  • name – characters that the dashboard name must contain

  • to_dictionary (bool, optional) – if True, return Dashboards as list of dicts

  • to_dataframe (bool, optional) – if True, return Dashboards as pandas DataFrame

  • limit – limit the number of elements returned. If None (default), all objects are returned.

  • **filters – Available filter parameters: [‘name’, ‘id’, ‘type’, ‘subtype’, ‘date_created’, ‘date_modified’, ‘version’, ‘acg’, ‘owner’, ‘ext_type’, ‘view_media’, ‘certified_info’, ‘project_id’]

Returns:

List of dashboards or list of dictionaries or DataFrame object

mstrio.project_objects.document module

class mstrio.project_objects.document.Document(connection: Connection, name: str | None = None, id: str | None = None)

Bases: Entity, VldbMixin, CopyMixin, MoveMixin, DeleteMixin, ContentCacheMixin, TranslationMixin

Python representation of MicroStrategy Document object

_CACHE_TYPE is a variable used by ContentCache class for cache filtering purposes.

alter(name: str | None = None, description: str | None = None, folder_id: mstrio.object_management.folder.Folder | str | None = None, hidden: bool | None = None)

Alter Document name, description and/or folder id.

Parameters:

  • name (string, optional) – new name of the Document

  • description (string, optional) – new description of the Document

  • folder_id (string | Folder, optional) – A globally unique identifier used to distinguish between metadata objects within the same project. It is possible for two metadata objects in different projects to have the same Object ID.

  • hidden – Specifies whether the document is hidden

get_connected_cubes() → list[mstrio.project_objects.datasets.super_cube.SuperCube | mstrio.project_objects.datasets.olap_cube.OlapCube]

Lists cubes used by this document.

Returns:

A list of cubes used by the document.

list_available_schedules(to_dictionary: bool = False) → list[mstrio.distribution_services.schedule.schedule.Schedule] | list[dict]

Get a list of schedules available for the object instance.

Parameters:

to_dictionary (bool, optional) – If True returns a list of dictionaries, otherwise returns a list of Schedules. False by default.

Returns:

List of Schedule objects or list of dictionaries.

list_properties()

List properties for the document.

Returns:

A list of all document properties.

publish(recipients: Optional[Union[str, User, UserGroup, list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]]]] = None)

Publish the document for authenticated user. If recipients parameter is specified publishes the document for the given users.

Parameters:

recipients (UserOrGroup | list[UserOrGroup], optional) – list of users or user groups to publish the document to (can be a list of IDs or a list of User and UserGroup elements)

share_to(users: Union[str, User, UserGroup, list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]]])

Shares the document to the listed users’ libraries.

Parameters:

users (UserOrGroup | list[UserOrGroup]) – list of users or user groups to publish the document to (can be a list of IDs or a list of User and UserGroup elements).

unpublish(recipients: Optional[Union[str, User, UserGroup, list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]]]] = None)

Unpublish the document for all users it was previously published to. If recipients parameter is specified unpublishes the document for the given users.

Parameters:

recipients (UserOrGroup | list[UserOrGroup], optional) – list of users or user groups to publish the document to (can be a list of IDs or a list of User and UserGroup elements)

mstrio.project_objects.document.list_documents(connection: Connection, to_dictionary: bool = False, to_dataframe: bool = False, limit: int | None = None, name: str | None = None, project_id: str | None = None, project_name: str | None = None, **filters) → list[mstrio.project_objects.document.Document] | list[dict] | pandas.core.frame.DataFrame

Get all Documents available in the project specified within the connection object.

Optionally use to_dictionary or to_dataframe to choose output format. If to_dictionary is True, to_dataframe is omitted.

Parameters:

  • connection (Connection) – MicroStrategy connection object returned by ‘connection.Connection()’

  • to_dictionary (bool, optional) – if True, return Documents as list of dicts

  • to_dataframe (bool, optional) – if True, return Documents as pandas DataFrame

  • limit (int, optional) – limit the number of elements returned. If None (default), all objects are returned.

  • name (str, optional) – characters that the document name must contain

  • project_id (str, optional) – Project ID

  • project_name (str, optional) – Project name

  • **filters – Available filter parameters: [‘name’, ‘id’, ‘type’, ‘subtype’, ‘date_created’, ‘date_modified’, ‘version’, ‘acg’, ‘owner’, ‘ext_type’, ‘view_media’, ‘certified_info’, ‘project_id’]

Returns:

List of documents or list of dictionaries or DataFrame object

mstrio.project_objects.document.list_documents_across_projects(connection: Connection, name: str | None = None, to_dictionary: bool = False, to_dataframe: bool = False, limit: int | None = None, **filters) → list[mstrio.project_objects.document.Document] | list[dict] | pandas.core.frame.DataFrame

Get all Documents stored on the server.

Optionally use to_dictionary or to_dataframe to choose output format. If to_dictionary is True, to_dataframe is omitted.

Parameters:

  • connection (Connection) – MicroStrategy connection object returned by ‘connection.Connection()’

  • name (string, optional) – characters that the document name must contain

  • to_dictionary (bool, optional) – if True, return Documents as list of dicts

  • to_dataframe (bool, optional) – if True, return Documents as pandas DataFrame

  • limit (int, optional) – limit the number of elements returned. If None (default), all objects are returned.

  • **filters – Available filter parameters: [‘name’, ‘id’, ‘type’, ‘subtype’, ‘date_created’, ‘date_modified’, ‘version’, ‘acg’, ‘owner’, ‘ext_type’, ‘view_media’, ‘certified_info’, ‘project_id’]

Returns:

List of documents or list of dictionaries or DataFrame object

mstrio.project_objects.dossier module

class mstrio.project_objects.dossier.ChapterPage(key: str, visualizations: list[mstrio.project_objects.dossier.PageVisualization], name: str | None = None, selectors: list[mstrio.project_objects.dossier.PageSelector] | None = None)

Bases: Dictable

Object that describes a Chapter Page

key

key/id of the page

Type:

string

visualizations

list of visualizations on the page

Type:

list[PageVisualization]

name

name of the page

Type:

string, optional

selectors

list of selectors on the page

Type:

list[PageSelector], optional

key: str
list_properties(camel_case=True) → dict

Lists properties of dossier chapter page.

name: str | None = None
selectors: list[mstrio.project_objects.dossier.PageSelector] | None = None
visualizations: list[mstrio.project_objects.dossier.PageVisualization]
class mstrio.project_objects.dossier.Dossier(connection: Connection, name: str | None = None, id: str | None = None)

Bases: Document

alter(name: str | None = None, description: str | None = None, folder_id: mstrio.object_management.folder.Folder | str | None = None, hidden: bool | None = None)

Alter Dossier name, description and/or folder id.

Parameters:

  • name (string, optional) – new name of the Dossier

  • description (string, optional) – new description of the Dossier

  • folder_id (string | Folder, optional) – A globally unique identifier used to distinguish between metadata objects within the same project. It is possible for two metadata objects in different projects to have the same Object Id.

  • hidden (bool, optional) – specifies whether the dossier is hidden

list_properties() → dict

List properties for the dossier.

publish(recipients: Optional[Union[str, User, UserGroup, list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]]]] = None)

Publish the dossier for authenticated user. If recipients parameter is specified publishes the dossier for the given users.

Parameters:

recipients (UserOrGroup | list[UserOrGroup], optional) – list of users or user groups to publish the dossier to (can be a list of IDs or a list of User and UserGroup elements)

share_to(users: Union[str, User, UserGroup, list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]]])

Shares the dossier to the listed users’ libraries.

Parameters:

users (UserOrGroup | list[UserOrGroup]) – list of users or user groups to publish the dossier to (can be a list of IDs or a list of User and UserGroup elements).

unpublish(recipients: Optional[Union[str, User, UserGroup, list[Union[str, mstrio.users_and_groups.user.User, mstrio.users_and_groups.user_group.UserGroup]]]] = None)

Unpublish the dossier for all users it was previously published to. If recipients parameter is specified unpublishes the dossier for the given users.

Parameters:

recipients (UserOrGroup | list[UserOrGroup], optional) – list of users or user groups to publish the dossier to (can be a list of IDs or a list of User and UserGroup elements)

class mstrio.project_objects.dossier.DossierChapter(key: str, pages: list[mstrio.project_objects.dossier.ChapterPage], name: str | None = None, filters: list[dict] | None = None)

Bases: Dictable

Object that describes a Dossier Chapter

key

key/id of the chapter

Type:

string

pages

list of the chapter pages

Type:

list[ChapterPage]

name

name of the chapter

Type:

string, optional

filters

(dict, optional): filters for the chapter

Type:

list[dict] | None

filters: list[dict] | None = None
key: str
list_properties(camel_case=True) → dict

Lists properties of dossier chapter.

name: str | None = None
pages: list[mstrio.project_objects.dossier.ChapterPage]
class mstrio.project_objects.dossier.PageSelector(key: str, selector_type: str, current_selection: dict, source: dict | None = None, multi_selection_allowed: bool = False, has_all_option: bool = False, display_style: str | None = None, available_object_items: list[dict] | None = None, targets: list[dict] | None = None, name: str | None = None, summary: str | None = None)

Bases: Dictable

Object that describes a Page Selector

key

key/id of the selector

Type:

string

selector_type

type of the selector

Type:

string

current_selection

current selection of the selector

Type:

dict

source

source of the selector

Type:

dict, optional

multi_selection_allowed

whether multi selection is allowed, defaults to False

Type:

bool

has_all_option

whether the selector has all options enabled, defaults to False

Type:

bool

display_style

style of the selector display

Type:

string, optional

available_object_items

list of objects available for the selector

Type:

list[dict], optional

targets

list of targets of the selector

Type:

list[dict], optional

name

name of the selector

Type:

string, optional

summary

summary of the selector

Type:

string, optional

available_object_items: list[dict] | None = None
current_selection: dict
display_style: str | None = None
has_all_option: bool = False
key: str
list_properties(camel_case=True) → dict

Lists properties of page selector.

multi_selection_allowed: bool = False
name: str | None = None
selector_type: str
source: dict | None = None
summary: str | None = None
targets: list[dict] | None = None
class mstrio.project_objects.dossier.PageVisualization(key: str, visualization_type: str | None = None, name: str | None = None, selector: mstrio.project_objects.dossier.VisualizationSelector | None = None)

Bases: Dictable

Object that describes a Visualization on a Page

key

key/id of the visualization

Type:

string

visualization_type

type of the visualization

Type:

string, optional

name

name of the visualization

Type:

string, optional

selector

selector for the visualization

Type:

VisualizationSelector, optional

key: str
list_properties(camel_case=True) → dict

Lists properties of page visualization.

name: str | None = None
selector: mstrio.project_objects.dossier.VisualizationSelector | None = None
visualization_type: str | None = None
class mstrio.project_objects.dossier.VisualizationSelector(visualization_key: str, selector_type: str, current_selection: dict, targets: list[dict] | None = None)

Bases: Dictable

Object that describes a Visualization Selector

visualization_key

key/id of the selector

Type:

string

selector_type

type of the selector

Type:

string

current_selection

current selection of the selector

Type:

dict

targets

list of the selector’s targets

Type:

list[dict], optional

current_selection: dict
list_properties(camel_case=True) → dict

Lists properties of visualization selector.

selector_type: str
targets: list[dict] | None = None
visualization_key: str
mstrio.project_objects.dossier.list_dossiers(connection: Connection, name: str | None = None, to_dictionary: bool = False, to_dataframe: bool = False, limit: int | None = None, project_id: str | None = None, project_name: str | None = None, **filters) → list[mstrio.project_objects.dossier.Dossier] | list[dict] | pandas.core.frame.DataFrame

Get all Dossiers stored on the server.

Optionally use to_dictionary or to_dataframe to choose output format. If to_dictionary is True, to_dataframe is omitted.

Parameters:

  • connection (object) – MicroStrategy connection object returned by ‘connection.Connection()’

  • name – characters that the dossier name must contain

  • to_dictionary (bool, optional) – if True, return Dossiers as list of dicts

  • to_dataframe (bool, optional) – if True, return Dossiers as pandas DataFrame

  • limit (int) – limit the number of elements returned. If None (default), all objects are returned.

  • project_id (str, optional) – Project ID

  • project_name (str, optional) – Project name

  • **filters – Available filter parameters: [‘name’, ‘id’, ‘type’, ‘subtype’, ‘date_created’, ‘date_modified’, ‘version’, ‘acg’, ‘owner’, ‘ext_type’, ‘view_media’, ‘certified_info’, ‘project_id’]

Returns:

List of dossiers or list of dictionaries or DataFrame object

mstrio.project_objects.dossier.list_dossiers_across_projects(connection: Connection, name: str | None = None, to_dictionary: bool = False, to_dataframe: bool = False, limit: int | None = None, **filters) → list[mstrio.project_objects.dossier.Dossier] | list[dict] | pandas.core.frame.DataFrame

Get all Dossiers stored on the server.

Optionally use to_dictionary or to_dataframe to choose output format. If to_dictionary is True, to_dataframe is omitted.

Parameters:

  • connection (object) – MicroStrategy connection object returned by ‘connection.Connection()’

  • name – characters that the dossier name must contain

  • to_dictionary (bool, optional) – if True, return Dossiers as list of dicts

  • to_dataframe (bool, optional) – if True, return Dossiers as pandas DataFrame

  • limit – limit the number of elements returned. If None (default), all objects are returned.

  • **filters – Available filter parameters: [‘name’, ‘id’, ‘type’, ‘subtype’, ‘date_created’, ‘date_modified’, ‘version’, ‘acg’, ‘owner’, ‘ext_type’, ‘view_media’, ‘certified_info’, ‘project_id’]

Returns:

List of dossiers or list of dictionaries or DataFrame object

mstrio.project_objects.library module

class mstrio.project_objects.library.Library(connection: Connection, project_id: str | None = None, project_name: str | None = None)

Bases: object

publish(contents: Union[list, Dashboard, Document, Dossier, str])

Publishes dashboard, dossier or document to the authenticated user’s library.

contents: dashboards, dossiers or documents to be published,

can be Dashboard/Dossier/Document class object or ID

unpublish(contents: Union[list, Dashboard, Document, Dossier, str])

Publishes dashboard, dossier or document to the authenticated user’s library.

contents: dashboards, dossiers or documents to be published,

can be Dashboard/Dossier/Document class object or ID

mstrio.project_objects.prompt module

class mstrio.project_objects.prompt.Prompt(type: str, answers: Any | list[Any], key: str | None = None, id: str | None = None, name: str | None = None, use_default: bool = False)

Bases: Dictable

A MicroStrategy class representing a prompt.

type

Type of the prompt Possible values are:

  • UNSUPPORTED

  • VALUE

  • ELEMENTS

  • EXPRESSION

  • OBJECTS

  • LEVEL

Type:

str

answers

Singular answer or list of answers to the prompt.

Type:

Any | list[Any]

key

Unique key of the prompt.

Type:

str, optional

id

ID of the prompt.

Type:

str, optional

name

Name of the prompt.

Type:

str, optional

use_default

Whether to use default value. If True, provided answer will be ignored. Defaults to False.

Type:

bool, optional

Note that only one of the key, id, or name needs to be provided. It is recommended to always provide the key as it’s always unique as opposed to ID or name that can be shared among prompts.

answers: Any | list[Any]
id: str | None = None
key: str | None = None
name: str | None = None
type: str
use_default: bool = False

mstrio.project_objects.report module

class mstrio.project_objects.report.Report(connection: Connection, id: str | None = None, name: str | None = None, instance_id: str | None = None, parallel: bool = True, progress_bar: bool = True)

Bases: Entity, CertifyMixin, CopyMixin, MoveMixin, DeleteMixin, ContentCacheMixin, TranslationMixin, VldbMixin

Access, filter, publish, and extract data from in-memory reports.

Create a Report object to load basic information on a report dataset. Specify subset of report to be fetched through Report.apply_filters() and Report.clear_filters(). Fetch dataset through Report.to_dataframe() method.

_CACHE_TYPE is a variable used by ContentCache class for cache filtering purposes.

connection

MicroStrategy connection object returned by connection.Connection().

id

Identifier of a pre-existing report containing the required data.

name

Report name

description

Report description

abbreviation

Report abbreviation

instance_id

Identifier of an instance if report instance has been already initialized, NULL by default.

type

Object type

subtype

Object subtype

ext_type

Object extended type

date_created

Creation time, DateTime object

date_modified

Last modification time, DateTime object

version

Version ID

owner

owner User object

view_media

View media information

ancestors

List of ancestor folders

certified_info

Information whether report is certified or not, CertifiedInfo object

sql

SQL View of the Report

attributes

List of attributes

metrics

List of metrics

page_by_attributes

List of attributes selected for Page By

attr_elements

All attributes elements of report

page_by_elements

Elements of attributes selected for Page By in the report. The IDs are in the terse format used for page selection, which is different than the one used in the attr_elements field.

current_page_by

Attribute elements selected for Page By in the report

selected_attributes

IDs of filtered attributes

selected_metrics

IDs of filtered metrics

selected_attr_elements

IDs of filtered attribute elements

dataframe

content of a report extracted into a Pandas DataFrame

prompts

List of report prompts

acg

Access rights (See EnumDSSXMLAccessRightFlags for possible values)

acl

Object access control list

alter(name: str | None = None, description: str | None = None, abbreviation: str | None = None, hidden: bool | None = None)

Alter Report properties.

Parameters:

  • name – new name of the Report

  • description – new description of the Report

  • abbreviation – new abbreviation of the Report

  • hidden – Specifies whether the metric is hidden

apply_filters(attributes: list | None = None, metrics: list | None = None, attr_elements: list | None = None, operator: str = 'In') → None

Apply filters on the reports’s objects.

Filter by attributes, metrics and attribute elements.

Parameters:

  • attributes (list or None, optional) – ids of attributes to be included in the filter. If list is empty, no attributes will be selected and metric data will be aggregated.

  • metrics (list or None, optional) – ids of metrics to be included in the filter. If list is empty, no metrics will be selected.

  • attr_elements (list or None, optional) – attribute elements to be included in the filter.

  • operator (str, optional) – a str flag used to specify if the attribute elements selected inside the filter should be included or excluded. Allowed values are: ‘In’, ‘NotIn’.

clear_filters() → None

Clear previously set filters, allowing all attributes, metrics, and attribute elements to be retrieved.

list_available_schedules(to_dictionary: bool = False) → list[mstrio.distribution_services.schedule.schedule.Schedule] | list[dict]

Get a list of schedules available for the report.

Parameters:

to_dictionary (bool, optional) – If True returns a list of dictionaries, otherwise returns a list of Schedules. False by default.

Returns:

List of Schedule objects or list of dictionaries.

list_properties()

List all properties of the object.

to_dataframe(limit: int | None = None, page_element_id: str | list[str] | dict[str, str] | None = None, prompt_answers: list[mstrio.project_objects.prompt.Prompt] | None = None) → DataFrame

Extract contents of a report instance into a Pandas DataFrame.

Parameters:

  • limit (None or int, optional) – Used to control data extract behavior. By default (None) the limit is calculated automatically, based on an optimized physical size of one chunk. Setting limit manually will force the number of rows per chunk. Depending on system resources, a higher limit (e.g. 50,000) may reduce the total time required to extract the entire dataset.

  • page_element_id (str, list[str] or dict[str, str], optional) – ID of the attribute elements chosen for Page By, for example, ‘h4;8D679D3511D3E4981000E787EC6DE8A4’. If passed as a list, the attribute elements should be listed in the same order as the attributes in the page_by_attributes field. If passed as a dictionary, the keys should be the attribute IDs and the values should be the attribute element IDs.

  • prompt_answers (None or list of Prompts, optional) – List of Prompt class objects answering the prompts of the report. Only needed if the report has prompts.

Returns:

Pandas Data Frame containing the report contents.

mstrio.project_objects.report.list_reports(connection: Connection, name: str | None = None, search_pattern: mstrio.object_management.search_enums.SearchPattern | int = SearchPattern.CONTAINS, project_id: str | None = None, project_name: str | None = None, to_dictionary: bool = False, limit: int | None = None, folder_id: str | None = None, folder_path: str | None = None, **filters) → list[type[mstrio.project_objects.report.Report]] | list[dict]

Get list of Report objects or dicts with them. Optionally filter reports by specifying ‘name’.

Optionally use to_dictionary to choose output format.

Wildcards available for ‘name’:

? - any character * - 0 or more of any characters e.g. name = ?onny will return Sonny and Tonny

Specify either project_id or project_name. When project_id is provided (not None), project_name is omitted.

Note

When project_id is None and project_name is None, then its value is overwritten by project_id from connection object.

Parameters:

  • connection – MicroStrategy connection object returned by connection.Connection()

  • name (string, optional) – value the search pattern is set to, which will be applied to the names of reports being searched

  • to_dictionary (bool, optional) – If True returns dict, by default (False) returns Report objects

  • search_pattern (SearchPattern enum or int, optional) – pattern to search for, such as Begin With or Contains. Possible values are available in ENUM mstrio.object_management.SearchPattern. Default value is BEGIN WITH (4).

  • project_id (string, optional) – Project ID

  • project_name (string, optional) – Project name

  • limit (integer, optional) – limit the number of elements returned. If None all object are returned.

  • folder_id (string, optional) – ID of a folder where the search will be performed. Defaults to None.

  • folder_path (str, optional) –

    Path of the folder in which the search will be performed. Can be provided as an alternative to folder_id parameter. If both are provided, folder_id is used.

    the path has to be provided in the following format:
    if it’s inside of a project, example:

    /MicroStrategy Tutorial/Public Objects/Metrics

    if it’s a root folder, example:

    /CASTOR_SERVER_CONFIGURATION/Users

  • **filters – Available filter parameters: [‘id’, ‘name’, ‘type’, ‘subtype’, ‘date_created’, ‘date_modified’, ‘version’, ‘owner’, ‘ext_type’, ‘view_media’, ‘certified_info’]

Returns:

list with Report objects or list of dictionaries

Module contents