Configuring Service Entities for Data Sources

  • With an open Rest Connection, navigate to the Service Entities section.
  • Type the Name for the service endpoint that is being defined as a source.
  • Click the Edit button to open the REST Service Entity Maintenance window.
  • The Endpoint field should be filled in to connect to the correct service. This will be combined with the Base URL to create the full URL.
  • The Request Method can be changed if a different VERB is required for a specific endpoint.
  • The Fields section will determine how to display fields from the payload of data that is returned from the service. It is recommended to use a sample file of the payload to load the structure and determine the path for each field.
  • The Type column can be changed after the fields are loaded from file if a data type is set incorrectly.
  • For a basic GET VERB to a service with no additional parameters, the setup would now be complete for that service endpoint.

Configuring Base Settings

  • From the main Navigation Menu, select Maintenance and then REST Services.
  • On the REST Services page, click the Create REST Service button.
  • This open the REST Service Maintenance window. The first section allows a name and an image to be set for the REST Connector.
  • The second section will store the information for the Base URL, Request Method, Response Type, Body Type and Authentication Method.
    • The Base URL should be the portion of the URL that is static for the service.
    • The Request Method should be the default VERB for pulling data from an endpoint for the service.
    • The Response Type should be set to either JSON or XML, based on the payload type for the service.
    • The Body Type should be set to one of JSON, Text, XML, or URL-Encoded-Form; depending on the payload body for the service.
    • The Authentication Method should be set to one of Basic, Exchange Token, None, or OAuth2; based on the service.
  • The last section allows the Date Format to be specified. The 4 types are Custom, Epoch Milliseconds, Epoch Seconds, or ISO 8601. Epoch time is displayed as the amount of time that has elapsed since January 1, 1970.
    • Epoch Milliseconds follows a format of: 1583340906149
    • Epoch Seconds follows a format of: 1583340920
    • ISO 8601 follows a format of: YYYY-MM-DDThh:mm:ssTZD
    • Custom allows the format to be defined, using the standard .Net datetime formatting.
  • The REST Service Maintenance window can be saved once the main Settings section is complete. The Service Entities or Service Actions would need to be defined to use the connection as a source or destination for any integrations, however.

Using a File Destination

  • Click on the Target tab.
  • Select Export to File as the Target.
  • If we want to send the file to an FTP Server, then we will need to select our FTP connector (which would need to be setup in the Connections) for the FTP Destination and select the FTP Path.
  • Otherwise if the FTP Destination is left blank, the integration will output a local file.
  • Enter the File Name
  • Enter the File Type, either Excel or Text file.
  • If we selected Text File, then select a Column Separator. The options are Csv, Tab, Pipe, or Custom Delimited. Enter the Custom delimiter in the text box shown below.
  • Select the Character Set, either ANSI or OEM.
  • Select which options you would like to add to your file.
  • Include Headings – This option will include the headings from our source file in the exported file.
  • Overwrite file – The option will overwrite any file given the same file name.
  • Append date/time – The option will add the date/time to the exported file name.
  • Separate file per key field – This option will create a separate file for each key field in the source.
  • Append key field to filename – This option will only become available if the “Separate file per key field” option is selected. It will append the key field to the file name.
  • Enclose column values in quotes (“”) – This option will enclose each data value in quotes in the exported file, not including the file headers.

Mapping and Running the Integration.

  • Click on the Integration tab.
  • Select Export to file as the Target Lines.
  • Under the Source Grouping tab, select any fields to group by.
  • Select the Target Integration tab.
  • Map the source fields that you want to the columns in the file destination.
  • Save and run the integration process.

Determining your Subscription Tier

SmartConnect.com is broken into 4 different subscription tiers that are available for purchase. It is important to decide which level fits your company best when looking to sign up for a plan.

 

The Basic, Standard, and Premium options are all based off the number of Connections that are used and will be the main subscriptions that are chosen from. Migration is a standalone subscription that allows unlimited connections, but integrations must be run manually and cannot be scheduled or setup to run real-time. As the name implies, it is intended for migration scenarios where multiple systems need to be connected to for a limited time.

When looking at the Connection count for your company – a Connection is defined as any system you want to integrate to or from. For example, if you want to connect a SQL Server, Salesforce, and Dynamics 365 Business Central – that will count as 3 Connections. It does not matter if you are sending data in one direction or bi-directionally between any one of those systems or how many integrations are created between them, it is 1 Connection per system.

