Follow

How to set up deployment with multiple environments

Introduction

When you have more than one environment for your Business Intelligence Solution, you will have to decide how to deploy the project from one environment to another. This article describes the different methods available with TX.

The environments can be located on either a single server or in a multiple server setup. The options available are the same in either case, but if your environments are located on the same physical server then you need ensure that elements from one environment do not inflict with elements of another environment.

The deployment methods are:

 

Automatic deployment using the multiple environments feature

We have a guide on using the multiple environments feature available for download. Please see that for more information on using the feature.

The following shows a multiple environment example. You can set up as many environments as you want.

1.png

Prerequisites

Before setting up multiple environments, ensure that the following prerequisites are met.

  1. The "Multiple Environments Deployment"-feature must be included in your TX license.
  2. TX must be of the same version including bit version (32-bit/64-bit) on all servers used in the multiple environment scenario.
  3. On all servers you to which you want to deploy, ensure that the TX Server Windows service is installed. 
  4. You must ensure that a TX repository has been created on all the servers that are used in the multiple environment scenario.

Setting up the production server

First step is to setup the production environment on the production server.

Make sure that you are logged on as the user that is intended to run the production environment.

  1. On the Tools ribbon tab, select Environment Properties. The Add Environment dialogue opens.

    2.png
  2. Give the environment a name, e.g. "Production".
  3. Select Local as you will only deploy to this environment and not from it.
  4. In Act as server on port, enter a port to communicate over. Make sure the port is free to avoid any conflicts on the network. NOTE: If you receive an error about TX being unable to access the security log, then please close TX, and restart it As Administrator.
  5. Close TX.
  6. Open Services on the production server and configure the TX Server service. Make sure the account runs under the Windows account you used for setting up the production environment in step 1.
  7. Start the Service.

Setting up the development environment

Next, you will set up the development environment on the development server.

Make sure that you are logged on to the developlent environment as the user that is intended to run the development environment.

  1. Open TX on the development server

    3.png
  2. Create a development environment
  3. Then create a reference to the production environment previously created.
  4. Select "Remote" and in the Server field, enter the server name/IP address for the production server.
  5. In Local Port, enter the local port, and then in Remote Port enter the port used when the production environment was created on the production server.

    4.png

Global databases

The last step is setting up the global databases used in the project. To do this you use the multiple environment feature in TX.

  1. Click New Global Database. In Type select "Data source", and then select the relevant Provider Type.

    5.png
  2. Create all the types of databases you have in your project.

    6.png
  3. Configure the global databases created in step 1. Make sure that you configure all required settings for both environments.

    7.png

Configure project connections

Now the environments have been setup and the global databases have been configured. We can now setup the connections in the project to use the global settings.

  1. Modify the Data Source connection.
  2. Select Use Global Database and then select the global database for the data source. Repeat this step for all connections in your project: additional data sources, staging database, data warehouse database and OLAP database.

    8.png
  3. Deploy and execute the project to apply the changes to the project.

Transfer project from development to production

  1. On the Tools tab click Multiple Environment Transfer. The project is the transferred from the development environment to the production environment.

    9.png
  2. Deploy the project on the production environment. Right click the production environment and select Deploy.

    10.png

Execution package(s) and schedule(s)

  1. Setup an execution package in TX.

    11.png

    12.png
  2. Add a schedule to the package.

    13.png

    14.png

  3. Deploy and execute either the entire project or a single table to ensure the execution package is contained in the deployed version of the project.
  4. Transfer the project to the production environment as described above for the initial transfer.
  5. Deploy the project on production environment as described above. You will now be able to see when the production environment will be executed next.

    15.png

Remote execution from the production environment.

Because you have defined an execution package in the project you can now also execute the project manually in the production environment.

  1. Right-click the production environment and select Execute Package.

    16.png

 

Manual deployment using Export/Import

Complete the following steps to perform manual deployment using export / import.

  1. Open the project from the development environment.
  2. Export the project from the development environment.
  3. Copy the XML-file to the production environment server.
  4. Import the project to the production environment.
  5. If the project already exists, save it as the latest version of the project.
  6. Change the connection to the data source(s). You can do this from the connection manager.
  7. Change Schema/Owner on the data source tables if they are different in this environment.
  8. Change connection to the staging dataset(s).
  9. Change connection to the data warehouse(s).
  10. Change connection to the OLAP Server(s).
  11. Add or change the execution packages and schedules.
  12. Deploy and execute the project.

If the environments are on the same physical server, make sure to use SSIS folders on the project to prevent overwriting of SSIS packages with similar names. Alternatively, you can change the name of the business unit(s), the data source(s), and the data warehouse.

 

Manual deployment using different project names

If you are not using history-enabled or incrementally loaded tables, you can do a manual deployment using different project names using the following steps.

  1. Open the dev-project.
  2. Select Save As to save the project under a new name.
  3. If the project exists, chose to save it as the latest version of the project.
  4. Change connection to the data source(s).
  5. Change Schema/Owner on the data source tables if they are different in this environment.
  6. Change connection to the staging dataset(s).
  7. Change connection to the data warehouse(s).
  8. Change connection to the OLAP Server(s).
  9. Add or change the execution packages and schedules.
  10. Deploy and execute the project.

If the environments are on the same physical server, make sure to use SSIS folders to prevent overwriting of SSIS packages with similar names. Alternatively, you can change the name of the business unit(s), the data source(s), and the data warehouse.


This article applies to: timeXtender 4.5, tX2012, TX2014, TX DWA.

Was this article helpful?
2 out of 2 found this helpful
Have more questions? Submit a request

6 Comments

  • 0
    Avatar
    Chris Shelley

    Is there a document that describes how this works where a Dev,Test and Production environment exist and what order you have to add these to the environment settings?

  • 1
    Avatar
    Richard Ray

    I would also be interested in any Dev > Test > Prod advice.

  • 0
    Avatar
    Thomas Lørup Duun

    We have a new and more detailed guide to setting up multiple environments in progress.

  • 0
    Avatar
    Maarten Vanleenhove

    Thomas, any progress on this?

    Customer wants test/dev on 1 machine and prd on different machine...

  • 0
    Avatar
    Thomas Lørup Duun

    Hi Maarten,

    The guide is done, just need to have it converted to an article.

    I will send you a copy to use until then!

  • 0
    Avatar
    Thomas Hjermitslev

    The new how-to guide can be downloaded here: https://support.timextender.com/hc/en-us/articles/214439823

Please sign in to leave a comment.