BusinessObjects Query Builder XI Release 2

Transcription

1 INTERNAL USE ONLY BusinessObjects Query Builder XI Release 2 Overview Contents The purpose of the this document is to introduce Technical Engineers to the BusinessObjects XI Release 2 Query Builder. The Query Builder is a useful application that allows users to query the Central Management Server (CMS) for object information that may not be readily available through the default Central Management Console (CMC) or InfoView user interface. PREREQUISITES... 3 QUERY BUILDER... 3 ACCESSING THE QUERY BUILDER... 3 QUERY BUILDER HELP FILES... 4 Properties...5 InfoObject Properties... 5 ProcessingInfo Properties... 6 SchedulingInfo Properties... 7 System Properties... 8 Category (Enterprise SDK Tables) CI_SYSTEMOBJECTS... 8 CI_APPOBJECTS... 9 Condition...9 CMS Performance and Processing the Condition... 9 Using the TOP N function XI RELEASE 2 INDEXED PROPERTIES...10 SI_CUID SI_GUID SI_HIDDEN_OBJECT SI_ID SI_INSTANCE_OBJECT SI_KIND and SI_PROGID /13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 1

2 DUSER SI_NEXTRUNTIME SI_OWNERID SI_PARENTID SI_PLUGIN_OBJECT SI_RECURRING SI_RUID SI_RUNNABLE_OBJECT SI_SCHEDULE_STATUS SI_UPDATE_TS SI_INSTANCE XI RELEASE 2 INDEXED PROPERTIES AND DATABASE EQUIVALENCIES...15 HOW AND WHEN TO USE DIRECT DATABASE QUERIES...16 CMS_INFOOBJECTS5.OBJECTID CMS_INFOOBJECTS5.PARENTID CMS_INFOOBJECTS5.OWNERID CMS_INFOOBJECTS5.TYPEID CMS_INFOOBJECTS5.SCHEDULESTATUS CMS_INFOOBJECTS5.NEXTRUNTIME CMS_INFOOBJECTS5.LASTMODIFYTIME CMS_INFOOBJECTS5.SI_INSTANCE_OBJECT CMS_INFOOBJECTS5.DUSER CMS_INFOOBJECTS5.SI_RECURRING QUERY SAMPLES...24 User and Group...25 List All Users List All Groups Lists Users Currently Logged On to Enterprise System Crystal Report...27 View Latest Instance ID of Report Retrieve All Instances for a Report Object Counting the Number of Historical Instances for a Report List Report Parameter Finding FRS Location for Report Reporting Database Logon Information Business View and Business View Connections...30 Finding What Business View a Report is Using Listing All Business Views Return All Properties for a Business View by All Reports Connected to a Specific Business View All Business View Connections Universe and Universe Connections...32 Listing All Universes and their Connection Information Return Web Intelligence Reports Connected to a Specific Universe Core and Derived Universe Information Web Intelligence Report...35 Web Intelligence Report Universe Connection Web Intelligence Report Parameter Information Web Intelligence Report and CACHE Output View Latest Instance ID for Web Intelligence Report Retrieve All Instances for Web Intelligence Report Object Counting the Number of Historical Instances for a Web Intelligence Report Finding FRS Location for Report Desktop Intelligence /13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 2

3 Prerequisites Desktop Intelligence Universe Connection and Data Providers Desktop Intelligence Report Parameter Information Desktop Intelligence Report and CACHE Output View Latest Instance ID for Desktop Intelligence Report Retrieve All Instances for the Desktop Intelligence Report Object Counting the Number of Historical Instances for a Desktop Intelligence Report Finding FRS Location for Report License Key...43 License Keys and Product Version Licensing Features Unlocked by Key Code Scheduling...43 Determining Report Scheduling Status All Recurring Scheduled Reports General Scheduled Report Information Servers...46 Servers Registered with the CMS Current CMS Load Listing CMS Members in the Cluster Server IOR (Interoperable Object Reference) Authentication...47 Authentication Used to Logon Authentication Plug-in Information LDAP Configuration Information Windows AD Configuration Information FINDING MORE INFORMATION...51 It is recommended that you have access to a BusinessObjects XI Release 2 installation before continuing with the rest of the documentation. Query Builder The BusinessObjects XI Release 2 Query Builder is a sample application that enables users to submit simple statements to retrieve information from the CMS InfoStore. Although the query language is a subset of the commonly used Structured Query Language (SQL), it does not support table joins or embedded statements. The syntax of a typical statement follows: <Properties> <Categories> <Conditions> Accessing the Query Builder The Query Builder application is located on the BusinessObjects Admin LaunchPad under Administration Tools (see Figure 1). 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 3

4 Figure 1 Once the link is clicked, the logon dialog appears (see Figure 2). Note that your query results are dependent on your user rights within the Enterprise system so you should use an Enterprise account with Administrator rights. Figure 2 Query Builder Help Files The most difficult part about building a query is determining what properties are available within the BusinessObjects Enterprise XI Release 2 SDK when using the Query Builder. You may use the asterisk * wildcard to retrieve all of the properties for an InfoObject. However, it is more advantageous to retrieve as few properties as possible for readability and performance purposes. The most efficient way of determining the properties available to the Query Builder is to view the Query Language Reference section in the Online Developer Help Guide: Go to BusinessObjects Enterprise SDK > COM Developer guide and API reference > Query Language Reference (see Figure 3). 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 4

5 Figure 3 Properties The Query Language Reference lists four primary property types (see Figure 4) that can be accessed from a query result. A brief definition of each is provided below. Figure 4 InfoObject Properties The InfoObject contains all the properties used to describe a BusinessObjects Enterprise object that is stored in the Central Management Server (CMS) repository. The image below lists some of the available properties you can add to the statement (see Figure 5). The properties are logically named so finding what you need is not difficult. A brief definition of each property is also provided in the pane to the right for each property. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 5

6 Figure 5 ProcessingInfo Properties The ProcessingInfo properties contain the information related to the processing of a report object. This includes properties such as, the database logon, the report format, prompting, the selection formula, and the printer information. To query for processing information you must add the SI_PROCESSINFO prefix first and then the property name afterwards. For example, to verify if a report object contains a default database logon, parameter value and record selection formula, add the following properties to your statement: SI_PROCESSINFO.SI_DBNEEDLOGON, SI_PROCESSINFO.SI_LOGON_INFO, SI_PROCESSINFO.SI_PROMPTS, SI_PROCESSINFO.SI_RECORD_FORMULA SI_ID = Report ID The image below lists some of the available properties you can add to your statement (see Figure 6). A brief definition of each property is also provided in the pane on the right for each property. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 6

