SirsiDynix Symphony Training Guide Web Reporter ...portal.psz.utm.my/.../WebReporterAdministrationFundamentals.pdf · Web Reporter Administration Fundamentals DOC-WRATGEN-S

SirsiDynix Symphony Training Guide

Web Reporter Administration Fundamentals

DOC-WRATGEN-S

Publication Name: Web Reporter Administration Fundamentals Training Guide

Publication Number: DOC-WRATGEN-S Version Number: SirsiDynix Symphony 3.2 First Printing: December 2008 Additional copies of this document can be downloaded from the Client Care section of the SirsiDynix web site, clientcare.sirsidynix.com. © 2008 SirsiDynix. All Rights Reserved. The processes and all the routines contained herein are the proprietary properties and trade secrets of SirsiDynix. Except as provided by license agreement, this manual shall not be duplicated, used or disclosed for any purpose or reason, in whole or in part, without the express written consent of SirsiDynix. The information in this document is subject to change without notice and should not be construed as a commitment by SirsiDynix. Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in sub-paragraph (b)(3) of the Rights in Technical Data and Computer Software clause in DFARS 252.227-7013. Rights for non-DOD U.S. Government departments and Agencies are as set forth in FAR 52.227-19(c)(1,2). Sirsi®, WebCat®, Vizion®, WorkFlows®, SirsiDynix Symphony®, SirsiDynix SymphonyECOLE®, SirsiDynix SymphonyOASIS®, SirsiDynix SymphonySTILAS®, Site Source®, DRA®, DRA Net®, Inlex®, MultiLIS®. Taos®, Taos and Design®, and JurisLink™ are trademarks of SirsiDynix. Other product and company names herein may be the trademarks of their respective owners. All titles, versions, trademarks, claims of compatibility, etc., of hardware and software products mentioned herein are the sole property and responsibility of the respective vendors. SirsiDynix makes no endorsement of any particular product for any purpose, nor claims responsibility for its operation and accuracy.

SirsiDynix Symphony Training Guide

Table of Contents Introduction and Overview ............................................................................................................ 3

Conventions ............................................................................................................................................. 4 Chapter 1: Architecture and Query Flow ..................................................................................... 5

Web Reporter Architecture ................................................................................................................... 5 ODBC Connectivity..............................................................................................................................................6 Certified ODBC Drivers .......................................................................................................................................6 Data Source Name ................................................................................................................................................7

Query Flow .............................................................................................................................................. 7 Report Execution ..................................................................................................................................................8 Element Browsing.................................................................................................................................................9 Object Browsing Flow ........................................................................................................................................10

Chapter 2: Configuration and Connection ................................................................................. 13 Connectivity Configuration Objects.................................................................................................... 14

Establishing Web Connectivity...........................................................................................................................16 Modifying Server Preferences ............................................................................................................................17

Configuring MicroStrategy Intelligence Server................................................................................. 19 Server Definition.................................................................................................................................................20 Governing ...........................................................................................................................................................21 Projects ...............................................................................................................................................................21 LDAP..................................................................................................................................................................21

Configuring a Project Source............................................................................................................... 22 Starting and Stopping Intelligence Server.......................................................................................... 25

MicroStrategy Service Manager .........................................................................................................................25 Microsoft Windows Services Settings ................................................................................................................26 MicroStrategy Desktop .......................................................................................................................................27

Chapter 3: Security ...................................................................................................................... 29 Security Overview................................................................................................................................. 29

Network and Operating System Security............................................................................................................29 Database Security ...............................................................................................................................................30 Microstrategy Security........................................................................................................................................30

Project Source Level Security.............................................................................................................. 31 AUTHENTICATION MODES ..........................................................................................................................31 Windows Authentication ....................................................................................................................................32 Standard Authentication......................................................................................................................................32 Anonymous Authentication ................................................................................................................................32 LDAP Authentication .........................................................................................................................................32 Group and User Accounts...................................................................................................................................33 Security Roles .....................................................................................................................................................42

Project Level Security........................................................................................................................... 46 Security Filters....................................................................................................................................................46 Creating a Security Filter ....................................................................................................................................47

Web Reporter Administration Fundamentals i

Object Level Security ........................................................................................................................... 51Permissions .........................................................................................................................................................51 Default Permissions ............................................................................................................................................52 Predefined Permission Groupings.......................................................................................................................52 Access Control Lists ...........................................................................................................................................54

Managing Licenses................................................................................................................................ 59 Chapter 4: Intelligence Server Administration........................................................................... 63

Monitors................................................................................................................................................. 63 Job Monitor.........................................................................................................................................................63 Project Monitor ...................................................................................................................................................65 User Connection Monitor ...................................................................................................................................67 Database Connection Monitor ............................................................................................................................69 Schedule Monitor................................................................................................................................................70 Cache Monitor ....................................................................................................................................................71 Governors ...........................................................................................................................................................72

Chapter 5: Caching and Scheduling ........................................................................................... 77 Project Source Settings......................................................................................................................... 78

Element Cache ....................................................................................................................................................78 Object Cache.......................................................................................................................................................80 Report Cache ......................................................................................................................................................82 Configuring Project Level Report Cache............................................................................................................82 Configuring Report Level Report Cache ............................................................................................................85 Report Cache Storage .........................................................................................................................................86 Report Cache IDs................................................................................................................................................87 Using Cache Monitor..........................................................................................................................................87 Creating a Schedule ............................................................................................................................................89 Scheduling a Report............................................................................................................................................94

SirsiDynix Symphony Training Guide ii

Introduction and Overview The Administration Fundamentals class is designed to provide an introduction to administering MicroStrategy Intelligence Server. The Web Reporter Suite: Administration Fundamentals training manual contains five chapters. Here is a short summary of each chapter:

• Chapter 1: Architecture and Query Flow. This chapter introduces Web Reporter architecture, ODBC functionality and the query process.

• Chapter 2: Configuration and Connection. This chapter introduces you to configuring Intelligence Server and establishing connectivity.

• Chapter 3: Security. This chapter introduces you to the types of security available in Web Reporter.

• Chapter 4: Intelligence Server Administration. This chapter introduces you to monitoring your Intelligence Server as well as administering server and project governors.

• Chapter 5: Caching and Scheduling. This chapter introduces the way cache is used as well as creating and managing schedules.

Web Reporter Administration Fundamentals 3

Conventions At SirsiDynix, we recognize training that is topically relevant and functionally urgent is subjective--mostly because libraries differ and considerations vary from library to library.

As you review the material in this manual, feel free to skip around in the order that benefits your learning. Don’t get too tied to the order displayed herein; remember, your training should include the tasks that you need to do your job.

This training manual is designed with large margins and lots of space for your personal notes. Mark up you manual with any tips or information your instructor provides – anything that will help you remember the step-by-step workflows that you routinely perform.

Icons are used throughout the manual for different purposes. You should be familiar with these icons and their meaning to take full advantage of your training manual:

This icon is presented where you can benefit from a specific tip or a relational idea.

This icon is placed beside a warning. Pay particular attention to this information.

This icon is placed beside a cross-reference. This information will direct you to other manuals or other chapters within this manual.

Step-by-step workflows are instruction based and task driven. (For example, “From the File Menu, select Save to keep your changes.”) Workflows do not include field-by-field screen definitions. You have field definitions in your context-sensitive on-line Help files.

SirsiDynix Symphony Training Guide 4

Chapter 1: Architecture and Query Flow

It is important to understand both the architecture of Web Reporter as well as understanding how the various components are connected. You also need to understand how reports are executed and the how the query process is handled.

After completing this chapter, you will be able to:

• Describe the architectural components of Web Reporter.

• Describe the way the components are connected in both a 3-tier and 4-tier environment.

• Describe ODBC connections.

• Describe the query flow for report execution, element browsing and object browsing.

