Set up labels

You must integrate the Aptean Labeling extension with a label printing software (BarTender, BarTender Cloud, Loftware Cloud Trigger, or Loftware Cloud Print ). Additionally, you can set up label groups, label categories, and label output field mapping to use labels efficiently.

Prerequisite

The following procedure outlines the prerequisite required to use labels.

1. Select the Search icon , enter Extension Management, and then choose the related link.
   The Extension Management page opens.
2. In the Search field, enter Aptean Labeling for Food and Beverage, and then select the Enter key.
3. Locate and select the Aptean Labeling for Food and Beverage extension.
   The Extension Settings page opens.
4. On the General FastTab, turn on the Allow HttpClient Requests toggle.
   

If this toggle is turned off, the system displays a notification on the Role Center indicating that it is turned off.

The prerequisite for using labels is complete.

To integrate with the BarTender software or BarTender Cloud

The following procedure outlines how to integrate the Aptean Labeling extension with the BarTender software or BarTender Cloud.

1. Select the Search icon , enter Labeling Setup, and then choose the related link.
   The Labeling Setup page opens.

2. On the General FastTab, in the Caption Language field, select a language code from the dropdown.

3. On the Communication FastTab, in the Integration Type field, select BarTender or BarTender Cloud depending on where you want to send labels.

4. In the Endpoint Label Software field, enter the URL of the endpoint selected in the Integration Type field to send labels.

   TheIntegration Type field cannot be left blank. If it is left blank, the system displays a notification on the Role Center indicating that it is not configured. For more information about the use of web services integration for the creation of the endpoint URL, see How to Set Up a Web Service Integration–BarTender Support Portal.

   

5. In the Communication Type field, select the following communication type for label batching that allows optimization of API calls when printing multiple labels.

   • Single: Send labels individually in separate API calls.
   • Combined: Group multiple labels into a single API call.

6. On the Authentication FastTab, in the Authentication field, select one of the following authentication types:

   • Basic: The basic credentials set up are used for authentication when on a machine running the BarTender integration with a local admin, non-domain account.
     We recommend using this authentication type.
   • Anonymous: Any user can access any public content without providing login credentials to the client browser.
     We do not recommend using this authentication type for a production environment. You can use this for testing or a sandbox environment.

7. In the User Name field, enter a user name that will be used as credentials for authentication.

8. In the Password field, enter a password name that will be used as credentials for authentication.
   The set up for the BarTender software integration ends here.

If you are integrating with BarTender Cloud, you also need to perform the following steps:

9. In the Client ID field, enter the client ID.
10. In the Client Secret field, enter the client secret key.

You can obtain the client ID and secret key from the application ID and secret key of the relevant console application and services (Password-based) on the BarTender Cloud API. For more information, seeConfiguring a Console App for Password-based OAuth Access.

11. In the Organization Name field, enter the organization’s name.

TheClient ID, Client Secret, and Organization Name fields are visible only when the Integration Type field is set to BarTender Cloud.

12. On the action bar, select Actions > Test Connection. The system validates the provided information and automatically updates the personal access token on the Customer Http Headers page.

This action is visible only when theIntegration Type field is set to BarTender Cloud.

When printing labels, the system checks the personal access token on the Customer Http Headers page to ensure it was generated within the last 10 hours. If the token is older than 10 hours, the system generates a new one, which remains valid for the next 10 hours. You can view the date and time of the last generated token in the TokenGeneratedTime table field.

To integrate with the Loftware Cloud Trigger or Loftware Cloud Print

The following procedure explains how to integrate Loftware Cloud Trigger (printing software) or Loftware Cloud Print with the Aptean Labeling extension:

1. Setup the Loftware Cloud Trigger.
   For more information, see Cloud Trigger – Loftware Help Center.
2. On the Labeling Setup page, in the Integration Type field, select Loftware Cloud Trigger or Loftware Cloud Print depending on where you want to send labels.
3. In the Endpoint Label Software field, enter the URL of the endpoint selected in the Integration Type field to send labels. (Use the created CloudTrigger, MyCloudTrigger shown in the below figure is an example).
4. In the Communication Type field, select the following communication type for label batching that allows optimization of API calls when printing multiple labels.
   • Single: Send labels individually in separate API calls.
   • Combined: Group multiple labels into a single API call.