7 Figure 6 SchedulingInfo Properties The SchedulingInfo properties are related to the scheduling of an InfoObject. These properties mostly include the how, where, and when a report will be processed. To query for scheduling information you must add the SI_SCHEDULEINFO prefix first and then the property name after. For example, if a user needs to verify the current processing state of a report and the machine the report is currently being processed on, a user can add the following properties in their statement: SI_SCHEDULEINFO.SI_PROGRESS, SI_SCHEDULEINFO.SI_MACHINE_USED SI_ID = Report ID The image below shows some of the available properties you can add to your statement (see Figure 7). A brief definition of each property is also provided in the pane on the right for each property. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 7

8 Figure 7 System Properties System properties provide information about the system and its administrative functions such as the CMS cluster name and the CMS cluster members. The image below shows the available properties you can add to your statement (see Figure 8). A brief definition of each property is also provided in the pane on the right for each property. Figure 8 Category (Enterprise SDK Tables) The Enterprise SDK exposes three logical tables named, CI_SYSTEMOBJECTS, and CI_APPOBJECTS. It is important to note that the Enterprise SDK tables are not the same physical database tables found in the CMS database. Instead, they are logical tables created in CMS memory that enable users to query from the four property types. Some of the object types for each table are listed below. The info object table allows users to retrieve folder, report and report instance information from the CMS InfoStore. CI_SYSTEMOBJECTS The system object table allows users to retrieve information regarding servers, users, groups, destinations and events from the CMS InfoStore. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 8

9 CI_APPOBJECTS The application object table allows users to retrieve information regarding business views, business view connections, universe connections, universes, list of values, command objects, repository objects and Business Objects applications. Condition A good rule of thumb when creating queries is to use indexed properties in the clause to narrow down your result set. The more you are able to filter down the result set using indexed fields the better. As well, adding as many indexed fields within the same sized result set may not necessarily improve performance. For example, if you have the SI_SCHEDULE_STATUS condition in your predicate, adding another indexed property like SI_INSTANCE will not improve performance. If SI_SCHEDULE_STATUS is equal to 1, SI_INSTANCE must be equal to 1 so adding SI_INSTANCE will only add additional processing overhead in the query. CMS Performance and Processing the Condition When the query is submitted for processing, the CMS will examine the clause for indexed properties and then construct an optimized query. It is important to note the CMS processes the properties from left to right. Placing indexed properties with the smallest result set first in the clause is best policy when there are multiple properties within the clause. For example, the clause below shows an inefficient and an efficient query that returns the identical instance information for a particular report called Test Report : Most Inefficient: * SI_INSTANCE=1 AND ='Test Report' In the query above, the CMS will retrieve all the instances in the system first and then search through the result set (from only those objects whose SI_INSTANCE property = 1) for the report named Test Report. More Efficient: 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 9

