3. creating

38
Page 1 of 38 For Internal Use Only Create a Web Intelligence document (HTML viewer) Step: 1 Web Client sends the request new Web Intelligence Document Request in a URL via the Web Server to the Web Application Serve. Map Process Web Client In an HTML 4.0 compliant browser, InfoView provides the option to create a new Web Intelligence Document. Once the new Web Intelligence Document button is selected from the toolbar, client side JavaScript requests a new page: new.do (Java). This process flow details the Java-based InfoView configured for HTML. Web Server A 3 rd party Web Server, typically Internet Information Server (IIS) or Tomcat Apache, the Web Server, logs the request and forwards it to the Web Application Server.

Upload: srivardan

Post on 09-Apr-2016

9 views

Category:

Documents


6 download

DESCRIPTION

creat

TRANSCRIPT

Page 1: 3. Creating

Page 1 of 38

For Internal Use Only

Create a Web Intelligence document (HTML viewer)

Step: 1 Web Client sends the request new Web Intelligence Document Request in a URL via the Web Server to the Web Application Serve.

Map

Process Web Client

In an HTML 4.0 compliant browser, InfoView provides the option to create a new Web Intelligence Document. Once the new Web Intelligence Document button is selected from the toolbar, client side JavaScript requests a new page: new.do (Java).

This process flow details the Java-based InfoView configured for HTML.

Web Server

A 3rd party Web Server, typically Internet Information Server (IIS) or Tomcat Apache, the Web Server, logs the request and forwards it to the Web Application Server.

Page 2: 3. Creating

Page 2 of 38

For Internal Use Only

Web Application Server

The Web Application Server is a collection of files written by Business Objects in either Java or ASP.Net. The selected solution is determined by the choice of Web Server as Microsoft’s Internet Information Server supports ASP.Net and Tomcat Apache processes Java pages.

Tools Web Client Interaction

AppSight

In circumstances where observing the user interacting with their system is not possible, AppSight is a tool used to record users interacting with their system. Similar to the black box recorder on an airplane, it records the user’s movements and choices and can later be played back by support personal to resolve issues.

http://www.appsight.com

HTTPAnalyzer

HTTP Analyzer is a sniffer tool that monitors and inspects HTTP/HTTPS traffic in real time. It displays a wide range of information, including: header, content, cookies, query strings, post data, request and response stream, and redirection URLs.

http://www.httpanalyzer.com

Web Server

Most vendors provide a set of monitoring tools for their Web Servers. Both Internet Information Services (IIS) and Apache Tomcat provide log files as a means to capture their respective workloads, though the level of detail and options differs.

Internet Information Server Log File Location

[Install Path]\System32\Logs\

Page 3: 3. Creating

Page 3 of 38

For Internal Use Only

By default, new log files created daily, though the size, occurrence and details recorded are configurable through the IIS Manager.

Apache Tomcat Logs File Location

[Install Path]\Program Files\Business Objects\Tomcat\Logs

The Administration utility allows the Administrator to set the level in addition to the location of the log files.

Page 4: 3. Creating

Page 4 of 38

For Internal Use Only

Config The Java-based InfoView allows the report panel to be configured whereas the .Net-based InfoView only implements a Java-applet.

Java-based InfoView Report Panel Options:

Query- HTML: Used to create or modify existing Web Intelligence Report documents in a pure HTML environment, this panel allows documents to be built from multiple data sources.

Java Report Panel: Designed for reports that require more flexibility in report layout and formulas, this panel provides a graphical Formula Editor to rapidly build reports through drag-and-drop functionality.

HTML Report Panel: Used for building basic reports, the HTML Report Panel supports building queries and setting additional report features (such as formatting) through a simple HTML interface. Each document can only be based on a single data source but can contain multiple reports that display different subsets of information.

Page 5: 3. Creating

Page 5 of 38

For Internal Use Only

Step: 2 The Web Application Server (Web Intelligence SDK) receives the URL request

Map

Process To create the Web Intelligence document, New.do is first requested by the Web Client.

