First Time Configuration

The configuration files that come with ERPWorks contain sensible defaults. Because every workplace environment has different standards and common practices, the configuration files are easy-to-read and flexible. Be sure to consult the detailed configuration file reference in the sidebar for more information.

ERPWorks configuration files are written in YAML, which has a simple data serialization syntax.

ERPWorks configuration files are found in the installation folder. They are as follows:

• erpworks-im-config.yml
• erpworks-oo-config.yml
• erpworks-pk-config.yml
• erpworks-sw-config.yml
• erpworks-ui-config.yml

To start using ERPWorks with the installation defaults, only one modification needs to be made to the erpworks-pk-config.yml file. We need to configure ERPWorks to connect to the ERP system’s database.

Obtaining the SQL Connection String

First, we’ll generate an SQL connection configuration string.

1. First, create a new, empty text document. The name doesn’t matter, as we’ll be deleting it at the end.

2. Rename the text document, changing the extension from .txt to .udl.

3. Double-click on the renamed file to open the Data Link Properties window. Follow the steps in the dialog.

   

4. Click OK on the dialog to save the configuration.

5. Rename the file again, change the extension back to .txt.

6. Open the file in a text editor like Notepad.

7. You should see something like this:

   [oledb]
   ; Everything after this line is an OLE DB initstring
   Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=PK1;Data Source=SERVER
   

   We are interested in the third line here, the one that begins with Provider=.... As you can see, this line is made up of a series of entries in the form of Key=Value, separated by semicolons. Copy out three of these entries:

   • Integrated Security
   • Initial Catalog or Database
   • Data Source or Server

   You should end up with a string that looks like this:

   Integrated Security=SSPI;Initial Catalog=PK1;Data Source=SERVER
   

   This is the SQL connection string. Copy this to your clipboard to use in the next section.

8. Delete the text file, as we won’t be needing it again.

Adding the SQL connection string to the configuration file

Open the configuration file called erpworks-pk-config.yml in a text editor like Notepad.

Find the line that looks like this:

SQL Server Connection String: ""

Paste the SQL connection string you got from the previous section in between the double quotes.

SQL Server Connection String: "<here>"

You should end up with something like this:

SQL Server Connection String: "Integrated Security=SSPI;Initial Catalog=PK1;Data Source=SERVER"

Save the file.

If you already have ERPWorks open, close it and open it again to reload the configuration files.

Congratulations! You connected ERPWorks to your ERP system!