1. NiceLabel Help Center
  2. NiceLabel Cloud
  3. NiceLabel Cloud Data Integration

Appendix A: Integration bundle

Your integration bundle includes a mockup application to demonstrate available types of integrated printing with Cloud Applications. We simulate your cloud-based applications with a JavaScript mockup application. Your mockup application can send printing data to:

  • Cloud Print APIs to demonstrate direct printing with cloud-enabled printers.

  • Cloud Trigger APIs to demonstrate server-based printing with Cloud Triggers.

  • NiceLabel Web Client to demonstrate thin client printing.

We provide you with sample files in LabelCloudDataIntegrationPack.zip. You can download it here:

For NiceLabel 10: https://ftp.nicelabel.com/software/demo/v10/LabelCloudDataIntegrationPack.zip

For NiceLabel 2019: https://ftp.nicelabel.com/software/demo/v8/LabelCloudDataIntegrationPack.zip

Your sample is configured for NiceLabel Cloud’s “demosystem” account. Follow the steps in the following sections to update your sample application to work with your NiceLabel Cloud account.

Configuring Control Center

Uploading files

  1. Log in to your NiceLabel Cloud Control Center. In your browser, type:

    https://<account>.onnicelabel.com/dashboard

    Note

    Replace <account> with your actual NiceLabel Cloud account name.

  2. Download and install NiceLabel Web Client.

    image6.png

  3. In Documents, create a new folder: /Demo/LabelCloudDataIntegration.

  4. Open LabelCloudDataIntegrationPack.zip (provided).

  5. Upload your Document Storage folder contents into your CloudIntegration folder (in your DMS).

Your files are uploaded in Control Center and ready to use.

Registering Web Applications

In Web Applications, you define which applications NiceLabel Web Client can run. We also use Web Applications for “thin client” printing demos.

Register your Web Application:

  1. Go to Applications > Web Applications (on your left) and click Add.

    image7.png

  2. For Name, type CloudIntegration-ThinClient.

  3. For Path (Solution or Label files), click Browse and select: /Demo/LabelCloudDataIntegration/ThinClient.nsln.

  4. For Authorized Users and Groups, add at least one user (yourself). Your users receive email invitations and all users you authorize can run the Web Application in NiceLabel Web Client.

  5. Click Save.

Your Web Application is registered and ready to use.

Creating Cloud Integrations

Cloud Integrations you create in Control Center authenticate your Cloud Print APIs and Cloud Trigger APIs. You use the same Cloud Integrations for IoT print using Cloud API and Cloud trigger printing demos.

Create your Cloud Integration:

  1. Go to Integrations > Cloud Integrations (on your left) and click Add.

    image8.png

  2. For Name, type a custom name for your integration (you can type any name).

  3. Click Save.

Your Cloud Integration is created in Control Center and ready for Developer Portal registration.

Registering Developer Portal Cloud Integrations

Before you can use Cloud Print APIs or Cloud Trigger APIs, you must register your Cloud Integration in the Developer Portal. Registering links your NiceLabel Cloud account with APIs and requires subscription keys to authorize your API calls.

Register your Cloud Integration:

  1. Open your Control Center User Guide.

  2. Read the chapter Cloud Print API.

  3. Follow the provided instructions to complete the following:

    1. Set up your new account on our Developer Portal.

    2. Create your new subscription.

    3. Register your Developer Portal subscription with your Cloud Integration (in Control Center).

      You must use your activated subscription key in custom HTTP headers (Ocp-Apim-Subscription-Key) with each of your API calls.

Your Cloud Integration is registered on the Developer Portal and ready for printer registration.

Registering cloud printers

Before you can execute Cloud Print APIs, you must register your cloud-enabled printers with your NiceLabel Cloud account.

For instructions and more information about the registration process, read our user guide:

image9.png