The request is processed by the Web Application Server and it responds by processing Universes.jsp. The Java page calls several components from the SDK, including a call to the Central Management Server (CMS) for verification of rights.

Tools Business Objects trace

Adding a command line trace parameter to the CMS instructs the server to log its actions. With a timestamp, the trace shows a range of information including method calls, metadata located in memory, or calls are made to the System Repository.

Page 6: 3. Creating

Page 6 of 38

For Internal Use Only

Step: 3 The CMS checks the system database to verify user rights.

Map

Process The Central Management Server (CMS) verifies the user’s credentials by searching through its memory cache or querying the System Repository.

Tools Business Objects trace

Adding a command line trace parameter to the CMS causes the server to log the actions it performs. Writing a Timestamp and ProcessID, the trace shows a range of information including method calls and when the CMS interacts with the System Repository.

Querytiming Parameter

This additional CMS command line parameter captures queries made to the System Repository from the CMS.

3rd Party Tracing

As the repository can be installed on a variety of platforms, the vendor’s database solution may also come with its own tracing utilities. For example, with Microsoft SQL Server, a utility called Profiler allows for the capturing of server load. Profiler displays the

Page 7: 3. Creating

Page 7 of 38

For Internal Use Only

SQL Statements executed against the server in addition to a range of information related to duration, i/o, deadlocks and locking.

Step: 4 The Central Management Server sends a response to the Web Application Server

Map

Process Via the Web Intelligence SDK, the confirmation of rights is returned through a component to View.do.

If the appropriate create credentials have not been granted, further processing of this workflow is suspended and the Web Client will display an error in a pop-up window.

Page 8: 3. Creating

Page 8 of 38

For Internal Use Only

Step: 5 The Web Application Server sends the list of Universes to the Web Client via the Web Server

Map

Process Universes.jsp (Java) requests a list of Universes from a component in the SDK and iterates through them to generate a hyperlinked list of Universes in an HTML format. Displaying their LongName property from the System Repository it’s a descriptive name up to 32 characters long. Each Universe also has its shortName (8 characters) and CUID (a unique identifier) appended to the hyperlink. The LongName and ShortName are assigned by the Universe developer and the unique identifier is automatically assigned when the universe is saved.

The HTML page is delivered to the Web Client.

Tools HTTPAnalyzer

HTTP Analyzer is a sniffer tool that allows you to monitor and inspect HTTP/HTTPS traffic in real-time. It displays a wide range of information, including: header, content, cookies, query strings, post data, request and response stream, redirection URLs and more.

http://www.httpanalyzer.com

Page 9: 3. Creating

Page 9 of 38

For Internal Use Only

Step: 6 A universe is selected in the client.

Map

Process The Web Client displays a list of hyperlinked Universes. Client-side JavaScript will submit a GET reqeuest and calls New.do from the Web Server. Several additional arguments are passed including:

CUID: A unique identifier stored in the System Repository for the Universe. Identified as UnivCUID in the query string.

Short Name: A short name assigned by the universe developer and stored in the System Repository. Identified as the UnivName in the query string.

In the Java-based InfoView, New.do is submitted and index.jsp is returned to the Web Client containing DHTML. The DHTML immediately requests Entry.jsp from the Web Application Server for processing.

The following is an abbreviated portion of the Index.jsp query string

viewType=H&unvid=UnivCUID=AcWR_AmyPJtKpaAvWXV7vA0

Page 10: 3. Creating

Page 10 of 38

For Internal Use Only

;UnivName=beach&lang=en

Tools HTTPAnalyzer

HTTP Analyzer is a sniffer tool that allows you to monitor and inspect HTTP/HTTPS traffic in real-time. It can trace and display wide range of information, including header, content, cookies, query strings, post data, request and response stream, redirection URLs and more.

http://www.httpanalyzer.com

Step: 7 A list of objects related to the selected Universe is requested from the Web Intelligence Report Server.

Map

Process To fulfill the request for a list of objects and classes related to the selected Universe, the Report engine is invoked and a Web Intelligence Session created. Report Engine To create and later work with a report, an instance of the Report

Page 11: 3. Creating

Page 11 of 38

For Internal Use Only

