To use redlining, you must be running
For setup instructions on connecting to the Hosted MS Word Services API, please consult our document.
Creating the Fields and Action Button
- On the General tab, name the action button (e.g., Compare Documents).
- Select the Execute Action checkbox.
- Click Add Action.
- In the pop-up window, click Create Document Comparison Action.
revised version. You can then download the redlined file from your knowledgebase.
Document Comparison actions are useful in situations where people review documents and provide potential changes before documents are finalized. For example, imagine you create a contract document from a record, and you must send it to your company's legal counsel before finalizing it. When the legal counsel sends a revised version of the document back, you can run a Document Comparison action to easily find any changes they suggest.
Create a Document Comparison Action
You can find the Actions wizard with several different navigation paths, but the easiest is to select Setup [Table Name] on the left pane for the table where you wish to create your action.
- Click the Actions tab in the Table wizard.
- Click Create Document Comparison Action. The Document Comparison action wizard opens.
On the General tab, name the action (e.g., ‘Compare Documents’).On the
and provide a description.
Once your action is saved, the system automatically adds an R: before your given title to distinguish it as a Document Comparison action.
On the Data Source tab, select the fields that hold theRevised File, Previous File, and the field to hold the Redlined document.
- For customers accessing the Hosted Word API services for redlining, select the Use Hosted Service to Compare Documents checkbox.
- All users: Finish the action. Finish setting up the action button and Save it. Continue organizing the layout and permissions as needed.
revised file, the baseline or previous file, and the redlined file.
- For the redlined file, choose whether to overwrite any existing files, append the new file, or update the latest file.
- If desired, select a Yes/No Choice field that's set to Yes if any differences are flagged between the baseline and revised files.
- Select whether any tracked changes in the comparison documents are accepted by Word before the comparison is performed.
- Choose whether to use the hosted service for the document comparison. Select this option if you are on a Linux/Unix system, or if you're a hosted customer using the Word API.
Compare Document Versions in the Same Field
With some caveats, you can compare two versions of a document within the same field by selecting the same field name for both the Revised File and the Previous File. When comparing documents this way, keep the following in mind:
- Versioning must be enabled for the file field.
- The field must contain at least two versions of a document, or the action will not run.
- If the field has several documents, the action runs on the most recently updated version. The action compares this version with the immediately previous version.