OneScript Manual


Table of Contents

OneScript System Quick Start
Installing OneScript Client
Add License Key
Add a License Key
Add a License Key While Offline
OneScript Database Setup
Application Users
Source Control
Projects
Edit Project Information (the Name Tab)
Members
Source Control
Automatically Injected Build Scripts
Project Summary and Save
Build Commands
Release Requests
Request Information and Type
File Filters
Select Files
Review Selected Files
Submit Request
Setup SMTP Server (Email Server) (Optional)
Log File
Themes
Installing the OneScript Webservice (Optional)

OneScript System Quick Start

The OneScript system might seem confusing at first but their are parts that are optional and their are a lot of advanced features that you don't have to use when getting started. The simplest path to building your first SQL release script file (your OneScript) consists of the following steps:

  1. Download the OneScript Client Setup and install it. The download link is http://www.OneScript.com/Downloads/OneScriptClientSetup.msi

  2. Start the OneScript Client.

  3. Initial Setup Prompt: Paste in your trial or permanent License Key. Click the button to activate your OneScript Client. The license key can only be used once.

  4. Initial Setup Prompt: Next you will be prompted for a connection string. On that same page is a link to open the OneScript.sql file. Create a new SQL Server database, name it something like "OneScript" and then run OneScript.sql on it. Edit the connection string to connect to that new database.

  5. Initial Setup Prompt: Once the OneScript Client connects to the database, add your Windows username as a OneScript member.

  6. Initial Setup Prompt: Enter the information to allow the OneScript Client to connect to your source control. This should be the path to your source control and not the complete path to your project.

  7. Initial Setup Prompt: Create a new project where you define the users, source control parent path to your files and edit your injected scripts.

  8. Once the new project is saved, create a build command and select the folder where the generated OneScript Build Release script file will be saved.

  9. In the build command editor specify the filters for your source control's SQL script files. An example would be: "include all files changed since '4/5/2016 11:44' or in a Release Request.

  10. Save and run the build command. You can optionally copy the command line and run the build from a command prompt.

You should now have a SQL script file in your build directory that contains all of the script files concatenated together in the right order.

More details about each of these steps can be found in the rest of this help site.