IReport NMS Setup

Nimsoft Documentation
Nimsoft Unified Reporter

Creating account aware reports
in iReport
Version 1.0
December 2, 2009
Copyright 1998-2009, Nimsoft Corporation.

www.nimsoft.com
Contents
What is an account aware report?.......................................................................3
Background information.................................................................................3
Re-use report templates for accounts..............................................................3
How is this solved in Unified Reporter?............................................................3
Setting up the environment...............................................................................4
iReport........................................................................................................4
Token replacement...........................................................................................8
Creating reports...............................................................................................9
Creating the first test report...........................................................................9
Creating report using stored procedure..........................................................15
Parameters for the stored procedure..............................................................21
Creating a report using dynamic SQL with token.............................................22
Known problems.............................................................................................34
Appendix.......................................................................................................34
Entire xml used in my first account aware report sample using SQL...................34
Entire xml used in my first account aware report sample using nimsoft query
language....................................................................................................37
What is an account aware report?

Background information
The Unified Reporter is a web application that is going to run within WASP
probe. SDP has been enhanced to be able to communicate with the Unified Reporter
web application and show a list of available reports (from Unified Reporter) but the
actual reports are being compiled and executed against the Unified Reporter.
We have developed methods in Unified Reporter to allow customers to create
reports which are what we call account aware. That means, you can create a
template report and re-use it on top of the Nimsoft NIS data and the executing
report will display different results depending on the user who is executing the
report.
It assumes you have good knowledge on separating data using
account/contact and origin fields. This concept has been in the NMS product for some
time now. It also assumes you have knowledge on how to create queries in SQL and
it assumes you have knowledge about how the iReport graphical report designer
works. For quick introduction, please refer to Nimsoft-UR-iReport-QuickStart. For
advanced topics on iReport, you can read the iReport Ultimate Guide.
The Unified Reporter and account aware reports are using the same concept
when data is being separated and displayed to different users who belong to different
origins.
For more information on the Nimsoft SLM data model, please refer to the
Nimsoft-UR-NIS-Datamodel document.
Re-use report templates for accounts

We would like to be able to have reports which can be reused across
accounts, and filter data based on whos viewing them.
How is this solved in Unified Reporter?

With Unified Reporter we are using a technology called a Query Executor. It
allows us to pick up the security context of the user(s) that are viewing a report in
Unified Reporter. Based on this security context, we can determine the appropriate
filter to use when selecting rows.
Nimsoft has written its own Query Executor and plugged it into the Unified
Reporter server. During execution time, it will modify the SQL query which is
associated with the report when the report is being run.
Setting up the environment
If you would like to design account aware reports, we recommend you design
them using iReport and add support for our query executor. Then deploy the report
to Unified Reporter and view the results.
First you will need to setup iReport.
iReport
1. Choose Tools -> Options menu
2. Choose classpath tab + click Add Jar button
3. Navigate to <NMS w/SDP install

folder>/probes/service/wasp/webapps/jasperserver-pro/WEB-INF/lib
4. Choose acegi-security-1.0.1.jar and click Open
5. Click Add Folder button

6. Navigate to <NMS w/SDP install
folder>/probes/service/wasp/webapps/jasperserver-pro/WEB-INF/classes
7. Click Open
8. Your window should now look like this (if you expand the columns).
9. Now select Query Executors tab

10. Click Add
11. Add these values (note that the language is nimsoft with lower case letters
only):
Language:
nimsoft
Factory Class net.sf.jasperreports.engine.query.NimsoftQueryExecuterFactory
Fields
com.jaspersoft.ps.nimsoft.NimsoftFieldsProvider
provider
12. Click OK.
13. Your query executor should now be listed here.
14. Click OK and the query executor should now be ready for use.
Please note, there is not 100% support for query executors in iReport 3.5.0, but the
problems seem to be corrected in 3.6.0.
Token replacement
The query executor is designed to examine the query of each report that is
setup to use the nimsoft query executor. If a know token is found, it will be replaced
with runtime values of the user who is viewing the report on the Unified Reporter
server.
This is the tokens that are currently possible to use in SQL queries for reports
which are using the nimsoft query executor:
token
nimsoft_account_id
nimsoft_account_name
nimsoft_acl
If nimsoft user is
executing
null
null
<acl>
If account/contact user is
executing
<account_id>
<account_name>
Null
Creating reports
Creating the first test report
In this example, we will try to create a basic report which displays some information
depending on whos logged in to Unified Reporter.
This is going to be a very plain example which will try to show you some of the steps
involved.
1.
2.
3.
4.
Create a new report in iReport (blank report).

