Loftware Cloud API Workday Integration

Loftware Cloud API for Workday

Loftware Cloud provides label printing support for Workday, the cloud system for finance, HR, and planning. You can print labels directly from Workday on your cloud-connected printers with no on-premise Loftware footprint and no printer driver installation.

Our Loftware Cloud API for Workday:

  • Accepts Workday XML payloads.

  • Generates print jobs (for example, using ZPL for Zebra printers).

  • Sends print jobs to your cloud-connected printers.

Workday supports XML data exports from multiple business processes, so you don't need to develop anything new.

You must configure your outbound connection from Workday to your new Loftware Cloud API and send XML payloads to the API.

The API recognizes the XML type and executes built-in workflows to extract data and print associated labels on your printers.

Workday API integrations work like other Loftware Cloud APIs.

Note

Use Workday Integration APIs to print labels you can scan and track with your mobile Workday app. For example, on a hand-held mobile device with the Workday mobile app, you can open your app inventory and scan your label to see information about your scanned items.

Printing from Workday

You can print labels from Workday on cloud printers connected to Loftware Cloud. You can use Workday XML data tags as variable data sources on your label templates and forms by matching your variable names with your XML tags. Loftware Cloud APIs process Workday XML data and print each record.

Workday API integrations support 6 types of XML from Workday:

  • Goods Delivery Group

  • Goods Delivery Ticket

  • Inventory Locations

  • Locations

  • Par Locations

  • Receipts

To print from Workday, configure your connection settings.

Configuring your Loftware Cloud Workday API

  1. In Control Center, add Loftware Cloud API subscriptions for your Workday APIs from the Developer Portal like other Loftware Cloud APIs.

  2. Add your cloud printers in Loftware Cloud. For more information, see Cloud Printers.

  3. Configure your HTTP transport in Workday to use your URL with your Control Center subscription key in the query string:

    https://labelcloudapi.onnicelabel.com/workdayintegration/v1/PrintFromXml?subscription-key={your subscription key}

  4. Create your label templates. Map your variable names to your Workday XML data.

  5. Add label templates you want to print from Workday to your Control Center Documents.

  6. Print your labels directly from Workday. For more information, consult your Workday documentation.

Testing Loftware Cloud Workday APIs in Loftware Developer Portal (POST)

  1. Sign in to the Developer Portal.

  2. Go to APIs > Workday Integration API v1 - v1. The Workday Integration API page opens.

  3. Go to PrintFromXml (POST) and click Try it.

  4. Add your query parameters.

  5. Select your correct Subscription Key (from your Developer Portal profile). You can use your primary or secondary key:

    POST https://labelcloudapi.onnicelabel.com/workdayintegration/v1/PrintFromXml HTTP/1.1
Host: labelcloudapidev.onnicelabel.com
Ocp-Apim-Subscription-Key: ••••••••••••••••••••••••••••••••
Reqest

    Note

    Workday Integration APIs do not use headers. Your Subscription Key is added to your URL in a query string instead of your HTTP header.

  6. In Request Body, add your Workday request body in XML.

    1. Add your printer:

      <wd:Label_Printer>YourCloudPrinterName</wd:Label_Printer>

    2. Add your label template path:

      <wd:Label_Template>/Labels/YourLabelName.nlbl</wd:Label_Printer>

    3. Optional: if your label templates have variables, add them here. Your variables must match the names of your Workday XML data tags to work on your labels. (For simple label templates or test prints, delete this section).

      For example, for your creation date, add:

      <wd:Created_Date>2020-01-12-17:00</wd:Created_Date>

      Your variable Created_Date displays your date using Workday data.

  7. Click Send.

Your Workday API takes your XML records and processes your data. You successfully test print your label on your cloud-connected printer.

Using Cloud Trigger API with Workday

Use Cloud trigger APIs with Workday to create custom configuration logic and print from Automation service without cloud printers. Automation must be installed on a computer with access to your printers.

