Skip to Content

This blog is the continuation from BSI TaxFactory 10 Installation/Upgrade for SQL Server and BSI TaxFactory 10 Installation for SQL Server – Part 2, which collectively covered gathering materials, configuring SQL Server, installing SAP Gateway, creating the TaxFactory database, and installing the TaxFactory server executables. Now we will move on to the TaxFactory web client and loading our dataset, and then in Part 4 we will get it all connected to SAP.

Client Installation

Unlike previous releases, TaxFactory 10 introduces a new web-based client, which requires the installation of a small web server and associated XML files. You will therefore need to install a Java Runtime Environment (JRE), Apache Tomcat web server, Microsoft SQLJDBC driver, and the TaxFactory 10 Client component itself.

Java Runtime Environment

Earlier (in Part 1) you downloaded Oracle Java 7 for Windows 64-bit. You should now have in your Source folder a file named similarly to jre-7u67-windows-x64.exe (the u67 portion may be different if you downloaded a more recent patch). Execute this file. Accept the warning, then on the Welcome screen click on Install. After a moment you should see a success message. Click Close.

To test that the installation was successful, open a command prompt and type java -version. If the JRE is properly installed you should see version information.

Apache Tomcat

Tomcat is a lightweight web server that provides the environment for the TaxFactory web client. Again, you have already downloaded the installation files (in Part 1) to your Source folder, where it will have a name similar to apache-tomcat-7.0.55.exe. Execute this file. Accept the security warning and click Run.

The Apache Tomcat Setup Wizard will start. Click Next. Accept the license agreement by clicking I agree. On the Choose Components page, leave everything at default and click Next.

On the Configuration Options page, leave everything at default (other than optionally checking the box for Create shortcuts for all users) and click Next.

On the Java Virtual Machine page, the wizard should have automatically located the path to your JRE 7 installation. Click Next. On the Choose Install Location page, change the destination folder as appropriate for your software installation standards, or leave it at the default, and click Install. The installation is very quick. When it is done, leave Run Apache Tomcat checked and click Finish. You should briefly see a message about the service starting.

SQLJDBC

Just as the TaxFactory server requires an ODBC driver to connect to the database, so the TaxFactory client, which runs in the Java context of the Tomcat web server, requires a JDBC driver. Earlier (in Part 1) you downloaded the Microsoft JDBC Driver 4.0 for SQL Server and saved it to your Source folder. Extract the contents now.

Create a new folder named sqljdbc_4.0. There are two files you need to copy to this new folder:

  • \Source\Microsoft JDBC Driver 4.0 for SQL Server\sqljdbc_4.0\enu\sqljdbc4.jar
  • \Source\Microsoft JDBC Driver 4.0 for SQL Server\sqljdbc_4.0\enu\auth\x64\sqljdbc_auth.dll

TF10Client

Earlier (Part 1 again) you downloaded the TF10 Client Package for Windows as a zip file. Extract the contents to create a source folder called TF10ClientInstall. Inside that folder, open TF10ClientInstallation.pdf to find the official installation instructions, and follow along in that document along with this blog to continue.

Execute TF10ClientInstall.exe. Accept the security warning and click Run. Make a note of the functions and prerequisites on the welcome screen and click Next.

Enter the Cyclic password you received from BSI via email and click Next.

Review the license agreement and click I Agree.

On the Configuration Analyzer screen you should note that no prior TF10 Client environments are installed, and that the installer automatically found your Tomcat installation.

If the installer did not find Tomcat, double-check that Tomcat is actually running (it is a Windows service named Apache Tomcat 7.0 Tomcat7). Once your screen looks similar to the above, click Next.

On the XML Server Configuration screen, check the box for 64 bit XML Server and set the appropriate path for installation. I recommend putting this under the same \BSI folder you created earlier for the TaxFactory server executables (in Part 2). Click Next.

