Report Services silent configuration parameters

Use the following parameters in the Report Services configuration file (config.json). You don't need to use all of them; it depends on which kind of database you use and whether you're configuring Report Services in domain mode or zone mode. These parameters match what you would enter in the installer interface.

The installer also supplies some sample configuration files (in the Report Services installation folder) that you can use as a guideline, depending on your deployment:

Database type Domain mode Zone mode
Microsoft SQL Server config_sql_server_domain_mode_sample.json config_sql_server_zone_mode_sample.json
PostgreSQL config_postgresql_domain_mode_sample.json config_postgresql_zone_mode_sample.json

 

Parameter name Parameter type Description Example
NewDB true or false Specifies whether to create a new database instance or not "NewDB": true
DBInstallerPath string

If you're creating a new database instance, this parameter specifies the location of the database installer file.

"DBInstallerPath": "D:\\Common\\SQLEXPR\\SQLEXPRADV_x64_ENU.exe"
DBInstallationPath string

If you're creating a new database instance, this parameter specifies where to install the new database instance.

For directories or path separators, use \\ instead of \.

"DBInstallationPath": "C:\\Program Files\\Microsoft SQL Server\\130"
DBName string

If you're creating a new database instance, the name of the new database.

"DBName": "Report"

InstanceName

string

(SQL Server only) If you're creating a new database instance, the name of the new database instance.

For directories or path separators, use \\ instead of \.

"InstanceName": "REPORTS"

IsDeployReport

true or false

(SQL Server only) Specifies whether or not to deploy reports.

"IsDeployReport": true

ReportWebServiceUrl

string

(SQL Server only) Specifies the web service URL for deploying reports. You use the web service URL to read reports.

"ReportWebServiceUrl": "http://MYCOMPUTER/ReportServer_REPORTS"

ReportManagerUrl

string

(SQL Server only) Specifies the report manager URL. You use this URL to edit, publish, and administer reports.

"ReportManagerUrl": "http://MYCOMPUTER/Reports_REPORTS"

Server

string

(PostgreSQL only) The name of the PostgreSQL server.

"Server":"localhost"

Port

integer

(PostgreSQL only) The port for the PostgeSQL database.

If you don't specify this parameter, the default port of 5432 is used.

"Port": "5432"

AdditionalParam

string

(PostgreSQL only) Use this parameter if you have any additional PostgreSQL parameters that you need to specify.

 

OdbcName

string

(PostgreSQL only) The name of the ODBC driver to use to connect with the PostgreSQL database.

"OdbcName": "PostgreSQL Unicode"

OdbcInstaller

string

(PostgreSQL only) The path and filename of the PostgreSQL installer file.

 

DomainMode

 

(Domain mode only) Use this parameter to specify domain mode. Inside of this parameter you specify the domains to synchronize to the reporting database.

"DomainMode": {

"MonitoredDomains": {

"test.com": "dc.test.com",

"us.test.com": "dc.us.test.com"

}

}

ZoneMode

 

(Zone mode only) Use this parameter to specify zone mode. Inside of this parameter you specify the MonitoredClassicZones and the MonitoredHierarchicalZones parameters and their respective settings.

 

ZoneMode": {

"MonitoredClassicZones": [],

"MonitoredHierarchicalZones": [

"test.com/Program Data/Zones/hZoneA"

],

"ForestsForClassicZones": [

"test.com"

],

"ForestsForHierarchicalZones": [],

"DomainControllers": {

"test.com": "dc.test.com",

"us.test.com": "dc.us.test.com"

}

}

MonitoredClassicZones (list) list of string values (Zone mode only) If you use classic zones, use this parameter to specify the list of zones to synchronize with report services. ["test.com/Program Data/Zones/ZoneC", "test.com/Program Data/Zones/ZoneD"]

MonitoredHierarchicalZones

list of string values (Zone mode only) The list and location of hierarchical zones ["test.com/Program Data/Zones/hZoneA", "test.com/Program Data/Zones/hZoneB"]

ForestsForClassicZones

list of string values

(Zone mode only) The forest that contains the classic zones

 

ForestsForHierarchicalZones

list of string values

(Zone mode only) The forest that contains the hierarchical zones

["companyA.com", "companyB.com"]

DomainControllers

dictionary

(Zone mode only) -- key = domain, value = domain controller

{"test.com": "dc.test.com"}

ScheduleRule

string

You use this parameter in conjunction with the ScheduleFrequency setting. With this parameter, you specify what sets of time to count when scheduling the frequency of report services synchronization.

The options that you can specify are "daily", "interval", or "weekly". Interval specifies an hourly interval.

"ScheduleRule": "weekly",

"ScheduleFrequency": 2,

The above example specifies that the report synchronization will happen every 2 weeks.

ScheduleFrequency

 

integer

You use this parameter in conjunction with the ScheduleRule setting. With this parameter, you specify the number of hours, days, or weeks to configure how often the report synchronization will happen.

For example, if you set ScheduleRule to weekly and you specify ScheduleFrequency to 1, the synchronization will happen every week. If you change the ScheduleFrequency to 3, the synchronization will happen every 3 weeks.

 

"ScheduleRule": "interval",

"ScheduleFrequency": 2,

The above example specifies that the report synchronization will happen every 2 hours.

ScheduleStartTime (string)

string

Specifies the time of day to start the report services synchronization, in the 24 hour format of hh:mm:ss.

"ScheduleStartTime": "14:00:00",

ScheduleWeekDays (list)

list of string values

Specifies on which days of the week the report services synchronization will happen.

You can specify "all" for a daily synchronization or "none" to just do it manually as needed. Otherwise, you can specify one or more of the following for days of the week:

"mon", "tue", "wed", "thu", "fri", "sat", "sun"

"ScheduleWeekDays": ["mon", "wed", "fri"]