Engine is required. Created from the Enterprise Session, the Report Engine is reused during the lifetime of the Enterprise Session (also known as a Logon Session or User Session). The Enterprise session was established when the Web Client first logged into InfoView. The Enterprise session contains a range of user and security settings. The Report Engine creates a proxy SDK Document Instance after locating the Web Intelligence Server(s) through the SDK or OCA library. It is upon creating the SDK Document Instance that the Web Intelligence Session is created. Web Intelligence Session A Web Intelligence Session (also known as a Cadenza Session or Document Session) is initialized. Created specifically for that document, the session is not be reused. The Web Intelligence Session is used for:

• Creating and managing temporary folders (on the Web Intelligence Server)

• Storing local copies of Web Intelligence Document (WID) files • Storing Universes

Considered a child session, A Web Intelligence Session inherits user and security settings from its parent Enterprise Session. The Central Management Server stores session information pertaining to the session in the repository and the license count is incremented.

Once the web Intelligence session has been established, then the list of Universes can be retrieved. The Web Intelligence Report Server calls on the Query Technique (QT) component to generate a SQL statement that will be used to retrieve metadata, including its location in the Input File Repository. The Connection Server (also a part of the Report Server) executes the statement.

Tools Business Objects trace

Adding the command line trace parameter to the Web Intelligence Report Server causes the server to log specific actions. The trace includes a range of information including back bone related entries during the initialization and shutdown, file and folder creation/ access and method calls to sub components.

Classic Webi Trace

Page 12: 3. Creating

Page 12 of 38

For Internal Use Only

In a pipe delimited format, the Classic BO Trace is used to record in explicit detail, the operations of the Web Intelligence Report Server. Once the tracing levels have been set, the trace will identify a range of operations including working with sub components and creating and opening files.

Working with this trace requires a BO_Trace.ini file to be created. Three optional environment variables can also be set:

Environment Variables

BO_TRACE_CONFIGDIR = c:\mypath

BO_TRACE_CONFIGFILE=c:\mypath\BO_TRACE.INI

BO_TRACE_LOGDIR= C:\MyLogFolder

BO_TRACE.INI

active=true; important=’<<’; (options are <<,<=,==,>=,>> where << logs informational lines to >> which is critical/error lines) size=10000; keep=true;

Page 13: 3. Creating

Page 13 of 38

For Internal Use Only

Step: 8 The Web Intelligence Report Server retrieves the Universe from the Input FRS.

Map

Process The Universe is placed into a local Session cache on the Web Intelligence Server.

A session cache (also known as a private cache) is used when • a shared cache is not enabled • pages are refreshed • real time functions are used. • documents are created

A sub folder is created and named after storage token under the sessions folder. This new folder holds a set of temporary files that contains both formatting and data for the report. The folder is cleared periodically and automatically deleted, along with all other session sub folders, when the Web Intelligence Report Server is stopped.

Page 14: 3. Creating

Page 14 of 38

For Internal Use Only

Tools Business Objects trace

Adding the command line trace parameter to the Input File Repository Server causes the server to log specific actions. The –trace captures the file name and location of the Universe requested.

FileMon

Sysinternals provides a range tools to analyze a system. FileMon is a tool that monitors in real time the files that have been accessed. FileMon captures the creation of folders and files created and access in the private cache.

Configuration The location of the files stored in the Input FRS is configurable. The example below shows the property tab where both the location and idle time can be changed.

Page 15: 3. Creating

Page 15 of 38

For Internal Use Only

Step: 9 A list of available objects for the given Universe back to the Web Application Server (Web Intelligence SDK).

Map

Process Using the Universe files from the session folder, the Web Intelligence Report Server extracts classes and objects into a set of temporary files before returning the list of objects to entry.jsp.

Tools Business Objects trace

Adding the command line trace parameter to the Web Intelligence Report Server causes the server to log specific actions. The –trace includes a range of information including back bone related entries during the initialization and shutdown, file and folder creation/ access and method calls.

Classic Webi Trace