Ensure the relevant configurations are completed in the NiceLabel Cloud software for this functionality to take effect. To know more about the configurations on the NiceLabel Cloud software, see:

Batch Printing

Session Printing

Configuring JSON filter.

5. On the Authentication FastTab, in the Authentication Type field, select Anonymous.
   

6. Enter the following header names and header values via Custom Http Headers. This is automatically added as additional http header values in the request to the NiceLabel Cloud as shown below:
   i. Api-Version, value as setup when creating the Cloud Trigger in Nicelabel Cloud, default is v1.
   ii. Ocp-Apim-Subscription-Key, key as generated when creating the Cloud Trigger in Nicelabel Cloud, example value: 12345e1fca123dc12a1e123456789b1e.

   

Based on the above setup, the headers are accepted in the NiceLabel Cloud environment:

Set up label group

You can create a label group that can be used to group certain items, customers or vendors for which you want to print the same label, on the Label Groups page. Before being able to link the vendor, customer, or item, the label group must be defined.

1. Select the Search icon , enter Label Groups and then choose the related link.
   The Label Groups page opens.

2. On the action bar, click New.

3. Enter Code.

4. Enter Description.

5. In the Label Group Type dropdown list, select the required option.

   

   

   A label group is now set up and can be used for items, customers and vendors. See Select label group to link the label group. Repeat the steps for every label group.

Select label group

A label group can be linked to an item, customer or vendor. In the description below, an example is given of linking an item to a label group.

1. Select the Search icon , enter Items and then choose the related link.
   The Items list page opens.

2. Select the required No.
   The Item Card page opens.

3. On the action bar, click Related > Item > Label Group Setup.
   The Label Group Setup page opens.

4. Click the lookup button in the Label Group field.
   Only label groups with Item label group type are shown.

5. In the Code dropdown list, select a label group.

   

   A label group is now set up for the item.

Label categories

Label categories make it possible to print more than one different label at once, for instance, one for the product and one for its packaging. When printing labels, one label code per set up combination of source table and label category can be printed.

1. Select the Search icon , enter Label Categories and then choose the related link.
   The Label Categories page opens.

2. Enter Code.

3. Enter Description.

   

4. Repeat the steps to create multiple label categories. See Labels to link the label category to a label.

Label output field mapping

The data for the labels is stored in an output file. To give the user the freedom to decide for himself which data should be included in the output file, it is up to the user to map this data.

On the Label Output Field Mapping page, a link can be made between the “Print From Table” Fields and the “Label Output” Fields.

For the labels that are included in the Aptean Food & Beverage “APTFB 26 LBL Labels” package, the output field mapping has already been performed.

1. Select the Search icon , enter Label Output Field Mapping and then choose the related link.
   The Label Output Field Mapping page opens.

2. Click the lookup button in the Print From Table Filter field.
   The All Objects with Caption page opens.

3. Click the required Object Type to select the table. This is a table that corresponds with a table that is used as a “level 0 table” in the label setup. See Labels for more information.

   

4. Click OK.

Fixed value

1. Click the lookup button in the Mapping Field Name field on the Mapping Lines FastTab on the Label Output Field Mapping page.

   

   These are the fields from the label output header.

2. Click the required No. to select the mapping field name.

   

3. Click OK.

   If the Value Source is Fixed Value then Print From Field Name can be entered manually.

4. Select the Fixed Value option in the Value Source field.

   

5. Enter Print From Field Name.

Field value

If the Value Source is Field Value that is set as default, the Print From Field Name is a value from the Print From Table.

1. Click the lookup button in the Mapping Field Name field on the Mapping Lines FastTab on the Label Output Field Mapping page.

2. Click the required row to select the mapping field name, e.g., “Document No.”.

3. Click OK.

4. Click the lookup button in the Print From Field Name field.

   These are the fields from the selected Print From table.

   A field is now mapped for the sales lines table.

   Repeat these steps for as many tables and fields as needed.

5. Click the required No. to select a field name to link, e.g., “Source ID”.

   

6. Click OK.

   

   These fields are now mapped for the Tracking Specification table. Repeat these steps for as many tables and fields as needed.

Delete mapping

1. On the action bar, click Actions > Delete Mapping on the Label Output Field Mapping page.

   

2. A confirmation dialog box appears, click Yes to confirm.

   

   The mapping for the Print From Table Filter is now deleted.