Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Enterprise Reporter 3.5.1 - Report Manager User Guide

Table of Contents

Quest Enterprise Reporter Report Manager

Quest Enterprise Reporter Report Manager

Introducing the Report Manager

Starting the Report Manager Finding Answers and Getting Help An Overview of the Report Manager Security Explaining My Reports, Published Reports, and the Report Library

What are My Reports? What are Published Reports? What is the Report Library?

Reports Included in Enterprise Reporter

Active Directory Reports Azure Reports Computer Reports Enterprise Reporter System Reports Exchange Reports File Storage Analysis Reports

File Categories Folder Categories

Hybrid Reports Microsoft SQL Server Reports NTFS Reports Microsoft 365 Reports Registry Reports Security Explorer Remediation Reports

Report Types Included in Enterprise Reporter

Active Directory Report Types Azure Active Directory Report Types Azure Resource Report Types Common Objects Report Types Computer Report Types Exchange Report Types Exchange Online Report Types File Storage Analysis Report Types Microsoft Teams Report Types NTFS Report Types OneDrive Report Types Registry Report Types SharePoint Online Report Types SQL Server Report Types

Configuring Global Settings (System Configuration)

Running and Scheduling Reports

Running Reports

Running Category Reports

Showing and Applying Category Report Parameters Change the Category Report View Navigating Within a Category Report

Running Regular Reports Running Reports or Exporting Reports to CSVand Other Formats from Different Containers Entering Parameter Values Searching for Parameter Values Importing Parameter Values Using Saved Parameters Searching for a Report Viewing Report Properties Previewing a Report Exporting a Report to Other Formats

Configuring a Default Email Server Scheduling Reports

Creating a Schedule

Delivering Scheduled Reports by Email

Types of Schedules

Run Your Schedule Once Run Your Schedule on a Daily Interval Run Your Schedule on Specified Days of the Week Run Your Schedule on a Specified Day of the Month Run Your Schedule Yearly

Working with Schedules

Adding Reports to a Schedule Editing Report Output Options on a Schedule Removing Reports from a Schedule Deleting a Schedule Running a Schedule Disabling or Enabling a Schedule Viewing Schedule History Transferring Ownership of Schedules

Troubleshooting Scheduling Issues

Using the Credential Manager

Changing passwords using the Credential Manager Changing account names using the Credential Manager

Organizing Reports

Working with Report Categories Moving Reports Copying Reports Deleting Reports

Creating and Editing Reports

Editing Reports

Using My Reports Changing the report icon Modifying the Fields to be Included

Performing Calculations Within a Report Indicating Data Age on a Report

Working with Report Parameters

What is a Parameter? Types of Parameters Parameter Operators Custom Query Data Types Working with Parameters

Changing the Layout Report Modification Example

Creating New Reports

Creating Report Layouts Setting CSV File Export Options Exporting and Importing Report Definitions

Report Designer Tips and Tricks

Report Bands Binding a Data Field to a Control Adding a Parameter Field to a Report Layout Adding a New Grouping to a Report Layout Adding a New Column to a Table Formatting Rules: Hiding or Showing a Field Based on Data Values Creating a Calculated Field Creating a Script to Run with a Report

Publishing Reports Integrating with SSRS

Configuring SSRS Publishing Reports to SSRS

Troubleshooting Issues with Enterprise Reporter

Troubleshooting connectivity issues

Restoring a connection to the Enterprise Reporter Server Restoring a connection to the Enterprise Reporter database

Troubleshooting Connection Timeouts Troubleshooting credential change failures Auditing Report Manager Activity Exporting Logs from the Report Manager Resolving Issues in the Report Manager

What To Do if the Data in Your Report is Not What You Expect Other Issues Viewing information about your Enterprise Reporter configuration

Troubleshooting Issues with SSRS

Appendix: PowerShell cmdlets

What is Microsoft Windows PowerShell? What are cmdlets? Registering Enterprise Reporter cmdlets Adding the snap-ins automatically to new sessions Enterprise Reporter cmdlets Enabling Enterprise Reporter cmdlets Loading the Enterprise Reporter cmdlets Using cmdlets to manage clusters and nodes

Creating a cluster Creating a node Disabling a node Enabling a node Finding a node by name Piping cmdlets Finding a cluster by name Disabling a cluster Enabling a cluster

