Mass PDF

With the Mass PDF operation you can create PDF files from natives, images, and produced documents, and save those PDFs on your computer. The mass PDF operation also allows you to store PDFs created from native files or original images in Relativity and review them in the PDF Viewer. The Mass PDF application is available from the mass operations bar on the document list.

    Notes:
  • The mass PDF operation support jobs that contain up to 10,000 documents or 1,000,000 images.
  • You cannot use mass operations on Data Grid-enabled fields.
  • The PDF application does not integrate with the Password bank. If you try to convert a native document that is password protected, an error occurs.
  • The PDF application is not available in workspaces created from the RelativityOne ECA Template or in workspaces where the Repository Workspace application is installed.
  • The PDF application needs to be manually installed on any workspace that was restored using ARM.
  • If you are having problems running a PDF job, verify that you have both the PDF Manager and PDF Worker agents are running and enabled. You can check this on the Agent tab.
MadCap:conditions="Relativity Documentation.On-prem only">

PDF permissions

The PDF application has the following associated permissions:

  • A new Tab Visibility permission, PDF, controls access to the PDF and PDF Profile tabs.
  • A new Object Security permission, PDF Profile, controls access and operations over the PDF Profile object.
  • The previous Save as PDF permission is replaced with the new PDF permission.
  • If installing the new PDF application on 10.3 before upgrading to Relativity 2022, the Save as PDF permissions will be applied to the new PDF application. The new PDF application has to be installed in all workspaces for this to occur and this application needs to be installed as a part of the upgrade workflow. If installing the new PDF application while still active in 10.3, the Save as PDF permissions will not be carried over. The client must re-add the permissions.
  • If upgrading from Relativity version 2021 and above, when the new PDF application is first installed on a workspace, it applies the previous Save as PDF permission settings to all groups.
  • System administrators with the correct permissions setup for Save as PDF, are unable to test this in Preview Security mode. This is done to prevent downloading documents that haven't been authorized.

PDF profile

Use the PDF profile to customize how to create and save your PDFs.

To create a new PDF profile, go to the PDF Profile tab or use the quick search to find this tab.

PDF Profile view

General options

The options under this section apply to every file type: natives, original images, and produced images.

General options section
  • Name—provide a name for your PDF Profile.
  • Stamp Identifier—select this option to add branding on each page of the resulting PDF in a specific page location. You can choose to brand your PDFs after one of the following options:
    • Document Identifier—choose this option to stamp each page of the PDF with the document identifier. For example: REL_00001.
    • Document Identifier and Page Number—this option will stamp [Document Identifier]-[page number]. You can choose among three options:
      • Add the page number to every page of the PDF
        • Page 1: REL_00001-0001
        • Page 2: REL_00001-0002
      • Start the page numbering on the second page 
        • Page 1: REL_00001
        • Page 2: REL_00001-0001
      • Start the page numbering on the second page with 2 
        • Page 1: REL_00001
        • Page 2: REL_00001-0002
    • Field—choose this option to stamp the PDFs with a field value.
    • Free Text—choose this option to stamp the PDFs with the a text of your choice.
  • Stamp Location—select the area of the page where you want to add your stamping.

Numbering

You can add new sequential numbers to rendered PDFs before they are produced. The following options can be configured in the PDF Profile:

Numbering PDFs

  • Numbering type—select Page Level or Document Level numbering.
  • Prefix—enter a prefix to be used for numbering.
  • Minimum Box Number—enter a minimum box number. This is set to 1 by default and indicates the Start Number.
  • Minimum Folder Number—enter a minimum folder number. This is set to 1 by default.
  • Minimum Page Number—enter a minimum page number. This is set to 1 by default.
  • Delimiter—select period, hyphen, or underscore.
  • Relational Field Behavior—select none or keep in same folder
  • Relational Field Behavior—select a ,relational field such as Family Group or
  • Maximum Box Number—enter a maximum box number. This is set to 9999 by default.
  • Maximum Folder Number—enter a maximum folder number. This is set to 9999 by default.
  • Maximum Page Number—enter a maximum page number. This is set to 9999 by default.

Branding

When adding branding to produced PDFs, the following options can be configured in the PDF Profile:

Branding PDFs
  • Branding Font—select a font for branding.
  • Branding Font Size—select a font size.
  • Branding Field—select a field for branding. You can only select and use one branding field.
  • Wrap Branding Text—if the text being stamped is too long, wrap the text to fit multiple lines. Flip this option to true to wrap text within the allotted field.
  • Left Header—select a left header. Choose Document Identifier, Document Identifier + Page Number, Field, Free Text, or Level Numbering.
  • Left Footer—select a left footer. Choose Document Identifier, Document Identifier + Page Number, Field, Free Text, or Level Numbering.
  • Center Header—select a center header. Choose Document Identifier, Document Identifier + Page Number, Field, Free Text, or Level Numbering.
  • Center Footer—select a center footer. Choose Document Identifier, Document Identifier + Page Number, Field, Free Text, or Level Numbering.
  • Right Header—select a right header. Choose Document Identifier, Document Identifier + Page Number, Field, Free Text, or Level Numbering.
  • Right Footer—select a right footer. Choose Document Identifier, Document Identifier + Page Number, Field, Free Text, or Level Numbering.

Native options

Enter values for the following fields:

Native options
  • Paper Size—select the size for both the PDFs that you create to download and to the PDFs you store in Relativity. The paper size option only applies when the source file type of the PDF job is natives. The paper sizes available are: Letter, Legal, A5, A4, A3, and original. The original option will maintain both the original paper size and orientation of each page on the native file. The Letter, Legal, A5, A4, and A3 options will create a PDF with portrait orientation in the selected paper size.
  • Burn Native Redactions—indicates that you want to include redacted natives as part of the PDF job. Toggling this field on makes the Native Options Markup Set field required below.
  • Native Options Markup Set—indicates which markup set is used to apply native redactions to the documents you are about to convert to PDF. This field is only visible if you selected to burn native redactions above. Select the desired markup set from the dropdown.

Image options

When converting original images or produced images to PDFs, the following options can be configured in the PDF Profile:

Image options

Make Text Searchable—select this option to translate images of text, such as scanned and redacted documents, into actual searchable text characters in the resulting PDF. 

Note: This function applies only to Original Image and Produced Image file types. 
  • OCR Profile—select the OCR profile to be used to translate images of text into actual searchable text characters.
    Note: If there are not OCR profiles created in the workspace, Relativity will use a default OCR profile.
  • Include highlights—select this option to include persistent highlights in the resulting PDFs. This option applies only when converting original images to PDF, and is only for highlights which are associated with a markup set. You will be required to specify the markup set profile to use.
  • Include redactions—select this option to include redactions in the resulting PDFs. This option applies only when converting original images to PDF, and is only for redactions which are associated with a markup set. You will be required to specify the markup set profile to use.
  • Include Slip Sheet—select this option to include a slip sheet on the first page of the generated PDF. Available options are:
    • Blank Page
    • identifier only
    • coding layouts

Placeholder Options

Optionally create a placeholder PDF for encrypted documents. Documents that are not to be rendered to PDF should have a PDF Placeholder. Select Never, Always, or For Errors/Unsupported File Types when assigning a PDF placeholder for a document during PDF Rendering.

Placeholder options

Microsoft Word Options

When converting native file types that are MS Word Documents into PDFs, the following options can be configure in the PDF Profile:

Microsoft Word options

  • Show Track Changes—if the native MS Word document has track changes, this option will include those track changes in the resulting PDF.
  • Show Comments—if the native MS Word document has comments, this option will include those comments in the resulting PDF.

Microsoft PowerPoint Options

When converting native file types that are MS PowerPoint Documents into PDFs, the following options can be configure in the PDF Profile:

Microsoft PowerPoint options

  • Show Speaker Notes—if the native MS PowerPoint document has track speaker notes, this option will include those speaker notes in the resulting PDF.
  • Show Presentation Comments—if the native MS PowerPoint document has Presentation Comments, this option will include those comments in the resulting PDF.

Once a PDF profile is created, it is available on the Mass PDF action and from the Viewer.

PDF profile viewer

The PDF application comes with a default profile that is not listed on the PDF profile tab and that cannot be modified. This is a basic profile that creates non-searchable PDFs without highlights, redactions, slip sheet or stamp identifier.

The default PDF profile is only available if there are no other PDF profiles created in the workspace. Once a system administrator creates a new PDF profile, the default Profile is no longer available for the users.

Creating PDFs via mass operation

Note: If you are creating PDFs to open in the Viewer, it is important to note that the Viewer displays PDF text by mapping the character codes to Unicode in most cases. To check whether PDF text has been properly encoded and will display correctly in the Viewer, copy the text in the original PDF file and paste it into another application like Microsoft Word or Notepad. If the pasted text does not display correctly, the PDF is not properly encoded. If the pasted text displays correctly in another application but not in the Viewer, contact Support for assistance.