Web Reporter Architecture The core component of Web Reporter is the MicroStrategy Intelligence Server. In a 3-tier environment other components include the Desktop, metadata database and SirsiDynix Symphony database. If you access Web Reporter from a web browser you are operating in a 4-tier environment.

This is a 3-tier Connection:

MicroStrategy Desktop connects to the MicroStrategy Intelligence Server with a TCP/IP connection. The Intelligence Server then connects to your SirsiDynix Symphony database and your metadata using ODBC connections. ODBC (open database connectivity) allows an application like Web Reporter to connect to different database management systems using the same source code. Web Reporter will be able to connect to your data. TCP/IP (transmission control protocol/internet protocol) which connects your desktop to the Intelligence Server is a communication protocol that allows one computer to connect to and communicate with other computers on the internet or an internal network.

MicrostrategyDesktop

Workstation

Symphony Web Reporter Server

Symphony Server

MicrostrategyIntelligence

Server

Metadata SymphonyDatabase

HTTPTCP/IPODBC


This is a 4-tier connection: In a 4-tier environment, you connect to Web Reporter using a web browser. Your web browser connects to a web server. While this server can be located anywhere, it is often on the SirsiDynix Symphony Web Reporter server along with MicroStrategy Intelligence server.

Web BrowserMicrostrategy

DesktopWorkstation

Symphony Web Reporter Server

Symphony Server

MicrostrategyIntelligence

Server

Web Server (IIS)Microstrategy

Web

Metadata SymphonyDatabase

HTTPTCP/IPODBC

When the web server and the Intelligence Server are on the same machine they connect using an ODBC connection. If they are on different servers, they connect using TCP/IP. Your web browser connects to the web server using HTTP (hypertext transfer protocol).

ODBC Connectivity ODBC is a standard database access method that lets an application, in this case MicroStrategy Intelligence Server, connect to a database regardless of the database management system (DBMS) software being used. ODBC uses a database driver to translate the Web Reporter requests into commands that the DBMS understands. That means that you need a specific driver for each different DBMS.

There are a couple of components you need to be familiar with to create an ODBC connection.

Certified ODBC Drivers The ODBC driver is the translator that translates Intelligence Server requests into language that your database understands. For that reason you must have database specific drivers. It is important to only use drivers that have been certified by MicroStrategy.

Refer to the Readme file for information concerning certified drivers.


Data Source Name A data source is synonymous with a database. A data source name (DSN) points to the database that contains the information you need. When you create a DSN you specify the IP address of the computer that has the data, a database name and a name for the DSN.

A connection string contains the DSN definition. In addition to the server name or IP address and database name, it also contains the user id and password needed to access the database.

Creating the ODBC connections necessary for accessing your metadata and SirsiDynix Symphony databases is part of your Web Reporter installation.

Query Flow It’s important to know what happens when you execute different types of queries. While you probably think of running a report when you hear the word query there are actually other types of interactions that also send queries through the Intelligence server. We’ll talk about each of these:

• Report Execution

• Element Browsing

• Object Browsing


Report Execution This is the process that’s invoked when you execute a report in three-tier mode. Remember the only difference in a four-tier environment is that the query goes from the web browser to the web server first and then continues to the Intelligence Server.

This figure shows the query flow for report execution:

DESKTOP CLIENT

CacheSQL

EngineQueryEngine

AnalyticalEngine

Metadata

Microstrategy Intelligence Server

1

2

3 or 8

3

4

5

6 7

8

SymphonyDatabase

This table explains each step in the report execution flow.

Step Process

1 Desktop client sends a report request to MicroStrategy Intelligence Server

2 Intelligence Server checks the cache to see if the report results are already there. If it finds a valid cache, it skips directly to step 8. Otherwise it continues with step 3.

3 Intelligence Server obtains the report definition and definitions of the applications from the metadata.

4 The information is sent to the SQL Engine. The SQL Engine generates the SQL and optimizes it for the database being used.

5 The SQL query is sent to the Query Engine.

6 The Query Engine runs the SQL against the SirsiDynix Symphony database.


Step Process

7 The report results are sent to the Analytical Engine. The Analytical Engine performs any additional calculations that are necessary (calculations that are not available in the database being used) and formats the results.

8 The results are returned to the Desktop and new cache is created on the Intelligence Server.

Element Browsing Elements are the distinct values of an attribute. Element browsing occurs when you do any of the following:

• Display a list of elements for an attribute in the Filter Editor.

• Execute a report with an attribute filter prompt that displays a list of elements for the user to choose.

This figure shows the query flow for element browsing:

DESKTOP CLIENT

CacheSQL

EngineQueryEngine

AnalyticalEngine

Metadata


1

2

3 or 7

3

4

5

6

7

SymphonyDatabase


Step Process


2 Intelligence Server checks the cache to see if the report results are already there. If it finds a valid cache, it skips directly to step 7. Otherwise it continues with step 3.

3 Intelligence Server obtains the report definition and definitions of the applications from the metadata.

4 The information is sent to the SQL Engine. The SQL Engine generates the SQL and optimizes it for the database being used.

5 The SQL query is sent to the Query Engine.

6 The Query Engine runs the SQL against the SirsiDynix Symphony database The report results are returned to the Desktop and cached in the RAM of the Desktop and Intelligence Server.

7

Object Browsing Flow You access object browsing when you double-click an object to open its definition. For example, if you open a report in the Report Editor you are browsing the set of objects that makes up the template. The object browsing flow is very simple.

This figure shows the query flow for object browsing:

DESKTOP CLIENT

CacheSQL

EngineQueryEngine

AnalyticalEngine

Metadata


1

3or 4

3

SymphonyDatabase

42


The following table explains each step in the object browsing flow:

Step Process


2 Intelligence Server checks the cache to see if the object cache exists. If it finds a valid cache, it skips directly to step 4. Otherwise it continues with step 3.

3 Intelligence Server obtains the object definition and from the metadata.

The results are returned to the Desktop and new cache is created in the RAM of the desktop machine and Intelligence Server.

4



Chapter 2: Configuration and Connection

As an administrator you will be responsible for understanding both how to configure the Intelligence server as well as how it connects to the other Web Reporter components.

After completing this class you will be able to:

• Recognize a 2-tier vs. 3-tier project source

• Configure a project source

• Define project source

• Modify a project source.

• Establish web connectivity

• Configure MicroStrategy Intelligence Server

• Create a new database instance.

• Point a project to a different database instance.

• Start and stop Microstrategy Intelligence Server


Connectivity Configuration Objects Connectivity refers to the way users access both the metadata and the SirsiDynix Symphony database. The connectivity is established when SirsiDynix Symphony Web Reporter is installed. However you should understand how the various pieces work together. The components in the diagram are configuration objects stored in the metadata.

This diagram shows the objects in a 3-tier environment.

DatabaseInstance

ProjectSource

DatabaseConnection

DSN

Database

Metadata

Project

Micro StrategyIntelligence

Server

BD Login

Project

In a 2-tier environment, the project bypasses the MicroStrategy Intelligence Server and connects directly to the metadata.

Microstrategy Intelligence Server Definition When SirsiDynix Symphony Web Reporter is installed, a server definition is created. There will first be an ODBC DSN created that points to the metadata database. The server definition then specifies the ODBC DSN, administrative user information and configuration parameters. Although it’s possible to have multiple server definitions that point to different metadata databases, only one can be in use at any given time. Therefore a single Intelligence Server essentially points to a single metadata database at any given time. We won’t talk in detail about the server definition since it’s created for you and unlikely that you will need to change it.


Project Source A project source represents a connection to the metadata. In a 3-tier environment, the project source points to the MicroStrategy Intelligence Server using TCP/IP, which in turns uses an ODBC connection to point to the metadata as defined in the server definition. It’s important to understand that a project source points to the Intelligence Server and therefore a single metadata database. It is possible to have multiple project sources pointing to the same metadata database. Every object created within this project source is stored in the same metadata database.

When looking at the folder list in Desktop, you can tell whether a project source is 2-tier or 3-tier by looking at its icon.

