wso2 / wso2/docs-apim

No any documentation for solr indexing configurations in registry.xml

Open
#6,593 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:
Hi team,
There are no any official documentation available for the public for the solr configuration parameters available in the registry.xml file.
Having proper explanation for these parameters is important for the users/customer who are trying to optimise the time taken for indexing.

i.e:
indexingConfiguration> <startIndexing>true</startIndexing> <skipCache>true</skipCache> <startingDelayInSeconds>35</startingDelayInSeconds> <indexingFrequencyInSeconds>3</indexingFrequencyInSeconds> <!--number of resources submit for given indexing thread --> <batchSize>40</batchSize> <!--number of worker threads for indexing --> <indexerPoolSize>40</indexerPoolSize> <!-- location storing the time the indexing took place--> <lastAccessTimeLocation>/_system/local/repository/components/org.wso2.carbon.registry/indexing/lastaccesstime</lastAccessTimeLocation> <!-- the indexers that implement the indexer interface for a relevant media type/(s) --> <indexers> <!--indexer class="org.wso2.carbon.registry.indexing.indexer.MSExcelIndexer" mediaTypeRegEx="application/vnd.ms-excel"/> <indexer class="org.wso2.carbon.registry.indexing.indexer.MSPowerpointIndexer" mediaTypeRegEx="application/vnd.ms-powerpoint"/> <indexer class="org.wso2.carbon.registry.indexing.indexer.MSWordIndexer" mediaTypeRegEx="application/msword"/> <indexer class="org.wso2.carbon.registry.indexing.indexer.PDFIndexer" mediaTypeRegEx="application/pdf"/> <indexer class="org.wso2.carbon.registry.indexing.indexer.XMLIndexer" mediaTypeRegEx="application/xml"/--> <!--indexer class="org.wso2.carbon.governance.registry.extensions.indexers.RXTIndexer" mediaTypeRegEx="application/wsdl\+xml" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> <indexer class="org.wso2.carbon.governance.registry.extensions.indexers.RXTIndexer" mediaTypeRegEx="application/x-xsd\+xml " profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> <indexer class="org.wso2.carbon.governance.registry.extensions.indexers.RXTIndexer" mediaTypeRegEx="application/policy\+xml" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/--> <indexer class="org.wso2.carbon.apimgt.impl.indexing.indexer.DocumentIndexer" mediaTypeRegEx="application/vnd.wso2-document\+xml" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> <indexer class="org.wso2.carbon.apimgt.impl.indexing.indexer.CustomAPIIndexer" mediaTypeRegEx="application/vnd.(.)+\+xml" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> <!--indexer class="org.wso2.carbon.registry.indexing.indexer.XMLIndexer" mediaTypeRegEx="application/(.)+\+xml"/> <indexer class="org.wso2.carbon.registry.indexing.indexer.PlainTextIndexer" mediaTypeRegEx="text/(.)+"/> <indexer class="org.wso2.carbon.registry.indexing.indexer.PlainTextIndexer" mediaTypeRegEx="application/x-javascript"/--> <indexer class="org.wso2.carbon.apimgt.impl.indexing.indexer.PlainTextIndexer" mediaTypeRegEx="text/plain+" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> <indexer class="org.wso2.carbon.apimgt.impl.indexing.indexer.PDFIndexer" mediaTypeRegEx="application/pdf" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> <indexer class="org.wso2.carbon.apimgt.impl.indexing.indexer.MSWordIndexer" mediaTypeRegEx="application/msword" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> <indexer class="org.wso2.carbon.apimgt.impl.indexing.indexer.MSPowerpointIndexer" mediaTypeRegEx="application/vnd.ms-powerpoint" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> <indexer class="org.wso2.carbon.apimgt.impl.indexing.indexer.MSExcelIndexer" mediaTypeRegEx="application/vnd.ms-excel" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> <indexer class="org.wso2.carbon.apimgt.impl.indexing.indexer.XMLIndexer" mediaTypeRegEx="application/xml" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> <indexer class="org.wso2.carbon.apimgt.impl.indexing.indexer.WSDLIndexer" mediaTypeRegEx="application/api-wsdl" profiles ="default,api-devportal-deprecated,api-publisher-deprecated,control-plane"/> </indexers> <exclusions> <exclusion pathRegEx="/_system/config/repository/dashboards/gadgets/swfobject1-5/.*[.]html"/> <exclusion pathRegEx="/_system/local/repository/components/org[.]wso2[.]carbon[.]registry/mount/.*"/> </exclusions> </indexingConfiguration>

Suggested Labels:

Suggested Assignees:

Affected Product Version:
APIM 400

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating registry.xml and the existing APIM documentation structure for configuration references. Document the purpose of the listed indexingConfiguration parameters, indexers, and exclusions, with enough guidance for users tuning indexing time; done means the registry.xml settings are explained in the public documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, search
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.