Microsoft Great Plains setup guide

Step 1: Prerequisites for setup

  1. Administrative access to the SQL server hosting the Dynamics GP company database.

  2. Access to make or coordinate making changes to the firewall/network to allow access to a web server where a website will be hosted.

  3. An existing server where you have administrative access to install applications and add the windows features needed to run a website.

  4. Access to your DNS provider or the ability to request a CNAME.

In order to ensure security and confidentiality of our customer's records the REST API website needs to communicate using the HTTPS protocol. To enable that a SSL certificate needs to be installed on the server where the REST API website will be hosted. The common name used in the SSL certificate will be used in your ConnectBooster Dynamics GP integration configuration.

SSL certificate

Get and install an SSL certificate that will be used to route traffic to the Rest API website that will be installed for ConnectBooster to interact with your Dynamics GP database.

Installing SSL certificate

SSL certificate is required to encrypt and keep the data secure that is sent between ConnectBooster and the Server. Once you have the SSL certificate right click and click Install PFX. This will open a Certificate Import Wizard and you can chose Local Machine and continue by selecting Next.

Then it will show you the .pfx file. Click Next.

It will ask for the password. click Next.

Then select Automatically select the certificate store based on the type of certificate. Click Next.

Then click Finish.

2. CNAME

A CNAME is needed to point a hostname at your server and for registering the SSL certificate. The ability to create a CNAME or have one created is required.

Make sure you are in the DNS management section where you should see DNS Settings, DNS Record or something similar. It varies for the different DNS providers.

Identify the domain or subdomain of which you want to create the CNAME for and choose Add Record or the CNAME record type label.

After you enter the required target record details, save the changes.

NOTE  It will take some time to propagate those settings.

For more info on Adding CNAME for Cloudflare: Set up a partial (CNAME) zone · Cloudflare DNS docs

3. Firewall port rules

In order to safeguard both networks, you will need to configure a firewall port rule. The port should be open to inbound HTTPS post and get traffic. You can choose any port, but we recommend something in the 8000 range.

NOTE  You will need the number for the port later in the setup.

Step 2: Download zip file containing install script and website

This PowerShell script is the core part of your GP install. This will prompt for the required parameters $DynamicsDatabaseName, $Port, and $Domain . These are the steps needed for a successful installation:

  1. Log into your ConnectBooster Portal

  2. Direct to Integrations in the left-hand menu

  3. Select the 3 dots in the upper right of the Dynamics GP integration and select Settings

  4. Download the config file noted in the integrations settings

  5. Copy the downloaded zip file to the server where the website will be hosted.

  6. Extract the ConnectBoosterGPSetup.zip file. Run Windows PowerShell as Admin.

IMPORTANT  Failure to run the script as an administrator will present an error message, so be sure to run this script as an administrator.

Step 3: Run the PowerShell Script

Navigate to the ConnectBoosterGPSetup extracted file in terminal and run the install script by using command .\ConnectBoosterInstall.ps1

You will be prompted for your Dynamics GP Company Database name.

We use GPSAM when testing. You will then be asked if this "Is this an existing ConnectBooster integration?"

Enter "n" for a fresh install

The PowerShell script will install required windows features if needed and prompt for host domain of the SSL certificate.

This will be the domain used when creating the CNAME. If a wildcard domain name was used omit the * and only include the base domain. Examples: mycompanyname.com, cbapi.mycompanyname.com.

Next, you will be prompted to enter the HTTP Port used to configure the firewall.

You will also be prompted to enter an HTTP port. The HTTP port should not be opened in the firewall.

NOTE  The HTTP port will only be used to access the website locally on the server to manage configuration and see logs.

The Powershell script will ask for a HTTP Port if running locally to configure and view logs. This port does NOT need to be exposed through the firewall.

The next prompt will ask for the SQL Server Name and Password. These are the credentials that have administrative access to the SQL server where the Dynamics GP company for which the integration is being setup.

IMPORTANT  These credentials will only be used during this setup. The credentials will not be stored. We will create a different user with limited access for the integration


The SQL database user that will be created is based on the Company Database name following the format CompanyDatabaseNameCBUser to identify the user as being used for the CB (ConnectBooster) integration.

For example, for the GPSAM test company database the user would be GPSAMCBUser.

Once the user has been created, the website for configuration and viewing logs should open.

Congratulations the server side of the Dynamics GP installation is finished.

Step 4: ConnectBooster Configuration

Open your companyname.connectboosterportal.com website and navigate to the Integrations page and fill in API Key , API Secret and Endpoint URL found in the GP integration settings.

Use the API Key and Secret from the server configuration outlined in the previous steps.

The Endpoint URL should include HTTPS, the hostname used in setting up the CNAME, and the HTTPS port that was opened in the firewall.

Example: https://cbapi.mycompanyname.com:8097

Make sure your endpoint URL port is HTTPS, available to use, properly configured, and open.

After you save the settings, you should be able to run the Test Connection. If the connection is properly established you will get a success dialog box in the lower left-hand corner.

Step 5: Configuring GP credit cards

ConnectBooster requires at least one credit card payment type to be configured. To configure your credit card payments types, follow these steps:

1. Navigate to Tools+ Setup + Company + Credit Cards.

2. Create a Credit Card record for each supported card type, based on the following table:

Card/transaction type

 Accepted card names
Visa Visa, VC, VS
MasterCard MasterCard, MC, Master Card
Discover Discover, DISC, DS
American Express AmericanExpress, American Express, AMEX, American Ex, AM EX, AX
E-Check/ACH ACH, E-check, Echeck, E check, E-cheque, Echeque, E cheque, EFT

Ensure you have used one of the “Accepted Card Names” from the table above for the Card Name field. Check the “Accepted from Customers” box. Choose Bank Card and the appropriate Checkbook ID. Save a new record for each card type that is supported and for E-Check if appropriate.
 

Step 6: (Optional)

Open your ConnectBooster portal and click on Integrations. Direct to the “Custom” integration. If this integration does not exist, please contact support@connectbooster.com to have them add it for you.

Open your new integration and give it the name, SSRS Connector.

Click the GetInvoiceImage button and fill in the integration settings. Use a GET method and enter your URL for the SSRS Connector you set up in the configurations page on the server with the website. The full URL would be https://yoururl/reports/Invoice/. Click the Add Header button with the Header Key named authorization. Paste the Base64 encoded key value from ApiConfigs page of site. Bes sure to Save your settings, then direct to Configurations + Billing.

In the Invoice Image Data section, check the box of your SSRS Connector integration and move it to the top of the list. Click Save.

Congratulations! You have now set up the ConnectBooster SSRS Connector.