KBA-01439: Overview of the FileTypeConfig rules

Overview:

The FileTypeConfig rules control various optional behavior and handling of files.

The FileTypeConfig rule group is found in the Rules Maintenance tool on the System Admin Dashboard. Each rule in the group consists of a rule name, a filter value (which can be blank) and a result value.


Filter Value:

Any File type

The FileTypeConfig rules accept any file type (as indicated by filename extension) as the filter value.


Result Value:

Varies

Result values for the FileTypeConfig rules depend on the rule and are indicated within the description of each rule. Some rules are enabled and disabled through a checkbox in the result value, for example:

checkbox result value


Rules:

AliasTo

Specifies (in the result value) the already configured file type whose configuration should be used to automatically configure the filter file type. This rule saves you from setting up the following rules for similar file types.

EditIcon

Specifies (in the result value) the icon image that will appear for files of the indicated type that will allow editing of the file, if the user has appropriate native editing software and permission to edit. In addition, this icon only applies to users accessing the system via the “Full Spitfire Dashboard”.  The full dashboard includes the Windows integration components necessary to checkout the file, download it, monitor the edit session and upload/check the new version.  For users that are logged in via other browsers, this icon is suppressed.  The result value accepts any filename with an image extension (e.g., word.png or word.jpg). This icon file must be in the web application images folder on the IIS server. (See also KBA-01452.)

KBA01439_01

  • 0 = disable editing for the file type indicated in the filter value.

SummaryIcon

Specifies (in the result value) the image that will appear for files of the indicated type beneath the attachment grid to summarize the number of similar files attached.  To exclude a file type from the summary, specify 0 as the result value.  If this rule is not present for a file type, the ViewIcon (below) is used.

ViewIcon

Specifies (in the result value) the image that will appear for files of the indicated type that will allow viewing of the file, if the user has appropriate native editing software and permission to view. The result value accepts any filename with image extension (e.g., word.png or word.jpg). This icon file must be in the web application images folder on the IIS server.

KBA01439_02

  • 0 = disable editing of the file type indicated in the filter value.

ViewIcon:Generic

Specifies (in the result value) the image that will appear for files of the indicated type on mobile devices and browser-based dashboards, allowing viewing of the file. The result value accepts any filename with an image extension (e.g., word.png or word.jpg). This icon file must be in the web application images folder on the IIS server. The default for this rule is the result value for the ViewIcon rule.

  • 0 = disable viewing of the file type indicated in the filter value.
  • E = use the result value configured for the EditIcon rule.

ViewViaHTML

Specifies (in the result value) the HTML that should be rendered to offer the file type for viewing. See KBA-01064. There is no default.

VVHAutoOpen

Specifies (in the result value checkbox) whether HTML-viewed files should be opened automatically using javascript. This rule is ignored if the ViewViaHTM rule (above) is not specified.

  • unchecked = No (default).
  • checked = Yes.

WXFileClass

(V2021+) Specifies (in the result value) a Webix file class for use in the Power UX catalog.  Possible result values are shown below with some distributed examples

  • “archive” for .zip and gz files
  • “audio” for .mp3 and wav
  • “code” for .html, js and css
  • “document” for docx and pdf
  • “video” for mp4 and avi
  • “image” for .png and jpg
  • “file” the default for any file of unspecified type

Additional Comments:

For more information, see the Focus on System Administration guide.


KBA-01439; Last updated: February 10, 2023 at 13:39 pm; green text = new
Keywords:  rule