SSRS OCF Connector: Install and Configure

Alation Cloud Service Applies to Alation Cloud Service instances of Alation

Customer Managed Applies to customer-managed instances of Alation



Make sure that the connector can access ports ports 80 (HTTP) and 443 (HTTPS) are available for SOAP API communication on the SSRS server.

Service Account

Perform the steps in the following sections to create a service account and assign it the required roles.

Create a Windows User

Create a Windows user account for SSRS. For details, refer to Microsoft Account in Microsoft documentation.

Assign Roles

Perform the following steps to assign the requried roles to the Windows user:

  1. Log in to the SSRS web portal with the Administrator account.

  2. Go to Settings > Site Settings.

  1. On the Security tab, click Add group or user.

  1. In the Group or user field, type the Windows user name and select the System User role. Click Ok.

  1. Go to Home > Manage Folder.

  2. On the Security tab, click Add group or user.

  3. In the Group or user field, type the Windows user name and select the Browser role. Click Ok.

  1. Navigate to the folder that you want to provide access. Go to Manage Folder > Security tab and click Use same security as parent folder.


Setup SSL with SSRS

Perform the following steps to set up SSL with SSRS:


This configuration is required only if SSL authentication is used.

Generate a Self-Signing Certificate using Powershell

  1. Run the nslookup command for SSRS instance IP. From the result, note down the dns-name.

    nslookup command example - nslookup Dns-name example -

  2. Run the following command. Replace the dns-name parameter with the dns-name generated in the previous step.

    New-SelfSignedCertificate -CertStoreLocation cert:\LocalMachine\my -dnsname {dns-name}
    $pwd=ConvertTo-SecureString "password1" -asplainText -force
    $file="C:\temp\ssrs_cert.pfx" # ensure folder C:\temp exists
    Export-PFXCertificate -cert cert:\LocalMachine\My\<Thumbprint produced during first command> -file $file -Password $pwd
    Import-PfxCertificate -FilePath $file cert:\LocalMachine\root -Password $pwd

Configure the Web Service URL

  1. Open Reporting Services Configuration Manager and click Connect.

  2. On the Web Site URL tab, click the HTTPS Certificate drop-down box and select the certificate you installed. Click Apply.


Update Authentication Configuration for Report Server

  1. Locate and open the rsreportserver.cofig file from the SSRS folder on the machine that has SSRS installed.

  2. Make the following changes in the rsreportserver.cofig and restart the report server.

    • Change Authentication type from the default RSWindowsNTLM to RSWindowsBasic

    • Set RSWindowsExtendedProtectionLevel property to allow

    • Set RSWindowsExtendedProtectionScenario to Direct



The SSRS OCF connector supports only RSWindowsBasic and RSWindowsNTLM authentication types. RSWindowsNegotiate or RSWindowsKerberos authentication types are not supported.

Export Certificate

  1. Go to Control Panel > Manage computer certificates.

  2. Select the certificate at Personal/Certificates.

  3. Right click on the certificate and select All Tasks > Export.

  4. Click Next.

  5. Select the option No, do not export the private key and Click Next.

  6. Make sure that the DER encoded binary X.509 (.CER) is selected and click Next.

  7. Select a location to save the certificate and click Next.

  8. Click Finish.


    Make sure your firewall is set to allow incoming connections on port 443.


BI Server URI Format

<Host or IP_Name>:<Port>/Report_Manager_Virtual_Directory_Name


Port number must be included in the URI only if any custom port is used apart from the default ports 80 or 443.


BI Connection URI Format

<Host or IP_Name>:<Port>


Port number must be included in the URI only if any custom port is used apart from the default ports 80 and 443.



Step 1: Install the Connector

Alation On-Premise


Installation of OCF connectors requires Alation Connector Manager to be installed as a prerequisite.

To install an OCF connector:

  1. If this has not been done on your instance, install the Alation Connector Manager: Install Alation Connector Manager.

  2. Ensure that the OCF connector Zip file is available on your local machine.

  3. Install the connector on the Connectors Dashboard page using the steps in Manage Connectors.

Alation Cloud Service


On Alation Cloud Service instances, Alation Connector Manager is available by default.

Depending on your network configuration, you may need to use Alation Agent to connect to databases.