A picture of a server

is a direct or 2-tier source.

A picture of a server with a globe behind it

is a server or 3-tier source.

Project A project is a configuration object that contains all the schema and application objects. It’s the environment in which all reporting is done. Where the project source provides the connection to the metadata, the project provides the connection to the SirsiDynix Symphony database through a database instance. A single project source may contain multiple projects.


Establishing Web Connectivity Finally, you have to convert your 3-tier project source to a 4-tier source before users can access it from the web. This is done from the Web Administrator interface.

Follow these steps to establ ish a connection to your server.

1. Select Start, Programs, SirsiDynix Symphony Web Reporter, Web, Web Administrator. A screen like this one displays:

There are two sections displayed:

• Connected Servers—servers that are currently online and ready to be accessed.

• Unconnected Servers—servers that are defined but not yet online.

If your server is not displayed in one of these sections you’ll need to add it.


Fol low these steps to add a server:

1. Enter your server name in the Add a server manually field

2. Click Add.

By default the new server is added as an unconnected server. You can modify its settings so that it connects automatically when you start Intelligence Server.

Modifying Server Preferences You can modify the server’s preferences to determine whether or not the server connects automatically as well as the available authentication methods.

Fol low these steps to view the server preferences:

1. Select Start, Programs, SirsiDynix Symphony Web Reporter, Web, Web Administrator.

2. Select your server name in the connected servers field.

3. Click . Modify


4. hether

eed to manually connect the server on the Administrator page

restarted. The other

Mark the appropriate radio button to determine wor not you want to automatically connect.

If you don’t connect automatically, you’ll n

each time the Intelligence Server issettings will not be discussed in this class.

5. Scroll down to the Login section.

e available.

default.

8. Click Save.

6. Mark the check boxes for the authentication modes you want to mak

7. Mark the radio button for the method you want to be the


Configuring MicroStrategy Intelligence Server

The MicroStrategy Intelligence Server Configuration Editor lets you specify server definition settings and decide which projects load at startup. Although your server is configured when Web Reporter is installed, you should be familiar with accessing other configuration settings. You may find the need to adjust some of the settings. This manual will only cover those you are most likely to use. Details on other settings can be found in the product manuals.

Follow these steps to open the Intel l igence Server Configuration Editor:

Open the MicroStrategy Intelligence Server Configuration Editor.

1. Do one of the following from MicroStrategy Desktop:

Select Server, Configure MicroStrategy Intelligence Server from the Administrator menu.

Right-click on the Project Source in the Folder list and select Configure MicroStrategy Intelligence Server.

These are the categories and subcategories in the MicroStrategy Intelligence Server Configuration Editor:


Server Definition • General—you cannot change the server name but can add

or edit a description if you wish.

user.

• Advanced—lets you specify several advanced settings.

Backup frequency (minutes)—specifies how often data is written from server RAM to disk. One implication is related to caching. When report results are cached they are initially written to the server RAM. Periodically the data is written to disk so information is not lost in the case of an unexpected shutdown. Setting this value to 0 will write cache to disk as soon as it’s created. Keep in mind that writing to disk does take resources so it’s possible that backing up more often than necessary could have adverse performance implications.

Time to run license check—Intelligence Server scans you metadata once every 24 hours to be sure that you are in compliance with your license agreement. This setting specifies what time of day it should run. You can’t choose to turn it off. It will always run. You can only specify the time.

Scheduler—Use MicroStrategy Scheduler—allows the scheduling of reports to be run at a future time.


Scheduler—Scheduler Session Timeout—specifies the number of seconds before the scheduler times out. When the schedule completes running each of its reports, it needs to time out so the next schedule can log in and run.

Governing Please refer to Chapter 4 for details on governing.

Projects • General—lets you choose which projects will be

automatically loaded when the Intelligence Server is started. Mark the checkboxes for the projects to be loaded.

LDAP • LDAP settings will not be discussed in this class.


Configuring a Project Source Follow these steps to open a project source defini t ion and modify i t , i f necessary:

1. Open a 2-tier project source.

2. Open MicroStrategy Desktop.

3. Right-click on the Project Source.

4. Click Modify Project Source.

The connection tab specifies the following:

source—the name assigned to this project source

tier) or server (3-tier) connection

r IP address of the

for connecting to the server. The default is 34952.

Project

