Determining the Correct LuName and KeyRef
How to determine the correct LuName and KeyRef format
If you are unsure of the correct KeyRef or LuName format required for an entity or projection, you can determine the exact values by creating a data set against that entity/projection.
When reviewing the data set results, look for the following columns:
LUNAMEKEYREF
These columns display the exact format expected by the system for attachments, document references, or related integrations.
- Create a data set using the target entity or projection.
- Retrieve a sample record from the data set.
- Locate the LuName and KeyRef columns in the returned data.
- Use the values shown in those columns as the template for your configuration or integration.
The KeyRef is often more complex than a single ID value. Depending on the object type, it may include:
- Task sequence numbers
- Work order numbers
- Equipment numbers
- Customer IDs
- Multiple concatenated key values
The data set provides the exact structure required by the application, eliminating the need to manually guess or build the format.
For example, a data set may return values similar to the following:
LUNAME = WorkTaskKEYREF = TASK_SEQ=12345^
This indicates that:
- The object is associated with the
WorkTaskLU. - The
KEYREFmust use theTASK_SEQformat and include the trailing caret (^).
Using the values directly from the data set helps ensure attachments and references are associated with the correct business object.