In a pipe delimited format, the Classic BO Trace is used to record in explicit detail, the operations of the Web Intelligence Report Server. Once the tracing levels have been set, the trace will identify a range of operations including working with sub components as well as creating and opening files.

Working with this trace requires a BO_Trace.ini file to be created.

Page 16: 3. Creating

Page 16 of 38

For Internal Use Only

Optionally, three environment variables can also be set:

Environment Variables

BO_TRACE_CONFIGDIR = c:\mypath

BO_TRACE_CONFIGFILE=c:\mypath\BO_TRACE.INI

BO_TRACE_LOGDIR= C:\MyLogFolder

BO_TRACE.INI

active=true; important=’<<’; (options are <<,<=,==,>=,>> where << logs informational lines to >> which is critical/error lines) size=10000; keep=true;

Page 17: 3. Creating

Page 17 of 38

For Internal Use Only

Step: 10 The Web Application Server (Web Server Intelligence SDK) forwards the list to the web client via the Web Server.

Map

Process An SDK component in Entry.jsp iterates through the collection of classes and object passed from the Web Intelligence Report Server. Entry.jsp creates DHTML to allow any HTML 4.0 compliant browser to select a range of objects from the previously selected Universe.

The page returned is constructed of HTML and client-side JavaScript.

Every object from the Universe is displayed by name. The objects also store their unique identifiers and information about their associated DataProvider. The provider information is used to retrieve data from its associated data store when the refresh button is clicked.

Tools HTTPAnalyzer

HTTP Analyzer is a sniffer tool that monitors and inspects HTTP/HTTPS traffic in real time. It displays a wide range of information, including: header, content, cookies, query strings, post data, request and response stream, and redirection URLs.

http://www.httpanalyzer.com

Page 18: 3. Creating

Page 18 of 38

For Internal Use Only

Step: 11 The Web Client selects the specific database objects and issues a request to run the query to the Web Application Server (Web Intelligence SDK) via the Web Server.

Map

Process In the Web Client, once Universe objects are selected and report formatting decided, the document must first be populated before it can be saved.

InfoView provides a refresh button which submits the values to Web Intelligence Report Server by calling apply.jsp.

The example below shows a small subset of the posted content including WOMqueryobs which corresponds to Data Provider entries in the private session folder in the Web Intelligence Report Server

WOMqueryobjs=%5BDS0.DO6%2CDS0.DO2%5D&

WOMqueryAtt=%5B-1%2C-1%2Ctrue%2C0%2Ctrue%5D&

WOMqueryfilters=%5Btrue%2C%5B%5D%5D&

Page 19: 3. Creating

Page 19 of 38

For Internal Use Only

WOMquerycontexts=%5B%5D&

WOMdoc=%5Bundefined%2Ctrue%2C%5B%245%2450%2440%244132%246%244%245255%244255%244202%246%2444%2448.26%24411.682%2440%2440.79%2440.79%2440.79%2440.79%244%245%245%244text%

To display the report however, several additional jsp files are requested and handled by the Web Application server.

A redirect is initiated to ViewDocument.jsp which continues to build the look and feel of the Web Intelligence document but ultimately it requests a processing page, ViewCDZDocument.jsp.

Tools Classic Webi Trace

This trace is used to record Web Intelligence Report server processes and differs from the Business Objects trace as it logs only its own interactions in its own process rather then all the other CORBA commands such as pings to the CMS. These traces also keep track of the XML files generated by Web Intelligence in a folder called wicdztrace.

The tracing levels are configurable and will identify a range of operations including working with sub components and creating and opening files. Errors in the workflow are marked with an |E|.

Working with this trace requires a BO_Trace.ini file to be created. Three optional environment variables can also be set:

Environment Variables

BO_TRACE_CONFIGDIR = c:\mypath

BO_TRACE_CONFIGFILE=c:\mypath\BO_TRACE.INI

BO_TRACE_LOGDIR= C:\MyLogFolder

BO_TRACE.INI

active=true; important=’<<’; (options are <<,<=,==,>=,>> where << logs informational lines to >> which is critical/error lines) size=10000; keep=true;

Page 20: 3. Creating

Page 20 of 38

For Internal Use Only