Using cmdlets to manage discoveries

Getting job information Creating a job Running a job Scheduling a job Deleting a job

Using cmdlets to run reports

Connecting to the server Getting report information Exporting a report definition Importing a report definition to a category Generating a report with data

Starting the Enterprise Reporter Log Viewer Finding and opening log files Viewing and searching log file entries Filtering log file entries

Using cmdlets to manage discoveries

An important aspect of Enterprise Reporter, discoveries return information about the systems in your environment. Discoveries gather data about Active Directory, computers, SQL Server, and NTFS permissions for files and folders. When using Enterprise Reporter cmdlets, discoveries are referred to as jobs. The examples in this section demonstrate how to create and run jobs using cmdlets.

This section contains the following examples:

•

Getting job information

•

•

•

Scheduling a job

•

Enabling a cluster

Getting job information

You probably have configured and run discoveries in the Enterprise Reporter Configuration Manager. These job definitions are useful in understanding how the cmdlets work and provide good examples for you to follow when creating new jobs using cmdlets. The Get-ERJobDefinition cmdlet returns information on the jobs.

Get-ERJobDefinition [-ClusterId <Nullable`1[Guid]>] [-ClusterName <String>] [-JobDefinitionName] <String>

Get-ERJobDefinition [-Unassigned [<SwitchParameter>]]

Get-ERJobDefinition -JobDefinitionId <Guid>

Get-ERJobDefinition -JobDefinition <JobDefinition>

In this example, information about a job identified with the name of Active Directory is returned.

Get-ERJobDefinition -JobDefinitionName "Active Directory"

JobDefinitionId : ecaae8bb-f0f8-48ee-91ff-da959a937dfa

JobTypeId : bec47934-cadf-4b94-8ff7-68efadc88165

Name : Active Directory

Configuration : <DiscoveryResolutionTask subType="ActiveDirectory"><Scopes><Scope

type="ActiveDirectory"><Content><Root class="Domain" inex="Include"><Ldap>LDAP:

//AMER.amer.sitraka.com/DC=AMER,DC=amer,DC=sitraka,DC=com</Ldap><Dns>

AMER.amer.sitraka.com</Dns><DC>AMERGENDC.AMER.amer.sitraka.com</DC>

</Root></Content></Scope></Scopes><Parameters><Parameter

key="GatherSharedEntities"><Value>False</Value></Parameter><Parameter

key="CollectDCs"><Value>True</Value></Parameter><Parameter

key="CollectAccounts"><Value>True</Value></Parameter><Parameter

key="CollectComputers"><Value>True</Value></Parameter><Parameter

key="CollectOUs"><Value>True</Value></Parameter><Parameter

key="CollectSites"><Value>True</Value></Parameter><Parameter

key="CollectTrusts"><Value>True</Value></Parameter><Parameter

key="CollectPhysicalComputerInfo"><Value>False</Value></Parameter><Parameter

key="FindForeignMember"><Value>False</Value></Parameter><Parameter

key="SyncLogon"><Value>False</Value></Parameter><Parameter

key="CollectPermissions"><Value>False</Value></Parameter><Parameter

key="CollectRemoteServices"><Value>False</Value></Parameter><Parameter

key="CollectPhotosForUsers"><Value>False</Value></Parameter>

</Parameters></DiscoveryResolutionTask>

AssignedClusterId : af0e6da4-10b9-4b20-bf5a-f19f0d71b589

AssignedClusterName : First Cluster

IsTombstoned : False

Schedule : <Trigger Type="RunOnceTrigger" StartDateTime="2014-07-14T13:50:00Z"

Expression="2014-07-14 13:50:00Z@0 50 13 14 7 ? 2014" />

In this example, information about all the jobs (the * wildcard is used in -JobDefinitionName) located on the cluster named Second Cluster is returned.

Get-ERJobDefinition -ClusterName "Second Cluster" -JobDefinitionName *

JobDefinitionId : 7a8d758b-15e8-4f84-a30e-1c8545eed4f5

JobTypeId : bec47934-cadf-4b94-8ff7-68efadc88165

Name : Computer

Configuration : <DiscoveryResolutionTask subType="Computer"><Scopes><Scope type="Computer">

<Content><Rootclass="Domain" inex="Include"><Ldap>LDAP://AMER.amer.sitraka.com

/DC=RPTCH,DC=dev,DC=hal,DC=ca,DC=qsft</Ldap><Dns>AMER.amer.sitraka.com

</Dns></Root></Content></Scope></Scopes><Parameters><Parameter

key="GatherSharedEntities"><Value>False</Value></Parameter><Parameter

key="CollectAccounts"><Value>True</Value></Parameter><Parameter

key="CollectEventLogConfig"><Value>True</Value></Parameter><Parameter

key="CollectPolicies"><Value>True</Value></Parameter><Parameter

key="CollectPrinters"><Value>True</Value></Parameter><Parameter

key="CollectServices"><Value>True</Value></Parameter><Parameter

key="CollectShares"><Value>True</Value></Parameter><Parameter

key="CollectVolumes"><Value>True</Value></Parameter><Parameter

key="CollectExtendedWMIEntities"><Value>True</Value></Parameter><Parameter

key="PingTimeout"><Value>0</Value></Parameter></Parameters>

</DiscoveryResolutionTask>

AssignedClusterId : 390b0bd1-6488-4ace-b2cc-616925b55c06

AssignedClusterName : Second Cluster

IsTombstoned : False

Schedule : <Trigger Type="RunOnceTrigger" StartDateTime="2014-07-15T13:58:00Z"

Expression="2014-07-15 13:58:00Z@0 58 13 15 7 ? 2014" />

As you can see in these examples, there is a lot of information contained in the job definition. The largest and seemingly most complicated part is the configuration, which contains all of the information about the jobs that you created using the Discovery Wizard. For more information about the configuration, see Creating a job.

Creating a job

Using cmdlets to create a new job requires planning as there is a lot information contained in a job definition. You would use cmdlets to automate a process, such as cloning a current job or creating a new job in an environment with limited resources.

New-ERJobDefinition [-Name] <String> [-JobType] <String> [-Configuration] <String> [[-ClusterId] <Guid>] [[-CredentialId] <Guid>] [[-Description] <String>] [[-Schedule] <String>] [[-NextRun] <Nullable`1[DateTime]>] [-PassThru [<SwitchParameter>]]

