1. Home
  2. Knowledge Base
  3. Internet Store
  4. Internet Store Interface
  5. Configuring the Artisan Task Manager (Internet Store Interface – ISI)

Configuring the Artisan Task Manager (Internet Store Interface – ISI)

>>> Available in Artisan POS 4.4 and Later Versions <<<

Artisan POS integrates with the WooCommerce (works with WordPress), Shopify, and BigCommerce shopping carts. These are very powerful tools, and you can choose one or both. To communicate with them, Artisan uses a utility called the Artisan Task Manager. This article is designed to help you configure its settings.

Artisan will automatically synchronize its database with the web store database. You can create items and categories in Artisan and specify which ones are to be sent to your web store. Artisan will even post the product pictures for you, along with shipping weight, extra descriptions, etc. Artisan can also download orders from your online store for completion.

The biggest benefit of this option is that you only have one inventory list to maintain instead of a list in Artisan and a list in your web store.

The shopping carts have a complete Content Management System (CMS) that you can use to edit other pages on your site to provide information about your store, such as directions, hours, and anything else that is important to your business.

Setting Up WooCommerce for Artisan Integration

Our WooCommerce interface requires WooCommerce version 2.6 or later.

In the WordPress control panel, add a user named Artisan, and make it an administrator.

To do this, click on “Users” and “Add New.”

Type CerTek as the username and support@certek.com as the email.

Click the “Generate Password” button, and save that password somewhere secure.

Select “Send the new user an email about their account.”

Select “Administrator” as the role, then save these settings.

Next, go to “Settings” and select “Permalinks.”

Select “Post name” permalinks.

Next, navigate to “WooCommerce” and “Settings.”

Click on the “Advanced” tab, then select “REST API.”

Select “Add key.”

Name the description “Artisan“, and select “Artisan” as the user. Select “Read/Write” as the “Permissions.” Then, click “Generate API key.”

Copy the Consumer Key and Consumer Secret for later use.

Add shipping zones, shipping options, and shipping classes if you haven’t already. Set the time zone to match your local time zone.

Return to your “CerTek” user and scroll down to “Application Passwords.” Type in “Artisan POS” and select “Add New.”

Copy the password and save it somewhere secure. This code goes in the “WordPress” password section in the task manager.

Open the Artisan Task Manager and click on “Task.”  Click “NEW” and name the task Woo Upload.

  1. Database Server Type: This is always PostgreSQL.
  2. Server Name is the name of the computer where the data is located. If it is THIS machine, you can simply use “localhost”. The easiest way to determine this is to click on “Help” -> “About” in Artisan.
  3. Database Server Port: This depends on how your PostgreSQL database was setup. Most likely it is 5432, but it will show the correct number in the “Help” -> “About” as shown above.
  4. Database Name: This is most likely POS, but again, whatever your “Help” -> “About” shows is correct.
  5. Task type is UPLOAD because that is what we always start with. Later, we will do the DOWNLOAD.
  6. Task Frequency is the number of minutes before it automatically uploads again. The default is 15. You can change this at any time. If you don’t want it to run automatically, set it to zero.
  7. Internet Store Type: WooCommerce.
  8. Store URL: This is the web address or website for your site. You must use https://
    Example: https://www.mystore.com/
  9. Store User ID: If you are using application passwords (highly recommended), then use a single dash here: –
  10. Store Password: The same thing here, a single dash:
  11. WordPress Username: If you followed the first steps, this should be CerTek.
  12. WordPress Password: This is where you paste the password from Application Passwords.
  13. Inventory Site #s: If you have multiple sites and only want to focus on specific sites, enter their numbers here.
  14. Categories to Include: Generally, you can leave this blank – unless you want to include or exclude specific categories.
  15. Custom Field(s) to Add to Descriptions: Generally, you can leave this blank, unless you want to add custom fields to descriptions.
  16. Upload Other Custom Fields as Attributes? Optional field, which will upload any other custom fields not included in the above field.
  17. Require Brief Description: This is another optional field. It will remind you to add a brief description to your items.
  18. Require Detailed Description: This is the same thing as above, except it will remind you to add a detailed description.
  19. Hide Out-Of-Stock Items? This will hide all inventory that currently is out of stock in Artisan from your webstore.
  20. Upload All Records (Once): The Task Manager keeps up with which records are new or have changed and only updates these items. This option will force all the Internet Store items to be uploaded regardless of whether or not it thinks they are needed.
  21. Upload SINGLE Record (Once): If you only have one item you want to change, you may select this option, so the Task Manager does not have to push out all of your inventory to the webstore.

