Skip to main content
Version: 10.2

Using Reporting Services Console Application

The Reporting Services Console Application of Analysis Server is a command line application that contains various commands for executing background and configuration tasks about SQL Server Reporting Services.

Open iT Reporting Services Console Tasks

To show the available tasks, follow these instructions:

  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe

    This command displays the available options:

    Example
    C:\Program Files\OpeniT\Analysis Server>OpeniT.Server.Rs.Console.exe 
    Open iT Analysis Server, <version>. Copyright 2008 Open iT, Inc. All rights reserved. http://www.openit.com

    Web Service URL: http://<hostname>/ReportServer/ReportService2005.asmx

    Usage: OpeniT.Server.Rs.Console <subcommand> [args]
    Type 'OpeniT.Server.Rs.Console help <subcommand>' for help on a specific subcommand.

    Available subcommands:
    ConfigureAll Automatically configure all settings
    ConfigurePolicies Configures the Reporting Services Policies
    ConfigureReportingServices Configures Email settings and enable PNG and JPG exports
    CreateDataSource Creates Data Source in the Reporting Services
    CreateLinkToAs Creates a link to Open iT AnalysisServer
    RefreshHomeLinks Refreshes the SSRS Links in the Home Page
    SetSiteName Set the Reporting Services site name
    SetWebServiceUrl Sets Reporting Services Web Service URL
    UploadReports Uploads all RDL files from a specified directory
    ManageLinkedServer Manage linked server(s) from OpeniT Database

    To show the available parameters for each command, add a help parameter before the command. Use the following syntax:

    Command Syntax
    OpeniT.Server.Rs.Console.exe help ConfigureAll

    This command displays the available options.

    Example
    C:\Program Files\OpeniT\Analysis Server>OpeniT.Server.Rs.Console.exe help ConfigureAll
    Open iT Analysis Server, <version>. Copyright 2013 Open iT, Inc. All rights reserved.http://www.openit.com

    Web Service URL: http://<hostname>/ReportServer/ReportService2005.asmx

    Automatically configure all settings
    usage: OpeniT.Server.Rs.Console ConfigureAll [/uri:value] [/instance:value] [/remote] [/smtp:value] [/email:value]
    [/uri:value] Reporting Services URI
    [/instance:value] Reporting Services instance name
    [/remote] Remote Configuration
    [/smtp:value] SMTP Server
    [/email:value] Sender's Email address

Available Tasks

ConfigureAll

This command configures all the important settings for the Reporting Services. It includes the following commands in chronological order:

  1. SetWebServiceURL
  2. ConfigurePolicies
  3. SetSiteName
  4. CreateDatasource
  5. UploadReports
  6. CreateLinktoAs
  7. ConfigureReportingServices
  8. RefreshHomeLinks
Instructions
  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe ConfigureAll

    To further customize the command, use the optional parameter.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureAll </uri:value> </instance:value> </remote> </smtp:value> </email:value>

    Optional Parameters:

    /uri:<value>
    Use this parameter to specify the Reporting Services URI where settings are applied.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureAll /uri:http://desktop123win

    /instance:<value>
    Use this parameter to specify the SQL Server instance name where SQL Server Reporting Services is hosted.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureAll /instance:DESKTOP-OiT\SQLSERVER2014

    /remote
    Use this parameter to execute a remote configuration. Use this when the SQL Reporting Services is hosted remotely. This parameter skips the email and export settings.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureAll /remote

    /smtp:<value>
    Use this parameter to specify the SMTP server for handling email.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureAll /smtp:HOST123WIN

    /email:<value>
    Use this parameter to specify the email address of the sender

    Example
    OpeniT.Server.Rs.Console.exe ConfigureAll /email:admin@openit.com

    Combine or use optional parameters at the same time to achieve necessary capabilities.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureAll /uri:http://desktop123win /instance:DESKTOP123WIN\SQLSERVER2008R2 /remote /smtp:HOST123WIN /email:admin@openit.com
  3. The Console Application will display information messages in the command prompt. Allow the process to finish.

ConfigurePolicies

This command configures all the necessary service policies used by the Reporting Services.

