TIPP Document Comparison
TIPP Document Comparison is a TIPP CORE page in Exact Synergy that uses an AI provider to compare two documents, or two versions of a document, and list the differences. Each difference gets a severity (High, Medium or Low), a category and a recommendation, and you can export the result to a PDF. It is normally used by people who review contracts, procedures or other Synergy documents and need to see what changed between versions.
Before you start
- A valid TIPP license is required. If the license is expired or missing, the page shows an error and all fields and buttons are disabled.
- TIPP page security applies. If your user is not allowed to open this page, access is denied.
- At least one AI provider must be set up on the TIPP AI Settings page. TIPP Document Comparison offers these providers when they are configured: ChatGPT (OpenAI), Claude, Gemini, Grok, Mistral and Azure OpenAI. A provider appears in the AI Provider list only when its API key is filled in (Azure OpenAI also needs an endpoint and a deployment name).
- The documents must be Exact Synergy documents. The document picker only offers documents that have a document type.
How to compare two documents
- Under Select Documents to Compare, click the Document A field and pick the first document in the document browser. The page then shows its Subject and a list of its Attachments.
- Pick the Document B field the same way. The Subject and Attachments of Document B appear below it.
- Optionally choose a Version for Document A and for Document B. Leave it on “(latest / no version)” to use the current document as it is stored. After you choose a version, the Subject and Attachments shown are those of that version.
- Under Run Comparison, choose an AI Provider. The first configured provider is selected by default.
- Click Run Comparison. When it finishes, the message “Comparison complete.” appears next to the button and the Comparison Results section is shown.
- Read the line “Overall difference level” and the table of differences. Click Toggle Raw AI Response if you want to see the unprocessed answer from the AI.
- Click Export to PDF to download the report.
How to compare two versions of the same document
- Pick the same document in both Document A and Document B.
- In the Version list under Document A, choose the older version, for example “Version 1”. Versions are listed newest first.
- In the Version list under Document B, choose the newer version, or leave “(latest / no version)”.
- Select an AI Provider and click Run Comparison.
How to export the result to PDF
- Run a comparison first so the Comparison Results section is visible.
- Click Export to PDF. A file named TIPP_DocumentComparison.pdf is downloaded.
- The PDF title is “Document Comparison – ” followed by the label of Document A, then ” vs “, then the label of Document B. Each label is the document subject followed by the version in brackets, for example “[v2]”, or “[latest]” when no version was chosen.
Screen guide
Select Documents to Compare
- Document A: the first document, chosen from the document browser. Required to run a comparison.
- Document B: the second document, chosen from the document browser. Required to run a comparison.
- Version (under each document): the stored versions of the chosen document, shown as “Version” followed by the number, newest first. The first entry “(latest / no version)” is the default and uses the document as currently stored. Changing the document resets this list to its default and reloads the versions of the new document.
- Subject: shown after you pick a document. It is the subject of the document or of the chosen version. If there is none, “(no subject)” is shown.
- Attachments: the file names of the attachments of the document (or of the chosen version). Shows “(none)” when there are no attachments.
Run Comparison
- AI Provider: the AI service that does the comparison. Only configured providers are listed. When none is configured the list shows “No AI providers configured” and is disabled.
- Run Comparison button: sends both documents to the selected AI provider. It is disabled when no AI provider is configured or when the license check failed.
Comparison Results
- Overall difference level: a summary line “Overall difference level: High”, “Medium”, “Low” or “Unknown”. It takes the highest severity found: High if any difference is High, otherwise Medium if any is Medium, otherwise Low. It shows Unknown when no differences were returned.
- Severity: High means a substantive change in meaning, obligations, numbers, dates or parties. Medium means a clarification or rewording that changes emphasis. Low means typos, formatting or minor wording. High is shown in red, Medium in amber and Low in green.
- Category: the kind of difference, for example Subject, Body Content, Attachment Content, Numbers/Figures, Dates, Parties, Clauses, Formatting, Missing Section or New Section. The AI chooses the category.
- Difference: a description of what is different between Document A and Document B.
- Recommendation: a suggested action for that difference.
- Toggle Raw AI Response: shows or hides the unprocessed text the AI returned.
- Export to PDF: downloads the result as a PDF report (Summary and Differences).
What the comparison looks at
- It compares the Subject, the body text of the document (formatting is removed) and the text of the attachments.
- Text is read from PDF and DOCX attachments. Other attachment types are read as plain text, which may not give readable content for binary files such as images.
- Only the first 12,000 characters of each document (Subject, body and attachment text combined) are sent to the AI. Differences after that point are not seen.
- The AI is asked to answer in English, whatever language the documents are in.
- If the two documents are identical, the AI is asked to return one Low item saying no differences were found.
Messages and what to do
- “TIPP License expired on” followed by a date: the TIPP license has expired. Ask your administrator to renew it.
- “No valid TIPP license found. Please contact your administrator.”: no TIPP license is installed. Contact your administrator.
- “No AI providers are configured. Please open TIPP AI Settings and add at least one provider.”: no API key has been set. Ask an administrator to add a provider on the TIPP AI Settings page.
- “Select both Document A and Document B.”: one or both documents are empty. Pick both documents and click Run Comparison again.
- “Select an AI provider.”: no provider is chosen in the AI Provider list. Choose one.
- “Unable to load one or both documents.”: the document could not be read. Check that the document and chosen version still exist.
- “AI call failed.”: the AI service did not succeed and gave no further reason. Try again or choose another provider.
- “AI returned an empty response.”: the AI sent back nothing. Run the comparison again or choose another provider.
- “Comparison failed:” followed by a reason: something went wrong during the comparison. The reason text tells you more; try again or contact your administrator.
- “[Provider name] is not configured. Please update TIPP AI Settings.”: the selected provider lost its settings. Ask an administrator to check TIPP AI Settings.
- “Run a comparison before exporting.”: you clicked Export to PDF without a result. Click Run Comparison first.
- “Failed to load document metadata:” or “Failed to refresh document metadata:” followed by a reason: the subject, versions or attachment list could not be read for the selected document.
- “Failed to load attachments for” followed by a document: the attachments could not be read.
- A single High finding in the category Parsing with the text “Unable to parse AI response.”: the AI answer was not in the expected format. Recommendation shown: “Review the raw AI response manually.” Click Toggle Raw AI Response to read it, or run the comparison again.
What you cannot do here
- You cannot edit, merge or restore documents or versions. This page only reports differences.
- You cannot compare more than two documents at once.
- You cannot set up AI providers here. That is done on the TIPP AI Settings page.
- The result is not saved on the page. Export it to PDF if you want to keep it, because running a new comparison replaces the shown result.
- The AI result is a review aid and can be incomplete or wrong. Check important differences against the documents.
Related pages
- TIPP AI Settings: where an administrator enters the API keys and models for the AI providers offered in the AI Provider list.
- Exact Synergy Documents: where the documents and their versions that you compare are created and stored.
Common questions
What is TIPP Document Comparison for?
It compares two documents or two versions of one document with AI and lists the differences with a severity, category and recommendation. You choose Document A and Document B, pick an AI Provider and click Run Comparison.
How do I compare two versions of the same document?
Select the same document in Document A and Document B, then choose different entries in the two Version lists. Choose an AI Provider and click Run Comparison.
Why is the AI Provider list empty or showing “No AI providers configured”?
No provider has an API key saved yet. An administrator must add at least one provider on the TIPP AI Settings page. Until then the AI Provider list and the Run Comparison button are disabled.
Why are all fields and buttons disabled?
The TIPP license check failed. The red message tells you whether the license expired or is not found. Contact your administrator.
Why can I not find my document in the Document A or Document B browser?
The browser only offers documents that have a document type set. Documents without a type are not listed.
What does “(latest / no version)” mean?
It means the document is used as it is currently stored, not a specific saved version. Pick a “Version” entry if you want an older saved version instead.
What does Overall difference level mean?
It is the highest severity among all differences found. High means at least one substantive change, Medium means at most rewordings that change emphasis, Low means only minor changes, and Unknown means no differences were returned.
What do High, Medium and Low mean in the Severity column?
High is a substantive change in meaning, obligations, numbers, dates or parties. Medium is a clarification or rewording that changes emphasis. Low is a typo, formatting or minor wording change.
Are attachments compared too?
Yes. The text of attachments is included, read from PDF and DOCX files and as plain text for other types. Only the first 12,000 characters of each document are sent, so changes later in a long document or its attachments can be missed.
Why are the results in English when my documents are not?
The AI is told to answer in English whatever the document language.
How do I keep the result?
Click Export to PDF in the Comparison Results section. The file is named TIPP_DocumentComparison.pdf. If you see “Run a comparison before exporting.”, run a comparison first.
TIPP resources
Some of this content was drafted with the help of AI. We aim to keep it accurate, but it may contain errors or become outdated as Exact Synergy and TIPP change. It is general guidance, not advice for your specific setup, so test changes in a non-production environment first. Spotted a mistake? Let us know at tipp@tice-it.com.