In the Report Inspector windows, right click and choose Edit Query
Type in a query like this: select myACL='ireport dummy'
Make sure the current TAB is Report Query, Query Language is : SQL and
uncheck Automatically Retrieve Fields. Then click Read Fields manually.
5. See screenshot below
6. In your report inspector, the node named Fields should now be updated with
your column value(s).
7. Drag this field (myACL in this demo) onto the detail section of your report
pane.
8. Click File -> Save.
9. Connect to your repository using the repository navigator; publish the report
as e.g. acl1 under /public.
10. Login to SDP and view your acl1 report
11. The result should be something like the screenshot
12. Here you can see it is using our hard-coded value of ireport dummy that we
typed in our query in step 4.
13. Go back to iReport and change your query to this: select myACL=nimsoft_acl
14. Change the query language from SQL to nimsoft, but do not click the read
fields button. Just click OK.
15. If your save button is not active, then make a change to your report pane to
trigger the save button.
16. Save the updated report.
17. Find your report unit in the Repository Navigator window. Expand it and right
click the main report definition file (usually main.jrxml) and select replace
with current jrxml.
18. Reopen your report unit in SDP/Unified Reporter and see how the content
changed.
19. Try logout.

20. Go back to iReport.
21. In the Report Inspector window, expand the Fields node and delete the field
called myACL.
22. Change the query to this: select myACL='nimsoft_acl',
account='nimsoft_account_name', change the query language back from
nimsoft to SQL and click the read fields button, then click OK.
23. Verify that your fields are up to date. If they are not, you may have to go
back into the query and click the Read Fields button one more time.
24. Now, you must change your query language again from SQL to nimsoft,
without clicking the read fields button (this is a know bug in iReport 3.5.0)
25. Drag the account field onto the report page
26. Save the report, republish it to the repository.

27. Login to SDP using both account and nimsoft user and see the result.
In this example, we have tried to explain how tokens can be replaced during
runtime, depending on whos viewing the report. To try and ease the use of this
technology, we have created a stored procedure which can be executed in order to

try and help filter data based on whos logged in, without using so many steps.
Creating report using stored procedure

Consider the following example. You want to run a query to list your sources, and
which targets have defined QOS for CPU Usage.
Your query might look like this:
SELECT qos.source, qos.target FROM S_QOS_DATA qos
WHERE qos.qos = 'QOS_CPU_USAGE'
ORDER BY qos.source ASC, qos.target ASC
Result example:
If you were to filter by origin, you would have to filter data on the origin column in
the s_qos_data table.
If we change the query to this:
SELECT qos.source, qos.target FROM S_QOS_DATA qos

WHERE qos.qos = 'QOS_CPU_USAGE'
AND qos.origin = 'xpgeha2'
ORDER BY qos.source ASC, qos.target ASC
We get a different result:
We have created a stored procedure to help write these types of queries, for use with
iReport and SDP/Unified Reporter, to make account aware queries.
The stored procedure is spn_js_ExecuteAccountAwareReport
It takes several parameters, they are:
@Select
varchar(max) = null,
@Orderby
varchar(max) = null,
@Restriction
varchar(max) = null, /* and d.origin = $placeholder
*/ /* where d.origin = $placeholder */
@AccountId
varchar(max) = null, /* nimsoft_account_id */
@ProcedureTrace int = 5
Argument 5 is used when debugging, so you can ignore that.
The first 3 arguments are very important. Always set the @AccountId parameter to
nimsoft_account_id.
Example:
EXEC
[dbo].[spn_js_ExecuteAccountAwareReport]
@Select = N'SELECT qos.source, qos.target FROM S_QOS_DATA
qos ',
@Restriction = N'WHERE qos.qos = ''QOS_CPU_USAGE'' AND

