topic Re: How to search by property in custom model in Alfresco Archive

How to search by property in custom model

tomekszy — Wed, 02 Nov 2016 12:23:58 GMT

Hi,I'm looking for a way to search by custom field in my custom aspect. I found some information, like https://www.bluefishgroup.com/insights/ecm/adding-metadata-fields-to-simple-search-and-live-search-with-alfresco-5/ or How to search metadata of documents ,but it seems very complicated. I can't fi

Re: How to search by property in custom model

ycoulon — Wed, 02 Nov 2016 14:02:16 GMT

Hi,

First could you tell us what version of Alfresco do you use ? It will help to look into the right code base.

For example in the latest version of Alfresco, the files are located in the share-services :

share/live-search-docs.get.config.xml at master · Alfresco/share · GitHub

And

share/search.get.config.xml at master · Alfresco/share · GitHub

If you can't find it in alfresco-remote-api jar look for a jar called share-services.

Regards

Re: How to search by property in custom model

kaynezhang — Wed, 02 Nov 2016 16:21:01 GMT

Both live-search-docs.get.config.xml and search.get.config.xml are packaged in

alfresco-share-services-***.jar under path alfresco/templates/webscripts/org/alfresco/slingshot/search

Yes you can place it at tomcat/webapps/alfresco/WEB-INF/classes/alfresco/extension/templates/webscripts/org/alfresco/slingshot/search

but it is recommeded to place it at /tomcat/shared/classes/alfresco/extension/templates/webscripts/org/alfresco/slingshot/search (make sure /tomcat/shared/classes is configured in your classpah).

Re: How to search by property in custom model

cesarista — Wed, 02 Nov 2016 16:23:07 GMT

Hi:

A direct way of searching for a custom metadata of your content model (without developing) is just to put in Alfresco search something like:

ASPECT:"mycustom:somethingable"

@mycustomroperty:"whatever"

http://docs.alfresco.com/4.2/concepts/rm-searchsyntax-intro.html

Regards.

--C.

Re: How to search by property in custom model

tomekszy — Thu, 03 Nov 2016 12:50:13 GMT

I don't have neither of this directories....

instead of

tomcat/webapps/alfresco/WEB-INF/classes/alfresco/extension/templates/webscripts/org/alfresco/slingshot/search

I have

/home/alfresco/alfresco-community/tomcat/webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/slingshot/rmsearch

- this one is most similar

and instead of

/tomcat/shared/classes/alfresco/extension/templates/webscripts/org/alfresco/slingshot/search

I have

/home/alfresco/alfresco-community/tomcat/shared/classes/alfresco/extension

- and thats it, no templates directory.

Maybe I should made them? But I assume, that if they not exist, Alfresco would not reach to them. Where can I find place to put files?

Re: How to search by property in custom model

kaynezhang — Thu, 03 Nov 2016 13:08:28 GMT

If the folder dose not exist ,please just create it ,it will work. Alfresco will search the folder.

Re: How to search by property in custom model

tomekszy — Thu, 03 Nov 2016 13:42:27 GMT

Thank you, I 'll try that.

But where should I copy files :

exampleModel.xml.sample
example-model-context.xml.sample

after editing them, and removing .sample suffix ? To the same directory as search XMLs? Or leave it with other samle files in /home/alfresco/alfresco-community/tomcat/shared/classes/alfresco/extension directory?

Re: How to search by property in custom model

kaynezhang — Thu, 03 Nov 2016 14:04:55 GMT

exampleModel.xml.sample/example-model-context.xml.sample are located in /home/alfresco/alfresco-community/tomcat//webapps/alfresco/WEB-INF/lib/alfresco-repository-**.jar under path /alfrescoextension

Copy them in to /home/alfresco/alfresco-community/tomcat/shared/classes/alfresco/extension and rename them to exampleModel.xml//example-model-context.xml.

Re: How to search by property in custom model

kalpesh_c2 — Thu, 10 Nov 2016 09:29:40 GMT

I don't know whether you created custom aspect properly. If you want to create custom aspect, you need to create model file and register it through context file.You can place these files in tomcat/shared/classes/alfresco/extension. In extension folder you may find "exampleModel.xml.sample", make a copy of that file in same folder(extension) and remove its .sample extension and make .xml file. After that, edit imports if you want to inherit some aspect defined in other content model this comes under <imports> tag. If you don't want inheritance , keep it as it is. Under <namespaces> tag create your namespace by giving unique URI and prefix. Remove the <types> element. And edit the <aspects> element and define your custom aspect there by giving it's name and add your custom properties in <properties> element. Also in order to make your property indexed add index tag and define its enabled attribute to "true" as code snippet given below:

<index enabled="true">
    <tokenised>TRUE</tokenised>
    <facetable>false</facetable>
</index>

‍‍‍‍‍

At this stage you created custom model which contains your aspect. In order to make alfresco to know your model register it with spring bean from a context file. You can also get sample context file example-model-context.xml, copy it and change its extension as you did before and in that file edit <beans> element and change bean id. And also change the path of the model file to the model file created by you.

After restart of alfresco service this model will be created and you can apply your aspect to any content in repository and can also search its properties through REST API or CMIS or alfresco share.

Here I am assuming you are using share. In order to make your aspect visible to share, edit share-config-custom.xml file present in tomcat/shared/classes/alfresco/web-extension(create if it is not present). Add aspect created by you to <visible> element. And you can edit or create advanced search forms through by placing this code in the same file.

Refer this code if you want to register your own advanced search form

