Config

Article Search needs to be configured with Content-Agent, ICP and Writer providers and endpoints.

go to Plugins > Article Search > settings > Configurations
add your own config inside the configEditor field.

Article Search also needs to be configured with requirements in Mappings section

go to Plugins > Article Search > settings > Mappings
select all the required actions by selecting from the dropdown for each required action.

Advanced feature

example

In your config object you can add your Slug OC-Property in propertiesToFetch and map it in propertyMappings as a slugline

{
    ...
    "propertiesToFetch": [
        "...",
        "Slug",
        "..."
    ],
    "propertyMappings": [
        {...},
        {
            "startpageField": "slugline",
            "ocProperty": "Slug"
        },
        {...}
    ]
    ...
}

results

Fetch article avatars

{
   ...
   "propertiesToFetch": {
        ...
        "ConceptRelations.ConceptAvatarRelation.uuid"
        ...
    },
    "propertiesFilter": {
        {
            "property" : "ConceptRelations",
            "q" : "ConceptImType:channel"
        }
    }
  ...
}

Sort order for SuggestSearch

In the configuration there is possibility to add a 'weight' on a suggest-property. The list is sorted descending, high -> low

{
   ...
   "suggestOrder": {
      "Products": 10,
      "Channels": 5,
      "Subjects": 3
    },
  ...
}

specify with autoSearch to start searching when the plugin has been loaded

{
    ...
   "autoSearch": true
    ...
}

Specify which OC property to use for sorting.

{
    ...
    "sorting": {
        "field": "YOUR_SORT_PROPERTY_FIELD", // or remove sorting object to get the default 'updated'
        "ascending": false
    },
    ...
}

Specify results per page

{
  ...
  "resultsPerPage": 10,
  ...
}

Specify default query that is set when no active suggestions are present

{
  ...
  "defaultQuery": "*:*",
  ...
}

Specify filter query that is added onto the suggestions query and final search query

{
  ...
  "filterQuery": "contenttype:Article",
  ...
}

Specify published property in order to add published as an option in date search

{
    ...
    "propertyMappings": [
        {
          "startpageField": "published",
          "ocProperty": "PubStart"
        },
    ...
}

OC Configuration

Article Search plugin requires that some properties are configured in OpenContent.

Note: There should also be a property with an updated value. We are currently using the default OC property called updated

Properties

- name: Authors
  type: TEXT
  multivalued: true
  sortable: false
  readonly: false
  suggest: true

- name: Headline
  type: TEXT
  multivalued: false
  sortable: false
  readonly: false
  suggest: false

- name: ImageFilenames
  type: STRING
  multivalued: true
  sortable: false
  readonly: false
  suggest: false
  description: Added to support app config.

- name: ImageUuids
  type: STRING
  multivalued: true
  sortable: false
  readonly: false
  suggest: false

- name: NewsPrio
  type: INTEGER
  multivalued: false
  sortable: true
  readonly: false
  suggest: false

- name: NewsPrioLifetime
  type: STRING
  multivalued: false
  sortable: false
  readonly: false
  suggest: false

- name: PubStart
  type: DATE
  multivalued: false
  sortable: true
  readonly: false
  suggest: false
  description: Added to support app config.

  - name: PubStatus
  type: STRING
  multivalued: false
  sortable: false
  readonly: false
  suggest: true
  description: Added to support app config.

- name: Services
  type: STRING
  multivalued: true
  sortable: false
  readonly: false
  suggest: true
  description: The NewsML "service" element to define for example siteContext or Product

- name: Text
  type: TEXT
  multivalued: true
  sortable: false
  readonly: false
  suggest: false

Sorting

Currently the Article Search uses the updated field to make sorting, so this MUST be present

sorting:
    - name: Updated
      indexfields:
          - name: updated
            ascending: false

    - name: Updated
      contenttype: Article

Examples in images

PreviousInstallation and upgrade NextFull config example

Last updated 5 years ago

Was this helpful?