For more information, read Executing Cloud trigger APIs.

To integrate with Workday using Cloud Trigger, use the Cloud Trigger API on the Developer Portal. You must implement Workday XML data processing in your Automation configuration, and add your subscription key in your Request URL instead of in your header:

https://labelcloudapi.onnicelabel.com/Trigger/v1/CloudTrigger/{triggerId}?subscription-key={your subscription key}

Table 3. Cloud Trigger API with Workday vs Workday Integration API

API:

Cloud Trigger API

Cloud Trigger API

Workday Integration API

Supported printers:

All types of printers.

Cloud printers only.

On-premise infrastructure

Yes, requires a computer with Automation service and access to printers.

No, cloud printers connect directly to LabelCloud.

Workday Studio required

Yes (requires http headers)

No

No

Workday XML processing logic

Configured manually in your Automation configuration with actions and filters.

Predefined

Endpoint

https://labelcloudapi.onnicelabel.com/TriggerApi/CloudTrigger/Workday

Requires http header: api-version:v1

https://labelcloudapi.onnicelabel.com/Trigger/v1/CloudTrigger/Workday?subscription-key={your subscription key}

https://labelcloudapi.onnicelabel.com/workdayintegration/v1/PrintFromXml?subscription-key={your subscription key}

Printer and label selection

Configured in Automation with actions.

Provided by Workday in XML payload.

Supported XML elements

Loftware Cloud Workday APIs support the following XML elements:

GoodsDeliveryGroup:

  • Goods_Delivery_Group_Data

    • Group_Number

    • Description

    • Assigned_To

    • Created_Date

    • Number_of_Copies

    • Label_Printer

    • Label_Template

Inventory_Label_Goods_Delivery_Ticket:

  • Goods_Delivery_Ticket_Data

    • Goods_Delivery_Ticket

      • Just_in_Time_Goods_Delivery

      • Created_Date

      • Created_by_Worker

      • Deliver-To

      • Deliver-To_Address

      • Delivery_Ticket

      • Origin

      • Originating_Business_Document

      • Requester

    • Number_of_Copies

    • Label_Printer

    • Label_Template

Inventory_Label_Inventory_Locations:

  • Inventory_Location_Data

    • Location

      • Global_Location_Number_-_GLN

      • Location_External_Name

      • Location_Identifier

      • Location_Name

      • Inventory_Location_Attributes

        • Inventory_Location

        • Inventory_Location_Chain

        • Inventory_Location_Usage_Type

        • Inventory_Site

    • Item_Descriptor

      • CAS_Number

      • CDM_Code

      • GTIN

      • HCPCS_Code

      • Is_Controlled

      • Is_Energy_Star

      • Is_Green

      • Is_Hazardous

      • Is_Latex-Free

      • Is_Patient_Chargeable

      • Is_Radioactive

      • Is_Refrigerated

      • Is_Reusable

      • Is_Toxin

      • Item_Description

      • Packaging_String

      • Item_Identifier

      • Item_Name

      • Manufacturer_Name

      • Manufacturer_Part_Id

      • Manufacturers_for_Procurement_Item

        • Item_Manufacturer

      • Spend_Category_for_Item

      • UNSPSC

      • UPN

      • Unit_Price

      • Default_Ordering_Unit_of_Measure

      • Legacy_Item_Number

    • Item_Inventory_Attributes

      • Replenishment_Type

      • Average_Daily_Usage

      • Base_Reorder_Point_Quantity

      • Fixed_Order_Quantity

      • Fixed_Order_Unit_of_Measure

      • Inventory_ABC_Classification

      • Include_in_Count

      • Purchase_Item

      • Replenishment_Unit_of_Measure

      • Inventory_Site

      • Lead_Time

      • Base_Maximum_Quantity

      • Preferred_Supplier_Lead_Time

      • Is_Preferred_Picking_Location

      • Is_Default_Put_Away_Location

      • Label_Printer

      • Label_Template

