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

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

Artisan POS integrates with the popular Woo Commerce (works with WordPress), and Shopify 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.

Additionally, Artisan Task Manager can also communicate with Magento Community Edition and Zoey, although these solutions are less popular.

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 pull-down 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.

Go to WordPress Settings > Permalinks, and turn on post name permalinks.

Go to WooCommerce > Settings > API.

Enable the REST API.

On the Keys/Apps tab, add a key for user Artisan with read/write access. 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.

Add the Plugin Called “Application Passwords” and “Activate.”

Within Application Passwords, enter Artisan POS and click “Add New.”

A password will pop-up on the screen. Copy that password and save it in Notepad, or just paste it into the Artisan Task setup directly on Line 12 in the image below.

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. The next 3 fields are answered for you here.
  4. 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.
  5. Database Name: This is most likely POS, but again, whatever your “Help” -> “About” shows is correct.
  6. Task type is UPLOAD because that is what we always start with. Later we will do the DOWNLOAD.
  7. 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.
  8. Internet Store Type: WooCommerce.
  9. Store URL: This is the web address or website for your site. This one can be a bit tricky. You must use the https://.
    Example: https://www.mystore.com/
  10. Store User ID: If you are using application passwords (highly recommended), then use a single dash here.
  11. Store Password: The same thing here, a single dash.
  12. WordPress Username: If you followed the first steps, this should be Artisan.
  13. WordPress Password: This is where you paste the password from Application Passwords.
  14. Internet Price Level: If your webstore prices are different from your retail, then choose the correct customer type here. Most likely it is Retail. This can be changed at any time.
  15. Categories to Include: For starters, leave this blank.
  16. Require Brief Description: This is optional. It will remind you to add a brief description to your items. 
  17. Require Detailed Description: This is the same thing as above, except it will remind you to add a detailed description.
  18. 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.

Now setup 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 “Manage Private Apps.

Copy the API Key and paste it into the “Store Password” section.

Click on the “Private App Name.”

Wait for the screen to load. Click on “show password” and paste that into the “Store Password” section.

In the Description field, enter Artisan, and change all of the permissions to “read and write.” For those that don’t provide that option, select “read access.” Click “Save.”

Add shipping and payment options.

Preparing for Artisan Integration

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.

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.”

 

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.

task_manager

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.