Connection via Alation Agent
  1. Ensure that Alation Agent is enabled on your Alation instance. If necessary, create a Support ticket with Alation for an Alation representative to enable the Alation Agent feature on your instance and to receive the Alation Agent installer.

  2. Install the Alation Agent.

  3. Install the OCF connector on Alation Agent.

Connection Without Agent

To install an OCF connector:

  1. Ensure that the OCF connector Zip file is available on your local machine.

  2. Install the connector on the Connectors Dashboard page using the steps in Manage Connectors.

Step 2: Create and Configure a New Data Source

In Alation, add a new data source:

  1. Log in to Alation as a Server Admin.

  2. Expand the Apps menu on the right of the main toolbar and select Sources.

  3. On the Sources page, click +Add on the top right of the page and in the list that opens, click BI Source. This will open the Add a Data Source wizard.

  4. On the first screen of the wizard, specify a name for your data source, assign additional Data Source Admins, if necessary, and click the Continue Setup button on the bottom. The Add a Data Source screen will open.

  5. On the Add a Data Source screen, the only field you should populate is Database Type. From the Database Type dropdown, select the connector name. After that you will be navigated to the Settings page of your new data source.

The name of this connector is SSRS OCF.



Configure Access

Applies from release 2023.3.5

On the Access tab, set the BI source visibility as follows:

  • Public BI Server—The BI source will be visible to all users of the catalog.

  • Private BI Server—The BI Source will be visible to users that have been assigned the BI Server Admin or Viewer role. It will be hidden for all other users.


You can add more BI Admins or Viewers in the BI Server Admins section if required.

For more information, see Configure Access to OCF BI Sources

General Settings


This section describes configuring settings for credentials and connection information stored in the Alation database. If your organization has configured Azure KeyVault or AWS Secrets Manager to hold such information, the user interface for the General Settings page will change to include the following icons to the right of most options:


By default, the database icon is selected, as shown. In the vault case, instead of the actual credential information, you enter the ID of the secret. See Configure Secrets for OCF Connector Settings for details.

Perform the configuration on the General Settings tab.

Application Settings

Specify Application Settings if applicable. Save the changes after providing the information by clicking Save.



Enable Raw Dump or Replay

The options in this drop list can be used to dump the extracted metadata into files in order to debug extraction issues before ingesting the metadata into Alation. This feature can be used during testing in case there are issues with MDE. It breaks extraction into two steps: first, the extracted metadata is dumped into files and can be viewed; and second, it can be ingested from the files into Alation. It is recommended to keep this feature enabled only if debugging is required.

  • Enable Raw Metadata Dump: Select this option to save extracted metadata into a folder for debugging purposes. The dumped data will be saved in four files (attribute.dump, function.dump, schema.dump, table.dump) in folder opt/alation/site/tmp/ inside Alation shell.

  • Enable Ingestion Replay: Select this option to ingest the metadata from the dump files into Alation.

  • Off: Disable the Raw Metadata Dump or Replay feature. Extracted metadata will be ingested into Alation.

Disable Automatic Lineage Generation

Select the Disable Automatic Lineage Generation checkbox to skip the creation of automatic Lineage after extraction. When automatic Lineage generation is disabled, during extraction Alation does not calculate Lineage data for this BI source.

For more information, see Disable Automatic Lineage Generation.

Disable Permission Enforcement

Not applicable. Leave the default setting (selected).

Disable Certification

Not applicable. Leave the default setting (selected).

Server URI

Provide the Server URI to access the SSRS server from the catalog page. Refer BI Server URI Format.

Connector Settings

Server Connection

Populate the BI source connection information and save the values by clicking Save in this section.



Data Source Connection


Specify the URI in the required format.


Report manager virtual directory name is not required for this URI which will be used for extraction.


Specify the service account username.


Specify the service account password.

Extract SQL Server Reporting Services (SSRS) Version

Specify the SSRS version. The default version supported is 2019.

Report Server Virtual Directory

Specify the report server virtual directory name. The default value is ReportServer.

Additional Settings

Enable SSL Certification

Enable or disable SSL authentication by selecting or clearing the Enable SSL Certification checkbox.

If the Enable SSL Certification checkbox is enabled, upload the SSL certificate using the upload link below this checkbox.

Report Manager Virtual Directory

Specify the report manager virtual directory name. The default value is Reports.

Enable Preview Extraction