Now, set up the DOWNLOAD task to import your sales from your site.

This is very similar to the upload tasks. Here is an example:

Setting Up Shopify for Artisan Integration

From the dashboard, click “Apps.

Click on “Develop Apps for Your Store.

Click “Allow Custom App Development” on the next two screens.

Select “Create an App.”

Click on “App Developer.” Type in “Artisan POS” for the “App Name.” The “App Developer” should default to your username/store name and email. Select “Create app.”

This should take you to a page to configure your new app. If it didn’t, click on “Apps” again and “Develop Apps for Your Store.

Select the “Artisan POS” app you made.

Click on “Configuration.”

Click on “Admin API Integration.”

Select both “read” and “write” checkboxes (if applicable) for the following sections, unless otherwise noted:

  • Customers (just “read_customers”)
  • Discounts
  • Files
  • Fulfillment Services
  • GDPR
  • Gift Cards
  • Inventory
  • Locations
  • Orders
  • Payment Terms
  • Product Listings
  • Products
  • Shipping
  • Shop Locales
  • Shopify Payments Accounts

Ignore the “Webhook” section.

Press “Save.”

Head to “API Credentials” and copy the API key and API secret key.

Paste this information into Notepad, as you’ll need it soon. Save the file.

Click “Install app” and “Install.

Copy the API key from Notepad and paste it into the “Store User ID” section.

Paste the password that starts with the letters shpat into the “Store Password” section.

Setting Up BigCommerce for Artisan Integration

Setting up the Task Manager  – Upload

1. Launch the Artisan Task Manager. Click “Task” and “New.” 

2. Give your task a name.

3.

Enter your “Server Name.” This is the name of the computer where the data is located. If it’s this machine, you can use “localhost.” Enter your “Server Port #.” Most likely it is 5432. Enter your “Database Name.” This is most likely POS.

To find out what your “Server Name,” “Server Port #,” and “Database Name” is, click on “Help,” and “About” in Artisan. 

4. Set the “Task Type” to “Upload.” Later, you’ll make one set to “Download.”

5. “Task Frequency” is the number of minutes before the “Task Manager” automatically starts uploading to BigCommerce again. The default is 15.  You may change this at any time. 

6. Set “Internet Store Type”  to “BigCommerce.” 

7. The “Store URL” is the web address for your site. You must use https:// at the beginning of the URL. For example, https://mystore.com

8. “Store Hash” is found by visiting your store inside the BigCommerce dashboard. It is a unique set of characters and letters in between https://store- and .mybigcommerce.com. For example, https://store-ghjkl67890.bigcommerce.com – ghjkl67890 is the hash.

Creating an API Token in BigCommerce

1. Log in to your BigCommerce account.

2. Click on “Settings.”

3. Scroll down to the “API” section. Select “Store-level API accounts.”

4. Select “Create new API Account.” Call it “Artisan POS.”

5. Make sure “Customers” is set to read-only, “Orders” is set to read-only, “Order transactions” is set to read-only, “Products” is set to modify, and “Store Inventory” is set to modify. You may leave the others set to their default, “none” unless instructed otherwise.

6. A text file with your “Client ID,” “Client Secret” code, and  “Access Token” should automatically download once you create the token. However, before you press “Done” on this screen, copy and paste the API token into a text file on your own, just to guarantee that you will have this for later. Paste the API Token into your Artisan Task Manager.

Setting up the Task Manager  – Download

In order to send the orders from your BigCommerce to Artisan, you’ll need to create a “Download” task in the “Task Manager.”

1. Click on “Task” and “New.” Give your task a name.

2. As with the setup for the “Upload” task, input your server name, port, and database name, which can all be found by going to “Help” and “About Artisan POS” within Artisan.

3. Set the “Task Type” to “Download.”