HTTPAnalyzer

HTTP Analyzer is a sniffer tool that monitors and inspects HTTP/HTTPS traffic in real time. It can trace and display wide range of information, including header, content, cookies, query strings, post data, request and response stream, and redirection URLs.

http://www.httpanalyzer.com

Step: 12 The Web Application Server instantiates a component in the Web Intelligence SDK, passing the values posted from the Web Client.

Map

Process ViewCDZ.jsp continues to process the values passed in the query string to construct the report.

Tools Classic Webi Trace

This is a trace is used to monitor Web Intelligence Report server processes. This approach differs from trace parameter as it does not log commands such as pings to the CMS but does identify a range of operations including working with sub components and working with files. This trace also records the XML generated by Web Intelligence

Page 21: 3. Creating

Page 21 of 38

For Internal Use Only

processes in a folder called wicdztrace.

With configurable tracing levels, the trace identifies a range of operations including working with sub components, creating and opening files. Errors in the workflow can be easily found as they are marked with |E|.

Working with this trace requires a BO_Trace.ini file to be created. Optionally, three environment variables can also be set:

Environment Variables

BO_TRACE_CONFIGDIR = c:\mypath

BO_TRACE_CONFIGFILE=c:\mypath\BO_TRACE.INI

BO_TRACE_LOGDIR= C:\MyLogFolder

BO_TRACE.INI

active=true; important=’<<’; (options are <<,<=,==,>=,>> where << logs informational lines to >> which is critical/error lines) size=10000; keep=true;

Page 22: 3. Creating

Page 22 of 38

For Internal Use Only

Step: 13 The Web Intelligence Report Server retrieves the records from the database according to the request

Map

Process Using the temporary files contained session folder and values passed from the Web Application Server, the Web Intelligence Report Server delegates the stages of initialization, retrieving and rendering to different components and their sub components.

The following illustrates the flow of information in the Web Intelligence Server. Each of the components and sub components, are part of the Web Intelligence Report Server:

Page 23: 3. Creating

Page 23 of 38

For Internal Use Only

1) A Query Specification is created from the values passed from the Web Application Server. The Query Specification is an XML description of all the data sources along with any additional properties that affects the connection and is derived from the Universe.

2) The Query Technique generates an SQL statement to retrieve the data.

3) The SQL statement is returned to the Data Provider.

4) The generated SQL statements are executed by the Connection Server (a sub component of the Web Intelligence Report server). These connections work with established 3rd party providers to connect to their respective data stores. If the user has insufficient rights to the data store the process is aborted and the client displays an error in a pop-up window.

5) The data is returned to the Data Provider.

6) The data is passed back to the Web Intelligence Report Server (WiReportServer).

7) The Report Specification is read and passed to the Report Engine (RepEng) from the Report Server. The Report Specification describes style information for the report and is derived by data passed from the Web Application Server.

8) To create aggregations, the Report Engine passes the data to the Query Facility, where a calculation plan is built and executed.

WiReportServer (communication, orchestration)

Cube RepEng (page rendering in xml)

DP (orchestrate

data fetching)

Calculator (build and execute calculation plan from report spec

and DP)

QF

QT (generate SQL)

CS (execute SQL)

Report spec (xml)

Report output (xml)

1

2 3

4 5

6

7

8’ 8

9

10

Facilitate communication between RepEng and

Calculator using iterators

DP : Data provider

QF : Query facility

QT : Query technique

CS : Connection server

RepEng : Report Engine

Query spec (xml)

Dico

Page 24: 3. Creating

Page 24 of 38

For Internal Use Only

9) The data is returned to the Report Engine where the output is rendered as XML (this includes the styles from the Report Specification along with the embedded database values

10) The Report Output is cached on the Web Intelligence Report Server

Tools Business Objects trace

Adding the command line trace parameter to the Web Intelligence Report Server causes it to log its actions. Writing a Timestamp and ProcessID, the trace shows a range of information including method calls and file access.

Classic Webi Trace

This trace is used to monitor Web Intelligence Report server processes and differs from trace parameter in that it logs only its own interactions in its own process. These traces save the XML files generated by Web Intelligence in a folder called wicdztrace.

