Show TOC

Procedure documentationGenerating Reports Locate this document in the navigation structure

 

Reports allow you to gather meta-data about your repository in one of the following formats:

  • Comma separated values (CSV) to import into your favorite spreadsheet application

  • HTML to view in your browser

You can define multiple reports, and schedule System_ReportRun to generate the output. You can generate a report based on a an object filter or a query on the Report tab, choose the columns of the query you want to end up in the report in the Columns tab, and throttle the amount of rows in the Selections tab based on the values of two columns or the value in a column. The default filter names are descriptive, for example, the .alltop filters will only return data about the top nodes of applications.

Note Note

Your custom object filters are available by their name, which might differ from the description which is shown in the object view.

End of the note.
Actions

Reports support the following actions:

Action

Description

Submit Report

Submit a job to generate the report

Export

Export the report into a CAR file

Edit

Edit the report

Edit Security

Edit the security of the report

Delete

Delete the report

Duplicate

Make a copy of the report to create a similar one

Expand All

Expand all reports in the current filter

New

Create a new report

Filter > New Filter

Create a new report filter

Filter > Edit Filter

Edit current report filter

Filter > Delete

Delete current report filter
Finding Reports

You can search for reports using filters and the Search Reports box on the Reports tab. This box is known as the intelliSearch box and located under your username on the top right-hand side of the user interface. Filters allow you to specify a list of objects with static criteria. IntelliSearch allows you to specify complex queries in a simple way using prefixes. Prefixes are used to specify which property you are searching in and have short and long syntaxes. For example, if you want to display all reports with the term import in the comment, you would use the search criteria as follows:

c:import

You can search more than one property, as follows:

c:import n:Bi

Note Note

No spaces should be entered before or after the colon (:).

End of the note.

See the Advanced Object Search for more information.

The following table illustrates the available prefixes for reports:

Prefixes

Description

n, name

searches the name property

c, com, comment

searches the comment property

d, desc, description

searches the description property

a, app, application

searches the application property
Deleting Reports

Reports can deleted without having to delete the jobs that generated the report output. You should make sure that all jobs have finished before you delete a report.

Security

Privilege

Description

Report.Create

Create reports

Report.Delete

Delete reports

Report.Edit

Edit reports

Report.View

Access reports

You can grant privileges on two levels, Access and Admin; a privilege granted on Admin level allows the grantee to grant the privilege to other users. These privileges can be granted system-wide, per partition or isolation group.

If you have the security module, which requires the Module.Security license key, you have an additional Security tab on the report. It allows you to specify which users can access, edit, and delete the report.

Procedure

Create the report

  1. Navigate to   Definitions → Reports  .

  2. Choose New from the context menu.

  3. On the Report tab, fill a name into the Name field and choose a filter name in the query field.

  4. On the Columns tab choose Create All Columns and remove the LLP Version column from the list.

  5. On the Selections tab choose a column and a condition.

  6. On the Sorting tab, choose the columns you want to sort by and give each a unique sort order.

Generate the report

  1. Navigate to   Definitions → Job Definitions  

  2. Choose Submit from the context menu of the job definition System_ReportRun.

  3. Fill a report name and format into the fields and choose Submit.

  4. Navigate to   Monitoring → Jobs   and locate the job you just submitted.

  5. In the lower details pane of the job, expand Files and choose report.

Example

Create a report for the error jobs in the production environment

  1. Navigate to   Definitions → Reports  .

  2. Choose New from the context menu.

  3. On the Report tab, fill AllErrorJobs into the Name field and Job.state.Error into the query field.

  4. On the Columns tab choose Create All Columns and remove the LLP Version column from the list.

  5. On the Selections tab fill Remote System into the Left Report Column field, choose Matches Regex in the Operation field, and enter PR.* in the Value field of the Column/Value area. You have to choose the radio button to fill the Value field.

  6. On the Sorting tab, enter JobId.

  7. Choose Save and Close to leave the edit window.

Generate the report and view its output

  1. Navigate to   Definitions → Job Definitions  

  2. Choose Submit from the context menu of the job definition System_ReportRun.

  3. Fill AllErrorJobs Report field, choose HTML in the Report Format field and choose Submit.

  4. Navigate to   Monitoring → Jobs   and locate the job you just submitted.

  5. In the lower details pane of the job, expand Files and choose report.