What is an Arch ID, and what is it used for?

What is an Arch ID?

An Arch ID serves as a globally unique identifier for an object within ArchFX Cloud and within Arch applications such as the Global KPIs Solution. Sites, Areas, Lines, Machines, sensor Devices such as IOTile PODs, Access Points, and ArchFX Connector software connectors are all assigned Arch IDs. Arch IDs are sometimes referred to as "slugs" in technical documentation and APIs.

Where do I find Arch IDs in the Global KPIs Solution?

• Arch IDs are shown in lists of Areas, Lines, and Machines near the object's name.
• You can find a Line's or Machine's Arch ID on its Details tab.
• A Machine's Details tab also shows the Arch ID of the Machine's Site, Area, Line, and Devices or Connectors.

See "Examples of different ways to find Arch IDs" below for more details.

How does an Arch ID help me?

The Arch ID makes it easy to specify which object you're referring to.

• When you're filing a Change Request or help ticket about an IOTile POD, Machine, or Line with Arch Support, please include the Arch ID of the IOTile POD, Machine, Area or Line if you know it. That will make sure Arch Support knows which object you're referring to.
  • For example, if you change the head on an SMT Machine, you may need to update the Machine's Target to match the derated Target for the new head. Open a Help ticket and make sure to include the Arch ID of the Pick and Place Machine whose Target needs to be updated as well as the date at which the change took effect (even if that date is in the past).

• In ArchFX Cloud and the Global KPIs Solution, you can search for an object by entering the object's Arch ID into the search box.

• IT administrators use Arch IDs when using the ArchFX Setup Desktop App to set up Access Points, GPIO Kits, PLC Kits, or Beam Break Kits.

• When a developer is getting data from the ArchFX Cloud API, they use the Arch ID to specify which object they want data for. (See ArchFX Cloud Tutorial: Getting Machine Data via API for more information.)

What does an Arch ID look like?

An Arch ID has a prefix that indicates the type of object it represents, followed by a series of hexadecimal numbers. For example:

• Sites: Factory sites are represented with a ps-- (e.g. ps--0000-0001)

• Areas: Factory areas within a site are represented with a pa-- (e.g. pa--0000-0001)

• Lines: Factory lines within an area (or within a site) are represented with a pl-- (e.g. pl--0000-0001)

• Machines: Factory machines are represented with a d-- (e.g. d--0000-0001-0000-1234). Machines all start with d--0000-0001-

• Devices: A device, which represents an IOTile POD hardware sensor or an ArchFX Connector software connector, is also represented with a d--, but devices always use d--0000-0000-. For IOTile PODs and Access Points, the Arch Device ID is also the device's serial number, and represents the UUID that is programmed into the device Firmware. The Arch ID is marked as "UUID" for "Universally Unique IDentifier" on the physical device.

Note that Machines and Devices share the same d-- prefix, but machines will always have a non-zero in the first 16 digits (d--0000-0001-) while Devices always have zeros (d--0000-0000-).

Examples of different ways to find Arch IDs

How do I find the Arch ID of a Line in Global KPIs by browsing?

In Global KPIs, open the Site. Within the Site, open the Area that encloses the Line. Look at the list of Lines, and you will see the Arch IDs listed under the names of the Lines:

How do I find the Arch ID of a Line in Global KPIs via searching?

In Global KPIs, at the Global home page, click the Lines tab. In the search box, enter the name of the Site that has the Line and hit enter. You will see a list of all the Lines at that Site. Under each Line's name is its Arch ID:

How do I find the Arch ID of a Machine on a Line in Global KPIs by browsing?

In Global KPIs, open the Site. Within the Site, open the Area that encloses the Line. Open the Line. Look at the list of the Line's Machines, and you will see the Arch IDs listed under the names of the Machines:

How do I find the Arch ID of a Machine on a Line in Global KPIs by searching?

In Global KPIs, at the Global home page, click the Machines tab. In the search box, enter the name of the Site that has the Line, enter the name of the Line (using double quotes if necessary), and hit enter. You will see a list of all the Machines at that Site on that Line. To the left of each Machine's name is its Arch ID:

How do I find Arch IDs using the ArchFX Cloud Factory Map? (administrator users only)

Log in to ArchFX Cloud and choose your Organization. At the App Launcher, click "Factory Map:"

In the Factory Map, expand the "Factory Map" menu option on the ribbon menu on the left hand side:

• If you click "Sites," you'll see a list of all the Sites with the Arch ID of each.
• If you click "Areas," you'll see a list of all the Areas with the Arch ID of each.
• If you click "Lines," you'll see a list of all the Lines with the Arch ID of each. 

For more information

• Installing and Using the ArchFX Setup Desktop App

• How to Use the ArchFX Setup Desktop App to Scan for Devices

• How Do I Install a GPIO Kit?

• How Do I Install a PLC Kit?

• How Do I Install the GPIO Beam Break Kit?

• ArchFX Cloud Tutorial: Getting Machine Data via API