With configurable tracing levels, the trace identifies a range of operations including working with sub components, creating and opening files. Errors in the workflow can be easily found as they are tagged with |E|.

Working with this trace requires a BO_Trace.ini file to be created. Optionally, three environment variables can also be set:

Environment Variables

BO_TRACE_CONFIGDIR = c:\mypath

BO_TRACE_CONFIGFILE=c:\mypath\BO_TRACE.INI

BO_TRACE_LOGDIR= C:\MyLogFolder

BO_TRACE.INI

active=true; important=’<<’; (options are <<,<=,==,>=,>> where << logs informational lines to >> which is critical/error lines) size=10000; keep=true;

Page 25: 3. Creating

Page 25 of 38

For Internal Use Only

RegMon

Capturing both reads and writes to the registry, this monitoring tool from Sysinternals displays the name of the process, time of access and value requested or written.

http://www.Sysinternals.com

Database Vender Tools

The vendor’s database solution may also come with its own tracing utilities. For example, Microsoft provides a utility called Profiler. Capturing the server, Profiler displays the SQL Statements executed against the server in addition to a range of metrics including statement duration, i/o, deadlocks and locking

Step: 14 The Report Output is passed to the Web Application Server.

Map

Process The Web Application Server renders the report as HTML and passes the contents to Report.jsp in the Web Application Server.

Page 26: 3. Creating

Page 26 of 38

For Internal Use Only

Step: 15 The Web Application Server returns the populated Web Intelligence document to the Web Client.

Map

Process Report.jsp is returned to the client as HTML.

Tools HTTPAnalyzer

HTTP Analyzer is a sniffer tool that monitors and inspects HTTP/HTTPS traffic in real time. It displays a wide range of information, including: header, content, cookies, query strings, post data, request and response stream, and redirection URLs.

http://www.httpanalyzer.com

Page 27: 3. Creating

Page 27 of 38

For Internal Use Only

Step: 16 The Web Client works with the result set and clicks the save button to save the report.

Map

Process Choosing Save from the toolbar in InfoView calls Save.do. This initiates a GET request from the Web Application Server, passesing several query string arguments:

processSave.jsp?iViewerID=1&sEntry=we00030000e6937f93f396&iReport=0&sPageMode=Page&sReportMode=Viewing&iPage=1&zoom=100&isInteractive=false&ViewType=H&isNew=true&repotype=&doctype=wid&forceViewType=&mode=full

Save.do is returned and in an iFrame SelectFolder.jsp is called asking for a location to save the Web Intelligence document. Choosing a location and clicking the OK button, initiates the final steps by calling ProcessSave.jsp.

Page 28: 3. Creating

Page 28 of 38

For Internal Use Only

Tools HTTPAnalyzer

HTTP Analyzer is a sniffer tool that allows you to monitor and inspect HTTP/HTTPS traffic in real time. It can trace and display wide range of information, including header, content, cookies, query strings, post data, request and response stream, redirection URLs and more.

http://www.httpanalyzer.com

Step: 17 The Web Application Server (Web Intelligence SDK) forwards the save request to the Web Intelligence Server.

Map

Process ProcessSave.jsp submits several items to the Web Intelligence Server through the forms collection in addition to items stored in the query string including the name of the Web Intelligence document to be saved and the folder it relates to.

Values passed via the form collection

Page 29: 3. Creating

Page 29 of 38

For Internal Use Only

name=North+America+Sales&description=&keywords=&folderId=2794&categories=&personalCategories=&refreshOnOpen=false&permanentRegionalFormatting=false

Values passed via the query string

processSave.jsp?iViewerID=1&sEntry=we000900001134fc446250&iReport=0&sPageMode=Page&sReportMode=Viewing&iPage=1&zoom=100&isInteractive=false&ViewType=H&isNew=true&repotype=&doctype=wid&forceViewType=&mode=full&overwrite=true

Tools Classic Webi Trace

This trace is used to monitor Web Intelligence Report server processes and differs from trace parameter in that it logs only its own interactions in its own process. These traces save the XML files generated by Web Intelligence in a folder called wicdztrace.