Instructions
  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe ConfigurePolicies admin reporters

    Required Parameters:

    admin
    Use this parameter to specify the Administrators Group to be assigned in the Open iT Reporting Services with administrative rights.

    reporters
    Use this parameter to specify the Administrators Group to be assigned in the Open iT Reporting Services with managing rights for reports.

    Example
    OpeniT.Server.Rs.Console.exe ConfigurePolicies Administrators_Group Reporters_Group
  3. The Reporting Services Console Application should display information messages in the command prompt. Allow the process to finish.

ConfigureReportingServices

This command configures the email settings of Reporting Services for subscription.

instructions
  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe ConfigureReportingServices

    To further customize the command, use the optional parameter.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureReportingServices </instance:value> </smtp:value> </email:value>

    Optional Parameters:

    /instance:<value>
    Use this parameter to specify the SQL Server instance name where SQL Server Reporting Services is hosted.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureAll /instance:DESKTOP123WIN\SQLSERVER2014

    /smtp:<value>
    Use this parameter to specify the SMTP server for handling email.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureAll /smtp:HOST123WIN

    /email:<value>
    Use this parameter to specify the email address of the sender.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureAll /email:admin@openit.com

    Combine or use optional parameters at the same time to achieve necessary capabilities.

    Example
    OpeniT.Server.Rs.Console.exe ConfigureReportingServices /instance:DESKTOP123WIN\SQLSERVER2014 /smtp:HOST123WIN /email:admin@openit.com
  3. The Console Application will display information messages in the command prompt. Allow the process to finish.

CreateDataSource

This command triggers the creation of a Data Source on the Reporting Services Report server.

Instructions
  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe CreateDataSource

    To further customize the command, use the optional parameter.

    Example
    OpeniT.Server.Rs.Console.exe CreateDataSource </olapName:value> </sqlName:value> </folder:value>

    Optional Parameters:

    /olapName:<value>
    Use this parameter to specify the name of the OLAP shared data source to create. If not specified, it will create the default OLAP data source name, Open iT Shared Data Source.

    Example
    OpeniT.Server.Rs.Console.exe CreateDataSource /olapName:"OLAP Data Source"

    /sqlName:<value>
    Use this parameter to specify the name of the SQL shared data source to create. If not specified, it will create the default SQL data source name, Open iT SQL Shared Data Source.

    Example
    OpeniT.Server.Rs.Console.exe CreateDataSource /sqlName:"SQL Data Source"

    /folder:<value>
    Use this parameter to specify the name of the folder where the data sources will be created. Make sure that the value for the /folder parameter begins with a slash (/), indicating the root directory (e.g. /folder:/DSFolder).

    warning

    The folder should exist in the Report Server.

    Example
    OpeniT.Server.Rs.Console.exe CreateDataSource /folder:/DataSourceFolder

    Combine or use optional parameters at the same time to achieve necessary capabilities.

    Example
    OpeniT.Server.Rs.Console.exe CreateDataSource /olapName:"OLAP Data Source" /sqlName:"SQL Data Source" /folder:DataSourceFolder
  3. The Console Application will display information messages in the command prompt. Allow the process to finish.

CreateLinkToAs

This command creates a Reporting link in the Analysis Server, which holds the link to access the Reporting Services report portal.

Instructions
  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe CreateLinkToAs siteMap uri

    Required Parameters:

    siteMap
    Use this parameter to specify the path to the web interface website mapping file, Mvc.sitemap. If only the filename is specified, it will scan in the installation directory.

    uri
    Use this parameter to specify the URI of the Open iT Reporting Services with the format, http(s)://<server_name>:<post_number>.

    Example
    OpeniT.Server.Rs.Console.exe CreateLinkToAs Mvc.sitemap http://desktop123win/

    To further customize the command, use the optional parameter.

    Example
    OpeniT.Server.Rs.Console.exe CreateLinkToAs siteMap uri </instance:value>

    Optional Parameters:

    /instance:<value>
    Use this parameter to specify the SQL Server instance name where SQL Server Reporting Services is hosted.

    Example
    OpeniT.Server.Rs.Console.exe CreateLinkToAs Mvc.sitemap http://desktop123win/reports /instance:DESKTOP123WIN\SQLSERVER2014
  3. The Console Application will display information messages in the command prompt. Allow the process to finish.

