Skip to main content

Guidewheel Integration: User Setup Guide

How to Integrate Guidewheel with Your Limble Account

Overview

This integration turns downtime issues in Guidewheel into Limble work orders. When Guidewheel logs an issue on one of your machines, a work order is created on the matching Limble asset. When your technician completes that work order in Limble, the Guidewheel issue is automatically closed.

Each work order includes the time the downtime started and a link back to the issue in Guidewheel.


What syncs

From Guidewheel

What happens in Limble

New issue on a mapped device

New work order is created on the mapped asset

From Limble

What happens in Guidewheel

Work order completed

Guidewheel issue is closed

If a machine recovers on its own, its Limble work order stays open until someone closes it. Refer to Known limitations for the full list.


Before you begin

Gather the following before starting the setup wizard:

  1. Guidewheel API key: the API key for your Guidewheel account. The integration sends this as an x-api-key header on every Guidewheel request. Guidewheel limits each key to 1,000 calls per day, and this limit is shared by everything that uses the key.

  2. Guidewheel web address: the address you use to open Guidewheel in your browser, such as https://yourcompany.guidewheel.app.

  3. Limble location: the Limble location where work orders should be created. Each integration covers one location. If you have more than one plant, set up a separate integration for each location.

  4. Your plant's local time zone: used to show the downtime start time on each work order.


Navigate to the Limble integration center

  1. Log into your Limble account and go to Settings > Integration Center.

  2. Select Guidewheel and click Reconfigure.

If the Integrations Center is not yet configured in your Limble account and you'd like to start using Limble integrations, reach out to our support team or sales team to learn more.


Step-by-step setup

Step 1: Connect Guidewheel

Enter the connection details for your Guidewheel account.

Guidewheel API key - Enter your Guidewheel API key. If the key is changed in Guidewheel, update it here. The integration stops working until you do.

Guidewheel web address - Enter the address you use to open Guidewheel in your browser (e.g., https://yourcompany.guidewheel.app). This field is required and has no default. Every work order includes a link to its Guidewheel issue that is built from this address, so if the address is wrong or blank, the link won't work. To check it, sign in to Guidewheel and copy the address from your browser's address bar.

Guidewheel base URL - Leave the default (https://api.safisense.com/api) unless Guidewheel gave you a different host (e.g., a staging environment). https:// and /api are added automatically if omitted. This is not the same as your Guidewheel web address.

Tag name filter (default: *) - Controls which tags appear in the Approved Tags list in Step 3. Leave it as * to show all tags. To show fewer tags, enter one or more words separated by commas. A tag appears if its name contains any of those words (not case-sensitive).

This filter only changes which tags you see in the list. It does not decide which issues create work orders. If you change it later, go back to Step 3 to refresh the list.

Step 2: Select a location

Limble location - Select the Limble location where work orders will be created. This is required.

Step 4 will only list assets from this location, and the integration only works with work orders in this location.

Step 3: Choose which tags create work orders

Guidewheel issues are labeled with issue_details tags. This step controls which tagged issues create work orders. Issues with no issue_details tags never create work orders.

Sync all issue tags (default: on) - When on, every issue with an issue_details tag creates a work order. Most accounts can leave this on.

Turn it off to choose specific tags from the Approved Tags list.

Approved tags - Available when Sync All Issue Tags is off. Check each tag that should create work orders. If no tags are checked, no work orders are created.

An issue with no issue_details tags is always skipped regardless of this setting.

Step 4: Map Guidewheel devices to Limble assets

The Device Asset Map pairs each Guidewheel device with a Limble asset. Work orders for a device are created on its mapped asset.

The wizard fills in the table for you by matching Guidewheel device nicknames to Limble asset names. A device is matched only when its nickname and an asset name are the same (not case-sensitive).

The description above the table shows how many devices are mapped and lists any that aren't.

  1. Review the rows the wizard filled in and correct any wrong matches.

  2. Add a row for each device that wasn't matched.

  3. Confirm each mapped asset is in the location you selected in Step 2.

Note: A device with no row in the table doesn't create work orders, and no error appears. Work orders for assets outside the selected location are also skipped. If the same device is mapped in two rows, only the first row is used.

Step 5: Review advanced settings

Guidewheel source tag (default: @Guidewheel) - This tag is added to every work order the integration creates. The integration uses it to find its own work orders and avoid creating duplicates. Only change it if it conflicts with a tag used by another integration.

Do not change the Guidewheel source tag after work orders have been created. If you change it, the integration can no longer find its earlier work orders and will create duplicates.

Poll schedule (default: every 5 minutes) - How often the integration checks Guidewheel for new issues. Enter a number of minutes, such as 5. Five minutes is the minimum, because of Guidewheel's 1,000-calls-per-day limit.

Set the schedule's time zone to your plant's local time zone. The integration uses it for the downtime start time on each work order.


How the sync works

Once deployed, the integration runs automatically. Here's what to expect:

  • Guidewheel → Limble: The integration checks Guidewheel on the schedule you set. New issues on mapped devices become work orders on the mapped assets. Issues that are already resolved when the integration checks are skipped.

  • Limble → Guidewheel: When you complete a work order in Limble, the integration closes the Guidewheel issue. This usually happens right away. As a backup, the integration also checks for completed work orders on a regular schedule.

About the meta1 field on work orders

Work orders created by this integration store the Guidewheel issue ID in a field called meta1. This links the work order to its Guidewheel issue. The meta1 field isn’t shown in Limble, so it can only be changed through the Limble API.

If you use the Limble API or another integration to update work orders, do not clear or overwrite meta1 on work orders created by the Guidewheel integration. If it’s removed, completing the work order no longer closes the Guidewheel issue, and the integration may create a duplicate work order.


Known limitations

  • Work orders don't close when a machine recovers on its own. If a machine comes back up without a repair, its Limble work order stays open until someone closes it.

  • Each integration covers one Limble location. To cover more than one plant, set up a separate integration for each location.

  • Guidewheel → Limble is not real-time. New Guidewheel issues appear in Limble after the next scheduled check, not instantly.


Troubleshooting

Symptom

What to check

No work orders are being created

Confirm your Guidewheel API key is valid, a Limble location is selected, and at least one device is mapped to an asset in that location. Then confirm Sync All Issue Tags is on, or at least one tag is checked in Approved Tags. Issues that are resolved before the integration checks are skipped.

No work orders for one machine

Confirm the machine's Guidewheel device has a row in the Device Asset Map and that the mapped asset is in the selected location.

The Guidewheel link on a work order doesn't work, or shows an ID instead of a link

Correct the Guidewheel Web Address in Step 1, then save the connection. The integration will pick it up on the next check. Only work orders created after the fix get the corrected link.

Completing a work order doesn't close the Guidewheel issue

Redeploy the integration to restore the real-time connection. Completed work orders still close their Guidewheel issues through a backup check, but not right away. If you use the Limble API or another integration to update work orders, make sure it isn’t clearing the meta1 field.

Duplicate work orders for the same downtime event

Check whether the Guidewheel Source Tag was changed or the @Guidewheel tag was removed from the original work order. If you use the Limble API or another integration to update work orders, make sure it isn’t clearing the meta1 field.

Work orders stay open after a machine recovers on its own

This is a known limitation. Close the work order manually.

Step 3 shows no tags, or fewer tags than expected

The Tag Name Filter in Step 1 doesn't match your tags. Change it to * or the correct word, then go back to Step 3 to refresh the list.

The Device Asset Map shows no Limble assets

Select a location in Step 2. The asset list is empty until a location is selected.

Need help?

If you have questions about the Guidewheel integration, contact our support team and reference this article.

Did this answer your question?