Guide for setting up the account and users

1. Introduction

AFAS version 7 integrates with the Transsmart APIv2. Earlier versions integrated with APIv1.

When exchanging messages with APIv2, AFAS needs to authenticate itself. This is done using the user name and password of what will be referred to in this document as the integration user. These credentials need to be configured in AFAS and are, by default, used for all interactions with the Transsmart platform.

Printing is done by sending a print request to Transsmart. The platform then prepares the print job and sends it to the SmartPrint client installed within the customer's network. SmartPrint then sends it to the correct printer via QZ Tray.

2. Default setup

In case where printing only requires a single SmartPrint and a single printer, it is sufficient to configure the printing details only for the integration user. Once SmartPrint is running, go to the printing tab for that user and select the corresponding SmartPrint connection and the configure the correct ZPL/PDF printer.

The configured SmartPrint connection and printers are always used, regardless of the actual AFAS user that triggers the print action.

3. Multiple printers

In some cases it might be necessary to print on multiple printers and/or to print using multiple SmartPrint clients, depending on the AFAS user that triggers the print action. In such case it is necessary to configure additional users under the account.

We have agreed on an unambiguous way for identifying the correct printer settings to use for processing the print job. 

The print request from AFAS will include a specific parameter for the user name whose printer settings need to be used. The user name in that request will always be formatted like below: 

[AFAS user ID]@[AFAS account number], for example stevenluyckx@31010

The Transsmart APIv2 will take this parameter into consideration and act correspondingly:

a. user name found: print with the settings configured for that user

b. user name found, has no print settings : return an error

c. user name not found: print with the settings of the integration user account (fallback)

d. user name empty: print with the settings of the integration user account (fallback)

4. Customer onboarding process

All single-printer customers always print with the printer settings of the integration user. They don't require anything additional.

Customers that work with a multiple-printer environment need to do 2 things:

1. like for a default setup, configure the printer settings on the integration user

2. for every AFAS user that wants to print to a non-default printer, a corresponding user account needs to be created in MyTranssmart with the alternative printer settings 

The user name needs to be formatted like [AFAS user ID]@[AFAS account number]

5. Sample use case

Suppose the customer has AFAS account number "12345". 

Suppose printer X is linked to SmartPrint1 and printer Y is linked to SmartPrint2.

AFAS user list

userA 

userB 

userC

Transsmart user list

integration user account    configured to print with SmartPrint1 on printer X 

userC@12345                     configured to print with SmartPrint2 on printer Y

Sample requests

1. for userA 

printing user parameter userA@12345 

Transsmart doesn't find a matching user account, printing is executed with the settings of the integration user --) print job will be sent to printer X via SmartPrint1

2. for userB 

printing user parameter userB@12345 idem dito

3. for userC 

printing user parameter userC@12345 Transsmart finds a matching user and user has printer setttings configured, printing is executed with those settings --) print job will be sent to printer Y via SmartPrint2