Finding the Right Manual by Part Number

Help service teams recognise equivalent codes and choose the applicable instructions

Published

Paper-cut illustration distinguishes the confirmed AB-0712 part and its manual from the similar-looking AB0712R part and its different instructions.

A service technician types AB0712 into a document portal. The results include a manual for AB-0712, instructions for AB0712R and an older revision of the first manual. The technician needs to know which instructions apply before starting the job.

Use the supplier’s approved part reference to find the applicable manual. Recognise alternate spellings only where the product catalogue confirms they mean the same part. Show the supplier, part number, document status and revision with the result so the technician can check the match.

Resolve the part, then find its documents

  1. 1 · Identify

    Confirm the catalogue item

    Use supplier context and an approved cross-reference to recognise the entered code.

  2. 2 · Retrieve

    Find the applicable release

    Search document attributes for that part, the required document type, language and release status.

  3. 3 · Verify

    Check before use

    Display the actual part reference and revision, and enforce the audience’s access when opening the file.

A part number needs its catalogue context. Two suppliers may use the same code for unrelated items. If the entered code has several valid matches, ask the user to select the supplier or product before presenting one manual as applicable.

Decide which differences matter

Keep the entered code alongside the catalogue’s preferred reference. Preserve leading zeroes, punctuation and suffixes until a reviewed catalogue rule permits a change. Store identifiers as text so their formatting survives import. An approved alternate spelling identifies the same item; a replacement or compatible part needs its own relationship and applicability check.

Full-text discovery can help when someone has a partial reference or remembers wording from a manual. FormKiQ supports configured Typesense search and the OpenSearch-backed Enhanced Full-Text Search module, according to edition and deployment. Label content matches clearly: a manual may mention a code in a compatibility note without being the instructions for that part.

Search-engine text processing also matters. For example, OpenSearch’s standard analyser breaks text into terms and lowercases them. Test how the installed engine handles your real codes. The catalogue owner’s rules determine which codes are equivalent.

Worked example: find instructions for a replacement seal

Fictional catalogue and documents. Supplier East confirms that AB0712 is an alternate spelling of AB-0712. AB0712R identifies a different seal. Supplier West also uses AB0712, for an unrelated item. The service portal has the following records:

Expected treatment when a technician selects Supplier East and searches AB0712 for current service instructions.
DocumentCatalogue and releaseSearch treatment
Seal service manual, revision 3Supplier East · AB-0712 · approved current release.Return as the current manual for the confirmed part.
Seal service manual, revision 2Supplier East · AB-0712 · superseded release.Keep in authorised history; exclude from the current-instructions result.
Reinforced-seal manual, revision 1Supplier East · AB0712R · different part.Exclude from the confirmed-part result, even if its text mentions AB-0712.
Valve assembly instructions, revision 4Supplier West · AB0712 · unrelated item.Exclude for Supplier East. Offer a catalogue choice when supplier context is missing.
  1. Confirm the entered code

    The portal resolves Supplier East’s AB0712 to its preferred reference AB-0712 using the approved catalogue mapping. It displays that mapping to the technician.

  2. Retrieve the approved instructions

    The application uses configured FormKiQ attribute search for the supplier, part reference, service-document type and current release. In this example, revision 3 is the one qualifying manual. Its record carries the language and applicability information the technician needs to check.

  3. Keep broader discoveries understandable

    If the technician opens a separate text-search view, AB0712R may appear because its manual mentions the original seal. The result shows its different part reference and why it matched. Selecting it does not change the confirmed catalogue item.

  4. Handle a catalogue correction

    If Supplier East withdraws the alternate-code mapping, the integration updates it and the portal stops silently resolving new queries through it. Recheck affected document attributes, any search index and cached results before accepting the corrected lookup.

Make applicability and access part of the result

A document’s latest stored version and its approved service release can differ. Keep release status and applicable equipment, model or serial-number ranges explicit where the business requires them. A drawing or manual revision needs the relevant approval before the portal treats it as current. The controlled revisions guide explains that distinction.

A product match also needs to respect document access. Test service staff, engineering users and external partners against the permitted titles, metadata, previews, downloads and exports. Department, use-case and partner boundaries may differ even when people use the same catalogue. Apply the relevant policy to search results and recheck access when opening a file.

Checklist for a part-number search pilot

  • Agree who owns approved alternate codes, replacements and catalogue corrections.
  • Test punctuation, letter case, leading zeroes and near-identical suffixes against the catalogue’s rules.
  • Include the same code from two suppliers and an unknown code; require a clear choice or an unresolved result.
  • Check current, superseded, draft and language-specific instructions, including a manual that mentions another part only in passing.
  • Verify each audience’s results and file access, including partner and department restrictions.
  • Withdraw an alternate-code mapping and replace a manual; check synchronisation, indexing and cache behaviour.

Sources and further reading

Make the match clear before someone uses the instructions

Resolve the supplier’s approved part identity, retrieve the applicable release and show the evidence for the match. A technician should be able to recognise an alternate spelling, a different part and an older manual before choosing instructions for the job.

      Start with FormKiQ Core

      The open-source foundation — API-first, deployable into your own AWS account, and free to use. Right for architecture validation and early implementation.

      Get Started Free

      Deploy FormKiQ Essentials or Advanced

      Production-ready editions for departments and complex workflows. Start with a Proof-of-Value deployment or go straight to production.

      Explore Options

      Plan an Enterprise Rollout

      For governance-heavy environments with residency, sovereignty, assurance, and multi-jurisdiction requirements. Talk to us about the right deployment model.

      Book a Call