Configuring your mockup website

  1. Open LabelCloudDataIntegrationPack.zip (provided).

  2. Extract the Website subfolder to a temporary disk location.

  3. Open your extracted Website folder.

  4. Open index.html in your text editor.

  5. Find the string “nicelabelwebclient”. Update the URI reference:

    nicelabelwebclient10:?server=https://demosystem.onnicelabel.com/print

    Note

    Replace “demosystem” with your NiceLabel Cloud account name.

  6. Save your file.

  7. Open scripts/config.js in your text editor.

  8. Type your subscription key as your subscriptionKey value.

    Note

    You can get your subscriptionKey from Developer Portal > Products.

    Note

    Do not change values for label and uniqueIdentifier:

    • Label specifies which label file to use.

    • UniqueIdentifier specifies unique cloud trigger identifiers (defined in your Automation configuration).

  9. Save your file.

Your mockup website is set up and ready to use.

Configuring your integration server

  1. Run NiceLabel Automation Manager.

  2. Click Connect under “Connect to NiceLabel Cloud” to begin activation.

    image10.png

  3. Type your NiceLabel Cloud account name.

    Note

    Replace “demosystem” in the screenshot below with your actual NiceLabel Cloud account name.

    image11.png

  4. Click Connect.

  5. Select Microsoft or Google authentication (depending on how you logged in to Control Center from your invitation email). NiceLabel activates on your computer.

  6. In Automation Manager, click +Add. Browse to your Automation configuration file (.MISX) in Document Storage (Load the file you copied to /Demo/LabelCloudDataIntegration).

    image12.png

  7. Start all the triggers in your configuration.

    image13.png

Your integration server is set up and ready to use.

Configuring your Web Client

Configure your NiceLabel Web Client for “thin client” printing:

  1. Open ThinClient.nsln in NiceLabel Designer.

  2. Select the “question mark” Picture object.

  3. Double-click the “question mark” Picture object to open object properties.

  4. In Events, click Actions for On Click event.

  5. In the Open Document/Program action, direct your file name to your mockup website URL.

    Note

    If your mockup website runs from your local disk and not through a web server, you can delete the Open Document/Program action altogether.

  6. Save your changes.

NiceLabel Web Client is ready for “thin client” printing.

Executing sample integrations

Execute your sample integration:

  1. Go to the temporary folder on your disk with your extracted files from LabelCloudDataIntegrationPack.zip.

  2. Go to your Website folder.

  3. Double-click index.html. Your cloud system mockup opens in your browser:

    Mockup_Web_App.png

Your browser console logs outbound XML requests and inbound responses. To view your logs:

  1. Open your browser.

  2. Press F12.

  3. Click Console.

IoT printing with Cloud API

For each Print request, your mockup website writes and sends JSON messages as HTTP requests to our Cloud Print API. Cloud Print API processes the XML data, creates print jobs, sends print jobs to cloud-connected printers, and provides feedback.

Execute cloud printing:

  1. For your integration method, select IoT print using Cloud API.

  2. Select your printer from the list.

    Note

    Your list dynamically displays printers registered to your NiceLabel Cloud account. If your list is empty, register your printers. See Registering cloud printers.

  3. Click Print to print labels.

Your cloud printing is set up and ready to use.

Cloud triggers

For each Print or Preview request, your mockup website writes and sends XML messages as HTTP requests to our Cloud Trigger API. Cloud Trigger API redirects the messages to your on-premise NiceLabel Automation. Automation processes the XML data, executes the required actions (such as print or preview), and provides feedback.

Execute your server-based integration:

  1. Click Print to print labels.

  2. Click Preview to see label previews.

    Note

    Your list dynamic displays printers available on the computer where your NiceLabel integration system (NiceLabel Automation) is installed.

  3. For your integration method, select Cloud trigger.

  4. Select your printer from the list.

Your server-based integration is set up and ready to use.

Example thin clients

Execute your client-based integration:

  1. For your integration method, select Thin client.

  2. Click Print to open NiceLabel Web Client.

    Note

    You must have Web Client installed on the computer where your mockup web application runs.

  3. Log in to the Web Client with your Microsoft or Google account (Select Remember me to save your credentials). Web Client opens your Web printing application:

    ThinClient.png

  4. Choose a printer from the drop-down list to print your labels.

  5. Click Save to remember your printer.

  6. Keep your Web application running.

  7. Click Print in your mockup application to transmit product data to your Web Client in a query string. Your labels print to your local printer.

  8. If you have no driver installed, click Download printer driver and install your driver.

Your client-based integration is set up and ready to use.