This command updates the links created in the Analysis Server Home page.

Instructions
  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe RefreshHomeLinks
  3. The Console Application will display information messages in the command prompt. Allow the process to finish.

SetSiteName

This command sets the title of the Reporting Services web portal.

Instructions
  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe SetSiteName

    To further customize the command, use the optional parameter.

    Example
    OpeniT.Server.Rs.Console.exe SetSiteName </name:value>

    Optional Parameters:

    /name:<value>
    Use this parameter to specify the name to be assigned to the website of the Open iT Reporting Services. If not specified, it will use the default name, Open iT Reporting Services.

    Example
    OpeniT.Server.Rs.Console.exe SetSiteName /name:"Reporting Service of Open iT"
  3. The Console Application will display information messages in the command prompt. Allow the process to finish.

SetWebServiceUrl

This command sets the Web Service URL (Uniform Resource Location) used by the Reporting Services.

Instructions
  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe SetWebServiceUrl uri

    Required Parameters:

    uri
    Use this parameter to specify the URL to be assigned to the web service URL of the Reporting Services.

    Example
    OpeniT.Server.Rs.Console.exe SetWebServiceUrl http://desktop123win

    To further customize the command, use the optional parameter.

    Example
    OpeniT.Server.Rs.Console.exe SetWebServiceUrl uri \</instance:value\>

    Optional Parameters:

    /instance:<value>
    Use this parameter to specify the SQL Server instance name where SQL Server Reporting Services is hosted.

    Example
    OpeniT.Server.Rs.Console.exe SetWebServiceUrl http://desktop123win /instance:DESKTOP123WIN\SQLSERVER2014
  3. The Console Application will display information messages in the command prompt. Allow the process to finish.

UploadReports

This command uploads the available SSRS report templates to the Report Server, which can be accessed through the Reporting Services report portal.

Instructions
  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe UploadReports directory

    Required Parameters:

    directory
    Use this parameter to specify the full path to the directory that contains the report templates or RDL files.

    Example
    OpeniT.Server.Rs.Console.exe UploadReports "Templates\LicenseAnalyzer Level 1"

    To further customize the command, use the optional parameter.

    Example
    OpeniT.Server.Rs.Console.exe UploadReports directory </folder:value> </description:value> </olapDatasource:value> </sqlDatasource:value>

    Optional Parameters:

    /folder:<value>
    Use this parameter to specify the target folder where to upload the report templates. If not specified, Open iT Standard Reports folder will be created.

    Example
    OpeniT.Server.Rs.Console.exe UploadReports "Templates\LicenseAnalyzer Level 1" /folder:"LA - Level 1"

    /description:<value>
    Use this parameter to set the description of the target folder. This is recommended to come with the folder parameter. If the target folder already exists, description is not applied.

    Example
    OpeniT.Server.Rs.Console.exe UploadReports "Templates\LicenseAnalyzer Level 1" /folder:"LA - Level 1" /description:"This folder contains the reports of LA - Level 1"

    /olapDatasource:<value>
    Use this parameter to specify the location and name of OLAP data source. The location should always start with a slash (/) that signifies the Home directory. If not specified, Open iT Shared DataSource is used.

    Example
    OpeniT.Server.Rs.Console.exe UploadReports "Templates\LicenseAnalyzer Level 1" /olapDataSource:/OpeniT

    /sqlDatasource:<value>
    Use this parameter to specify the location and name of SQL data source. The location should always start with a slash (/) that signifies the Home directory. If not specified, Open iT SQL Shared DataSource is used.

    When a report exists under the targeted folder, this parameter updates the SQL data source of the report.

    Example
    OpeniT.Server.Rs.Console.exe UploadReports "Templates\LicenseAnalyzer Level 1" /sqlDataSource:/"OpeniT SQL"

    Combine or use optional parameters at the same time to achieve necessary capabilities.

    Example
    OpeniT.Server.Rs.Console.exe UploadReports "Templates\LicenseAnalyzer Level 1" /folder:"LA - Level 1" /description:"This folder contains the reports of LA - Level 1" /olapDataSource:/OpeniT /sqlDataSource:/"OpeniT SQL"
  3. The Console Application will display information messages in the command prompt. Allow the process to finish.