As this is the first install on this server, the next screen (BSI TaxFactory 10 Environment Configuration) will read Production Environment Configuration and will have the Install checkbox checked. The screen will be greyed out, because you are required to install one “production” environment on your web server. Don’t be alarmed if this is not intended to be “production” but is actually a DEV or QAS system; BSI has set up the client install to allow the installation of multiple environments onto a single web server, but they require PRD to be the first install. My recommendation is to have physically separate DEV, QAS, and PRD servers, which means that BSI will assume a “PRD” environment on each of them. That’s ok. Accept the choice here and click Next.

The next screen is probably the most important to get right in this process. This is the “Client Environment” screen. The WEB Server Service Port, WEB Server Service Name, and Database Schema fields will be pre-filled. Do not change these. Under “WEB Server JDBC Configuration / XML Server ODBC Configuration” select the radio button for MS SQL Server.

A pop-up box will ask Does your MSSQL server connection use Windows Authentication? Click Yes.

Now the JDBC JAR file location field will be ready for input (it was greyed out before selecting your DBMS). Click Browse and locate the sqljdbc4.jar file you setup earlier (see “SQLJDBC” in this blog).

Enter the following information into these fields:

  • Database Name:  TF10
  • Database Port:  1433
  • Database Host:  <your database/taxfactory server hostname>
  • DSN:  <select the ODBC Data Source you set up earlier (in Part 2), i.e “TFP” or the SID for your Gateway (if you followed my recommendation)>

When you are done, your screen should look similar to this:

Click Next. If all went well, you will see a popup stating Successfully tested ODBC connection and schema for DOMAIN/sidadm. Click OK.

The next screen is TaxFactory XML Server Configuration for MSSQL Windows Authentication. Here you must supply the username and password that the TaxFactory XML server will use to connect to the database. It will default to your currently logged-on user, which at this point is probably sidadm (tfpadm in our example). This is fine to use, as long as the password is set to never expire.

Browse to the path for sqljdbc_auth.dll that you setup earlier (again, in “SQLJDBC” in this blog). When you are done, your screen should look similar to this:

Click Next.

The next five screens are for adding additional environments (DEV, QA, Test1, Test2, and Test3) to the server. You don’t need to do that, at least not at this time. Leave the Install button cleared (the default) on each of them and click Next until you come to the confirmation screen:

Check the checkbox for Install PRD Environment(s) and click FINISH. The installation will take a minute or two and will start some services. When it is done you should see Setup was completed successfully and Completed. Click Close.

Load Data Set

Now it’s time to launch the client. Switch to your workstation and start your web browser. Navigate to http://hostname.domain.com:8091/eTF10d/PRD, substituting your taxfactory server’s hostname. If you are on a newer Cyclic than 10.0.d, use the appropriate cyclic name in place of eTF10d. Logon to the client with:

  • User:  TF10
  • Password:  bsi

Create Data Set

After logging on, you will see the following screen:

Click on the DEFAULT Data Set ID to connect to it. This is necessary before you can navigate to any other screen in the client.

In the upper right corner, locate the Jump To drop-down box and select System Tools.

Under Access Tools, select Manage Data Set.

Under Manage Data Sets, above the list of available Data Sets, click the link for Click here to add new Data Set.

Under Enter Data Set Information, enter your SAP payroll client number as the Data Set ID and a description of your choice. Select the checkbox for Apply default permission to this Data Set and click Save.

Back at the Manage Data Sets screen, click on your new Data Set to configure it.

Under Related Activities, select Manage Logins and Permissions.

Select the TF10 login (the one in caps).

Select Click here to manage Tool level permissions for this login.

On the Permissions screen, for Permission for Dataset, select your new Data Set and click Refresh.

Scroll to the bottom of the page, select Check All, then Save, then Exit.

Back on the Manage Logins screen, click Manage Data Set, then Connect to Data Sets. Click on your new Data Set to connect to it. Now notice in the lower right (at the right end of the copyright text bar) that your Data Set should be listed as the one that you are connected to.

Install License

Earlier (in Part 1) you created a Machine Key on the BSI website and downloaded it as a file. Now it’s time to apply that to your TaxFactory database.

In the Jump To drop-down in the upper right corner, once again select System Tools. Under Database Tools, select Install Machine Key.

