Knowledge Base
SmartConnect
Installing and Configuring SmartConnect 21
Creating and Configuring the API in SmartConnect 21

Creating and Configuring the API in SmartConnect 21

Published: May 05, 2021

Popdock
- Welcome to Popdock Documentation
SmartConnect
- Welcome to SmartConnect Documentation
- Adding Tasks to an Integration View Category
  - Creating document level run integration tasks in SmartConnect.com
  - Adding a Run Map Task
  - Adding an Email Task
- Creating an Integration Process View Category
  - Using a Restriction
  - Defining Remaining Options
  - Using a Custom Rolling Column
  - Using a Translation
  - Using a Date Calculation
  - Using a Calculation
  - Performing the Field Mapping
  - Determining Source Grouping
  - Defining an Integration Target
  - Defining an Integration Source
  - Populating the Integration Details
- Getting Started with SmartConnect.com View Category
  - Switching Companies within SmartConnect.com
  - Adding an Initial User to SmartConnect.com
  - Determining your Subscription Tier
  - Signing Up for a Plan
  - Adding Users to SmartConnect.com
  - Logging into the SmartConnect.com App
- Importing and Exporting Integrations View Category
  - Importing an Integration Process
  - Exporting an Integration Process
- Installing and Configuring SmartConnect 21 View Category
  - Creating and Configuring the API in SmartConnect 21
  - Creating and Configuring the Windows Service in SmartConnect 21
  - Updating SmartConnect 21 Configuration Options
  - Configuring Additional SmartConnect 21 Instances
  - Configuring a SmartConnect 21 Instance
  - SmartConnect 21 Installation Steps
- Maintaining Setup Options View Category
  - Setting Up Change Trigger Maintenance
  - Setting Up Integration Groups
  - Setting Up Translation Tables
  - Setting up Global Rolling Columns
  - Setting up Global Variables
- Navigating the Dashboard View Category
  - Viewing the Latest News, Links, and Videos Widgets
  - Reviewing the Login History Widget
  - Using the SmartConnect Processes Widget
  - Using the Quick Start Widget
- Setting Up Additional Functionality View Category
  - Using Error Processing to Correct Integration Process Failures
  - Scheduling an Integration Process
- Working with Dynamics 365 Business Central View Category
  - Using an Odata Field Lookup
  - Creating a Dynamics 365 Business Central Change Data Source
  - Creating a Dynamics 365 Business Central Real-time Data Source
  - Connecting to Dynamics 365 Business Central using an OAuth Token
  - Setting up an Integration to Dynamics 365 Business Central
  - Creating a Dynamics 365 Business Central Bulk Data Source
- Working with Dynamics 365 Finance View Category
  - Using a Dynamics 365 Finance Lookup
  - Setting up an Integration to Dynamics 365 Finance and Operations
  - Creating a Dynamics 365 Finance Bulk Data Source
  - Connecting to Dynamics 365 Finance using an OAuth Token
- Working with Dynamics 365 Sales View Category
  - Using an Activity Party
  - Using an Entity Lookup
  - Connecting to Dynamics 365 Customer Engagement using an OAuth Token
  - Using a Relationship
  - Using a List Option Lookup
  - Using a Multi Lookup
  - Setting up an Integration to Dynamics 365 Sales
  - Creating a Dynamics 365 Sales Real-Time Data Source
  - Creating a Dynamics 365 Sales Change Data Source
  - Creating a Dynamics 365 Sales Bulk Data Source
  - Setting up a Dynamics 365 Sales Connection
  - Using an Entity Reference
- Working with Dynamics CRM View Category
  - Using an Activity Party
  - Using an Entity Lookup
  - Setting up an Integration to Dynamics CRM
  - Creating a Dynamics CRM Real-Time Data Source
  - Using a MultiList Option Lookup
  - Creating a Dynamics CRM Change Data Source
  - Creating a Dynamics CRM Bulk Data Source
  - Setting up a Dynamics CRM Connection
  - Using a Relationship
  - Using a List Option Lookup
  - Using a Multi Lookup
  - Using an Entity Reference
- Working with Dynamics CRM On-Prem View Category
  - Using a MultiList Option Lookup
  - Using a List Option Lookup
  - Using a Multi Lookup
  - Using an Entity Lookup
  - Using an Activity Party
  - Using an Entity Lookup
  - Setting up an Integration to Dynamics CRM
  - Setting up a Dynamics CRM Connection
  - Creating a Dynamics CRM Real-Time Data Source
  - Creating a Dynamics CRM Change Data Source
  - Using a Relationship
  - Creating a Dynamics CRM Bulk Data Source
  - Setting up a Dynamics CRM Connection
- Working with Dynamics NAV View Category
  - Using a Page Field Lookup
  - Using a Page Key Field Lookup
  - Setting up an Integration to Dynamics NAV
  - Creating a Dynamics NAV Bulk Data Source
  - Setting up a Dynamics NAV Connection
- Working with Dynamics NAV OData On-Prem View Category
  - Using an OData Field Lookup
  - Setting up an Integration to Dynamics NAV OData
  - Creating a Dynamics NAV OData Bulk Data Source
  - Setting up a Dynamics NAV OData Connection
- Working with Dynamics NAV Soap On-Prem View Category
  - Using a Page Field Lookup
  - Using a Page Key Lookup
  - Setting up an Integration to Dynamics NAV Soap
  - Creating a Dynamics NAV Soap Bulk Data Source
  - Setting up a Dynamics NAV Soap Connection