Enable or disable preview extraction by selecting or clearing the Enable preview extraction checkbox.


If the preview extraction is enabled it will eventually increase the MDE time.

Logging Configuration

Select the logging level for the connector logs and save the values by clicking Save in this section. The available log levels are based on the Log4j framework.



Log level

Select the log level to generate logs. The available options are INFO, DEBUG, WARN, TRACE, ERROR, FATAL, ALL.

Application Settings

Not applicable.

Obfuscate Literals

Obfuscate Literals — Enable this toggle to hide the details of the queries in the catalog page that are ingested via QLI or executed in Compose. This toggle is disabled by default.

Test Connection

Under Test Connection, click Test to validate network connectivity.

Extraction Settings

Selective Extraction

Under Selective Extraction, you can select the projects to include or exclude from extraction. Selective extraction settings are used to apply a filter to include or exclude a list of projects.

To configure selective extraction:

  1. Enable the Selective Extraction toggle if you want only a subset of projects to be extracted.

  2. Click Get List of Projects to first fetch the list of projects. The status of the Get Projects action will be logged in the Extraction Job Status table at the bottom of the Metadata Extraction page.

  1. When project synchronization is complete, a drop-down list of the projects will become enabled.

  2. Select one or more projects as required.

  3. Check if you are using the desired filter option. Available filter options are described below:

Filter Option


Extract all Projects except

Extract metadata from all projects except from the selected projects.

Extract only these projects

Extract metadata only from the selected projects.

  1. Click Run Extraction Now to extract metadata. The status of the extraction action is also logged in the Job History table at the bottom of the page.


Once you have extracted, if you notice any mismatch between the folders in the SSRS instance and in Alation, make sure that your connector is updated to version 1.2.0.

Automated and Manual Extraction

If you wish to automatically update the metadata extracted into the Catalog, under Automated and Manual Extraction, turn on the Enable Automated Extraction switch and select the day and time when metadata must be extracted. The metadata extraction will be automatically scheduled to run on the selected schedule.


Refer to Troubleshooting.

Migration from Native to OCF

You can migrate your existing SSRS BI source that is cataloged using the built-in (GBMv1) connector for SSRS to the SSRS OCF connector.


  1. Before you begin the migration, make sure you do the Alation backup to restore back to the last working stage incase of migration failure.

  2. Make sure you have the SSRS migration scripts provided by Alation with the connector zip file. For Alation version < 2022.4, contact Alation Support for the migration scripts.

  3. Install the SSRS OCF connector. Do not configure the new BI source as the migration script supplied by Alation will migrate the native (GBMv1) BI source to OCF BI source.

  4. Find out the ID of the BI source you want to migrate. See How to Find Data Source ID.


Perform the following steps:

  1. Copy the migration scripts provided by alation to the tmp directory. Substitute the placeholder <ssh-user>@{alation-instance-ip} with the actual value.

scp <ssh-user>@{alation-instance-ip}:/tmp
scp <ssh-user>@{alation-instance-ip}:/tmp
  1. Use SSH to connect to the Alation server.

  2. Stage the migration scripts in the one_off_scripts directory.

sudo cp /tmp/ /opt/alation/alation/opt/alation/django/rosemeta/one_off_scripts
sudo cp /tmp/ /opt/alation/alation/opt/alation/django/bi_metadata/models/bi_server/strategies/v2
  1. Enter the Alation shell and navigate to one_off_scripts directory.

sudo /etc/init.d/alation shell
sudo su alation
cd opt/alation/django/rosemeta/one_off_scripts/
  1. Run the command given below to find out the ID of the OCF connector that will be used for this migration:

    alation_ypireti list --fields id name

This command returns a list of IDs and names of the OCF connectors that are currently running on the Alation host. Locate the ID of the connector that you need.

  1. Run the migration scripts using the following command. Substitute the placeholders {Native(GBMv1) SSRS Datasource Server Id},  {SSRS OCF Connector Id} with actual values.

python --source_id {Native(GBMv1) SSRS Datasource Server Id} --id {SSRS OCF Connector Id} --confirm


[root@df33fe74ea7f one_off_scripts]# python --source_id 2 --id 1 --confirm
  1. Run full metadata extraction for folder hierarchies and to view the parent to child relationship of the folders. The full extraction is required as the parent to child relationship of the folders is not supported in the native connector.