Inventory_Label_Location:

  • Location_Data

    • Global_Location_Number-GLN

    • Location_Attributes

    • Location_External_Name

    • Location_Hierarchies_included_with_Allowed_Values

    • Location_Identifier

    • Location_Name

    • Superior_Location

    • Worksite_ID_Code

    • Location_Inventory_Attributes

      • Inventory_Location

      • Inventory_Location_Chain

      • Inventory_Site

      • Source_Inventory_Site

    • Label_Printer

    • Label_Template

Inventory_Label_Par_Location:

  • Par_Location_Data

    • Location

      • Global_Location_Number-GLN

      • Location_Attributes

      • Location_External_Name

      • Location_Hierarchies_included_with_Allowed_Values

      • Location_Identifier

      • Location_Name

      • Superior_Location

      • Worksite_ID_Code

    • Par_Location

      • Inventory_Stock_Request_Type

      • Par_Company

      • Par_Count_Option

      • Par_Location

      • Requisition_Type

      • Source_Inventory_Site

      • Source_Requisition_Company

      • Enforce_Reorder_Point

    • Bin

    • Item

    • Item_Description

    • Kanban

    • Item_Identifier

    • Par_Company

    • Par_Level

    • Just_In_Time

    • Replenishment_Source

    • Required

    • Par_Unit_Of_Measure

    • Line_Source_Inventory_Site

    • Line_Source_Requisition_Company

    • Reorder_Point

    • Item_Specific_Data

      • CAS_Number

      • CDM_Code

      • GTIN

      • HCPCS_Code

      • Is_Controlled

      • Is_Energy_Star

      • Is_Green

      • Is_Hazardous

      • Is_Latex-Free

      • Is_Patient_Chargeable

      • Is_Radioactive

      • Is_Refrigerated

      • Is_Reusable

      • Is_Toxin

      • Item_Description

      • Item_Identifier

      • Item_Name

      • Packaging_String

      • Manufacturer_Name

      • Manufacturer_Part_Id

      • Manufacturer

        • Item_Manufacturer

      • Spend_Category_for_Item

      • UNSPSC

      • UPN

      • Unit_Price

      • Default_Ordering_Unit_of_Measure

    • Label_Printer

    • Label_Template

Inventory_Label_Receipt_Goods_Line:

  • Receipt_Line_Data

    • Receipt_Date

    • Purchase_Order_for_Receipt_Line

    • Quantity_Shipped

    • Item_Description

    • Spend_Category

    • Unit_Cost

    • Delivery_Type

    • Ship-to_address

    • Ship-to_contact

    • Deliver-to__Location_

    • Deliver-to__Address_

    • Put_Away_Location

    • Worktags

    • Worktag

  • Receipt

    • Receipt_Number

    • Company

    • Supplier

    • Received_By

    • Just_In_Time_Purchase_Order

  • Item_Descriptor

    • Item_Identifier

    • Packaging_String

    • Unit_Price

    • Item_Name

    • Default_Ordering_Unit_of_Measure

    • Item_Lead_Time

    • CAS_Number

    • UNSPSC

    • Manufacturer_Name

    • Manufacturer_Part_Id

    • Manufacturer_URL

    • GTIN

    • UPC

    • NIGP

    • Is_Toxin

    • Is_Radioactive

    • Is_Radioactive_Minor

    • Is_Hazardous

    • Is_Select_Agent

    • Is_Controlled

    • Is_Green_Product

    • Is_Green

    • Is_Energy_Star

    • Is_Patient_Chargeable

    • Is_Recycled

    • Is_Reusable

    • Is_Latex-Free

    • Is_Refrigerated

    • Manufacturers_for_Procurement_Item

      • Item_Manufacturer

    • UPN

    • CDM_Code

    • HCPCS_Code

  • Number_of_Copies

  • Label_Printing_Unit_of_Measure

  • Label_Printer

  • Label_Template