Browse to the file you saved (default name is machinekey.lic) and click Upload. After a second or two you should see the message License Key has been installed successfully. If there is an error here, ensure that you correctly entered the hostname on the BSI website when you created the key (including using all caps for a Windows hostname). Also note that the machine key is only valid for installation for a period of five days after creation on the BSI website, so if it has been longer than that, you will need to regenerate the key. Otherwise, click Exit.


Load Tax Master File

Back in Part 1 you downloaded a master file with the latest Cyclic and Regulatory data from BSI. This file will have a name similar to TFU10034.PKG (where 034 indicates the Regulatory, or TUB, level of the file). Using this file enables you to bypass having to separately load the latest Cyclic and every Regulatory bulletin, instead loading it all in one step for initial setup. After this, when BSI releases new Cyclic and Regulatory bulletins, you will apply those normally.

Back on the System Tools page, under Database Tools, select Database Load. Browse to your tax master file and click Upload. On the Database Load  screen that pops up, select the checkbox next to tf.xml and click Process.

This load will likely take about five minutes. If it appears to happen quickly, it’s best to wait several minutes, as it is probably still loading in background. Normally, however, you will see an IN PROGRESS message while the load is happening. When the load is finished there will be an output file with an audit of the results. Look through the log to see that all records were processed (all zeroes for the second number in each row). When satisfied, click Exit twice.

Back on the System Tools page, under Maintenance Tools, note that the level numbers for Regulatory Bulletin and Cyclic have advanced to the current status (previously they were 0).

Optional: TaxLocator File

Not all states and not all organizations use TaxLocator, but if you do, now is the time to load the TaxLocator file from BSI, using the same procedure as the tax master file.

Load Initial Tax Mapping

The Initial Tax Mapping is a file provided by SAP, not BSI, which provides a mapping between SAP tax codes and BSI tax codes. You downloaded this file in Part 1 from the same location as the SAP TUB files. After extraction, you should have the file BTXTAXC.xml on your workstation.

Note: if you are performing an upgrade and using a Custom Backup and Restore from your TF9 database, you do not need to perform this step, as this data will be contained in the backup/export from TF9. For an initial install, or if you are choosing a ‘clean’ install of TF10 rather than upgrading, then you will need this file.

On the System Tools page, under Database Tools, select Custom Backup/Restore. On the Custom Backup/Restore page, select Restore. Select your BTXTAXC.xml file and press Upload.

On the Custom Data Restore page that follows, select the radio button for Existing Data Set and choose your new Data Set. Do not select Delete Existing Data nor Restore Permission (Rights). Click Process.

The restore should take less than a minute. Again, when done there will be an output audit file. Verify that there were no unprocessed records, then click Exit four times.

You should now be back at the Welcome screen. Under System Summary you will notice that where previously you had zero mapped tax codes, now you will have several thousand. You may also see a handful of unmapped authorities. This is normal.

<continued at BSI TaxFactory 10 Installation for SQL Server – Part 4>

To report this post you need to login first.

17 Comments