- Working with File Options View Category
  - Creating a Text Folder Data Source
  - Creating an XML Folder Data Source
  - Using a File Destination
  - Creating a XML File Source
  - Creating a Text File Source
  - Creating an Excel Source
  - Setting up a FTP Server Connection
  - Creating an Excel Folder Data Source
- Working with Generic Connections View Category
  - Troubleshooting ODBC Data Source Errors
  - Creating an OLEDB Bulk Data Source
  - Creating an ODBC Bulk Data Source
  - Setting up an ODBC Connection
  - Setting up an OLEDB Connection
- Working with Microsoft Graph View Category
  - Using Outlook as a Data Source
  - Using OneDrive as a Data Source
  - Using SharePoint as a Data Source
  - Setting up a Microsoft Graph Odata Connection
  - Creating a Teams Task
- Working with NetSuite View Category
  - Setting up a Multi Lookup
  - Setting up a Reference Lookup
  - Setting up an Integration to NetSuite
  - Creating a NetSuite Real-Time Data Source
  - Creating a NetSuite Bulk Data Source
  - Setting up a NetSuite Connection
- Working with Popdock View Category
  - Creating a Popdock Bulk Data Source
  - Setting up a Popdock Connection
- Working with Pre-Defined Connectors View Category
  - Setting up a Zendesk Connector
  - Setting up a ShipStation Connector
  - Setting up a HubSpot Connector
  - Setting up a Shopify Connector
  - Setting up a WooCommerce Connector
  - Setting up a Magento Connector
  - Setting up a Xero Connector
- Working with Salesforce View Category
  - Using an Entity Lookup
  - Setting up an Integration to Salesforce
  - Creating a Salesforce Real-Time Data Source
  - Creating a Salesforce Change Data Source
  - Creating a Salesforce Bulk Data Source
  - Setting up a Salesforce Connection
- Working with Slack View Category
  - Creating a Slack Task
  - Setting up a Slack Connection
- Working with SQL Server View Category
  - Setting up an Integration to SQL Server
  - Creating a SQL Server Real-Time Data Source
  - Creating a SQL Server Change Data Source
  - Creating a SQL Server Bulk Data Source
  - Setting up a SQL Server Connection
- Working with the REST Connector View Category
  - Using Error Handling
  - Using Service Variables
  - Using a Service Lookup
  - Creating a Service Lookup
  - Setting up an Integration to a REST Service
  - Creating a Service Destination Definition
  - Configure Data Source Paging
  - Adding a Bulk Service Data Source
  - Creating a Service Data Source Definition
  - Configuring Exchange Token Authentication
  - Configuring OAuth2 Authentication
  - Adding a REST Service Connection
  - Creating a REST Service Definition
  - Configuring Service Entities for Data Sources
  - Configuring Base Settings
- Working with Trello View Category
  - Setting up a Trello Connection
  - Creating a Trello Task
Zendesk Apps
- Inner zendesk category View Category
  - Test documentation

Creating and Configuring the API in SmartConnect 21

Published: May 05, 2021

The Create API Service button will install and activate the SmartConnect API on the current workstation for the current active SmartConnect instance. The workstation must have the IIS feature enabled in Windows in order for SmartConnect to be able to create and publish the SmartConnect API. The SmartConnect API should only be installed on one workstation for any particular SmartConnect instance, and not across multiple workstations.

The SmartConnect API is used for any real-time data sources or triggers, any use of the Excel Add-in or Excel Templates that allow users to run integrations directly from Excel, or any third-party system that calls into SmartConnect to run an integration on demand.

The buttons across the top of the window will perform different actions based on the current settings.

Save
- Saves the current configuration and creates the web service (API) if it is not present yet. Only available once the credentials have been validated for the service.

Cancel
- Cancels any changes made to the window since opening it.

Start
- Starts the current web service (API) the configuration is tied to for the active instance. Applies to the current workstation.

Stop
- Stops the current web service (API) the configuration is tied to for the active instance. Applies to the current workstation.

Remove
- Removes the web service (API) from the current workstation that the configuration is tied to.

The different options allow the SmartConnect API to be configured during the setup process.

Service Name
- The name of the web service (API) that will be published. Can be changed to differentiate multiple services on one workstation from another in the scenario where multiple SmartConnect instances are switched between. For most scenarios, the default name can be left in place.

Port Number
- The port that the web service (API) will run under. Can be changed to any valid port within IIS and the environment. Useful for configuring a secure port for the API if opening to external access outside of the client network.

Service User
- The windows account that will create and managed the web service (API). Must be an account with local admin rights to log any errors to the event viewer.

User Password
- The password for the account used to run the service.

Domain
- The domain for the account used to run the service.

Validate Credentials
- Will validate the account information entered can connect and create a windows service correctly. Validation must pass before the windows service can be saved and created.

API Connection Timeout
- The length of time (in seconds) that the SmartConnect API will wait while trying to establish a connection.

API Command Timeout
- The length of time (in seconds) that the SmartConnect API will wait while trying to execute a command within an open connection.

API Debug
- Will enable debug logs to be written to the SmartConnect directory. Should not be left on for production environments unless troubleshooting an issue with API processes.

Feeling stuck? Get the support and guidance you need to help you power through any data challenge

We're on your integration team. Connect with our people and let us know how we can help you.

Get support