10 * ='Test Report' AND SI_INSTANCE=1 In the case above, the CMS will only retrieve reports named Test Report and then search through the result set (from only those objects whose = Test Report for report instances. Using the TOP N function In situations where a large result set is unavoidable, users should use the TOP N function to limit the selection. If the CMS is forced to select too many objects, it may cause the system to become overloaded with requests. TOP N Example: TOP 100 * SI_KIND = 'CrystalReport' XI Release 2 Indexed Properties Listed below are the most commonly-used index properties provided in the Developers Help Guide. For a complete list, see Performance Issues in the Query Language Reference section. SI_CUID This is the unique cluster ID of the InfoObject. This property uniquely identifies objects within the Enterprise cluster. If the object is migrated to a different deployment of Enterprise, the SI_CUID remains the same so the ID reference is not corrupted. SI_GUID This is the unique global object ID of the InfoObject. This property is a globally-unique identifier for an object. If the object is migrated to a different deployment of Enterprise, the SI_GUID changes. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 10

11 SI_HIDDEN_OBJECT This property indicates whether or not an object is hidden. To query for hidden objects, you must specify that SI_HIDDEN_OBJECT = 1 or SI_HIDDEN_OBJECT!= 0; otherwise, by default, only non-hidden objects are returned. SI_ID This is a number that uniquely identifies an object in the Enterprise system. The number is assigned at creation time, and is never changed until the object is destroyed. No two objects have the same ID, even if they are different types of objects; that is, you will never find a report that has the same ID as a folder. SI_INSTANCE_OBJECT This is a boolean value specifying whether or not the Enterprise object is a report instance that is the result of a job that has already run. Instead of using SI_INSTANCE_OBJECT to determine the status of an instance, it is recommended that you use SI_SCHEDULE_STATUS Property. An instance may be runnable (it is scheduled to run and create another instance), or it may not be runnable (it is the result of a job that has already run). Use this property to retrieve only those instances that have already been run, and the SI_RUNNABLE_OBJECT Property to retrieve only those instances that are runnable. Values set in BOOLEAN: 1 = True 0 = False SI_KIND and SI_PROGID These are string values that identify the Enterprise Object type. These properties return a predetermined identifier for an InfoObject. Use the SI_KIND property as a replacement for the SI_PROGID property that is being deprecated. A comparison of the two properties: SI_PROGID = CrystalEnterprise.Folder SI_KIND = Folder Predetermined Identifier Values: ProgID CrystalEnterprise.AuditAdmin CrystalEnterprise.CacheServerAdmin CrystalEnterprise.Calendar SI_KIND AuditAdmin CacheServerAdmin Calendar 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 11

12 CrystalEnterprise.Category CrystalEnterprise.CMSAdmin CrystalEnterprise.Connection CrystalEnterprise.Report CrystalEnterprise.Diskunmanaged CrystalEnterprise.Event CrystalEnterprise.EventServerAdmin CrystalEnterprise.Excel CrystalEnterprise.FavoritesFolder CrystalEnterprise.Folder CrystalEnterprise.FileServerAdmin CrystalEnterprise.Ftp CrystalEnterprise.FullClient CrystalEnterprise.Hyperlink CrystalEnterprise.Inbox CrystalEnterprise.JobServerAdmin CrystalEnterprise.LicenseKey CrystalEnterprise.Managed CrystalEnterprise.ObjectPackage CrystalEnterprise.Overload CrystalEnterprise.PageServerAdmin CrystalEnterprise.PersonalCategory CrystalEnterprise.Pdf CrystalEnterprise.Powerpoint CrystalEnterprise.Profile CrystalEnterprise.Program CrystalEnterprise.Publication Category CMSAdmin Connection CrystalReport Diskunmanaged Event EventServerAdmin Excel FavoritesFolder Folder FileServerAdmin Ftp FullClient Hyperlink Inbox JobServerAdmin LicenseKey Managed ObjectPackage Overload PageServerAdmin PersonalCategory Pdf Powerpoint Profile Program Publication 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 12

13 CrystalEnterprise.ReportAppServerAdmin ReportAppServerAdmin CrystalEnterprise.Rtf CrystalEnterprise.Server CrystalEnterprise.Shortcut CrystalEnterprise.Smtp CrystalEnterprise.SSOAdmin CrystalEnterprise.Txt CrystalEnterprise.Universe CrystalEnterprise.User CrystalEnterprise.Usergroup CrystalEnterprise.Webi CrystalEnterprise.WebiServerAdmin CrystalEnterprise.Word Rtf Server Shortcut Smtp SSOAdmin Txt Universe User Usergroup Webi WebiServerAdmin Word This property stores the name of an object. It can be used both to display the object's name and to search for a particular object. This is not a unique value; therefore, different objects may have the same names. To list objects by a unique value use the SI_ID property. DUSER Returns True if the license being used is a named user. If False, the license being used is a concurrent user. Values set in BOOLEAN: 1 = True 0 = False SI_NEXTRUNTIME This property stores the date and time when the report will next be run. The format of the date in the query string must be yyyy.mm.dd.hh.mm.ss, where you can omit anything starting from the right, and the separator can be any separator character. The time part must be in UTC time (GMT with no daylight savings) and it must use the 24 hour clock. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 13

14 SI_OWNERID The ID of the user who owns the InfoObject. This property can be used to list all the reports, and folders, for a particular user. Similar to the SI_ID property, this value is unique. SI_PARENTID The SI_PARENTID property is a numeric Long value; it refers to the unique ID for a particular object's parent. It can be used to locate all the children for a particular object. SI_PLUGIN_OBJECT Returns True if the InfoObject is a plug-in, and False otherwise. Value is set as BOOLEAN: 1 = True 0 = False SI_RECURRING Returns True if the InfoObject is a recurring instance, and False otherwise. An instance that is recurring is also runnable. However, a runnable instance may not be recurring. To retrieve only runnable objects, use the SI_RUNNABLE_OBJECT Property. To check the current status of an instance, use the SI_SCHEDULE_STATUS Property Value is set as BOOLEAN: 1 = True 0 = False SI_RUID Returns the unique ID of the InfoObject in the object package. SI_RUNNABLE_OBJECT Returns True if the report object is runnable, and False otherwise. Value is set as BOOLEAN: 1 = True 0 = False SI_SCHEDULE_STATUS The current status of the scheduled job. Schedule Status Values: Value Description 3 The job failed. Use error message or outcome to 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 14

15 get more information. 8 The job is paused. Even if all dependencies are satisfied, it will not run. 9 The job has not started because dependencies are not satisfied. Dependencies include time constraints and events. 0 The job is currently being processed by the job server. 1 The job completed successfully. SI_UPDATE_TS This is a time stamp property that stores the last time the object was modified. An object is modified when any of its properties change. Note that although the date is returned in the format MM/DD/YYYY HH:MM:SS AM/PM, the format of the date in the query string must be yyyy.mm.dd.hh.mm.ss, where you can omit anything starting from the right, and the separator can be any separator character. The time part must be in local time and it must use the 24 hour clock. SI_INSTANCE This property can be used to find all instances of a particular report. When a report is scheduled to run on a recurring basis (for example, hourly), two instances are created: a runnable instance, which is able to run and create another instance, and an instance object, which is the result of a job that has already run. Use the SI_RUNNABLE_OBJECT property to retrieve only those instances that are runnable, and use the SI_INSTANCE_OBJECT property to retrieve only those instances that have already been run. Values set as BOOLEAN: 1 = True 0 = False XI Release 2 Indexed Properties and Database Equivalencies Understanding the links between the Enterprise SDK properties and the physical database fields are important when troubleshooting large customer databases restored in-house. At times, it will be impossible to run an efficient query to collect the information you need when the result set is too large for the CMS in the Query Builder. The Equivalencies Table maps the Enterprise SDK properties to the CMS 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 15

16 database fields (non-binary) that you can use to query directly against the database. Equivalencies Table CMS Database Field CMS_INFOOBJECTS5.OBJECTID CMS_INFOOBJECTS5.PARENTID CMS_INFOOBJECTS5.OWNERID CMS_INFOOBJECTS5.TYPEID CMS_INFOOBJECTS5.SCHEDULESTATUS CMS_INFOOBJECTS5.NEXTRUNTIME CMS_INFOOBJECTS5.LASTMODIFYTIME CMS_INFOOBJECTS5.SI_INSTANCE_OBJECT CMS_INFOOBJECTS5.SI_PLUGIN_OBJECT CMS_INFOOBJECTS5.SI_HIDDEN_OBJECT CMS_INFOOBJECTS5.DUSER CMS_INFOOBJECTS5.SI_RECURRING CMS_INFOOBJECTS5.RUNNABLE_OBJECT Enterprise SDK Property SI_ID SI_PARENTID SI_OWNERID SI_OBTYPE SI_SCHEDULE_STATUS SI_NEXTRUNTIME SI_UPDATE_TS SI_INSTANCE_OBJECT SI_PLUGIN_OBJECT SI_HIDDEN_OBJECT DUSER SI_RECURRING SI_RUNNABLE_OBJECT How and When to use Direct Database Queries Although the database fields can help you collect the records you require, the information returned will be of little value unless you plug them back into the Query Builder. Most of the important object information is held within the binary fields; therefore you will need to use the Query Builder to translate these objects into a more useful format. CMS_INFOOBJECTS5.OBJECTID The main purpose of running a direct query against the database is to further narrow down your record set by collecting the OBJECTIDs (SI_IDs) necessary for your SDK query. Once the OBJECTIDs are collected you can run a more efficient query in the Query Builder using the IN operator in the clause. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 16

17 For example, to collect the OBJECTIDs for all recurring reports in the system database, run the following query: Direct Database SQL: NOTE If you do not know how to write your own SQL against the CMS database create a Crystal, Web Intelligence, or Desktop Intelligence report to filter the data. ObjectID CMS_InfoObjects5 (SI_RECURRING = 1) AND (SI_RUNNABLE_OBJECT = 1) Result Set Sample for OBJECTID = (1,2,3,4,5,6,7,8,9,10) The SI_RUNNABLE_OBJECT property was used to further ensure the object retrieved was not an archived instance. For more information see the CMS_INFOOBJECTS5.SI_RUNNABLE_OBJECT section. With the OBJECTID result set collected, run the following SDK query to return the Enterprise SDK property information for the objects: Query Builder SQL: * SI_ID IN (1,2,3,4,5,6,7,8,9,10) CMS_INFOOBJECTS5.PARENTID The PARENTID field is the best filter strategy for your clause. Every InfoObject within the CMS database will always have a PARENTID. If we start at the lowest level, ObjectID 11, 12, 7006, 7010,.. PARENTID will be 19 since the objects live beneath ObjectID 19 (19 Users), and ObjectID 19 (19 Users) PARENTID will be 4 since it lives beneath ObjectID 4 (4 SMARTYPANTS.CRYSTALD.NET) (see Figure 9). 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 17

18 Figure 9 All InfoObjects within the system are organized in this manner so filtering objects directly against the database using PARENTID simplifies your record set substantially. Using the sample above you can retrieve all of the XI Release 2 users with the following database query: Direct Database SQL: ObjectID CMS_InfoObjects5 (PARENTID = 19) AND (TYPEID = 19) Result Set Sample for ObjectID = (11, 12, 7006, 7010, 7014, 7018, 7022, 7026) The TYPEID property is used to further ensure that the object retrieved is a user object. For more information on the TYPEID property see the CMS_INFOOBJECTS5.TYPEID section. With the result set collected, run the following SDK query in the Query Builder to translate all of the binary properties: Query Builder SQL: * CI_SYSTEMOBJECTS SI_ID IN (11, 12, 7006, 7010, 7014, 7018, 7022, 7026) 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 18

19 CMS_INFOOBJECTS5.OWNERID The OWNERID field is rarely used to query the database other than to find how many objects a particular user owns within the XI Release 2 system. If the OWNERID information is required, use an SDK query to identify the SI_OWNERID first in order to find your information. Since the OWNERID field is stored as a number it will hold very little value until you find out the username that is assigned to the unique value. Run the following SDK query to get the SI_OWNERID value for a user. Query Builder SQL:, SI_OWNERID CI_SYSTEMOBJECTS = Username AND SI_KIND = User Sample Result Set: = Administrator SI_OWNERID = 12 The SI_KIND property was used to ensure the (Username) value returned was a User account. For more information regarding the SI_KIND property, see the Predetermined Identifier Values table located in the XI Release 2 Indexed Properties section. Once you have obtained the SI_OWNERID value, run the following query to get a count of how many objects the user account owns: Direct Database SQL: COUNT(OBJECTID) CMS_InfoObjects5 OWNERID = 12 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 19

20 The COUNT(OBJECTID) function was used to return the aggregate count of all the objects the user owns. If you require a count of specific object types such as, reports, folders, or instances, add the TYPEID field in your clause. For more information on the TYPEID field, see the CMS_INFOOBJECTS5.TYPEID section. CMS_INFOOBJECTS5.TYPEID The SI_KIND and SI_PROGID SDK properties are stored in the database as binary fields; therefore, the TYPEID field must be used to filter out specific object types if required. The table below links the static TYPEID value for each InfoObject type available within the XI Release 2 system. Note that these values may change between Enterprise product versions. The following is a listing for XI Release 2 only: TYPEID ProgID SI_KIND 22 CrystalEnterprise.Calendar Calendar 45 CrystalEnterprise.Category Category 41 CrystalEnterprise.Connection Connection 2 CrystalEnterprise.Report CrystalReport 331 CrystalEnterprise.Diskunmanaged Diskunmanaged 21 CrystalEnterprise.Event Event 319 CrystalEnterprise.Excel Excel 18 CrystalEnterprise.FavoritesFolder FavoritesFolder 1 CrystalEnterprise.Folder Folder 11 CrystalEnterprise.FullClient FullClient 310 CrystalEnterprise.Hyperlink Hyperlink 48 CrystalEnterprise.Inbox Inbox 24 CrystalEnterprise.LicenseKey LicenseKey 290 CrystalEnterprise.ObjectPackage ObjectPackage 280 CrystalEnterprise.Overload Overload 47 CrystalEnterprise.PersonalCategory PersonalCategory 279 CrystalEnterprise.Pdf Pdf 278 CrystalEnterprise.Powerpoint Powerpoint 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 20

21 277 CrystalEnterprise.Profile Profile 276 CrystalEnterprise.Program Program 275 CrystalEnterprise.Publication Publication 270 CrystalEnterprise.Rtf Rtf 16 CrystalEnterprise.Server Server 8 CrystalEnterprise.Shortcut Shortcut 265 CrystalEnterprise.Txt Txt 264 CrystalEnterprise.Universe Universe 19 CrystalEnterprise.User User 20 CrystalEnterprise.Usergroup Usergroup 260 CrystalEnterprise.Webi Webi 259 CrystalEnterprise.Word Word The following SQL will perform a count of all the Crystal Reports owned by the Administrator account: Direct Database SQL: COUNT(OBJECTID) CMS_InfoObjects5 OWNERID = 12 and TYPEID = 2 CMS_INFOOBJECTS5.SCHEDULESTATUS Be cautious when using the SCHEDULESTATUS field when directly querying the system database. Some of the values have more than one meaning. For example, When looking at the values available in the table, a value of 9 may mean the scheduled job is in pending state because it is waiting for a file event, schedule event, or it has not reached its next runtime. The most reliable values are 3 or 1 since these values do not change over time. Value Description 3 The job failed. Use error message or outcome to get more information. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 21

22 8 The job is paused. Even if all dependencies are satisfied, it will not run. 9 The job has not started because dependencies are not satisfied. Dependencies include time constraints and events. 0 The job is currently being processed by the job server. 1 The job completed successfully. To find the number of failed jobs within the XI Release 2 system use the following SQL: Direct Database SQL: COUNT(OBJECTID) CMS_InfoObjects5 SCHEDULESTATUS = 3 CMS_INFOOBJECTS5.NEXTRUNTIME Do not use this field to filter. The field is not declared as a DATETIME field but a VARCHAR. Your results will be incorrect. CMS_INFOOBJECTS5.LASTMODIFYTIME Do not use this field to filter. The field is not declared as a DATETIME field but a VARCHAR. Your results will be incorrect. CMS_INFOOBJECTS5.SI_INSTANCE_OBJECT The SI_INSTANCE_OBJECT field can be used to collect all successfully run jobs. The field can be used to distinguish between the recurring instances and archived instances within the system. If the value is True (1), the object is an archived instance and cannot be run again. To collect all the archived instances within the system run the following query: Direct Database SQL: ObjectID CMS_InfoObjects5 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 22

23 SI_INSTANCE_OBJECT = 1 Result Set Sample for ObjectID = (11, 12, 7006, 7010, 7014, 7018, 7022, 7026) Use the result set to run the following Enterprise SDK query: Query Builder SQL: * SI_ID IN (11, 12, 7006, 7010, 7014, 7018, 7022, 7026) CMS_INFOOBJECTS5.DUSER The DUSER field can be used to return all named or concurrent users within the XI Release 2 system. Set the value to True (1) for named users and False (0) for concurrent users in the clause. The following query will return only the named users within the system: Direct Database SQL: ObjectID CMS_InfoObjects5 DUSER = 1 Result Set Sample for ObjectID = (11, 12, 7006, 7010, 7014, 7018, 7022, 7026) Query Builder SQL: 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 23

24 * CI_SYSTEMOBJECTS SI_ID IN (11, 12, 7006, 7010, 7014, 7018, 7022, 7026) CMS_INFOOBJECTS5.SI_RECURRING SI_RECURRING is another field that can be used to collect all the recurring report instances from the system. The following SQL will return all the Crystal report recurring instances that are owned by the Administrator within the XI Release 2 system: Direct Database SQL: ObjectID CMS_InfoObjects5 SI_RECURRING = 1 AND SI_OWNERID = 12 AND TYPEID = 2 Query Builder SQL: * SI_RECURRING = 1 AND SI_OWNERID = 12 AND SI_KIND = crystalreport Query Samples This section provides a list of sample queries to use in the Query Builder. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 24

25 User and Group List All Users, SI_ID, SI_OWNERID, SI_KIND, SI_ALIASES, DUSER, SI_CHANGEPASSWORD, SI_USERGROUPS, SI_PASSWORDEXPIRE, SI_USERFULLNAME, SI_LASTLOGONTIME CI_SYSTEMOBJECTS SI_KIND = 'user' The query above will return all users in the system specifying the following object information: SI_ID SI_OWNERID SI_KIND Username Unique ID within Enterprise system. The unique value applied to objects the user owns. The Enterprise object type. SI_ALIASES The authentication type set for the user account. DUSER User license type. 1 for d and 0 for concurrent. SI_CHANGEPASSWORD Value shows if the user has the right to change their password. SI_USERGROUPS Lists the Enterprise Groups the user belongs to. The values are listed by the User Group unique SI_ID (See the User Group query for how to return group names for the associated Group SI_IDs). SI_PASSWORDEXPIRE Specifies if the password has expired (True or False). SI_USERFULLNAME Users full name. SI_LASTLOGONTIME The date and time the user last logged onto the system. List All Groups, SI_DESCRIPTION, SI_ID, SI_ALIASES, SI_GROUP_MEMBERS 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 25

26 CI_SYSTEMOBJECTS SI_KIND = 'usergroup' The query above will return all the groups within the system specifying the following information: SI_DESCRIPTION SI_ID SI_ALIASES SI_GROUP_MEMBERS Group Group Description The Unique ID of object within Enterprise system. This ID is added to SI_USERGROUP property for each User in Enterprise system that is part of the group. Specifies if the group is an Enterprise, Active Directory, LDAP, or Windows NT group. Lists all the unique user SI_IDs that belong to the group. Lists Users Currently Logged On to Enterprise System SI_APSNAME, SI_AUTHEN_METHOD,, SI_DESCRIPTION, SI_CREATION_TIME CI_SYSTEMOBJECTS SI_KIND = 'connection' The query above will return all currently logged on users within the Enterprise system specifying the following information: SI_APSNAME SI_AUTHEN_METHOD SI_DESCRIPTION The user account logged on. The CMS the user is currently logged onto. The authentication type of user. The user description. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 26

27 SI_CREATION_TIME The date and time of when the user logged on. Crystal Report View Latest Instance ID of Report SI_ID, SI_PARENTID,, SI_LAST_SUCCESSFUL_INSTANCE_ID SI_ID = ReportID OR SI_ID, SI_PARENTID,, SI_LAST_SUCCESSFUL_INSTANCE_ID = Report AND SI_INSTANCE = 0 AND SI_KIND = CrystalReport The queries above will return the Last Successful Instance ID for a report object. The ID is used for the View Latest Instance link for each schedulable report in InfoView. The query provides the following information: SI_LAST_SUCCESSFUL _INSTANCE_ID SI_ID SI_PARENTID The SI_ID value of the latest instance scheduled. This ID is used as the SI_PARENTID value for each report instance it creates beneath it. The parent ID of the Report. The value is usually the Folder unique SI_ID it resides in. The report name. Retrieve All Instances for a Report Object 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 27

28 SI_SCHEDULEINFO.SI_STARTTIME,, SI_INSTANCE SI_PARENTID = ParentID AND SI_INSTANCE = 1 ORDER BY SI_ID DESC The SI_PARENTID will be the main Report Objects SI_ID value. The query above will return all instances for a report object specifying the following information: SI_INSTANCE SI_SCHEDULEINFO.SI_ STARTTIME Report Instance Used to confirm that the object is an instance rather than report template. Value should be True or 1. The date and time the instance actually began being processed. Counting the Number of Historical Instances for a Report COUNT(SI_ID) SI_PARENTID = Main Report ID The SI_PARENTID needs to be the unique SI_ID value of the main report object. The query above will return the aggregate count for a report object specifying the following information: Count(SI_ID) The total number of instances created by the report object. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 28

29 List Report Parameter, SI_PROCESSINFO.SI_PROMPTS SI_ID = Report ID The query above returns the following report parameter information: SI_PROCESSINFO.SI_P ROMPTS The report name. The parameter prompt name, default parameter values, and current parameter values used to process the report. NOTE SI_DEFAULT_VALUES are not the parameter values that are going to be used to process the report. When the report is processed, the SI_CURRENT_VALUES property values are used instead. Finding FRS Location for Report, SI_FILES SI_INSTANCE = 0 AND SI_ID = Report ID The query above will return the physical file location of the report object in the file repository. Reporting Database Logon Information, SI_PROCESSINFO.SI_LOGON_INFO SI_INSTANCE = 0 AND SI_ID = Report ID 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 29

30 The query above will return the database information specifying the following information: SI_PROCESSINFO.SI_ LOGON_INFO The report name Displays the data source, database logon, and database driver name. Business View and Business View Connections Finding What Business View a Report is Using, SI_BUSINESSVIEWS, SI_PROCESSINFO.SI_BUSINESS_VIEW_INFO SI_ID = Report ID The query above will return the Business View s unique SI_ID and SI_CUID value that Crystal Reports is using to link back to the Business View. SI_BUSINESSVIEWS SI_PROCESSINFO.SI_B USINESS_VIEW_INFO The report name. The Business Views unique SI_ID value. The SI_CUID of the Business View used by the report. Listing All Business Views SI_ID,, SI_CUID, CI_APPOBJECTS SI_KIND = 'MetaData.BusinessView' The query above will return all the Business Views within the XI Release 2 system. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 30

31 The properties specify the following information: SI_ID SI_CUID The unique ID of the Business View. This value is used in Crystal Report properties SI_BUSINESSVIEWS property to link back the Business View. Business View The Business View cluster ID. This value is referenced in Crystal Reports SI_PROCESSINFO.SI_BUSINESS_VIEW_INFO property to maintain a link between the two objects. Return All Properties for a Business View by * CI_APPOBJECTS = Business View All Reports Connected to a Specific Business View, SI_REPORTS CI_APPOBJECTS = 'Business View ' The query above will return all the unique report SI_IDs using the Business View as a data source. The property values returned specify the following information: SI_REPOR TS The name of the Business View The SI_ID of the reports connected to the Business View. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 31

32 To return the name of the reports, run a second query using the SI_IDs returned from SI_REPORTS property:, SI_KIND SI_ID IN (reportid1, reportid2, reportid3) The query above will return the following information: SI_KIND The report name. The type of report using the Business View. All Business View Connections, SI_ID CI_APPOBJECTS SI_KIND = 'MetaData.DataConnection' The query above returns all the Business View and universe connections within the XI Release 2 system. There is no predetermined identifier to separate Business View and universe connections. The values returned are: SI_ID The connection name. The unique connection ID. Universe and Universe Connections Listing All Universes and their Connection Information, SI_ID, SI_FILES, SI_DATACONNECTION 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 32

33 CI_APPOBJECTS SI_KIND = universe The query above lists all of the universes and their associated universe connections within the Enterprise XI Release 2 system by specifying the following information: SI_ID SI_FILES SI_DATA CONNEC TION The name of the universe. The unique ID of the universe. The physical location and name of universe file in FRS. The data connections assigned to the universe object. The value listed will be the SI_ID of the universe connection. For property information on the connection use the following query: * CI_APPOBJECTS SI_ID = ID returned in SI_DATACONNECTION Return Web Intelligence Reports Connected to a Specific Universe, SI_WEBI, SI_DATACONNECTION CI_APPOBJECTS SI_KIND = universe and = Universe The query above returns all the Web Intelligence documents assigned to the universe by specifying the following information: 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 33

34 SI_WEBI SI_DATACONNECTION The name of the universe. The list of Web Intelligence documents assigned to the universe by SI_ID. The data connection assigned to this universe. To list the Web Intelligence report names run the following query: SI_ID IN (ID from SI_WEBI, ID from SI_WEBI) Core and Derived Universe Information SI_DERIVEDUNIVERSE, SI_COREUNIVERSE, SI_DATACONNECTION, SI_SHORTNAME, CI_APPOBJECTS SI_KIND = 'universe' AND = Universe The query above returns the SI_ID of the derived or core universes by specifying the following information: SI_DERIVEDUNIVERSE SI_COREUNIVERSE SI_DATACONNECTION SI_SHORTNAME The universe name. The derived universes assigned to the universe object. A derived universe inherits objects and classes from core universes. The ID of the core universes assigned to the object. A core universe is the building block, or base, for a derived universe. The data connections assigned to the universe object. Sets the short name for this universe object. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 34

35 To return the name of the derived or core universes run a second query using the SI_IDs returned from SI_COREUNIVERSE and SI_DERIVEDUNIVERSE. SI_ID = SI_ID from SI_COREUNIVERSE OR SI_DERIVEDUNIVERSE Web Intelligence Report Web Intelligence Report Universe Connection, SI_UNIVERSE = webi report name and SI_KIND = webi The query above will return the Web Intelligence report s universe connection information. The value returned will be the SI_ID of the universe. To return the properties for the universe run the following query:, SI_DATACONNECTION CI_APPOBJECTS SI_ID = SI_UNIVERSE values Web Intelligence Report Parameter Information, SI_PROCESSINFO.SI_WEBI_PROMPTS, 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 35

36 SI_PROCESSINFO.SI_HAS_PROMPTS, SI_PROCESSINFO.SI_PROMPT_USER_VIEWING = webi report name and SI_KIND = webi The query above will return the parameter prompt information within the Web Intelligence document by specifying the following information. SI_PROCESSINFO.SI_WEBI_PROMP TS SI_PROCESSINFO.SI_HAS_PROMP TS SI_PROCESSINFO.SI_PROMPT_USE R_VIEWING The Web Intelligence report name. The prompt names and parameter values for the Web Intelligence report. Specifies TRUE if the Web Intelligence report has parameters. Specifies if the Web Intelligence report will prompt the user for parameter values. Web Intelligence Report and CACHE Output, SI_PROCESSINFO.SI_PRECACHE_HTML, SI_PROCESSINFO.SI_PRECACHE_OUTPUTS = webi report name AND SI_KIND = webi The query above will specify if the Web Intelligence reports have precached outputs turned on. The properties return the following information: SI_PROCESSINFO.SI_PR ECACHE_HTML The Web Intelligence report name. Indicates whether the HTML text stream that represents a Web Intelligence document will be pre-loaded into the cache. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 36

37 SI_PROCESSINFO.SI_PR ECACHE_OUTPUTS Contains a collection of information that represents the different output types for a Web Intelligence document. View Latest Instance ID for Web Intelligence Report SI_ID, SI_PARENTID,, SI_LAST_SUCCESSFUL_INSTANCE_ID SI_ID = ReportID OR SI_ID, SI_PARENTID,, SI_LAST_SUCCESSFUL_INSTANCE_ID = Report AND SI_INSTANCE = 0 AND SI_KIND = webi The queries above will return the Last Successful Instance ID for a report object. The ID is used for the View Latest Instance link for each schedulable report in InfoView. The query provides the following information: SI_LAST_SUCCESSFU L_INSTANCE_ID SI_ID SI_PARENTID The SI_ID value of the latest instance scheduled. The unique ID of object. This ID is used as the SI_PARENTID value for each report instance it created. The parent ID of the report. The value is usually the unique folder SI_ID the report resides in. The Web Intelligence report name Retrieve All Instances for Web Intelligence Report Object 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 37

38 SI_SCHEDULEINFO.SI_STARTTIME,, SI_INSTANCE SI_PARENTID = ParentID AND SI_INSTANCE = 1 ORDER BY SI_ID DESC The SI_PARENTID value will be the main Report Objects SI_ID value. The query above will return all instances for a report object specifying the following information: SI_INSTANCE SI_SCHEDULEINF O.SI_STARTTIME The name of the Web Intelligence report instance. This property is used to confirm that the object is an instance. The date and time that the instance actually began being processed. Counting the Number of Historical Instances for a Web Intelligence Report COUNT(SI_ID) SI_PARENTID = Parent ID The Parent ID is the SI_ID value of the main report object. The query above will return the aggregate count for a report object specifying the following information: Count(SI_ID) The total number of instances created by the Web Intelligence report object. Finding FRS Location for Report, SI_FILES 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 38

39 SI_KIND = webi AND = webi report name The query above will return the physical file location of the Web Intelligence report. SI_FILES The report name. The physical directory location of report object. Desktop Intelligence Desktop Intelligence Universe Connection and Data Providers, SI_UNIVERSE, SI_PROCESSINFO.SI_FULLCLIENTDATAPROVIDERS = deski report name and SI_KIND = FullClient The query above will return the Desktop Intelligence reports universe connection and data provider information. The value returned for SI_UNIVERSE is the unique SI_ID of the universe. The SI_FULLCLIENTDATAPROVIDERS will return the universe name or the data provider name the report is using. To return the name of the universe run the following query:, SI_DATACONNECTION CI_APPOBJECTS SI_ID = SI_UNIVERSE values Desktop Intelligence Report Parameter Information, SI_HAS_PROMPTS, 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 39

40 SI_PROMPT_USER_VIEWING = deski report name and SI_KIND = fullclient The query above will return the parameter information specifying the following information. SI_HAS_PROMPTS SI_PROMPT_USER_VIEWING Desktop Intelligence report name. Returns TRUE if Desktop Intelligence report has parameters. Returns TRUE if user is to be prompted for parameter values. Desktop Intelligence Report and CACHE Output, SI_PROCESSINFO.SI_PRECACHE_HTML, SI_PRECACHE_XLS, SI_PRECACHE_PDF, SI_PROCESSINFO.SI_PRECACHE_OUTPUTS = deski report name AND SI_KIND = FULLCLIENT The query above will return the reports pre-cache settings by specifying the following information: SI_PROCESSINFO.SI_P RECACHE_HTML SI_PROCESSINFO.SI_P RECACHE_XLS SI_PROCESSINFO.SI_P RECACHE_PDF The Desktop Intelligence report name. Indicates whether the HTML text stream that represents a Desktop Intelligence document will be preloaded into the cache. Indicates whether the Excel text stream that represents a Desktop Intelligence document will be pre-loaded into the cache. Indicates whether the PDF text stream that represents a Desktop Intelligence document will be pre-loaded into the cache. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 40

41 SI_PROCESSINFO.SI_P RECACHE_OUTPUTS Contains a collection of information that represents the different output types for a Desktop Intelligence document. View Latest Instance ID for Desktop Intelligence Report SI_ID, SI_PARENTID,, SI_LAST_SUCCESSFUL_INSTANCE_ID SI_ID = ReportID OR SI_ID, SI_PARENTID,, SI_LAST_SUCCESSFUL_INSTANCE_ID = Deski Report AND SI_INSTANCE = 0 AND SI_KIND = FULLCLIENT The queries above will return the Last Successful Instance ID for a report object. The ID is used for the View Latest Instance link for each schedulable report object in InfoView. The query properties provide the following information: SI_LAST_SUCCESSFU L_INSTANCE_ID SI_ID SI_PARENTID The SI_ID value of the latest instance scheduled. The unique ID of object report object. This value will be the SI_PARENTID for each instance the report creates. The parent ID of the report. The value is the unique SI_ID of the folder the report resides in. The Desktop Intelligence report name. Retrieve All Instances for the Desktop Intelligence Report Object 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 41

42 SI_SCHEDULEINFO.SI_STARTTIME,, SI_INSTANCE SI_PARENTID = ParentID AND SI_INSTANCE = 1 ORDER BY SI_ID DESC The SI_PARENTID will be the main Report Objects SI_ID value. The query above will return all instances for a report object. The properties will specify the following information: SI_INSTANCE SI_SCHEDULEINFO.S I_STARTTIME The Desktop Intelligence report instance name. This value is used to confirm that the object is an instance. Value of 1 ensures it is a report instance. The date and time that the instance actually began being processed. Counting the Number of Historical Instances for a Desktop Intelligence Report COUNT(SI_ID) SI_PARENTID = Parent ID The Parent ID is the SI_ID value of the main report object. The query above will return the aggregate count for a report object by specifying the following information: Count(SI_ID) The total number of instances created by the Desktop Intelligence report object. Finding FRS Location for Report, SI_FILES 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 42

43 SI_KIND = FULLCLIENT AND = deski report name The query above will return the physical file location of the Desktop Intelligence report object by specifying the following information: SI_FILES The report name. The physical location of the report object. License Key License Keys and Product Version SI_LICENSE_KEY, SI_PRODUCT_VERSION CI_SYSTEMOBJECTS SI_KIND ='LicenseKey' The query above will return the Enterprise XI Release 2 license key and the product version. Licensing Features Unlocked by Key Code SI_SYSTEM_INFO CI_SYSTEMOBJECTS SI_ID = 4 The query above will return the unlocked Enterprise features the license key allows for. Scheduling Determining Report Scheduling Status SI_SCHEDULEINFO.SI_PROGRESS, 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 43

44 SI_SCHEDULE_STATUS = 0 The SI_SCHEDULEINFO.SI_PROGRESS will return a numeric value specifying the current state of the report instance. The value definitions are described below: Value 0 New 1 Outstanding 2 Running 3 Complete All Recurring Scheduled Reports, SI_SCHEDULEINFO.SI_STARTTIME SI_RECURRING = 1 The query above will return all the recurring reports within the XI Release 2 system by specifying the following properties: SI_SCHEDULEINFO.SI_STARTTIME The recurring report name. The date and time the report is scheduled to run next. General Scheduled Report Information, SI_SCHEDULEINFO.SI_SUBMITTER, SI_PARENTID, SI_KIND, SI_NEXTRUNTIME, SI_PROCESSINFO.SI_DBNEEDLOGON, SI_PROCESSINFO.SI_LOGON_INFO, 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 44

45 SI_PROCESSINFO.SI_PROMPTS, SI_PROCESSINFO.SI_RECORD_FORMULA, SI_FORMAT_INFO, SI_DEPENDENCIES SI_ID = Report ID The query above returns the most common properties for a scheduled report. SI_SCHEDULEINFO.SI_S UBMITTER SI_PARENTID SI_KIND SI_NEXTRUNTIME SI_PROCESSINFO.SI_DB NEEDLOGON SI_PROCESSINFO.SI_LO GON_INFO SI_PROCESSINFO.SI_PRO MPTS SI_PROCESSINFO.SI_REC ORD_FORMULA SI_FORMAT_INFO SI_DEPENDENCIES The scheduled report name. The user who submitted the scheduled report. The reports parent SI_ID. The export format the report is to be scheduled to. The date and time the report will run next. Returns True if the reporting database requires a database logon. Lists the database logon information as well as the database driver used to process the report. Lists the report parameter information. This property is a text value that stores the selection formula used to retrieve, and filter, records from the database. The options that have been set in the report for exporting to different format types. The collection of dependency events that the object waits for before being triggered. Values returned are the unique SI_ID values of the events the report depends upon. To return the names of the events, run the following query using the SI_DEPENDENCIES values. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 45

46 CI_SYSTEMOBJECTS SI_KIND = event Servers Servers Registered with the CMS SI_DISABLED,, SI_SERVER_KIND, SI_SERVER_IS_ALIVE, SI_FRIENDLY_NAME, SI_SERVER_NAME, SI_NTSERVICE_NAME, SI_REGISTER_TO_APS CI_SYSTEMOBJECTS SI_KIND = 'server' The query above will return the current status of all the Enterprise XI Release 2 Servers registered with the CMS by specifying the following information: SI_DISABLED SI_SERVER_KIND SI_SERVER_IS_ALIVE SI_FRIENDLY_NAME SI_SERVER_NAME SI_NTSERVICE_NAME SI_REGISTER_TO_APS The name of the XI Release 2 Server. Returns FALSE if the server is enabled. Specifies the type of server that is registered with the CMS. Returns True if server is alive (running). The servers friendly name as specified in the Command line name switch for each server in the Central Configuration Manager. The name of the host (machine) where the server is running. The Windows NT operating system's service name. Returns True if the server has successfully registered with the CMS name service, and False otherwise. Current CMS Load SI_APS_LOAD 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 46

47 CI_SYSTEMOBJECTS SI_KIND='Server' and SI_SERVER_KIND = 'APS' The query above returns the current number of users connected to the CMS. Listing CMS Members in the Cluster SI_CLUSTER_MEMBERS CI_SYSTEMOBJECTS SI_ID = 4 Server IOR (Interoperable Object Reference), SI_SERVER_KIND, SI_SERVER_IOR CI_SYSTEMOBJECTS SI_KIND ='server' The above query returns the IOR (Interoperable Object Reference) for each server. The CMS keeps track of each registered server IOR for communication. In general terms, the IOR is a data structure associated with a CORBA object that contains enough information to locate that object from anywhere on the network. For XI Release 2 servers the IOR includes, among other things, the port and host name of the server. The encrypted string can be decrypted through an internal command line utility. Authentication Authentication Used to Logon, SI_AUTHEN_METHOD 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 47

48 CI_SYSTEMOBJECTS SI_KIND='Connection' The query above returns the currently logged on users in the Enterprise system and the authentication type used. SI_AUTHEN_METHOD The user name. The authentication type used to logon to the Enterprise system. Authentication Plug-in Information, SI_MAPPED_GROUPS, SI_DEFAULT_DOMAIN, SI_AVAIL, SI_SSO_ENABLED CI_SYSTEMOBJECTS IN ('secwinad', 'secenterprise', 'secldap', 'secwindowsnt') The query above will return the authentication groups mapped into the Enterprise system. SI_MAPPED_GROUPS SI_DEFAULT_DOMAIN SI_AVAIL SI_SSO_ENABLED The authentication type. Returns the SIDs of the mapped in AD or NT groups. LDAP groups return the LDAP group name. The default domain specified in the authentication tab of the CMC. Indicates whether the authentication plug-in is available or not. Returns TRUE if Single Sign-On is enabled. LDAP Configuration Information 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 48

49 , SI_MAPPED_GROUPS, SI_HOST_AND_PORT, SI_APS_ADMIN_DN, SI_BASE_DN, SI_AVAIL, SI_SSL_SERVER_AUTH_STRENGTH, SI_SSO_ENABLED, SI_LDAP_SERVER_TYPE CI_SYSTEMOBJECTS = 'secldap' The query above will return the configuration settings for the LDAP server. SI_AVAIL SI_MAPPED_GROUPS SI_HOST_AND_PORT SI_APS_ADMIN_DN SI_BASE_DN SI_SSO_ENABLED SI_LDAP_SERVER_TYPE SI_SSL_SERVER_AUTH_S TRENGTH The LDAP plug-in name Indicates whether or not LDAP authentication is available. Returns the mapped in LDAP group names. The host and port numbers used to connect to the LDAP server. The LDAP server administration distinguished name. The Base LDAP distinguished name. Returns True if enabled. The LDAP server yype. Indicates the server-side SSL strength. See available values and definitions in table below. Server-side SSL strength values table: Member Value Description ceweak 0 Accept the server's certificate. cecert 1 Accept the server's certificate only if we trust the Certificate Authority who issued the certificate. cecncheck 2 Accept the certificate only if we trust the Certificate Authority that issued the certificate, and the value of the CN attribute in the certificate is the DNS hostname of the server. cenone 3 SSL is not being used. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 49

50 The authentication strength options are: ceweak cecert cecncheck cenone CeWEAK does not require the client to trust the LDAP server's certificate authority (CA). Therefore, no configuration is needed for the cert7.db database. In the cecert scenario, the client must trust the CA of the LDAP server's certificate. This requires that the LDAP server CA's certificate is added to the cert7.db database. The cecncheck option requires that the client must trust the CA of the LDAP server's certificate, and the CN attribute of the LDAP server's certificate matches its DNS hostname. In order to accomplish this, the LDAP server CA's must be added to the cert7.db, and the LDAP server must trust the client's certificate. Windows AD Configuration Information,SI_AVAIL, SI_MAPPED_GROUPS, SI_DEFAULT_DOMAIN, SI_APS_ADMIN_DN, SI_SSO_ENABLED, SI_KERBEROS_ENABLED, SI_CACHE_SECCONTEXT, SI_SERVER_SSPI_SPN CI_SYSTEMOBJECTS = 'secwinad' The query above returns the Windows AD configuration within the XI Release 2 system by specifying the following information: SI_AVAIL SI_MAPPED_GROUPS SI_DEFAULT_DOMAIN SI_APS_ADMIN_DN SI_SSO_ENABLED Description Windows AD plug-in name. Indicates whether or not the AD plug-in is available. The SID of the mapped in AD group. The Default Domain as specified in the AD tab in the CMC. The AD Administration. Returns True if Single Sign-On is enabled. 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 50

51 SI_KERBEROS_ENABLED SI_CACHE_SECCONTEXT SI_SERVER_SSPI_SPN Indicates whether kerberos single sign-on is enabled. Returns True if enabled. This value indicates whether the security context for Kerberos authentication is cached. Returns True if enabled. Returns the Server Principle. Finding more information For more information and resources, refer to the product documentation and visit the support area of the web site at 6/13/ :42:00 AM Copyright 2007 Business Objects. All rights reserved. Page 51