Additionally, support can be purchased with any of the three ongoing subscriptions. If support is purchased, it has a minimum commitment length of 6 months. With the unlimited support option, your team gets access to the full eOne support team to help resolve issues that are encountered during the use of the application.

The subscription tier your company owns can be changed after purchase as well. If your integration needs have grown, it is possible to upgrade to a higher level at any time. The subscription can also be downgraded as long as the number of active Connections in the application do not exceed the limit for that subscription tier.

Signing Up for a Plan

To get started using the SmartConnect.com application, a subscription plan must be chosen on the smartconnect.com/pricing/ web page.

Once an option is chosen, the checkout page will open. If you are an existing eOne Solutions Partner, you will follow the prompts and be directed back to the main eonesolutions.com site where you can place an order for any existing or new customer and have them added to your account. If you are a direct customer, you can fill in your information directly on this screen and click the Get Started button.

 

The partner process will match the experience for ordering any other existing product off the eOne Solutions site. For a direct customer, once the Get Started button is clicked, the payment information and the option to add/remove support needs to be entered.

Once payment has been completed, you can manage your account directly in SmartConnect.com.

Adding Users to SmartConnect.com

Users can be added and removed to any account on the smartconnect.com/account web page. That can be accessed by clicking the Login button at the top right of the main SmartConnect.com site.

 

The New User button will allow you to add another user to SmartConnect.com and set their permission level. The 3 user levels are Account Admin, App Admin, and End User.

 

  • An Account Admin has full permissions across both smartconnect.com and app.smartconnect.com. They can adjust the subscription level of the account, perform any action within the application itself, and can add or edit other users and promote them to Account Admins as well. There must always be at least one Account Admin for an account.

     

  • An App Admin has full permissions in app.smartconnect.com. They cannot see the invoice details or any other billing-related data within SmartConnect.com but have full permissions inside app.smartconnect.com. They can add other users and promote them up to the App Admin level.
  • An End User has no rights within the account management pages, they can access app.smartconnect.com to run existing integrations and process errors but cannot create any new connections.

 

Logging into the SmartConnect.com App

There are 2 ways to log into the SmartConnect.com application. The first is through the SmartConnect.com account management page. Clicking the “Log in to app” button will take the user to the Dashboard for the application.

 

The second is to navigate directly to app.smartconnect.com. There will be a login window that requires an email and password to be entered. It will be the same credentials that would be used to login to the smartconnect.com account management page.

 

When successfully logged into the application, the user will be directed to the Dashboard.

Setting Up Translation Tables

  1. From the options column on the left side expand Maintenance and click on Translation Tables.

  2. Click on Create Translation Table button.

  3. The Translation Table window will open.

  4. Key – enter a name for the table.
  5. Description – enter a description for the table.
  6. Import File – if the translations already exist in a file, instead of manually entering them in the Translations area of the window, the file can be imported here. The translations will then be available to be used when setting up integration processes.
  7. Translations – translations can be manually entered in this section and existing translations can be deleted.
  8. Save button – saves the Translation Table.

Setting up Global Rolling Columns

Setting up Global Rolling Columns

  1. From the main Navigation Menu, select Maintenance>>Global Rolling Columns.

  2. To create a new Global Rolling Column, click the Create Global Rolling Column button.

  3. Enter a unique Name for the global rolling column.
  4. Enter a Description.
  5. Enter a starting value for the Next Number field. When an integration process uses the global rolling column, this is the value that will be retrieved and incremented.

  6. IMPORTANT: The value used in the global rolling column will never expand beyond the number of characters that it is created with. For example, the value of SC01 will only work for 99 records, once the rolling column is incremented to SC99 – it has no room to increment to the next value as the total number of characters will not change during use. A much more appropriate starting value in this scenario would be SC0000001.
  7. Click Save to complete the creation of the new global rolling column.

Setting up Global Variables

  1. From the main Navigation Menu, select Maintenance>>Global Variables.

  2. To create a new Global Variable, click the Create Global Variable button.

  3. Enter a unique Name for the global variable.
  4. A default value can be set by populating the Value field. If nothing is entered for the Value, the global variable will be initialized as a blank string when an integration process that uses it starts.

  5. If the Secure option is checked, the value will be masked when entering it through the interface. If a user opens the global variable to edit it, it will display the masked value rather than the actual value.

  6. Click Save to complete the creation of the new global variable.
  7. To edit an existing global variable, click the Edit button on the correct variable row.
  8. To delete a user-created global variable, click the Delete button on the correct variable row. The predefined global variables cannot be deleted.