Instructions for custom mime type in SmartUI

Would you let me know if it exists instructions on how to define the a custom mime type for SmartUI?

On the classic UI we did the following:
Add entries into the following file:
- mime.gifs
- mime.types

Configure the two following sections into the opentext.ini:
- [HHExcludedMIMETypes] to disable hit highlighted.
- [ExcludedMimeTypes] to instruct the Enterprise Extractor to ignore the content of documents of that MIME type, extracting only the metadata from documents of that MIME type in the Content Server database.

Create two icons .giv and stored them into \CS16\support\webdoc
- givaudan-placeholder.gif 16x16
- givaudan-placeholder_large.gif 32x32

Create two .gif stored under \support\mimetypeimages
- application.givaudan-placeholder145.gif 145x145
- application.givaudan-placeholder32.gif 32x32

But these settings does not work for the logos into the SmartUI.

Could you please guide me to new instructions?

Thanks,

JP

Find more posts tagged with

Comments

Ferdinand Prantl

Custom icons for nodes displayed in Smart UI can be added by a Smart UI extension. It can be a custom subtype introduced by a CS module developed inside or outside OpenText. It can be a not-yet recognised MIME type of documents used by a customer. Smart UI extensions are deployed inside a CS module today. If you maintain a solution without an OScript module, you will need to create an empty one to host the static assets of the Smart UI extension (CSS, JS, JSON files).

If you want to replace an existing icon with a custom one, you can do it by a Smart UI style override. It is a stylesheet deployed on a web server and entered on the Smart UI administration page (?func=admin.smartui). The rules in the stylesheet match the original rules assigning the original icon. Because the stylesheet is loaded as the last one on the page, its rules will override the original ones and make the custom icons show up. These stylesheets (and SVG icons) are usually deployed using the Support Asset Volume.

Details: Icons of nodes are assigned in Smart UI by evaluating rules registered for the "csui/utils/nodesprites" extension point. You can specify your custom icon by a rule using any common node property (type, mime_type, reserved, etc.). The most often used are type and mime_type.

Ferdinand Prantl

These instructions have been entered to the internal request LPAD-76702. If you are familiar with the concept of registering for a Smart UI extension point as described in Smart UI SDK, you should be able to follow them

Let us say, that somebody wrote an "acad" extension to add an icon for AutoCAD drawings (DWGs). It would require including the following four files in the Smart UI (extension) project:

src/icons/images/dwg.svg:

The icon image content.

src/icons/icons.css:

.binf-widgets .acad-mime-dwg {
  background-image: url('images/dwg.svg');
}

src/icons/icons.js:

define([
  'css!acad/icons/icons'
], function () {
  return [
    {
      equalsNoCase: {
        mime_type: [
          'application/acad,',
          'application/x-acad,',
          'application/autocad_dwg,',
          'image/x-dwg,',
          'application/dwg,',
          'application/x-dwg,',
          'application/x-autocad,',
          'image/vnd.dwg,',
          'drawing/dwg'
        ]
      },
      className: 'csui-icon acad-mime-dwg',
      mimeType: 'AutoCAD Drawing',
      // Take precedence over the common document icon,
      // which has the default sequence of 100.
      sequence: 50
    }
  ];
});

src/acad-extensions.js:

{
  "csui/utils/nodesprites": {
    "extensions": {
      "acad": [
        "acad/icons/icons"
      ]
    }
  },
  ...
}

Jean Philippe Forti

Thanks Ferdinand.
To be 100% sure, without a dedicated Oscript module using the SmartUI SDK, I cannot add icons for mime types not managed out of the box by Content Server (application/vnd.xmind.workbook for example).
Correct?

Ferdinand Prantl

Yes, Jean-Philippe, you're correct.

Technically, a pure-UI Smart UI extension wouldn't need an OScript module. It's a bunch of JS, CSS and JSON files to be unpacked to the support directory. They are loaded by the browser as static assets from the web server. The OScript module is needed to ensure deployment to each front-end CS server without copying them manually, and to let the /app page know (during the server start), where is that support directory with the Smart UI extension located. We'd have an idea how to make a Smart UI extension more lightweight and easier to deploy, but it got never the appropriate interest. If it is important to you, you could file a feature request about it. Thanks!

Jean Philippe Forti

"If it is important to you, you could file a feature request about it." --> Yes please, make it simple.

Ferdinand Prantl

Jean-Pierre, I'm afraid that you need to file the request at the OT Customer Support. You need to reach the management. This discussion forum is for getting help from engineers, who have usually no influence on the feature planning :-)

Jean Philippe Forti

Is LPAD-76702 enough?

Ferdinand Prantl

Yes, it is. I didn't know that you initiated its creation. (I there are more customers asking the same, they will be added to that issue.)