<config replace='true' evaluator='string-compare' condition='AdvancedSearch'>
      <advanced-search>
        <forms>
            <form labelId='search.form.label.cm_content' descriptionId='search.form.desc.cm_content'>cm:content</form>
            <form labelId='search.form.label.cm_folder' descriptionId='search.form.desc.cm_folder'>cm:folder</form>
        </forms>
      </advanced-search>
  </config>
‍‍‍‍‍‍‍‍

And Refer this code to create or edit form

<config evaluator='model-type' condition='cm:folder'>
      <forms>
         <form id='doclib-common'>
            <field-visibility>
               <show id='cm:name' />
               <show id='cm:title' force='true' />
               <show id='cm:description' force='true' />
            </field-visibility>
            <create-form template='../documentlibrary/forms/doclib-common.ftl' />
            <appearance>
               <field id='cm:title'>
                  <control template='/org/alfresco/components/form/controls/textfield.ftl' />
               </field>
            </appearance>
         </form>
         <form id='search'>
            <field-visibility>
               <show id='cm:name' />
               <show id='cm:title' force='true' />
               <show id='cm:description' force='true' />
            </field-visibility>
         </form>
      </forms>
   </config>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

For further details you can go through this link

Apart from share, if you are using CMIS then you can search your properties through query. Or you can also search it by REST APIs provided by alfresco.

Thanks,

Kalpesh

ContCentric

Re: How to search by property in custom model

tomekszy — Thu, 17 Nov 2016 12:32:20 GMT

Hey

I did it thanks to Kalpesh Patel's description (by the way Dobra robota). Thank you very much. But I have one small problem. Properties from my aspects are often lists of predefinied vavues, when one option is already selected, like here:

so if i'm searching anything I have to chose one value from list (in this example, in 'Rodzaj' or 'Projekt Rok' property, there are selected 'Publikacje' and '2000'), but I want be able to search something, that hasn't got my aspect's properties filled, or just search something by only one property.

So I assume, I need to have some "universal" value, which will be some kind of widcard for all other values, but of course if I just add one extra value (named for example "undefinied"), it won't do the trick.

So my question is, how to do that?

Re: How to search by property in custom model

tomekszy — Tue, 13 Dec 2016 14:56:19 GMT

I've managed to do this. I had to add <apperance> for <form id='search'> section and chose control template for each property. Thank you all for all replies and help. This is how it looks like in share-config-custom.xml:

<config replace='true' evaluator='string-compare' condition='AdvancedSearch'>
<advanced-search>
<forms>
<form labelId='search.form.label.cm_content' descriptionId='search.form.desc.cm_content'>cm:content</form>
<form labelId='search.form.label.cm_folder' descriptionId='search.form.desc.cm_folder'>cm:folder</form>
</forms>
</advanced-search>
</config>

<config evaluator='model-type' condition='cm:content'>
<forms>
<form id='doclib-common'>
<field-visibility>
<show id='cm:name' />
<show id='cm:title' force='true' />
<show id='cm:description' force='true' />
<show id='meta:date_asp' force='true' />
<show id='meta:type_asp' force='true' />
<show id='meta:proj-rok_asp' force='true' />
<show id='meta:komorka_asp' force='true' />
</field-visibility>
<create-form template='../documentlibrary/forms/doclib-common.ftl' />
<appearance>
<field id='cm:title'>
<control template='/org/alfresco/components/form/controls/textfield.ftl' />
</field>
</appearance>
</form>
<form id='search'> 
<field-visibility>
<show id='cm:name' />
<show id='cm:title' force='true' />
<show id='cm:description' force='true' />
<show id='meta:date_asp' force='true' />
<show id='meta:type_asp' force='true' />
<show id='meta:proj-rok_asp' force='true' />
<show id='meta:komorka_asp' force='true' />
</field-visibility>
<appearance>
<field id='cm:title'>
<control template='/org/alfresco/components/form/controls/textfield.ftl' />
</field>
<field id='meta:date_asp'>
<control template='/org/alfresco/components/form/controls/daterange.ftl' />
</field>
<field id='meta:type_asp'>
<control template='/org/alfresco/components/form/controls/selectmany.ftl' />
</field>
<field id='meta:proj-rok_asp'>
<control template='/org/alfresco/components/form/controls/selectmany.ftl' />
</field>
</appearance>
</form>
</forms>
</config>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

and this is how looks the final effect:

Re: How to search by property in custom model

christogz — Tue, 21 Mar 2017 16:02:28 GMT

Hi Kayne, Tomasz,

Sorry, newbie here. I followed your thread up until creating nonexistent path;

I've modified alfresco/tomcat/shared/classes/alfresco/web-extension/share-config-custom.xml to include my custom properties;
I've also created the ff. paths:
- alfresco/tomcat/webapps/alfresco/WEB-INF/classes/alfresco/extension/templates/webscripts/org/alfresco/slingshot/search
- alfresco/tomcat/shared/classes/alfresco/extension/extension/templates/webscripts/org/alfresco/slingshot/search
Modified both live-search-docs.get.config.xml and search.get.config.xml to include my custom properties
copied them to the above paths and
restarted alfresco
- alfresco/alfresco.sh restart

Custom properties are still not searchable. What did I miss? Please help

Regards,

ChrisTogz

Re: How to search by property in custom model

mehar460 — Sun, 14 Oct 2018 00:59:48 GMT

Hello,

I am working alfresco enterprise edition v5.2 I couldn't find alfresco-share-services-***.jar anywhere. Please help on this.

I have to search content based two custom attributes (one property from document and another user role)

Re: How to search by property in custom model

douglascrp — Tue, 16 Oct 2018 14:43:23 GMT

Why do you want the jar?

You don't need it at all to configure search.

It would be better if you start a new discussion and explaining what you are trying to do, what you have already tried, and what is not working.