qos.origin=$origin_place_holder',
@Orderby = N'ORDER BY qos.source ASC, qos.target ASC',
@AccountId = nimsoft_account_id
The stored procedure will produce the SQL for us, based on what we pass in and the
token nimsoft_account_id will be replaced by the query executor during runtime if we
use this approach.
Create an account aware report using this approach

1.
2.
3.
4.
Create a new empty report.

Edit the report for the query, set query language to SQL.
Copy the query above into the window and click the Read Fields button.
Click OK and verify you now have fields populated.
5. Drag the fields onto the report. Also drag target to the column header as an
aggregate function.
6. Edit the query again, change language from SQL to nimsoft and click OK.
7. Save report, publish to unified reporter. Try to login as nimsoft user and a
contact to see the result.
8. You may see this dialogue when you publish a new report to unified reporter
from iReport 3.5.0
It is not a problem. Your report should still be published. You will not see this
message if you first publish as SQL language and then update the report from
iReport.
Results:
Using a nimsoft user:
There are 26 targets on this page.
There are 30 on page 2, and so on.
With a contact user you get filtered data based on the origin.
You now have created a sample report, using the stored procedure and Nimsoft
query executor to replace the token nimsoft_account_id during runtime with the
actual account id. It will be used by the stored procedure to filter on the origin.
Parameters for the stored procedure

parameter
@Select
@Restriction
@Orderby
@AccountId
example
'SELECT qos.source, qos.target FROM
S_QOS_DATA qos '
'WHERE qos.qos = ''QOS_CPU_USAGE'' AND
qos.origin=$origin_place_holder'
'ORDER BY qos.source ASC, qos.target
ASC'
nimsoft_account_id
The restriction parameter should contain the origin column = $origin_place_holder in

all the tables that you include that have the column. In the above example, the
s_qos_data table is included in the query and we include the origin filter as shown
above.
The stored procedure will create and run SQL statements like this:
(Assuming a contact user with account id 2 is running the report)

Before token replacement:
SELECT qos.source, qos.target FROM S_QOS_DATA qos WHERE qos.qos = 'QOS_CPU_USAGE' AND
qos.origin=$origin_place_holder ORDER BY qos.source ASC, qos.target ASC
After token replacement:

SELECT qos.source, qos.target FROM S_QOS_DATA qos WHERE qos.qos = 'QOS_CPU_USAGE' AND
qos.origin IN (SELECT origin FROM CM_ACCOUNT_OWNERSHIP WHERE account_id = 2) ORDER BY
qos.source ASC, qos.target ASC
Creating a report using dynamic SQL with token

Because our special tokens are not recognized by MS SQL server directly, we
recommend you use dynamic SQL while designing your query, and leave the token as
a comment in the SQL statements until you are ready to publish your report to
Unified Reporter.
If you do not wish to use the stored procedure we have prepared in the
previous chapter,you can create more complex queries where you have more control
over it.
One of the last steps you will need to do is change the query language from
SQL to nimsoft and then publish the report again.
Here is one example of doing dynamic SQL.
Lets assume you wish to create a report of your account users.
-
The report should be filtered based on account

The report should display average ldap response time last 30 minutes
(assuming your account has any ldap response qos times)
(In your example, you can pick a different QOS if you like)
For a little overview of which qos you have available, you could run this query on
your SQL server:
select def.description, def.name from s_qos_definition def order by
def.description asc
In this demo database we have 108 different objects. For this example we choose
QOS_LDAP_RESPONSE_TIME.
Next, we start by pulling data from both s_qos_data and the corresponding rn table,
which holds the actual samples. We need to find which rn table to use.
You can use this query to grab the rn table for a given QOS.
declare @qos1 varchar(max)
select @qos1 = 'QOS_LDAP_RESPONSE_TIME'
declare @rntable1 varchar(max)
select @rntable1 = 'RN_QOS_DATA_' + reverse(stuff('0000' , 1,
len(cast(s.qos_def_id as varchar(max))), reverse(cast(s.qos_def_id as
varchar(max))))) from s_qos_definition s where name = @qos1
select qos=@qos1, rn=@rntable1
Result in our demo database:
You can choose to use and hardcode the value for your report, or use this dynamic
approach.
This guide will use the dynamic approach.
Now you have a QOS and the RN table. The SQL to get average last 30 minutes of
ldap response times might have been this if you do not use dynamic SQL:
declare @dtFrom datetime