•

[-JobType] values are: ActiveDirectory, Computer, Exchange, MS SQL, NTFS, and Registry.

•

[-Configuration] is the XML representation of the job or discovery configuration. See any of the job examples in the Getting job information section, which discussed the Get-ERJobDefinition cmdlet. This is the best way to get a configuration to use in creating a job manually.

The configuration can be contained in an XML file, making it easier to navigate. Using Notepad, copy the configuration from an existing job and paste it into a file. It is recommended that you create default files with the extension .XML and have the format as seen below which makes it easier to go thru and make the setting you want to make.

Do not use any special program that provides an XML format. Any additional data in the file will not be interpreted correctly and can cause errors with the job creation. Use Notepad to avoid unseen character formatting.

As you can see in this example, each section of the XML file has an opening and a closing statement. When you are working with a copy of the configuration from the Get-ERJobDefinition cmdlet, pay attention to spaces, text, slashes, and other characters, as missing or extra characters will cause an issue with the job.

<DiscoveryResolutionTask subType="NTFS">

<Scope type="NTFS">

<Root class="Computer" inex="Include">

<Ldap>LDAP://AMER.amer.sitraka.com/DC=AMER,DC=amer,DC=sitraka,DC=com</Ldap>

<Dns>\\AMERGEN02.AMER.amer.sitraka.com</Dns>

<Parameter key="CollectPublicShares">

<Value>True</Value>

<Parameter key="TreatSharesAsShares">

<Value>True</Value>

<Parameter key="CollectFolderPermissions">

<Value>True</Value>

<Parameter key="CollectChildACLDifferences">

<Value>True</Value>

<Parameter key="FolderDepth">

<Value>-1</Value>

<Parameter key="GatherSharedEntities">

<Value>False</Value>

<Parameter key="GlobalInclude"/>

<Parameter key="GlobalExclude" />

<Parameter key="CollectFiles">

<Value>True</Value>

<Parameter key="CollectFilePermissions">

<Value>True</Value>

<Parameter key="CollectOnlyExplicitFilePermissions">

<Value>False</Value>

<Parameter key="IncludeFile">

<Value>*.*</Value>

<Parameter key="PingTimeout">

<Value>0</Value>