Connection mode—specifies whether this is a direct (2-

Server name—the network name oMicroStrategy Intelligence Server

Port number—the port used


Connection times out after—specifies the number of minutes before the connection times out and the user is required to reconnect.

5. Click the Advanced tab.

The advanced tab lets you specify how users will be authenticated. We’ll discuss these in more detail in Chapter 3. Here are brief definitions:

Use Network Login ID (Windows authentication)—lets users connect to the Intelligence Server using their Windows network login and password. You must first create a MicroStrategy login for the user and then map it to the Windows login.

User Login ID and password entered by the user (standard authentication)—users must log in using a MicroStrategy user name and password. This is the default.

Use Guest account (anonymous authentication)—lets a user login in with the privileges of the Public group. By default the public group has no privileges so you must first assign a security role to the public group for this authentication to work.


the

and eated MicroStrategy

tion (lightweight directory sers can login in using their LDAP

login and password.

Use Login ID and password entered by the user forWarehouse (database authentication)—lets users log inusing their SirsiDynix Symphony server loginpassword. You must have first crusers and then linked them to the SirsiDynix Symphony login and password.

Use LDAP Authenticaaccess protocol)—u

6. Click the Caching tab.

Specifies how the maximum RAM used for object and

7. tab is only used for modifying sn’t apply to SirsiDynix

Symphony Web Reporter.

element caching should be configured. We’ll talk more about caching in Chapter 5.

The Metadata Table Prefix version 6.x project sources and doe

8. Close the Project Source Manager.


Starting andnt

configurations: as an application or as a service. It starts as a service auto t

You n tion although it’s reco it as a service. If you start it as an application it otely. You must perform all adm

erver as a service:

•

e

MicroStrategy Service Manager two ways:

•

•

Stopping Intelligence Server MicroStategy Intelligence Server can be started in two differe

ma ically after the install is complete.

ca also start Intelligence Server as an applicammended that you always start

cannot be administered reministration tasks on the server itself.

There are four ways to start Intelligence S

• MicroStrategy Service Manager

• Microsoft Windows Services window

MicroStrategy Desktop

• MicroStrategy Command Manager—not discussed her

The MicroStrategy service manager can be accessed in

Double-click the MicroStrategy Service Manager icon on the Windows taskbar.

Click on Start/Programs/SirsiDynix Symphony Web Reporter/Tools/Service Manager


Microsoft Windows Services Settings You can start or stop MicroStrategy Intelligence Server from the Microsoft Windows Services window.

Follow these steps to start or stop MicroStrategy Intel l igence Server from the Microsoft Windows Services window:

1. Click Start/Settings/Control Panel.

2. Double-click Administrative tools.

3. Double-click Services.

4. Double-click MicroStrategy Intelligence Server from the services list.

5. Either Start or Stop the service.


MicroStrategy Desktop You can also start the server from the MicroStrategy Desktop.

Follow these steps to start or stop the Intel l igence Server from the MicroStrategy Desktop:

1. Click Start/Programs/SirsiDynix Symphony Web Reporter/Desktop/Desktop.

2. Log into your project as Administrator.

3. Right-click the Administrator folder in the Folder list.

4. Click Start Server (or Stop Server).



Chapter 3: Security Web Reporter security lets you create users, control which SirsiDynix Symphony data they are allowed to see, which MicroStrategy objects they are allowed to use and which functionality they can access.


• Identify the three levels of security within MicroStrategy.

• Define authentication modes.

• Create users and groups.

• Create and use security roles.

• Create and use security filters.

• Understand the implications of using security filters in the SirsiDynix Symphony environment.

• Assign user access and permissions to objects and object folders.

Security Overview There are three areas of system-level security that work together to provide a secure reporting environment.

Network and Operating System Security You probably have a network login that identifies who you are and what you can see and do on your network. MicroStrategy integrates with your network and operating system security. The discussion of this type of security is beyond the scope of this class since every library’s network is unique. See your network administrator for further information about how your network security is defined.


Database Security Your database management system provides database level security. In order to log into SirsiDynix Symphony, you must first have a database login. This is the login you enter by clicking the Server button on the SirsiDynix Symphony login screen. Your database login authenticates you as a legitimate user on the SirsiDynix Symphony server and and also specifies which tables you can access in the SirsiDynix Symphony database. By default, there are two database logins in the SirsiDynix Symphony environment, system administrator (sa) and staff. The staff login has full access to all tables necessary for using the SirsiDynix Symphony application. Further restrictions are provided by SirsiDynix Symphony security to control access to SirsiDynix Symphony functions.

Microstrategy Security MicroStrategy security lets you create users and control several things.

• What data they can access from SirsiDynix Symphony. For example, you may want to allow users at a specific location to only view borrowers and items from that location.

• What MicroStrategy metadata objects they can use, view and modify.

• What MicroStrategy functionality they can use.

Security is provided at three levels:

• Project source level.

• Project level.

• Object level.


Project Source Level Security Project source level security controls access across all the projects within a project source. There are three components of project source security:

• Authentication modes

• Security roles

• Users and groups

AUTHENTICATION MODES Authentication modes are the way MicroStrategy validates a user when they log into a project within the project source. Authentication is configured using the Project Source Manager. This was demonstrated briefly in Chapter 2.

Follow these steps to access the project source manager (where you set up the authentication mode you want to use):

1. Open the Project Source Manager.

2. Right-click the project source, and select Modify Project Source.

3. Click the Advanced tab.

You have various authentication modes to choose from. The following paragraphs define available authentication modes.


Windows Authentication This type of authentication validates the user based on the fact that they successfully logged into Windows. They will not be asked for a MicroStrategy login.

Using Windows authentication requires that you first create a MicroStrategy user login and then link it to the Windows login. We’ll discuss this later when we talk about user accounts. Remember that authentication has nothing to do with the specific privileges the user has within Web Reporter. Those privileges are granted within the user account. Using Windows authentication simply allows you to bypass entering a separate login to access Web Reporter.

Standard Authentication This type of authentication asks the user to enter a MicroStrategy login and password. They are validated by MicroStrategy Intelligence Server based on that login.

Anonymous Authentication This type of authentication does not validate users when they access a project. Anonymous users inherit the user privileges specified for the Public/Guest group. You can use this type of authentication in a situation where all users need exactly the same privileges across all projects and can view the same SirsiDynix Symphony data.

Also, keep in mind that all users have the same guest account, so it’s not possible to trace individual activity. This type of authentication is not recommended in the Web Reporter environment.

LDAP Authentication If you use LDAP, this type of authentication lets you use your existing user base stored in LDAP servers to perform authentication and other access checks. A discussion of LDAP authentication is outside the scope of this course. Please refer to your user documentation for more details.


Group and User Accounts Because you create group and user accounts at the project source level, users log into all projects within the project source using the same login. It is possible to restrict which projects a user has access to, however.

Using groups means that you don’t have to assign privileges individually to every user. You can assign privileges to a group instead. Then, every user who is a member of the group will inherit those privileges. This is similar to the way groups work in the SirsiDynix Symphony environment. If a user is a member of more than one group, they will have the union of the privileges (all privileges) in both groups. In that case, if there’s a conflict, the higher privilege will take precedence.

Groups A group is a set of users or other groups. The following groups are available by default and already have security privileges defined for them.

• Everyone—all users automatically belong to the Everyone group.

• MicroStrategy Architect

• MicroStrategy Desktop Analyst

• MicroStrategy Desktop Designer

• MicroStrategy Web Reporter

• MicroStrategy Web Analyst

• MicroStrategy Web Professional

• Public/Guest

• System Monitors

• System Administrators

• LDAP Public

• LDAP Users

Notice that the names of some of the groups correspond with the licenses you can purchase. That makes it simple to add a user to a specific group and know exactly how many users you’ve set up with each type of license.


You can use an existing group or create new ones as necessary. The default ones should be sufficient for most users. Groups are assigned privileges in 3 ways:

• Inherited from another group to which this group belongs. This lets you build groups hierarchically. For example, the Web Analyst group is a member of the Web Reporter group. So, the Web Analyst group automatically has all the privileges of the Web Reporter group plus additional privileges needed by web analysts.

• Specifically assigned to the group. These are privileges added specifically to a group rather than being inherited from another group.

• Security role. A security role is a group of privileges that can be reused from project to project. All privileges assigned to a group other than through a security role apply across all projects.

Follow these steps to display a group and see how i t is defined:

1. Open the MicroStrategy Web Analyst group in the Group Editor.

2. Open the Administration/User Manager/MicroStrategy Web Reporter folder.

The MicroStrategy Web Analyst group is a group within the MicroStrategy Web Reporter group. This means that the Web Analyst will automatically have all the privileges of the Web Reporter group as well as any other privileges added to it specifically.

3. Right-click on the MicroStrategy Web Analyst group and select Edit.


The General tab specifies the Group name and description.

4. Click the Groups tab.


Because the Web Analyst group is a member of the Web Reporter group, that group is checked. So, the Web Analyst group automatically has all the privileges of the Web Reporter group.

5. Click the Project Access tab.

Although you can’t tell here, all of the privileges in the Web Reporter folder are in blue and indicate that the privileges are inherited from the MicroStrategy Web Reporter group. This is because the Web Analyst group is itself a member of the Web Reporter group.


6. Scroll down so you can see the Web Analyst folder.

All of the privileges in the Web Analyst folder have checks in the Group column indicating that these privileges were added specifically to this group rather than being inherited from another group.

Also, note the blue check marks in the project column. Those indicate that the privileges were either assigned to the group or inherited from another group and not assigned through a security role. Green checks indicate the privileges comes from a security role.

7. Scroll back to the top and click the Security Role Selection drop-down box.


Don’t worry too much about security roles right now; we’ll talk about them in detail later. For now, just know that the Security Role Selection drop-down box is used to assign a security role to the group. These are the default options:

+ Inherited means the group/user has access according to the security role assigned to the Everyone group. By default the security role assigned to Everyone is the Normal User role which as no privileges.

[Role] + Inherited means the user has a combination of the security role assigned to the Everyone group and another role.

Custom means you can select a combination of available security roles.

8. Click the Members tab.

You can add members to the group from this tab. You can also add a user to a group from the User Manager.

You will learn more about Security Filters in the Project Level Security section.


Users Users are added using the User Editor. All users belong to the Everyone group in addition to whatever other groups they may belong to. If you click the Everyone group and add a new user, you can then make the new user a member of other groups as well or just add a few privileges. A user does not have to be a member of any group other than Everyone. However, if you know that you want to create a new user who will have Web Professional privileges, you can select that group first, then add the new user. This will automatically make them a member of the group.

Follow these steps to create a user with Desktop Designer pr ivi leges:

1. Open Administration/User Manager/MicroStrategy Desktop Analyst.

2. Click MicroStrategy Desktop Designer.

3. Click File/New/User.

4. Enter a login in the Desktop login field. This is the login that connects the user to the project source.

5. Enter the user’s full name in the Full name field.

7. Enter the user’s password in the Password field.

6. Enter a description in the Description field, if desired.


8. Enter the password again in the Confirm password field.

There are several options for managing user’s passwords. These options are similar to those used by SirsiDynix Symphony security.

User cannot change password

User must change password at next login

Password expiration—you can set a particular date, a number of days to pass before the password expires, or a recurring frequency.

Account disabled

9. Click the Groups tab:

Notice the checkmark next to MicroStrategy Desktop Designer. Because you had that group highlighted when you clicked File/New/User, the user is automatically added to the group. Also notice that the Desktop Designer group is indented under the Desktop Analyst group. Desktop Designer has more privileges than Analyst. It’s inside the Analyst because it is a member of the Analyst group and therefore inherits all of the Analyst privileges.



Let’s analyze the privileges for this user.

First, notice that the Security Role Selection says + Inherited Access. This means the user has inherited the role given to the Everyone group by default. This is the Normal Users role which has no privileges. If you scroll through the entire list, you’ll see there are no green checks meaning no privileges are coming from a security role.

Next, notice that there are red Xs for all the web folders indicating that the user has no web based privileges in the project.

11. Scroll down to the Desktop Analyst and Desktop Designer folders.

Notice the blue checks indicating that the user has inherited those privileges because they belong to the Desktop Designer group which has all those privileges. The Desktop Designer group is a member of the Desktop Analyst group and so has inherited Desktop Analyst privileges.

Suppose that you also want to give the user the single privilege ‘Web user’ from the Web Reporter folder.


12. Click the checkbox next to Web User.

The user can now access reports from the web but has none of the other web reporter privileges.

13. Click OK.

Security Roles A security role is a grouping of privileges that can be given to a user or group at the project level while groups and users are created at the project source level.

By default there are two security roles, Normal Users and Power Users. The Normal Users security role has no privileges and is automatically assigned to the Everyone group for all projects. Power Users is the role assigned to the administrator for all projects and has full access to all privileges.

Follow these steps to create Web Analyst and Web Reporter securi ty roles that have no OLAP services pr ivi leges:

1. Select Security Roles from the Administration menu.

2. Click New.


3. Enter Web Analyst no OLAP in the Name field.

4. Mark the box next to the Web Reporter and Web Analyst folders in the Available Privileges field. If you want just some of the privileges in the folder, mark the check boxes for the individual privileges instead.

5. The privileges marked with ** are associated with OLAP services. Unmark Web execute document.


6. Click OK.

7. Repeat the above steps to create the Web Reporter role.

8. Click OK.

In the next exercise you will create a new user. You will assign the user to no groups, but give Web Analyst privileges in one project and Web Reporter privileges in another.


Follow these steps to create a new user:

1. Highlight the Everyone group in the Administration/User Manager folder.

You must use the Everyone group. If you put the user in any other groups, they will have the group privileges in all projects. Our purpose here is to give different access to the user in different projects.

2. Select File/New/User and complete the General tab.


Notice that the user has no privileges for Web execute document.


Project Level Security Some security features are applied at the project level and can be set differently for different projects.

Security Filters A security filter is a filter that you assign to users or groups to narrow their result set when they execute reports. For example, you may want a particular library to only see its own bibs and items, or its own borrowers. By applying a security filter you ensure that the results are always filtered. Using a report filter to accomplish the same thing means that you would have to create separate reports for different locations.

In addition, if the user has appropriate rights he or she can remove the report filter from the report. A security filter is connected to the user or group and can only be removed by the system administrator.

Before you begin using security filters, it’s important to consider the implications. Suppose you create a security filter that limits the user to only accessing borrowers from the Main location. If the user executes a report that shows which items are checked out, along with the borrower that has the book, he or she will not retrieve items that may be checked out to borrowers from another location.

In other words, the security filter may in some cases be too restrictive. And, because a security filter is applied at the project level, you can’t use it on some reports and not others.

While security filters may seem important in the case of consortia who need to protect data access by location, be sure you consider the implications for report restriction before employing security filters.

Here are some important things to note about security filters:

• A user can only be assigned one security filter for a given project.

• A user may have a different security filter for a different project.

• Because a user may be assigned a security filter as well as being associated with other security filters through their group membership, the multiple filters will be merged when used in reports.


• Security filters may only contain attribute qualifications.

• Security filters can contain as many filtering expressions as you like, joined together by logical operators.

Creating a Security Filter We will now create a security filter that limits User Profiles to ‘FACULTY’, ‘SCHOOL’, and ‘GRADUATE’.

Follow these steps to create a securi ty f i l ter for User Profi le:

1. Open the Administration folder.

2. Right-click on Project Monitor and select Security Filter Manager.

3. Choose the project from the top drop down box.

4. Click New.


5. Browse to Attributes/Users/User Profile.

6. Drag and drop User Profile onto the Filter definition pane.

7. Click Add.


8. Select ‘FACULTY’, ‘SCHOOL’, and ‘GRADUATE’ and add to the Selected Objects pane.

9. Click OK.

10. Click OK again.

Save the filter as User Profile Security Filter.

add it to a group in which case it would apply

i le securi ty f i l ter (you just created) to your new user:

1. r Manager if it’s not already open from the last exercise.

11.

Assigning the Security Filter to a User Next we will add the security filter to the user you created earlier. Remember that you could to everyone in the group.

Fol low these steps to assign the User Prof

Open the Security Filte

2. Click the Users and Groups tab.

4. k on the name of the group that contains your

5. Users radio button is marked on the

3. Click the Show Users check box.

Double-clicnew user.

Be sure the Groups/right-hand pane.


6. Select your user and click the right arrow to add the user

7.

the right.

User Profile Security Filter and click the right

OK.

Testing the Se have added the security filter, we can test it to be sure it

wor rrower Name and Use

Fo ys user name f i le—and save i t as a securi ty f i l ter rep

eport from the File menu.

3.

4.

you can create it. You can name it anything you choose. Its purpose is just to give

n one of the SirsiDynix folders.

r Report.

7. Log out of Web Reporter

8. Log back in as the user to which you attached the security filter.

9. Run the Security Filter Report

to the user pane.

Click the Security Filters tab.

8. Highlight your new user’s name on

9. Select the arrow to add it to the selected user.

10. Click

ecurity Filter Now that w

ks as intended. Let’s create a report that shows Bor Profile.

l low these steps to create a report that displaand User Pro

ort:

1. Select New/R

2. Add the User Name and User Profile attributes.

Click Save

Click Close.

5. Browse to Public Objects, Reports, Custom/Local. If this folder doesn’t exist on your system,

you a place to store reports you create rather than putting them i

6. Save the report as Security Filte


Note that only the selected User Profiles appear on the report.

Object Level Security Object level security lets you control access to specific objects or folders. Where the project level security set in a user’s record controls the functionality the user has access to, object level security controls which objects they are allowed to use. The person who creates an object has control over the object and can determine what access other users have. By default the Administrator has Full Control over all objects.

Permissions Where privileges are assigned to users and describe what they can do across multiple objects, permissions are assigned to objects. Each object has an Access Control List (ACL) that specifies which permissions different users have on that object.


Default Permissions These are the default permissions for objects in a new project:

• The administrator user owns the Public Objects folder and its default child folders.

• The Everyone group has View access to the Public Objects folder and its default child folders.

• The administrator user owns the Schema Objects folder and all its default children folders. In the SirsiDynix Symphony Web Reporter environment, View access is given to the MicroStrategy Web Professional group.

Predefined Permission Groupings There are some groupings of permissions that can be used to easily grant sets of permissions.

Grouping Description of Permissions Granted

View Group or user can:

•Browse •Execute •Read •Use

Modify Group or user can:

•Browse •Execute •Read •Write •Delete •Use

Full Control Group or user can:

•Browse •Control •Delete •Execute •Read •Use •Write

Denied All Explicitly denies the group or user all permissions for the object No permissions are assigned.

Default Neither grants or denies permissions. Permissions are provided by inheritance.

Custom Allows you to create a custom combination of permissions.


These are the definitions of each permission:

• Browse—see the object in the Folder List and Object Viewer.

• Read—view the object’s definition and access control list.

• Write—modify the object’s definition, but not the object’s access control list.

• Delete—delete the object.

• Control—modify the access control list of the object or take ownership of it.

• Use—use the object when creating or modifying other object such as reports or documents.

• Execute—execute reports (or documents) that reference the object.


Access Control Lists The access control list is the list of all users who have access to a project.

Follow these steps to open the Access Control List for the report (047) I tems by Col lection (count).

1. Browse to Public Objects/Reports/Cataloging Reports.

2. Right-click on Call Number Counts and select Properties.

3. Click the Security tab.

Notice that the Administrator login has Full Control and the entire Everyone group has view access.

Permissions on Objects You can now grant or deny permissions to this particular object by changing the users in the Access Control List or changing the type of access the users have.

Since all users are members of the Everyone group, they will all have access to this report by default. Suppose you want to make this report accessible only to some users. You must first remove the Everyone group and then grant access to the individuals who need access.

Follow these steps to edit the Access Control List to give View access to the new user you created (and no one else):

1. Highlight Everyone in the User list and click Delete.

2. Click Add.

3. Select Everyone from the Desktop users and group drop-down box.

4. Mark the Show users checkbox.

5. Click on the user’s name.

7. Click OK

6. Select View from the Access Permissions drop-down box.


You can give Jeanna a custom set of permissions rather than the ones included in the View set.

8. If you want to edit Jeanna’s permissions to give her a custom set of permissions, continue. Otherwise, skip to step 12.

9. Click View in the Object field next to Jeanna’s name.

10. Select Custom from the drop-down box.


11. Click the value in the Type field and select the appropriate permission level.

1. Browse to Public Objects/Reports/Cataloging Reports.

2. n the Cataloging Reports folder and select Properties.

12. Click OK.

13. Click OK

Permissions on Folders It’s also possible to set permissions at the folder level. These permissions will then be inherited by every object in the folder. In some cases you may want to simply hide certain folders. For example, if your library doesn’t use Acquisitions, you can hide the folder so users don’t see the Acquisitions reports. Or, you may want only your Acquisitions staff to see those reports and hide them from the view of other users.

You open the Access Control List for a folder the same way as for an individual object. However, there is an additional column of information.

Follow these steps to open the Access Control List for the I tem Reports folder:

Right-click o


3. Click the Security tab.


Managing Licenses When you purchase Web Reporter, you purchase licenses that provide users a particular level of access. You will be allowed to create the number of named users at each level that corresponds to the number of licenses you have. MicroStrategy audits your system every 24 hours to determine if you are in compliance with your license agreement. If you are out of compliance, the system administrator will receive a notification message.

You can click the Details button to find out how many licenses you own of each type and the current number of named users for that license type. You have 14 days to bring your system into compliance before your users will also be notified when they log in that you are out of compliance.

To bring your system back into compliance you can do one of the following:

• Change your users privileges to conform to your license agreement.

• Purchase additional licenses from SirsiDynix.

If a user has even a single privilege in a group, they will be considered to be a named user at that level.

If your system is out of compliance, you may not be able to assign privileges related to the license that is out of compliance.


Using License Manager You can use the license manager to:

• Audit to determine the specific number of licenses being used by a specific user group

• Display the number of licenses you have in each group

• Upgrade your license key if you purchase additional licenses, without reinstalling any products

• Manually run a compliance check

Auditing Your System While clicking the Details button on the Out of Compliance notification shows you how many licenses you have and how many named users you currently have with each type of license, it does not tell you who the users are at each level. You can find that information by doing an audit in the License Manager. Do the following to perform an audit to determine the number of each type of license in use:

Follow these steps to run an audit on your system:

1. From the Start menu, select Programs/MicroStrategy/License Manager.


The Installed Products tab displays all the products for which you have licenses. You can click on any one and view the number of licenses you own in the Product Information column.

2. Click the Audit tab.

3. Double click Intelligence Server.

4. Double click your project source.

5. Enter the Administrator user and password.

6. Click Connect.

7. mpliance message, click OK. If you get an out of coOtherwise, continue.

Mark th8. e group or groups you want to audit and click Audit.


The display shows the number of users you have in each group. You can click the plus sign (+) next to the number of licenses to see which users have that license.

Upgrading a License If you receive a new license key from SirsiDynix because you changed your license agreement you can use the Upgrade tab to make the changes. They will become effective immediately.

Follow these steps to access the Upgraded License screen:

1. Click the License Administration.

2. Click the radio button next to Update local License Key.

3. Click Next.

4. Enter the new key in the New License Key field.

5. Click Next.


Chapter 4: Intelligence Server Administration

Intelligence Server administration involves using administration monitors to oversee project operations, specify server and project governors, and manage job priorities.


• Monitor operations on projects

• Configure server and project level governors

• Identify the purpose of job prioritization.

Monitors There are several monitors in MicroStrategy to assist you in monitoring various elements of your Intelligence Server and projects. These are listed under the Administration folder in your Project Source:

• Job Monitor

• Project Monitor

• User Connection Monitor

• Database Connection Monitor

• Schedule Monitor

• Cache Monitor

• Cluster Monitor

Job Monitor The job monitor lets you monitor the status of jobs that have been submitted by users. The monitor provides information about the following types of jobs:

• Queued jobs

• Executing jobs

• Jobs that are waiting for a prompt response

• Jobs that errored out before completion

Jobs are removed from the monitor when processing is complete.


Follow these steps to open the Job Monitor:


2. Click Job Monitor.


Following is a table describing the columns in the Job Monitor:

Job Monitor Layout

Column Definition

Job ID Numeric identifier assigned to the ob.

Status Displays one of the following statuses: •Executing •Waiting •Waiting for Autoprompt •Canceled •Error

Description Current state of the job execution

Project ID ID of the project from which the job was submitted

Project Name Name of the project from which the job was submitted

Priority Priority of the connection on which the job was submitted

Creation time Time the job was created

IP address of the user that submitted the job Network address

3. If you don’t see all of the columns displayed, right-click on Job Monitor and select Complete Information.

Project Monitor The project monitor lets you manage some aspects of your project, including:

• Accessing the Project Configuration Editor

• Unload or load the project.

• Idle or resume the project.

• Purge report cache for the project.

• Purge element cache for the project.

• Purge object cache for the project.

• Access the Job Prioritization wizard.

• Access the Security Filter manager.


Loaded vs. Unloaded Projects A loaded project is seen as an available project in both Desktop and Web by those users who have access to the project. An unloaded project is unseen.

Idle/Resume A loaded project can be idled so that it’s available for architectural work on the project but not for job submission.

Follow these steps to idle or resume a project:

1. Open Administration/Project Monitor.

2. Right-click the project and select Idle/Resume.

3. Click the appropriate check box(es).

See below for a definition of idle type:

Idle Levels

Type Meaning

Request idle Completes any currently executing and queued jobs, but rejects newly submitted jobs.

Execution idle • Cancels all currently executing jobs and returns them to th• Newly submitted reports put in queue with Waiting status

e queue

• Reports in queue at time of idle remain in queue• Achieved by marking both boxes • Cancelled jobs are not placed in queue, but an error is put in user’s

History List

Full idle

• User must resubmit the request when project is resumed

4. To resume a project, open the Idle/Resume dialog box again and uncheck the boxes.


User Connection Monitor The user connection monitor lets you monitor the users who are logged into the project. You can check:

• The project they’re logged into.

• Any open jobs.

• Type of connection.

• Time they connected.

• First and last job in the session.

Fol low these steps to open the User Connection Monitor:

1. Click Administrator/User Connection Monitor. A window like this displays:


2. Right-click to delete the connection.

User Connection Monitor Information

Column Meaning

User name Name of connected user

Network Address Network address of connected user. If the connected user has scheduled a report, it displays a network address for MicroStrategy Scheduler.

Project Name of the project to which a user is connected. When a user connects to a project there will be separate entries for the project connection, server connection and scheduler if a report is scheduled.

Open jobs Number of jobs the user has open

Source Source for the connection: MicroStrategy Desktop, MicroStrategy Web, or MicroStrategy Scheduler

Time connected Date and time the user connected

First job in session Date and time the user ran their first job after logging in

Last job in session Date and time the user ran their last job


Database Connection Monitor The database connection monitor lets you monitor the number of busy and cached connections to SirsiDynix Symphony. A database connection is opened anytime a user executes an uncached report or browses uncached elements.

When a connection is processing a job, its status is busy. When it’s available to process a new request its status is cached. Because connecting and disconnecting to a database may cause a slight decrease in performance, MicroStrategy reuses database connections. So there will never be more connections than are necessary to process the submitted requests.

Follow these steps to access the Database Connection Monitor:

1. Open Administration/Database Connection Monitor.


2. You can disconnect a connection if necessary by right-clicking on the connection and selecting Disconnect.

Database Connection Monitor Information

Column Meaning

Connection ID Identifier for the connection

Status Specifies the status:

•Busy: the connection is currently busy with a job •Cached: the connection is available

Database Instance The database instance being used to connect to the SirsiDynix Symphony database

Database Connection The database connection being used to connect to the SirsiDynix Symphony database

User Name The name of the user connected

Database Login The login to the SirsiDynix Symphony database

Schedule Monitor The schedule monitor lets you monitor the reports that have been scheduled for the project source.

Follow these steps to access the schedule Monitor:

1. Click Administrator/Schedule Monitor.


2. You can delete a scheduled request by right-clicking on it and selecting Expire.

Schedule Monitor Information

Column Meaning

Request Name The name of the scheduled report

Schedule Name The name of the schedule

Schedule Type The type of schedule

Project Name The name of the project from which the request was made

User Name The user who made the request Next Update The next time (if time-triggered) or the name of the event (if event-

triggered request) that will next activate the schedule

Cache Monitor The cache monitor lets you manage and monitor report caches for the Project Source.

Follow these steps to access the Cache Monitor;

1. Click Administration/Cache Monitor.

This is the default layout. You can display further information by right-clicking on Cache Monitor and clicking Complete Information.


Governors A governor is a parameter that controls job execution and access to your system when certain thresholds are met. Some of the governors you can set control things like:

• Maximum amount of time a job can take to execute.

• Maximum amount of rows a job can return.

• Maximum number of user sessions.

There are two types of governors: server -level and project-level.

Server Level Governors Server level governors control access and functionality across all projects in the project source. Governor settings are controlled from the MicroStrategy Intelligence Server Configuration.

Follow these steps to open MicroStrategy Intel l igence Server Configuration:

1. Log into the Project Source.

2. Select Server/Configure MicroStrategy Intelligence Server from the Administration menu.

3. Click Governing/General.

General specifies basic settings including number of jobs and user sessions.

• Maximum number of jobs—the maximum number of jobs that can be active at any given time. Concurrent jobs includes report requests, element requests, object requests and prompts that are executing or waiting to execute. Remember that some jobs, like executing a Report Services document, may actually contain multiple jobs if there are prompts as well as several underlying reports that must be executed.


• Maximum number of user sessions—maximum number of users sessions across all projects. A user may have multiple sessions. You establish a connection to the Intelligence Server and another to each project to which you connect. You’ll see later how to set the maximum users per project.

• User session idle time—the amount of time a Desktop user can be idle before they are automatically logged out

• Web user session idle time—the amount of time a Web user can be idle before they are automatically logged out

• Project Level Governors Project governors are set at the project level and can therefore be different for different projects. These governors are set in the Project Configuration Editor.

Fol low these steps to open the Project Configuration Editor.

1. Log into the Project Source.

2. Right-click on the project name and click Project Configuration.

3. Click Governing.

Result sets


• Report execution time—maximum number of seconds a report can take to execute. This includes the time it sits in the queue waiting to execute.

• Number of report result rows—maximum number of report rows that can be returned from SirsiDynix Symphony.

• Number of element rows—maximum number of element rows that a report can have. If there are more, you will see them in increments of this value.

• Number of intermediate result rows—maximum number of rows in an intermediate result set for analytical processing.

Jobs

• Jobs per user account—maximum number of simultaneous jobs a user can submit, including those waiting in the queue.

• Jobs per user session—maximum number of simultaneous jobs a user can submit within one session, including those waiting in the queue. A session is an open instance of MicroStrategy application where a user is logged in to a project.


• Executing jobs per user—maximum number of simultaneously executing jobs per user. This setting only considers executing jobs, not those waiting in the queue.

• Jobs per project—maximum number of simultaneous jobs that can be submitted for a project across all users.

User Sessions

• User session per project—maximum number of sessions that can be opened for a project across all users.

If the total number of jobs exceeds the server level governors but not the project level governors, additional job requests are not accepted. If the total number of jobs exceeds the project level governors but not the server level governors, additional jobs are still accepted in other projects.



Chapter 5: Caching and Scheduling

Caching improves query response by retaining recently used report results, objects and elements. Users access results from previously stored files rather than executing queries against the database. You can improve response time by doing work ahead of time so it’s waiting for you when you need it.

There are three types of caches:

• Element cache—Lookup tables that are used frequently are stored in cache for quick access. Element cache is stored in the memory of the Intelligence server and the client machine.

• Object cache—Metadata objects that are used frequently. Object cache is stored in the memory of the Intelligence server and client machine.

• Report cache—Pre-executed reports are stored in the Intelligence Server memory and disk. There is no report cache stored on the client machine.

Cache that’s stored on the client machine is called ‘local cache’ and cache on the Intelligence Server is called ‘server cache.’ Object and element cache is always stored in memory—on the client and the server. Report cache is stored in both memory and on disk on the server.

Cache is stored and used at the project level. It is never shared across projects.


Project Source Settings Although cache is maintained at the project level, you can specify maximum RAM settings at the project source level for all projects in the project source.

Fol low these steps to open the Project Source Manager and view the Cache sett ings.

1. Right-click the project source and select Modify Project Source.

2. Click the Memory tab

.

3. You can choose a specific value for the maximum RAM used for both element and object caching. The default is to use the values set at the project level for each project.

Element Cache An element cache is a recently used list of attribute elements. Anytime you request an attribute element, you create element cache. You request an attribute element by:

• Browsing a list of attribute elements in Data Explorer.

• Browsing attribute elements in the Filter Editor.

• Executing a report with a prompt that presents you with a list of elements.


Configuring Editor.

Fosett gs iguration Editor.

Element Caching Element caching is configured in the Project Configuration

l low these steps to open the Element Caching in in the Project Conf

1. Right-click the project and select Project Configuration.

2. Open Caching/Element.

Server

ase

• e element cache. Element caches are also purged when you stop and restart Intelligence Server. You can purge

Client

• Maximum RAM usage—the maximum amount of RAM on the client that can be used for element caching.

• Maximum RAM usage—maximum amount of memory allocated for element caches. Default is 512KB. Set this value to 0 if you don’t want to cache elements.

• Create element caches per warehouse login and databconnection—by default these are marked. Keep the defaults.

Purge element caches—click this button to purge th

Desktop cache by closing the Desktop application.


Element Cache IDs Element cache IDs are the IDs that are compared to determine whether valid cache exists. This is the structure:

• Attribute ID

• Attribute Version ID

• Database Connection ID

• Warehouse Login ID

• Security Filter ID

• Security Filter Version ID

Object Cache An object cache is a list of recently used metadata objects. When you open an object editor you’re browsing the object definition and creating cache.


Configuring Object Cache Open the Object Cache settings in the Project Configuration Editor.

1. Right-click the project and click Project Configuration.

2. Click Caching/Objects.

Server

• Maximum RAM usage—maximum amount of server RAM to be used for object cache. The default and minimum is 1024KB.

• Purge object cache—the Purge Now button lets you purge object cache. It is also purged when you stop and restart Intelligence Server. Desktop cache is purged when you close the application.

Client

• Maximum RAM usage—maximum amount of client RAM to be used for object cache. The default is 512KB.

Object Cache IDs These are the IDs used to determine whether valid cache exists for an object.

• Object ID

• Object Version ID


Report Cache A report cache is the result from a previously run report. The cache is stored either in memory, disk or both on the Intelligence Server. There is no report cache stored locally on the client machine.

There are several ways that report cache gets created:

• Execute a saved report with only static (unprompted) objects from either Desktop or Web.

• Execute a saved report with prompts from Desktop or Web. The answers to the prompts create a unique set of responses that are part of the cache.

• Execute a template and filter combination in Web.

• Schedule a report in Desktop or Web.

• Send a report to History in Desktop.

When you create a new report and execute it for the first time, there is no cache created. Once it’s been saved and executed again, the cache is created which is the reason the first bullet above specifies a ‘saved’ report.

Configuring Project Level Report Cache Report cache options are configured from the Project Configuration Editor.

Fol low these steps to open the Caching sect ion of the Project Configuration Editor.

1. Right-click the project name and select Project Configuration.

2. Click Caching.


Reports (general)

• Cache file directory—storage location for disk caches. The default is C:\Program Files\MicroStrategy\Intelligence Server\Caches\Server definition\Machine name.

• Maximum RAM usage—amount of Intelligence Server memory allocated for report caches. If the memory is exceeded, cache in memory will be unloaded to disk in order of least recently used.

• Maximum number of caches—maximum number of report caches stored in both memory and disk. Reports cached from Web are XML caches and are stored as distinct cache. Therefore they count against the maximum cache.

• RAM swap multiplier—if RAM reserved for report caches is full and cache must be switched from disk into memory, this is the number of times that memory can be swapped out of memory to disk.

When a report is executed for which cache exists, the cache cannot be accessed from disk. It must first be loaded into Intelligence Server memory.

• Load caches on startup—loads caches from disk to memory when Intelligence Server is started. Otherwise, the cache is loaded as it’s needed.


Reports (Advanced)

• Enable report server caching—enables/disables report caching for the entire project. If it’s disabled, you can still use the History List. The following options are available only if this one is checked.

• Enable prompted report caching—enables reports with prompts to be cached. If many reports have prompts and users consistently select different prompts, it’s possible that the cache will rarely be used. In that case, it’s just taking up memory and disk space for no useful purpose and you may not want to cache prompted reports.

• Enable non prompted report caching—caches all reports that do not have prompts in their definition.

• Create caches per user—specifies the user ID of the user who created the cache as part of the cache ID. Then that user is the only one who can use the cache in the future.

• ☛Create caches per database login—specifies that the cache is restricted to a particular database login ID.

• Create caches per database connection—specifies that cache is restricted to a particular database connection ID.

• Never expire report caches—specifies that the report caches do not expire.


• Report cache duration—only available if the Never expire report caches check box is cleared. Specifies the frequency for invalidating cache. The minimum is 1 hour and the maximum is 24 hours.

• Purge report caches—purges all cache from both memory and disk.

Configuring Report Level Report Cache You can specify how to handle report cache for an individual report regardless of what the project setting are.

Follow these steps to access the report level cache sett ings for a report.

1. Open a report definition in the Report Editor.

2. Select Report Caching Options from the Data menu.

Mark the appropriate option to either enable, disable or use project level caching options. The default is to use project level options.


Report Cache Storage Report cache is first written to the memory of Intelligence Server and then backed up to disk. The backup frequency is set in the MicroStrategy Intelligence Server Configuration Editor.

Follow these steps to conf igure the backup frequency:

1. Select Configure MicroStrategy Intelligence Server from the Administration/Server menu.

2. Click Server definition/Advanced.

• Backup (frequency minutes)—specifies the number of minutes between writes of cache from memory to disk. If you set the value to 0, cache will be simultaneously written to both memory and disk when it’s created. It will cause a drain on resources however to write more often than necessary.

When cache is unloaded from memory to disk it no longer resides in memory. When a request is made for which cache exists, Intelligence Server loads the cache from disk to memory first and then retrieves the results from memory


Report Cache IDs Following are the components that make up the report cache ID. When a request is made, this ID is compared to the current request to determine whether or not cache exists that’s valid to fulfill the request.

• Report ID

• Report Version ID

• Template ID

• Template Version ID

• Filter Id

• Filter Version ID

• Security Filter ID

• Security Filter Version ID

• Answers to prompts

If you chose to create cache associated with users, database logins, or database connections in the Project Configuraton editor, then the User ID, Database Login ID, and the Database Connection ID are used as well.

Report Cache Invalidation There may be instances where the cache is invalid and can’t be used to fulfull a request. Cache becomes invalid when an application object (such as a report, template, or filter) has changed.

Using Cache Monitor The cache monitor lets you monitor and manage the cache for all projects in the project source.

Types of Caches There are two types of caches: matching and history. Matching cache is cache that is valid and can be used to fulfill a new request. History cache is cache that is invalid, expired, or both but still exists because there are messages in one or more users History List referencing that cache.

By default, history cache is not displayed in the cache monitor.


Fol low these steps to open the Cache monitor.


2. Open the Cache monitor.

Notice that some of the entries indicate that the cache is matching, history meaning that it can be used for new requests as well as being referenced in someone’s History List.

3. Right-click Cache monitor and click Show caches for History List messages.

This will show all the cache that is invalid but available for History.

Scheduling Scheduling reports allows the request to be executed at a pre-defined time rather than immediately after the requests are made. Scheduling of reports is important for two reasons:

• Reports that are accessed frequently can be pre-cached so that users experience very fast response times while not creating too large a load on the system.

• Reports that take a long time to run can be postponed to a time when the load on the system is not as heavy.

The system administrator must first create schedules and then reports can be asssigned to run on one of the available schedules. There are two ways to schedule a report:

• Let users schedule reports either through Desktop or Web. In order to schedule reports users must have schedule request privileges.


• System administrator schedules frequently-accessed reports on behalf of users to the reports are cached and users can simply access the cached report.

When a user’s report has been executed according to schedule, a message displays in the user’s History List alerting him or her that the report is ready to be viewed.

Creating a Schedule You create schedules from the Schedule Manager. Let’s create a new schedule.

Follow these steps to create a schedule that runs every day at 8:00 pm:

1. Expand the Administration folder.

2. Right-click on Schedule Manager.

The Schedule Wizard opens and displays the steps involved in creating a schedule.

3. Click Next.


4. Enter Daily at 8:00 pm as the name of the schedule and click Next.

The schedule can be triggered on a particular day and time or by the occurrence of some event.

5. Click Time-triggered and click Next.


6. Enter today’s date in the Start field.

7. Select No end date unless you want the schedule to only be active for a certain period of time.

8. Click Next.

The Recurrence Pattern screen lets you determine the type, time and frequency of recurrence.

9.

10. Enter 8:00 PM in the time field.

Select Daily, Every 1 day.


11. Click Next.

The Preview screen shows the next 20 occurrences based on the schedule you set up.

12. Click Next.

The Summary screen summarizes the settings you created.

13. Click Finish.


14. Your schedule now appears in the list of schedules and can be used for reports.


Scheduling a Report The steps for scheduling a report differ depending on whether you are scheduling via the Desktop or Web.

Schedule a Report on the Web This section provides information to schedule a report on the web.

Follow these steps to schedule the Borrower Count by User Prof i le and Location—Crosstab report for the Dai ly 8:00 PM schedule from the Web.

1. Log into Web Reporter from the Web.

2. Browse to the location where you save the report.

3. Click the Subscription link below the name of the report.


4. Click Add Subscription.


5. Select Daily at 8:00 PM from the drop-down list.

6. Click OK.

If the report you schedule has any prompts in it, you will be asked to answer the reports at the time that you schedule the report.


Documents

SirsiDynix Symphony Training Guide Web Reporter ...portal.psz.utm.my/.../WebReporterAdministrationFundamentals.pdf · Web Reporter Administration Fundamentals DOC-WRATGEN-S