4. The “Task Frequency” is how often the “Task Manager” will download orders from your store. The default is every 15 minutes between operating hours of 9:00 am to 5 PM. You may change this if you wish. 

5. Change the “Internet Store Type” to “BigCommerce.”

6. Copy and paste the “Store Hash” from the “Upload” task.

7. Copy and paste the API token. If you can’t find this information, delete the API and create a new one (which will need to be used for the “Upload” task as well). 

8. The last few fields default automatically – do not change them. Once you’re finished, click “Save,” then “Run.”

Uploading Single Items (Once)

You may upload individual items through the uploader if you choose. This is best for testing purposes.

  1. Enter the item code you want to upload.
  2. Click the “Save” button.
  3. Click the “Run” button.


Installing the Artisan Task Manager

Web store synchronization is performed by the Artisan task manager, which schedules each synchronization task according to a frequency that you specify.

Create a batch file containing the following command:

java -jar \Artisan directory\artisantasks.jar –context upload –context download

There must be a context parameter for each synchronization function: The example has two context parameters: “upload” will upload inventory data to the web store, and “download” will download order data from the web store.  If more than one store needs to be synchronized, you must specify context parameters for each store (with unique names).

The first time the program runs, click on each task tab, complete the profile, and save it. Each task will then be automatically scheduled to run with the frequency that you specified.

The fields on the profile tab are as follows:

  • Database Server Type – the Artisan database type (e.g., PostgreSQL).
  • Database Server Name – the network name of the database server (“localhost” if on the same computer).
  • Database Server Port – the server port number (5432 is the Artisan default).
  • Database Name – the name of the Artisan database, in upper case.
  • Synchronization Frequency – the frequency with which to synchronize the web store with the database, in minutes.
  • Synchronization Type – “upload” to upload inventory data, “download” to download orders and customer records.
  • Store Type – type of web store (Magento1 = Magento Community Edition).
  • Store Prefix – a string used to prefix the ID of each record downloaded to differentiate it from those created locally or from other web stores.
  • Store URL – the web site address of the web store, starting with “https”, and without a trailing slash.
  • Store User ID – the web service username created above.
  • Store Password – the web service password created above.

Zoey and Magento

Artisan POS no longer supports Magento and Zoey. Please contact sales@certek.com to discuss setting up a Shopify, BigCommerce, or WooCommerce store.

Zoey and Magento limit the size of attribute set (variant template) and attribute names, and do not allow special characters except the underscore. If the sum of the lengths of an attribute name and its set name exceeds 28 characters, it will be truncated, so it is a good idea to shorten any long variant template or attribute names before beginning.

Zoey and Magento
Setting Up Magento Community Edition for Artisan Integration

After Magento is installed, install the Bubble Extension from https://github.com/jreinke/magento-improve-api/downloads.  To install the extension, first, download it, unzip it, and then drag those contents to the Magento directories of the same names.
Sign on to the administrative panel.

Go to System->Configuration.

In the side menu, select Services->Magento Core API.

Turn on WS-I Compliance and save the changes.

Go to System->Web Services->Soap/XML-RPC – Roles.

Add a new role named admin.

On the “Role Resources” tab, set access to “All” and save the changes.

Go to System->Web Services->Soap/XML-RPC – Users.

Create a new user using attributes of your choice. Note the username and API key (password), as these will be used later.

On the user role tab, select “admin.” Save the changes.


Setting Up Zoey for Artisan Integration
Note: You must have Java 1.7 or later installed in order to use the Zoey interface.

Go to Advanced -> API Configuration.

Under Standard API, click on “API Roles.”

Click on “Manage API Roles.”

Add a new role named admin.

Under “Role Resources,” select “all.”

Select “Save Role.”

Go to Advanced -> API Configuration.

Under Standard API, click on “Manage API Users.”

Add a new user using attributes of your choice. Note the user name and API key (password), as these will be used later.

Under “User Role” select “admin.”

Select “Save User.”

Go to Advanced -> API Configuration.

Under Standard API, click on “More Standard API Options.”

Click on “Manage API Settings.”

Set “WS-I Compliance” to “yes” and click on “Save Config.”

Click Advanced -> Cache & Index.

Set Automatic Store Refresh to “Yes” and click “Save Config.”
Updated on January 26, 2024

Related Articles