</DiscoveryResolutionTask>

In this example, the contents of the XML configuration file is used with the New-ERJobDefinition cmdlet. The values for the -Configuration parameter are enclosed in a single quote mark (').

The parameters in this example are formatted to make it easier for you to read. When running the cmdlet, the parameters cannot contain any carriage returns in the command line. If you want to use this example, you must first paste it into NotePad and remove the carriage returns.

New-ERJobDefinition -Name "NTFS All" -JobType NTFS -Configuration '<DiscoveryResolutionTask subType="NTFS"><Scopes><Scope type="NTFS"><Content><Root class="Domain" inex="Include"><Ldap>LDAP://AMER.amer.sitraka.com/DC=AMER,DC=amer,DC=sitraka,DC=com</Ldap><Dns>AMER.amer.sitraka.com</Dns></Root></Content></Scope></Scopes><Parameters>

<Parameter key="CollectPublicShares"><Value>True</Value></Parameter><Parameter

key="TreatSharesAsShares"><Value>True</Value></Parameter><

Parameter key="CollectFolderPermissions"><Value>True</Value></Parameter><Parameter

key="CollectChildACLDifferences"><Value>True</Value></Parameter><Parameter

key="FolderDepth"><Value>-1</Value></Parameter><Parameter

key="GatherSharedEntities"><Value>False</Value></Parameter><Parameter key="GlobalInclude"/><Parameter

key="GlobalExclude" /><Parameter key="CollectFiles"><Value>True</Value></Parameter><Parameter

key="CollectFilePermissions"><Value>True</Value></Parameter><Parameter

key="CollectOnlyExplicitFilePermissions"><Value>False</Value></Parameter><Parameter

key="IncludeFile"><Value>*.*</Value></Parameter><Parameter

key="PingTimeout"><Value>0</Value></Parameter></Parameters></DiscoveryResolutionTask>'

-ClusterId af0e6da4-10b9-4b20-bf5a-f19f0d71b589 -Schedule '<Trigger Type="RunDailyTrigger"

StartDateTime="2014-07-17T04:00:00Z" Expression="2014-07-1704:00:00Z@0 0 4 1/2 * ?" EveryNDay="2" />'

In this example the configuration is in an XML file, which allows changes to be made to the configuration when using the cmdlets. The XML files are just simple files that can be edited using Notepad and do not require any special formatting. The configuration of any current job is in the XML format and can be used as a template.

$filepath = "c:\configuration.xml"

$configuration =[string]::join([environment]::newline, (get-content -path $filepath))

$foundCluster = Get-ERCluster 'First Cluster'

New-ERJobDefinition -Name NTFS10 -JobType NTFS -Configuration $configuration –ClusterId $foundCluster.ClusterId

In this example, you want to clone a current job. The important item to note is that the -Name parameter needs to be changed to a unique value. The first cmdlet Get-ERJobDefinition gets the data on the job you wish to clone. In the New-ERJobDefinition cmdlet you use the data in the configuration of the cloned job by using $JobDefinition.Configuration to supply the needed configuration for the new job.

$JobDefinition = Get-ERJobDefinition "NTFS All"

$foundCluster = Get-ERCluster 'First Cluster'

New-ERJobDefinition -Name NTFS2 -JobType NTFS -Configuration $JobDefinition.Configuration -ClusterId $foundCluster.ClusterId

Running a job

Now that you have a job or two you need to run them to retrieve data from your environment by sending a job to the Enterprise Reporter server for immediate execution. Depending on what is processing within the server, the job may be queued to run at the next available time. This is different than scheduling a job which is discussed later.

Submit-ERJobDefinition [-JobDefinitionId] <Guid>

Submit-ERJobDefinition [-JobDefinition] <JobDefinition>

In this example, the job or discovery identified by the JobDefinitionId ecaae8bb-f0f8-48ee-91ff-da959a937dfa is submitted for immediate processing. If the job starts, True is returned.

Submit-ERJobDefinition -JobDefinitionId ecaae8bb-f0f8-48ee-91ff-da959a937dfa

In this example, the information about the job definition retrieved by the Get-ERJobDefinition cmdlet is piped to the Submit-ERJobDefinition cmdlet, so the job starts immediately. If the job starts, True is returned.

Get-ERJobDefinition "Active Directory" | Submit-ERJobDefinition

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center