With configurable tracing levels, the trace identifies a range of operations including working with sub components, creating and opening files. Errors in the workflow can be easily found as they are tagged with |E|.

Working with this trace requires a BO_Trace.ini file to be created. Optionally, three environment variables can also be set:

Environment Variables

BO_TRACE_CONFIGDIR = c:\mypath

BO_TRACE_CONFIGFILE=c:\mypath\BO_TRACE.INI

BO_TRACE_LOGDIR= C:\MyLogFolder

BO_TRACE.INI

active=true; important=’<<’; (options are <<,<=,==,>=,>> where << logs informational lines to >> which is critical/error lines) size=10000; keep=true;

Page 30: 3. Creating

Page 30 of 38

For Internal Use Only

Step: 18 The Web Intelligence Report Server builds a Web Intelligence Document according to client specifications and streams that document to the Input FRS.

Map

Process The .wid file is used by other flows when a Web Intelligence Document or Document Instance is later requested. Depending upon the request, some or all of the .wid structures are used to fulfill the request.

Web Intelligence Document File Structure The .wid file is a compound file. Readable with a zip file editor, the logical structure of a .wid file is a tree structure organized as follows:

Page 31: 3. Creating

Page 31 of 38

For Internal Use Only

The root folder is the .wid name. Nodes represented by folders can be accessed by direct address (API). Each node corresponds to a Web Intelligence Report Server (WiReportServer) macro component including: C3 for Cube, CDZ for WiReportServer, Drill for Drill Engine, RE or Repeng for Report Enginge. Leaves are structured binary streams that must be traversed sequentially. The following sections describe each node of the file. Data Root

Node and/or leaf name Description Data (root) BO_Checksum (leaf) Data insuring integrity of the file.

C3 for Cube (node) Node and/or leaf name Description C3 (node) Used by Cube. DATASOURCES (C3 sub-node)

DataSource objects: names and hierarchies are contained in the document.

DATAPROVIDERS (C3 sub-node)

Description and data coming from DataProviders or queries.

Description (leaf) Main C3 document version (currently 2.0) and a string tag “cdzDocument”.

Document (leaf) Document properties: some flags including autoSynchronize=on/off.

DocumentFormula (leaf) List of anonymous formulas found in document reports. (User may set a formula without giving name.

DocumentVariable (leaf) List of variables, tokenized form, also called serial form (format is locale independant).

Page 32: 3. Creating

Page 32 of 38

For Internal Use Only

DocumentVariable_Data (leaf)

Domain for variables having custom sort.

DATASOURCES (C3 sub-node)

Node and/or leave name

Description

DATASOURCES node

DataSource objects: names, hierarchies contained in the document.

DSManager (leaf) Number of DataSources, last key id (for key generation). For each DataSource (DS): DSKey(DS0, DS1, …DSn) DS type (QT) and universe connection string=”Repold=12;UnivId=…) Hierarchies contained by the DS: “DS0.DH5” Database connection string=”4;ODBC17;SQLServer…” Others DS info such as: repold, name, long name, comments… DS properties: max =rowfetched, maxfetchtime Database (DB) date format, DB number format, DB decimal separator, maxOperandsForInList. Flag: allowMultiSelectContext.

DATAPROVIDERS (C3 sub-node)

Node and/or leave name Description DATAPROVIDERS (C3 sub-node)

Data from DataProviders.

DP0 (DataProviders sub-node)

Name of the DataProvider used in the document. In case of multiple Data Providers there will be several storage nodes: DP0, DP1.

Page 33: 3. Creating

Page 33 of 38

For Internal Use Only

Description (leaf) .wid version. DPManager (leaf) List of the Data Providers. SynchroManager (leaf)f For each synchronization: name, key

and source objects. SynchroManager_Data (leaf)

For each synchronization object having custom sort: domain (similar to DocumentVariable_Data).

DPO (DATAPROVIDERS sub-node)

Node and/or leave name

Description

DP0 (DataProviders sub-node)

