isNeatPublish Quick Start

If you haven't already, download the isNeatPublish and isNeatPublish.XmlGenerator fully functional trial installers (.msi files). The two files are as follows

  • isNeatPublish.msi : this contains the automated SSIS object publisher/deployer (isNeatPublish).
  • isNeatPublish.XmlGenerator.msi : this contains a user interface (UI) that allows the user to enter SSIS object source and target information, generate an (XML) input file for the automated SSIS object publisher/deployer (isNeatPublish). Note that along with the executable there will be Start menu item and desktop shortcut deployed.

isNeatPublish is executed from the command line with an isNeatPublish XML file (which is generated via isNeatPublish.XmlGenerator).  The isNeatPublish XML file specifies the configuration for all of the artefacts to be published (execution settings, source and target locations, etc)

 To setup how and what is published, follow the steps below:-

  • open isNeatPublish.XmlGenerator (can be done via the desktop shortcut)
  • choose the File | Import menu item. There are two file types you can import
    • SSIS deployment file (.ispac) - to import this file type go to here
    • otherwise, to import from an SSIS project file (.dtproj) or manually enter the objects you wish to deploy, continue reading below

SSIS Project File (.dtproj) import

  • Select the folder location of the source SSIS project file, packages, etc. You will then be prompted to select the desired SSIS project file (.dtproj) that contains the SSIS project details (i.e. package names, environments and variables information) you would like to publish/deploy to the server. When the .dtproj file is selected you will be prompted to confirm - click 'Import'. Note that this approach (i.e. via the import workflow) will get you started quicker, as you will then (after the import) have the source and target file-names/configuration available for edit within isNeatPublish.XmlGenerator - you can then modify accordingly and add any SQL Agent jobs, etc. (Note if desired, you can enter the SSIS object names manually by choosing the SSIS project file (.dtproj) then click 'Cancel')
  • after the import is done, depending on the 'completeness' of the configuration within the SSIS project file, some (or many) of the fields within the isNeatPublish.XmlConfiguration tabs will be populated. Completeness meaning how much the build configuration, parameter information, etc has already been entered as part of the SSIS project. There are examples on the Examples and Further Information page

SSIS Deployment File (.ispac) import

  • Select the SSIS deployment file (.ispac) (make sure the .ispac file is up to date by compiling the project using the desired build configuration/environment name) which will be in the bin/environment-name folder under the SSIS project file, packages, etc.
  • when this is done, some (or many) of the fields within the isNeatPublish.XmlConfiguration tabs will be populated. Note that because the .ispac file contains packages, parameter information, etc certain areas of the isNeatPublish.XmlGenerator UI will be read-only There are examples on the Examples and Further Information page
  • it is assumed at this stage all required services are started on the target SSIS instance. Services include (the name of the services depend on the target SSIS instance name):-
    • SQL Server
    • SQL Server Agent (if deploying SQL Agents jobs)
  • then when all is entered, to test the deployment, save and publish as per the configuration (Publish! | Save and Publish to Server).  This will do the following:-
    • save the current configuration file
    • creates a batch file that can be used to submit the configuration to the server (note that the statement generated within the batch file assumes a default installation of isNeatPublish [i.e. with a location of  "C:\Program Files (x86)\isNeatPublish\isNeatPublish\isNeatPublish.exe"] - if this file is not found the batch file will still be generated but will have the statement commented out [REM'd])
    • submits the batch file
    • Note that if the saving of any of the files (Xml configuration file or batch file) or publish to the server fails as a result of permissions, it may be that you need to run isNeatPublish.XmlGenerator as an Administrator (simply Shift-right-click the isNeatPublish desktop icon | Run as administrator)
  • to validate, the structure and SSIS objects should now reside can be viewed under the "Integration Services Calatlogs" which is under the root node of the target SQL Server instance mentioned under the Catalogs/Environment tabs
  • to validate, SQL Agent jobs, these should now be under "SQL Server Agent" which is under the root node of the target SQL Server instance mentioned under the SQL Agent Jobs tab