You must be Logged on to comment or reply to a post.

    1. Matt Fraser Post author

      Thank you, Tammy, that’s really nice to hear! It is, after all, the whole point to help others solve problems that either I personally found non-trivial, or which, from reading the forums, it seems others are finding the same. This upgrade of TaxFactory seems to have been more vexing to a lot of folks than previous upgrades.

      (0) 
  1. Andre Coetser

    Hi Matt,

    Unfortunately I found your blog 4 agonizing days too late, but I have saved the link. I actually have a question for you. I have installed the complete BSI TF10 system on my DEV box. My wish is to not install the entire system on QA again, but just let my QA system connect to the installation on the DEV system. What do I need to do? Here is what I already did:

    • Copied the server folder onto my QA system.
    • Created a ODBC connection to TF10 database installed on DEV.
    • Changed the tf10server.bat file to use my domain\<sid>adm account.
    • Added my domain\<sid>adm account to my TF10 database with dbo permissions.

    If I run the tf10server.bat file, I get an error in the debug file: “
    message missing -a <Program ID>

    (0) 
    1. Matt Fraser Post author

      Hi Andre,

      Sorry this has been agonizing for you! Anyway, what you’re trying to do should be very possible. What I would do in this circumstance, however, is not try to have two different tf10server installations pointing to a single database. Instead, consider reusing the existing tf10server installation you already have on your DEV box; you just set up the RFC connection in your QAS SAP system to point to the tf10server.bat on your DEV box.

      Do you use different client numbers between DEV and QAS? If so, then you need to ensure your DEV TaxFactory database has a unique Data Set for each one. If not, if you use the same client number for both, this isn’t really a problem. It just means that if you are troubleshooting payroll runs by looking in the TaxFactory message logs, you will see runs from both DEV and QAS mixed together there. However, you should be able to separate them by timestamp, and you only need them for troubleshooting. Actually payroll tax calculations will proceed fine. We actually do this with our QAS setup, since we have a sandbox, two test systems, and a training system that all reuse a single QA TaxFactory server.

      As for using your domain/<sid>adm account in your tf10server.bat file, I’m not sure that’s necessary. You use that in the JDBC connection from the TF web client, and while setting up the ODBC DSN. In the batch file itself, however, what you are setting is the TaxFactory application user and password. By default the user is ‘TF10’ and the password is ‘bsi’. You actually set this with the noessqv.sql script you ran earlier when creating the database — it’s not a Windows nor SQL Server login, but internal to the TaxFactory application. If you want to change the password, you must do so using the TF web client.

      Hopefully this helps.

      Best regards,

      Matt

      (0) 
      1. Andre Coetser

        Hi Matt,

        I configured the RFC connection like you suggest in your blog. I get a connection error when I test the connection to the tf10server.bat file. Do I have to make the changes to the gateway server file secinfo.dat since this is a SAP ERP system?

        (0) 
        1. Matt Fraser Post author

          That depends on the release of the DEV system where you are running tf10server, and when you installed it. If it was just installed in the past couple years, or if it’s one of the latest NetWeaver releases (i.e, EhP7), then you probably do need to edit the secinfo.dat file. The location of the file will be a little different than I described in the blog, since you’re using the integrated gateway of the SAP application rather than the standalone gateway as I describe. Also, your RFC connection will use the Start on Application Server option instead of Start on Explicit Host.

          (0) 
          1. Andre Coetser

            It is a new install on EH7. I found the secinfo file and it only has one line in it.

            USER=*, USER-HOST=local, HOST=local, TP=* # local

            Do I add your secinfo code before or below this line? Do I need to do anything on the calling server?

            Sorry for making this a RFC discussion, but I need to get this one up soon as it is overdue, and then I can take a breather and research more on the RFC topic.

            (0) 
            1. Matt Fraser Post author

              Add the new line in secinfo.dat below the existing line. That existing line basically allows access from callers originating on the same host as the SAP server (“local”), which would be why your TF is working from DEV (it’s local) but not from QAS. Normally you shouldn’t even need a local-only line like this, as it’s implied, but it certainly doesn’t hurt anything. So, you need to add a line starting with ‘P’ (for ‘Permit’), and TP=<local path to your tf10server.bat>, HOST=local (or the hostname of your DEV server), USER=*, and USER-HOST=<hostname of your QAS server, or IP range of your SAP servers in general>. So, if your tf10server is installed on drive E:, for instance, it might look something like:

              P TP=E:\BSI\TaxFactory\server\tf10server.bat HOST=devserver.domain.org USER=* USER-HOST=qasserver.domain.org

              (0) 
                1. Matt Fraser Post author

                  The location you’re looking for to put your secinfo.dat file is probably \usr\sap\<SID>\SCS<nr>\data. For NW 7.4 (i.e., EhP7), the gateway is part of the SCS instance. You can confirm the exact location by looking up the value for profile parameter gw/sec_info. If you haven’t explicitly set this parameter (which you probably haven’t), then you can find it by running RSPARAM in SA38.

                  There is some more information in Notes 1069911, 1105897, and 1305851, though they tend to look more at the REGINFO file instead of SECINFO (related, but slightly different). Also, I wrote about the REGINFO file and how to configure it in my blog about migrating SLD to a standalone server: SLD Migration and gw/acl_mode. While the two files serve a different purpose and the entries are not formatted exactly the same, nevertheless there is some crossover information about how to use them.

                  (0) 
                  1. Andre Coetser

                    Matt, my RFC connection to the other server will not work. I continue to get an error message “ERROR: User not authorized to start the program on the host”. The next line lists the Location as the server I am making the call from, not the host that has the gateway server configured. I have configured both the secinfo and reginfo files, but still no go. I have also added the path to the tf10server.bat file as a system environment variable.

                    My SM59 connection is configured as follow:

                    Activation Type = Start on Application server

                    Program = f:\bsi\tf10d\server\tf10server.bat

                    Default Gateway Value

                    Default Gateway Value

                    Gateway Host = host.domain.com

                    Gateway service = sapgw00

                    I see the secinfo and reginfo files in smgw and looks exactly like you did yours. If you do not have any ideas, I will just have to install BSI locally on the QA system.

                    (0) 
                    1. Matt Fraser Post author

                      Reginfo shouldn’t be a factor here, since you aren’t trying to register a program on the gateway, but it can’t hurt. Secinfo is the file of concern. Full RFC troubleshooting is probably beyond the scope of commenting on the blog entry, and perhaps is worthy of opening up with a question in the forums. This isn’t TaxFactory specific, it’s more about making the RFC connection to the remote gateway work. Starting up a separate question thread would encourage others to jump in and help.

                      Meanwhile, you could also try opening up the settings in secinfo.dat as an experiment, to see if that is the cause. I.e., set everything to * and see what happens.

                      Oh, one other thing to try first. Have you restarted the gateway since changing secinfo.dat? The settings in the file are ready by the gateway at startup and then cached. If you modify the file, you have to restart the gateway process to make the change take effect. You shouldn’t have to restart your entire DEV server, just the GWRD process on the SCS instance.

                      (0) 
                      1. Andre Coetser

                        You are correct Matt about my problem being beyond the scope of this blog. Still, I want to thank you for all your help and patience. You have been a great resource. Much appreciated.

                        (0) 
  2. Jaco Nel

    Hi Matt,

    We’ve completed the BSI TaxFactory 10.0 installation, following your guidelines.

    We at the step to load the Tax Master File – It processes for a couple of minutes and returns the following results in File Name 1416403762088_TFU10039.PKG(tf.xml).out “

    0 Records Processed in 0.00 Seconds


    Start Time: 15:29:26


    End Time: 15:29:26


    **** END OF REPORT ****

    Please advise on possible solution ?

    Thanks

    Jaco

    (0) 
    1. Matt Fraser Post author

      Hi Jaco,

      One thing I noticed while loading the tax master file (in my case, I loaded TFU10034.PKG) was that in some environments it loaded normally, and in others, it appeared to happen very quickly, almost instantly. These were identical environments. However, in all cases, it did load normally, but where it appeared to happen fast — it didn’t. It still took about five minutes, but it continued to load in background after the web page indicated it was done.

      So, what I would do in your case, after about five minutes have gone by, is to go back to System Tools -> Maintenance Tools and check to see the status of your Regulatory Bulletin and Cyclic. If you see 39 and D, then most likely the file loaded properly.

      You can also load it again, assuming you haven’t loaded new regulatory bulletins on top of it.

      Another possibility is that you’ve already applied a Cyclic or Regulatory Bulletins to the system. The tax master file assumes you are starting from zero, so if you already have regulatory data in your database, that might cause this behavior.

      Regards,

      Matt

      (0) 
      1. Jaco Nel

        Hi Matt

        Thank you for the response, we did try you suggestion but did not work. We contacted BSI and they suggested the following – see below comment.

        “Per our phone conversation we recommend loading the TF10 Initial Master Data File from the Server using tfloader command.  You were also able to find the
        instructions from the online Tech Doc. “

        This worked for us.

        Thanks agian for your assistance

        Regards

        Jaco

        (0) 

Leave a Reply