declare @dtTo datetime
select @dtFrom = dateadd(minute, -30, getdate())
select @dtTo = getdate()
select s.source, 'ldap profile'=s.target, s.host,
avg=avg(rn.samplevalue) from s_qos_data s
inner join rn_qos_data_0107 rn
on rn.table_id = s.table_id
where s.qos = @qos1
and rn.sampletime between @dtFrom and @dtTo
group by s.source, s.target, s.host
order by 'ldap profile' asc
Result:
In the example, two of the ldap profiles return NULL data for all rows in the time
span (30 minutes).
You can modify this SQL to be dynamic like this:
declare @sql varchar(max)
select @sql = '
select s.source, ''ldap profile''=s.target, s.host,
inner join ' + @rntable1 + ' rn
where s.qos = ''' + @qos1 + '''
order by ''ldap profile'' asc
'
exec (@sql)
The result is the same as the previous example.

You can then add a placeholder for the SQL + token needed to make the report
account aware (when we are going to run the report through the query executor).
Change the SQL used in the previous example to this:
select @sql = '
where s.qos = ''' + @qos1 + '''
'
/* add room here for account aware token */
select @sql = @sql +
'
'
exec (@sql)
You can now add the SQL + token needed to make the SQL account aware.
We suggest add 1 long line like this, which can be easy to copy onto new reports you
wish to make account aware.
if isnull(nimsoft_account_id, -1) > 0 begin select @query = @query + '

and d.origin in (select origin from cm_account_ownership where
account_id = nimsoft_account_id ) ' end
This one line will append the filter needed if the token is replaced during runtime
with a valid account id. Note: this line must be left commented out during our
session on the SQL server directly, because the SQL server does not understand the
token nimsoft_account_id.
Our complete SQL will now be:
select @sql = '
where s.qos = ''' + @qos1 + '''
'
--if isnull(nimsoft_account_id, -1) > 0 begin select @sql = @sql + '
and s.origin in (select origin from cm_account_ownership where
account_id = nimsoft_account_id ) ' end
'
'
exec (@sql)
Now you must create a report in unified report which uses this SQL + nimsoft query
executor.
1. Create a new blank report in ireport.
2. In the report inspector, select the report name and name it: my first account
aware report.
3. Edit the query for the report, and copy the query we prepared from the
previous example. Click the Read Fields button. Leave query language for
SQL for now.
4. Design your report. Here is one example of how it might look like:
If you click the XML button, you will get an xml view of the report. You can try to
copy this XML to your report for the purpose of this demo (assuming you used the
same ldap response qos).
The example XML used for this report will be later in this document. See table of
contents.
5. Publish the report to Unified Reporter repository and view the sample report
which currently used normal SQL.
6. Go back to iReport; change the query language from SQL to nimsoft.

