Configuring File Formats - System Administration - Cloud - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Cloud System Administration
Platform
OnBase
Product
System Administration - Cloud
Release
Foundation 23.1
License
Standard
Essential
Premier

Before OnBase can recognize and display a new file type, a File Format must be configured for the file type.

To configure a File Format

  1. In the Configuration module, select Document | File Formats to display the File Format Configuration dialog box.

    • To create a new format, type the name of a new format in the File Format Description field and click Create. The File Format Settings dialog box opens, allowing you to configure the settings for the new format.

    • To edit an existing format, select it from the File Format Description list and click Settings. The File Format Settings dialog box displays.

  2. In the Viewer Types section, select the appropriate type for your file format. See Supported File Formats for more information. OnBase provides several types of standard viewers that you can associate with your new file format. For example, if your file format is a text file (.txt), select Text Report Format.
  3. Enter the appropriate path and file name for the external viewer application in the Command Line field. OnBase uses this path to launch the viewer from within OnBase.
    Note:

    When you are editing the Engineering Drawings or Spicer Document file formats, the View Externally option is available in the File Format Settings dialog box. Select this option to enable the Command Line field and point to an external viewer.

  4. You may also have to provide additional variables in the Command Line field when using custom viewers. These Command Line variables provide more information about the application program's naming conventions and path information. After typing the path to the external viewer application in the Command Line field, enter a space and then one or more of the following Command Line variables.

    • You must have a space preceding the Command Line variables in the Command Line field

    • There can be no blank spaces between multiple variables in the Command Line field

    See the example for a proper Command Line entry for a custom viewer.

    This example has two Command Line variables showing OnBase that it is a path followed by an application with an extension.

    Note:

    You may not know if you need to provide these Command Line variables until after you try and open up a document from within OnBase.

    Note:

    The Web Client does not use the Command Line feature for custom file formats. To use a custom file format in the Web Client, the file format must be set to automatically launch an executable in Windows on the client machine. See Windows documentation on how to configure this.

    Variable

    Description

    Example

    %F

    File name without extension.

    filename

    %N

    File name with extension.

    filename.ext

    %D

    File name followed by a period.

    filename .

    %E

    Extension

    ext

    %P

    Path to file

    c:\path
    Note:

    In these examples, filename represents the file name used by OnBase to identify the document, ext represents the file extension, and path represents the location of the document.
  5. The MIME Type data entry field is required if the data will be accessed via the Web Client. If a Document Type is configured as an OLE file format and its documents are to be accessed via the Web Client, supply the correct MIME (Multipurpose Internet Mail Extension) for the data, as follows:

    OLE File Type

    MIME Type

    MS Word (.doc, .docx)

    application/msword

    MS Excel (.xls, .xlsx)

    application/vnd.ms-excel

    Note:

    To allow users to open CSV documents from the Web Client using Microsoft Excel, see CSV File Formats.

    MS PowerPoint (.ppt, .pptx)

    application/vnd.ms-powerpoint

    MS Publisher (.pub)

    application/x-mspublisher

    Adobe Acrobat (.pdf)

    application/pdf

    If you set the Default Extension to ??? for a file format configured with an OLE Viewer Type, ensure the MIME Type field specifies the appropriate application to open documents indexed with the selected file format.

    Note:

    You can only print documents that use custom file formats if a MIME type has been specified for that custom file format.

  6. Click Close.
  7. Click Save.