ManageLinkedServer

This command can be used to manage a linked server used for generating the Open iT Invoicing template. It can also be used to create, delete and update the linked server.

Instructions
  1. Open the command prompt and run the following command to go to the installation directory of Analysis Server, which is by default in C:\Program Files\OpeniT\Analysis Server\.

    Command Syntax
    cd "C:\Program Files\OpeniT\Analysis Server\"
  2. Once in the directory, run the following command:

    Command Syntax
    OpeniT.Server.Rs.Console.exe ManageLinkedServer action

    Required Parameters:

    action
    Use this parameter to specify the command to do. It accepts Create, Delete, or Test.

    Example
    OpeniT.Server.Rs.Console.exe ManageLinkedServer Create

    If the Delete action is chosen, a confirmation message should be displayed. Read the message carefully before continuing.

    Example
    C:\Program Files\OpeniT\Analysis Server>OpeniT.Server.Rs.Console.exe ManageLinkedServer delete
    Open iT Analysis Server, <version>. Copyright 2013 Open iT, Inc. All rights reserved. http://www.openit.com

    Web Service URL: http://localhost/ReportServer/ReportService2005.asmx

    The following configuration will be used:
    action: delete
    name: OPENIT_INVOICE
    provider: MSOLAP
    serverName: DESKTOP123WIN
    catalog: 9611
    localLogin: SVG\openit_service_account
    timeout: 30

    2022-04-15 13:32:24,747 INFO ReportingServices - delete linked server in Open iT database.

    Deleting a remote server deletes all remote logins defined for that server.
    Are you sure you want to delete linked server OPENIT_INVOICE? [n]

    To further customize the command, use the optional parameter.

    Example
    OpeniT.Server.Rs.Console.exe ManageLinkedServer action </name:value> </provider:value> </serverName:value> </catalog:value> </localLogin:value> </timeout:number>

    Optional Parameters:

    /name:<value>
    Use this parameter to specify the name of the linked server to manage. If not specified, the default value is OPENIT_INVOICE.

    Example
    OpeniT.Server.Rs.Console.exe ManageLinkedServer Create /name:OPENIT_LINKEDSERVER

    /provider:<value>
    Use this parameter to specify the name of the provider which handles the data access to the server. It accepts MSOLAP and SQLNCLI. When not specified, the default is MSOLAP.

    Example
    OpeniT.Server.Rs.Console.exe ManageLinkedServer Create /provider:SQLNCLI

    /serverName:<value>
    Use this parameter to specify the data source or host name of the server that hosts the linked server. When not specified, the default value is the current OLAP server configured for Open iT Analysis Server.

    Example
    OpeniT.Server.Rs.Console.exe ManageLinkedServer Create /serverName:DESKTOP123WIN

    /catalog:<value>
    Use this parameter to specify the name of the database to be used when making a connection. If not specified, the default value is the current OLAP database configured for Open iT Analysis Server.

    Example
    OpeniT.Server.Rs.Console.exe ManageLinkedServer Create /catalog:OpeniT

    /localLogin:<value>
    Use this parameter to specify a user account that is used to connect to the linked server. If not specified, the default value is the current service account configured for Open iT Analysis Server

    Example
    OpeniT.Server.Rs.Console.exe ManageLinkedServer Create /localLogin:SVG\openit_service_account

    /timeout:<number>
    Use this parameter to specify the time in seconds to wait for the SQL command to time out. If not specified, the default value is 30.

    Example
    OpeniT.Server.Rs.Console.exe ManageLinkedServer Create /timeout:300

    Combine or use optional parameters at the same time to achieve necessary capabilities.

    Example
    OpeniT.Server.Rs.Console.exe ManageLinkedServer Create /name:OPENIT_LINKEDSERVER /provider:SQLNCLI /serverName:DESKTOP123WIN /catalog:OpeniT /localLogin:SVG\openit_service_account /timeout:300
  3. The Console Application will display information messages in the command prompt. Allow the process to finish.