7. Remove the two characters that currently comment out the
nimsoft_account_id token line.
8. Click OK without clicking the Read Fields button.
9. Make a change in the report content to trigger the save button, then click
save. Update your report in the repository (right click + replace main.jrxml
with current).
Here is one example of what the report will look like for a contact user who does not
have any qos with ldap_response probe.
In the above screenshot, you see the word acc3; this is the same as you type when
you publish the report to Unified Reporter repository:
It is the same you will see in SDP:
In the demo described here, we used acc3 as the display name of the report unit.
This is what the report will look like for a different contact user belonging to an
account that has ldap response records:
And the nimsoft users do not have any filters:
Known problems
iReport 3.5.0 does not work 100% with query executors. It fails to read fields
when you click the Read Fields button if the query language is set to
nimsoft.
Publish a new report to Unified Reporter repository using query language
nimsoft also displays a dialogue box. But subsequent updates to a report unit
that already exist in Unified Reporter repository do not show this box. We
recommend first publish as SQL and then republish as nimsoft query language
in order to avoid this dialogue box.
iReport 3.5.0 cant preview reports correctly when using nimsoft query
language.
SQL language does not understand the nimsoft query executor supported
tokens.
Appendix
Entire xml used in my first account aware report
sample using SQL
<?xml version="1.0" encoding="UTF-8"?>
<jasperReport xmlns="http://jasperreports.sourceforge.net/jasperreports"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://jasperreports.sourceforge.net/jasperreports
http://jasperreports.sourceforge.net/xsd/jasperreport.xsd" name="my first account
aware report" pageWidth="595" pageHeight="842" columnWidth="535"
leftMargin="20" rightMargin="20" topMargin="20" bottomMargin="20">
<queryString>
<![CDATA[declare @qos1 varchar(max)
select @sql = '
select s.source, ''ldap profile''=s.target, s.host, avg=avg(rn.samplevalue) from
s_qos_data s
where s.qos = ''' + @qos1 + '''
'
--if isnull(nimsoft_account_id, -1) > 0 begin select @sql = @sql + ' and s.origin in
(select origin from cm_account_ownership where account_id = nimsoft_account_id )
' end
'
'
exec (@sql)
]]>
</queryString>
<field name="source" class="java.lang.String">
<fieldDescription><![CDATA[]]></fieldDescription>
</field>
<field name="ldap profile" class="java.lang.String">
</field>
<field name="host" class="java.lang.String">
</field>
<field name="avg" class="java.math.BigDecimal">
</field>
<background>
<band/>
</background>
<title>
<band height="79">
<staticText>
<reportElement x="72" y="14" width="395"
height="48"/>
<textElement textAlignment="Center">
<font size="24"/>
</textElement>
<text><![CDATA[My First account aware
report]]></text>
</staticText>
</band>
</title>
<pageHeader>
<band height="35">
<frame>
<reportElement mode="Opaque" x="0" y="0"
width="555" height="20" backcolor="#6666FF"/>
</frame>
</band>
</pageHeader>
<columnHeader>
<band height="20">
<staticText>
height="20"/>
<textElement/>
<text><![CDATA[Source]]></text>
</staticText>
<staticText>
height="20"/>
<textElement/>
<text><![CDATA[LDAP Profile]]></text>
</staticText>
<staticText>
height="20"/>
<textElement/>
<text><![CDATA[Value]]></text>
</staticText>
</band>
</columnHeader>
<detail>
<band height="20">
<textField>
height="20"/>
<textElement/>
<textFieldExpression class="java.lang.String"><!
[CDATA[$F{source}]]></textFieldExpression>
</textField>
<textField>
height="20"/>
<textElement/>
[CDATA[$F{ldap profile}]]></textFieldExpression>
</textField>
<textField pattern="###0.00;-###0.00">
height="20"/>
<textElement/>
<textFieldExpression class="java.math.BigDecimal"><!
[CDATA[$F{avg}]]></textFieldExpression>
</textField>
</band>
</detail>
<summary>
<band height="42">
<textField pattern="MMMMM dd, yyyy">
height="20"/>
<textElement/>
<textFieldExpression class="java.util.Date"><!
[CDATA[new java.util.Date()]]></textFieldExpression>
</textField>
<textField evaluationTime="Report">
height="20"/>
<textElement/>
[CDATA["Total pages: " + $V{PAGE_NUMBER}]]></textFieldExpression>
</textField>
</band>
</summary>
</jasperReport>
Entire xml used in my first account aware report