To convert multiple documents into PDFs:

  • From the mass operations bar on the document list, select either Checked items or All items in the current returned set.
  • Select PDF in the mass operations drop-down menu. The PDF options window displays.
  • Select the appropriate settings:
    • Notes:
    • The settings available depend on the file type selected. Natives, original images, or produced images. For example, production options are available if you select Produced Images. Likewise, if you are going to save all your documents in a single PDF, then there are no options on how to name the individual PDF.
    • When saving your PDF as a zip or PDF portfolio you can choose to name your individual PDFs using just the control number or the control number plus a field.
    • You also have the option to decide whether to include a numbering prefix on the file name. In the past that prefix was always added.

    PDF files action window
    Action
    • Download—download your PDFs.
    • Store—creates a PDF from the native or imaged version of the documents. Those PDFs will be stored in Relativity and can be reviewed using Relativity's PDF Viewer.
    • Brand—sequentially numbers documents with a structured Document ID and stamps the Document ID on each page of a PDF. Only profiles that have branding options set can be leveraged for this action.
    • Count—calculates and updates the PDF Page Count field when document page counts need to be updated in the database. This only works for counting rendered PDF documents.
    • Delete—deletes the stored PDFs associated with the selected natives.
    • Note: If you import PDF Images and the PDF Page Count is not set, you cannot brand the documents. You must run the Count action beforehand to make sure the field is populated.
      Note: Selecting the Brand option when using a PDF profile that has Level Numbering configured could conflict with the control number.
    File Types
    • Natives—saves the native of the documents.
    • Original Images—saves the imaged versions of the documents.
    • Produced Images—saves the produced versions of the documents.
    PDF Options
    • Individual PDFs In A Zip—saves resulting PDFs as a zipped file.
    • Single PDF—creates one PDF with all documents.
    • PDF Portfolio—creates one PDF Portfolio with all documents.
    • Note: When you Mass Save as PDF a group of documents, the documents retain their sort order based on the order in which they appear within your document list.
    • When saving a PDF as a .zip or PDF portfolio you can choose to name your individual PDFs using the control number, the control number plus a field, or just a field.
    • When saving a PDF as a zip or PDF portfolio you can decide whether to include a numbering prefix on the file name. In the past, that prefix was always added.
    Naming Options
    • This option defines the name of the individual PDFs created when documents are saved as Individual PDFs In A Zip or PDF Portfolio. The zip file or the portfolio file itself that contains the PDF files is always named result.[extension].
    • Naming options window
    • Control Number—choose this option to name the PDFs after the control number of the original document.
    • Control Number And Field—this option appends value of a field to the original control number name. When using this option, the resulting name of the document is [control number]_[field value].
    • Field—choose this option to name the PDFs after a field value.
    • Append File Type—appends _native, image, or _production at the end of the file name based on the type of documents used to create the PDF.
    • Prefix Sequential Number—this option appends a numeric prefix based on the sort order in which they appear within your document list. For example, 01_FirstDocument.pdf.
    • Note: If the length of file name is longer than 251 characters, the system will use the first 251 characters.
    Production Options
    • Include original images for documents that haven’t been produced—if a document has not been produced, you can check this option to create PDFs from the images associated with that document instead.
    • Modify Production Order—select which produced version of the document to include in the PDF set.
      • The save job first looks at the production set at the top of the list. If the document is included in this production that version is saved. If not, the save job checks if the document is in the next production. Only one production per document is saved.
      • The list includes only the productions related to the documents selected, those productions are sorted by recent to oldest. For example, if there are 8000 productions in your workspace, but the selected documents are produced across only 100 productions, the list will show only those 100 productions.

PDF Profile Options

The PDF Profile section displays the selected profile and all the corresponding values set on that profile. For details, see PDF profile.

Once you have applied all the desired settings, click Download, Store, or Delete, depending on the action you specified at the top of the layout. The system submits your PDF job. Once completed, the browser automatically downloads the resulting file. You also receive a confirmation email with a link to your PDFs to download.

Mass PDF progress bar

The PDF application has a progress bar where you can see the status of your job, the number of documents completed, percentage completed, and the total duration of the job from start to completion. The progress bar will show the following status:

  • Creating—your PDF job is being created and added to the queue.
  • Picked up—your PDF has been picked up from the queue.
  • In Progress—your PDFs are being created.
  • Packaging—all PDF were created and now the ZIP file, or the Portfolio file is being created.
  • Completed—job is complete.
  • Mass PDF in progress windowIf the job completes with errors, you have the option to download a .csv file with the list of errors. For example, if you try to create a PDF for a native file that is password protected, or if you try to create a PDF from images and a document doesn't have images, those PDFs will not be created and those documents are included in the .csv error file.

    Mass PDF progress window (with errors)