Topic
4 replies Latest Post - ‏2011-08-10T16:53:19Z by TigerTrix
christopha
christopha
9 Posts
ACCEPTED ANSWER

Pinned topic How can I configure a custom title to be shown in the Quickr Connector?

‏2011-08-09T22:25:46Z |
Hello all,

We are archiving documents from a Lotus Notes Database into CM8 using CommonStore for Lotus Domino.

The Item Type has an attribute named "Title" which contains the descriptive title coming from the Notes field "Subject". This item type is Quickr Services enabled using the CMQS admin tool. We ticked "represents the item" for the attribute "Subject" in the item type definition.

We don't get this attribute displayed in the folder tree using the Quickr Connector (desktop integration) in Windows Explorer and the Notes sidebar. There is always the original filename shown, which is not the expected solution.

Does anyone have a solution for that issue?

Christoph
Updated on 2011-08-10T16:53:19Z at 2011-08-10T16:53:19Z by TigerTrix
  • TigerTrix
    TigerTrix
    18 Posts
    ACCEPTED ANSWER

    Re: How can I configure a custom title to be shown in the Quickr Connector?

    ‏2011-08-10T00:20:27Z  in response to christopha
    Background
    There are 2 special fields in Quickr, name & title. All documents and folders are expected to at least have a name so that they can be displayed in search results. A title is optional, and can be more descriptive. For example, name="goneWithTheWind.doc" and title="Gone with the Wind". Or name="A0123sdfrl.htm", title="Some Web Page Title".

    Name and title appear as separate fields in the UI, separate from the list of custom properties.

    Mapping
    These two fields need to be mapped to metadata in any document. Name and title mapping algorithms must land on an attribute for name, and optionally on one for title. There is an ideal case where the an extension that is provided for document types is used and a DocumentTypeExtend tool is used to add such extensions and DB indexes. However, the algorithm will land on an attribute after sorting through the attributes and picking the most likely candidate of a name attribute. The "representative" flag is considered to be an indicator of a name attribute, not title, so it will land on a representative attribute before others. Then it will consider required, unique, and string types before others. It will also leverage the system attribute OrigFileName that appears on some item types such as "resource" classified item types, or often as a last resort OrigFileName on compound document "document" classified item types which have this attribute on document parts which are more expensive to retrieve and not always available due to optimizations. But on non-optimized item types they are normally retrieved and used on compound documents.

    The mapped name attribute will might be still appear in the custom property list for non-ideal cases, or be filtered out for ideal cases. System properties never appear on the custom properties list.
    • TigerTrix
      TigerTrix
      18 Posts
      ACCEPTED ANSWER

      Re: How can I configure a custom title to be shown in the Quickr Connector?

      ‏2011-08-10T00:30:52Z  in response to TigerTrix
      Regarding title mapping, I should mention that the title mapping is the same as name mapping, except that it only lands on root level attributes, never system attributes or OrigFileName on resource items or compound document parts. New values and changes to title are only persisted for ideal case title mappings, which is currently only the DocumentTypeEnable extension for it. However it shows through a root attribute value if not ideal due to the necessity to map something for search results that rely on titles, not file names. But non-ideal cases will most often just look like the file name.

      Also, the name & title ideal case mapping might change in the future to specifically account for "Title" attributes and that often "Title" is designated as "representative". Although no promises or guarantees. Btw, CM CMIS does account for "Title" as a special case in the name & title mapping for such cases.
      • christopha
        christopha
        9 Posts
        ACCEPTED ANSWER

        Re: How can I configure a custom title to be shown in the Quickr Connector?

        ‏2011-08-10T07:25:12Z  in response to TigerTrix
        Thanks for the quick replies!

        Just for clarification some detail explanations:
        • The CM8 attribute called "title" was just an example. In real life it might be named anything, may be "CompanyDocDescription"
        • We don't have any mapping because we are not talking about publishing documents from Lotus Quickr.
        • We have existing documents in CM8 which are in a folder structure. They were and are currently archived by CommonStore for Lotus Domino.
        • After CMQS came up we wanted to access these documents via Quickr Connectors. So we enabled the item type and built a library using the root folder.

        The problem is that CMQS and/or the connectors still show OrigFilieName instead of CompanyDocDescription.
        • TigerTrix
          TigerTrix
          18 Posts
          ACCEPTED ANSWER

          Re: How can I configure a custom title to be shown in the Quickr Connector?

          ‏2011-08-10T16:53:19Z  in response to christopha
          Extending existing item types with the new name & title attributes does not require migration to populate the new column. Adding the clbContent group by the DocumentTypeEnable tool only adds nullable attributes for name & title, and does not copy over values stored in non-standardized locations or less than ideal locations for querying and sorting by name or path. Any new data created or updated through Quickr will have data populated for the new column using whatever value was used in the create or update. Updating the any item through Quickr will copy over the value, but based on the name mapping algorithm. However, existing data that has not been converted or migrated still has a NULL value for the ideal name & title attribute. This is considered partially migrated where new and updated data has the new values, but existing data has NULL. The name & title mapping algorithms will detect NULL for the ideal value and revert to the previous backup plan to report the value that it would have otherwise reported had you not extended the item type. So extending the item type should be seamless from the user perspective because it will not change how the existing data was displayed due to the extension until it is converted. However, it is still based on the name & title mapping algorithms I referred to.

          So it sounds like your issue is with the name or title mapping algorithm not identifying your particular custom attribute for name or title. One thing is that OrigFileName (CM's system attribute on resource item types and compound document model parts / content elements) will always be taken ahead of any custom attribute mapping. The reason is that OrigFileName is really the CM file name attribute for any content elements. The only problem with it was that it wasn't in a standardized location on all item types so it cannot be universally relied upon to query by name or sort by name, except when you account for specific item types or restrict item type classifications. File name is what you would usually expect to appear in Windows Explorer for example. That is why when OrigFileName is available, it will always select it ahead of running through all the root attributes to pick the next best. So mapping goes in order of precedence -- (1) Ideal name attribute (label (or ICM$NAME)), (2) OrigFileName (if available), (3) Some root attr, (4) Item ID. Remember we are speaking of the "name" attribute. Title mapping goes in order of precedence -- (1) Ideal title attribute, (2) Some root attr.

          When a name value is expected, it will always try to use a name value over a title value. I'm not sure if you are trying to get title values to display in place of file name values where file name values are designed to be displayed. However, one problem might be that not all applications populate OrigFileName with a reasonable value if it wasn't important or relevant in the way the particular application was using it. I've seen some applications overwrite it with a temp file name even if Quickr sets it correctly. This is actually an interoperability problem with applications using the core CM data model in a standardized way. In order to interoperate, applications have to account on all applications at least following the core CM data model concepts, if not for themselves, but for potential other applications being able to generically understand the data. The only other alternative for interoperability is for Quickr to add custom handling to account for a proprietary or limited data model that isn't otherwise interoparable on the core CM data model. However, there are many CM solutions that don't all use the core CM data model because it wasn't required. So Quickr does intend to do a best effort to map to as many as possible, but has to land on some name & title mapping algorithm. But perhaps there is more that can be done for your case. For example, in CM CMIS, name & title mapping added accounting for attributes named "FileName" and "Title" specifically. However that is still behind OrigFileName when it comes to name mapping.

          Btw, CM 8.4.3 released a new data model called hierarchical item types. It ensures that all applications that intend to interoperate on basic naming & filing of documents in a browseable way can do so and the server will enforce. It adds a new standardized name attribute, ICM$NAME, to all such item types in a standardized location and is required. It also adds a repository root, and requires filing somewhere under root. The existing version of CM-Quickr can read the new data model, update existing items, but cannot write create new items to it yet. ICM$NAME will become the CM universal standarized name attribute for all item types.

          Question 1:
          So the question is, is there anything specific that we can ask to be done for your particular case to better configure the name & title mapping algorithm to account for it. Hopefully we can identify something generic, like a config setting that can be tweaked for any different data model, or else is there some other clue it can use to know to use an attribute ahead of considering OrigFileName. I think the key will be to dynamically add another "Ideal" case which comes ahead of OrigFileName. For example, if it would first consider one more custom attribute that you configure before considering OrigFileName. But can you please clarify if it is always the a single attribute to account for in any item type, or does it vary in name by item type, where a list of additional attributes could be considered ahead of OrigFileName, maybe in the order you specify.

          Question 2:
          Can you please clarify exactly whether your issue is with Quickr's concept of "name" or "title" so it is clear whether name mapping or title mapping is the issue you have. What I mean is when Quickr intends to display a file name such as the displayed name in Windows Explorer while browsing folders. Or do you mean Quickr's title field which shows up on Properties panels. In Windows Explorer, right click on any file, select "Properties", and you can see both name & title there, although they don't say "name" or "title". But on a Quickr-optimized item type like ClbDocument / Default Integrated Document Type, if if you set them differently, one editable through properties panel and others editable by right-click "rename", you can see the difference. Which exactly is the one you want to pick up the change so we know whether you want to change name mapping or title mapping.