sample using nimsoft query language
<?xml version="1.0" encoding="UTF-8"?>
<jasperReport xmlns="http://jasperreports.sourceforge.net/jasperreports"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://jasperreports.sourceforge.net/jasperreports
http://jasperreports.sourceforge.net/xsd/jasperreport.xsd" name="my first account
aware report" pageWidth="595" pageHeight="842" columnWidth="535"
leftMargin="20" rightMargin="20" topMargin="20" bottomMargin="20">
<queryString language="nimsoft">
<![CDATA[declare @qos1 varchar(max)
select @sql = '
select s.source, ''ldap profile''=s.target, s.host, avg=avg(rn.samplevalue) from
s_qos_data s
where s.qos = ''' + @qos1 + '''
'
if isnull(nimsoft_account_id, -1) > 0 begin select @sql = @sql + ' and s.origin in
(select origin from cm_account_ownership where account_id = nimsoft_account_id )
' end
'
'
exec (@sql)]]>
</queryString>
<field name="source" class="java.lang.String">
</field>
<field name="ldap profile" class="java.lang.String">
</field>
<field name="host" class="java.lang.String">
</field>
<field name="avg" class="java.math.BigDecimal">
</field>
<background>
<band/>
</background>
<title>
<band height="79">
<staticText>
height="48"/>
<textElement textAlignment="Center">
<font size="24"/>
</textElement>
<text><![CDATA[My First account aware
report]]></text>
</staticText>
</band>
</title>
<pageHeader>
<band height="35">
<frame>
<reportElement mode="Opaque" x="0" y="0"
width="555" height="20" backcolor="#6666FF"/>
</frame>
</band>
</pageHeader>
<columnHeader>
<band height="20">
<staticText>
height="20"/>
<textElement/>
<text><![CDATA[Source]]></text>
</staticText>
<staticText>
height="20"/>
<textElement/>
<text><![CDATA[LDAP Profile]]></text>
</staticText>
<staticText>
height="20"/>
<textElement/>
<text><![CDATA[Value]]></text>
</staticText>
</band>
</columnHeader>
<detail>
<band height="20">
<textField>
height="20"/>
<textElement/>
[CDATA[$F{source}]]></textFieldExpression>
</textField>
<textField>
height="20"/>
<textElement/>
[CDATA[$F{ldap profile}]]></textFieldExpression>
</textField>
<textField pattern="###0.00;-###0.00">
height="20"/>
<textElement/>
<textFieldExpression class="java.math.BigDecimal"><!
[CDATA[$F{avg}]]></textFieldExpression>
</textField>
</band>
</detail>
<summary>
<band height="42">
<textField pattern="MMMMM dd, yyyy">
height="20"/>
<textElement/>
<textFieldExpression class="java.util.Date"><!
[CDATA[new java.util.Date()]]></textFieldExpression>
</textField>
<textField evaluationTime="Report">
height="20"/>
<textElement/>
[CDATA["Total pages: " + $V{PAGE_NUMBER}]]></textFieldExpression>
</textField>
</band>
</summary>
</jasperReport>

IReport NMS Setup

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

IReport NMS Setup

Caricato da

Copyright:

Formati disponibili

Nimsoft Documentation

Nimsoft Unified Reporter

Copyright 1998-2009, Nimsoft Corporation.

What is an account aware report?

Re-use report templates for accounts

How is this solved in Unified Reporter?

Setting up the environment

3. Navigate to <NMS w/SDP install

5. Click Add Folder button

9. Now select Query Executors tab

Create a new report in iReport (blank report).

19. Try logout.

26. Save the report, republish it to the repository.

technology, we have created a stored procedure which can be executed in order to

Creating report using stored procedure

SELECT qos.source, qos.target FROM S_QOS_DATA qos

@Restriction = N'WHERE qos.qos = ''QOS_CPU_USAGE'' AND

Create an account aware report using this approach

Create a new empty report.

There are 26 targets on this page.

There are 30 on page 2, and so on.

Parameters for the stored procedure

The restriction parameter should contain the origin column = $origin_place_holder in

(Assuming a contact user with account id 2 is running the report)

After token replacement:

Creating a report using dynamic SQL with token

The report should be filtered based on account

declare @dtFrom datetime

The result is the same as the previous example.

if isnull(nimsoft_account_id, -1) > 0 begin select @query = @query + '

6. Go back to iReport; change the query language from SQL to nimsoft.

It is the same you will see in SDP:

And the nimsoft users do not have any filters:

<reportElement x="422" y="10" width="100"

Entire xml used in my first account aware report

Potrebbero piacerti anche