Name of the DataProvider used in our document. In case of multiple Dataproviders there will be several nodes DP0, DP1...

DP_Data (leaf) Query result also called local cube. Contains Node set of the domain. Node set contains indexes for each dimension (compressed with RLE), or hard-coded values for the measures: DP_Key, DP_Key value, Number of values, frequency of the values cube name, node set (rows, columns, indexes).

DP_Generic (leaf) XML of the query. For each query: query description, query xml format, server parameters, local DS information (DSx.Dpy object description)

DP_QT (leaf) Information related to the query execution:prompts description, SQL query expression tree (binary format).

CDZ for WiReportServer (node)

Node and/or leave name Description

Page 34: 3. Creating

Page 34 of 38

For Internal Use Only

CDZ (node) Used by WiReportServer. Contains information related to the workflows.

SESSION (CDZ sub-node) Information linked to the document state. Document state is linked to the Query Specification and to the Report Specification.

_PROPERTIES (leaf) Document properties and options: name,description… DP information is also duplicated (DP list, queries name).

MDPWORKFLOWINFOS (leaf)

Information linked to the current command execution. Information is used to resume an interrupted command in case, for example, of prompt or context execution.

SESSION (CDZ sub-node) Node and/or leave name

Description

SESSION (CDZ sub-node)

Information linked to the document state, which state is linked to the Query Specification and to the Report Specification.

State (leaf) Document state can be: Initial (document is just created) Created DP Defined query Waiting for Context or Prompt execution Executed query Defined report.

DRILL for Drill Engine (node)

Node and/or leave name Description DRILL (node) Used by Drill engine. Drill_Infos (leaf) Drill Infos such as Drill Setting, and per

report: Report_Id, Drill_Bar. Per Drill_Block: Block_Id and Drill_Hierarchies. Per Drill_Hierarchies: Dim_Key and Hier_Key. Drill_Dimensions. Query filters, Drill parameters.

RE for Repeng (Node)

Page 35: 3. Creating

Page 35 of 38

For Internal Use Only

Node and/or leave name Description RE (node) Used by Repeng. DOCSPEC (leaf) XML of the Report Specification and

formula tokenized form. Also called serial form (cube team).

Tools Business Objects trace

Adding the command line trace parameter to the Input FRS causes the server to log the actions it performs. Writing a Timestamp and ProcessID, the trace shows the folder and .wid file saved on the server.

Page 36: 3. Creating

Page 36 of 38

For Internal Use Only

Step: 19 The Web Intelligence Report server sends an update to the CMS indicating the document was successfully published.

Map

Process The Input FRS location, name and unique identifier for the Web Intelligence document are updated in the System Repository.

Tools Business Objects trace

Adding a command line trace parameter to the CMS causes the server to log the actions it performs. Writing a Timestamp and ProcessID, the trace shows a range of information including SQL update and insert statements executed against the System Repository.

Page 37: 3. Creating

Page 37 of 38

For Internal Use Only

Step: 20 The CMS updates the system database.

Map

Process The CMS sends a SQL insert statement to the System Repository, inserting to both the InfoObjects and Aliases tables.

Tools Business Objects trace

Adding a command line trace parameter to the CMS causes the server to log the actions it performs. Writing a Timestamp and ProcessID, the trace shows a range of information including method calls and when the CMS interacts with the System Repository.

The following is an example from the trace file.

INSERT INTO CMS_InfoObjects5 (ObjName, ObjNameIsTruncated, SI_TABLE, SI_HIDDEN_OBJECT, SI_RUID, SI_RUNNABLE_OBJECT, SI_INSTANCE_OBJECT, SI_GUID, SI_CUID, SI_PLUGIN_OBJECT, SI_NAMEDUSER, SI_RECURRING, SI_KEYWORD, SI_KEYWORDIsTruncated, LOV_KEY, SI_TYPEID_MACHINE, ObjectID, ParentID, TypeID, OwnerID, LastModifyTime, ObjFlags, UserFlags, ScheduleStatus, NextRunTime, CRC, Properties) VALUES( ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)

Page 38: 3. Creating

Page 38 of 38

For Internal Use Only