Page History
Solr Publisher Properties
| Field | Required | Default | Multiple | Notes | Example | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| type | Yes | - | No | The value must be "application". | "application" | ||||||
| _type | Yes | - | No | The value must be "application". | "application" | ||||||
| appName | Yes | - | No | The name of the application | "Solr_Publisher" | ||||||
| appType | Yes | - | No | The value must be "solr-publisher". | "solr-publisher" | ||||||
| config | Yes | - | No | The value must be "com.accenture.aspire:app-sample-summarizer". | "com.accenture.aspire:aspire-solr-publisher-source" | ||||||
| description | Yes | - | No | The description | "solr_publisher" | ||||||
| properties | Yes | - | No | Configuration object | |||||||
| useHost | Yes | false | No | Specify a Solr update URL by entering parts of it or the complete path | true / false | ||||||
| solrCore | No | - | No | Solr URL core. Example: myCore. | "test_core" | ||||||
| solrHost | No | - | No | Solr server hostname or IP address. Example: solr.domain.com. | "loclahost" | ||||||
| solrPort | No | 8983 | No | Solr port number. Example: 8983. | "8983" | ||||||
| solrUrl | No | - | No | The complete Solr update URL. Multiple hosts can be added separating them with a semi-colon (;) | "http://localhost:8983/solr/core/update?commitWithin=30000" | ||||||
| authType | No | - | No | Specify the authentication information. Allowed values are: "none" , or "basic" and "aws". | "none" | ||||||
| user | No | - | No | Provide the user for basic authentication. Required if authType is "basic". | "john.doe" | ||||||
| password | No | - | No | Provide the password for basic authentication. Required if authType is "basic". | "myP@ssword11" | awsRegion | No | - | No | Specify the AWS region to use. Required if authType is "aws". | "us-east-2" |
| useCredentialsProviderChain | No | false | No | Enable to specify a credentials provider chain. | true / false | ||||||
| awsAccessKey | No | - | No | Provide the access key for authentication with AWS. Required if authType is "aws" and useCredentialsProviderChain is false. | "AKIAQYO33L5HIS3N55NN" | ||||||
| awsSecretKey | No | - | No | Provide the secret key for authentication with AWS. Required if authType is "aws" and useCredentialsProviderChain is false. | "PPA3Qt+FqUA4Kk07DRS7w4T6Bya1IWebbcqFmqmI" | ||||||
| transformType | Yes | - | No | Type of the transformation file used. | "JSON" | ||||||
| transformFile | Yes | - | No | Path to the transform file. The default value is set to "${component.home}/config/groovy/transform.groovy" for the default JSON transformation file provided with Aspire. | "C:\transformfiles\groovy\mytransform.groovy" | ||||||
| processClear | No | false | No | Set to true to clear the index on full crawls. | true / false | ||||||
| clearType | Yes if processClear = Yes | - | No | Type of the clear. 2 options here : | |||||||
| uploadMappings | No | false | No | Upload Mappings. Relevant for clearType "deleteIndex" | true / false | ||||||
| uploadMappingsFrom | No | false | No | Source for the mappings. Required if uploadMappings is true. If uploadsMappingFrom is true the mappings will be used from the parameter below otherwise from the file | true / false | ||||||
| mappingsText | No | - | No | Mappings specified directly. Required if uploadMappings is true and uploadMappingsFrom is true. | "{\"mappings\":{\"properties\":{\"doc._id\":{\"type\":\"text\",\"fields\":{\"keyword\":{\"type\":\"keyword\"}}}}}}" | ||||||
| uploadMappingsFile | No | - | No | Mappings file path. Required if uploadMappings is true and uploadMappingsFrom is false. | "C:\mappings\myMappings\myMappingsFile.txt" | ||||||
| idleConnectionTimeout | No | - | No | Maximum time (in milliseconds) to keep an idle connection open. | 3600000 | ||||||
| maxConnections | No | - | No | Maximum number of connections to be opened. | 100 | ||||||
| maxConnectionsPerRoute | No | - | No | Maximum number of connections opened for the same target. | 10 | ||||||
| connectionTimeout | No | - | No | Maximum time (in milliseconds) to wait for the connection. | 15000 | ||||||
| socketTimeout | No | - | No | Maximum time (in milliseconds) to wait for a socket response. | 15000 | ||||||
| useThrottling | No | - | No | Set to true to specify Throttling Settings. | true / false | ||||||
| throttlingRate | No | 5000 | No | Time period (in milliseconds) to throttle the connection. | 6000 | ||||||
| throttlingConnectionRate | No | 500 | No | Maximum number of connections used during the Throttling Period. | 600 | ||||||
| maxRetries | No | 3 | No | Maximum number of retries for a failed document. | 5 | ||||||
| retryWaitTime | No | 5 | No | Time period (in milliseconds) to wait before a retry. | 6000 | ||||||
| batchSize | No | - | No | Maximum size of the batches that will be created. | 50 | ||||||
| simultaneousBatches | No | - | No | Number of batches that will be processed simultaneously. | 5 | ||||||
| batchTimeout | No | - | No | Period (in ms) after which a batch of documents will be closed and executed. | 5000 | ||||||
| debug | No | - | No | Set to true to enable debug mode to show debug messages from the publisher. | true / false |
Create example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"type": "application",
"_type": "publisher",
"description "appName": "Solr Publisher",
"appType": "ElasticsearchPublisherTestsolr-publisher",
"config": "com.accenture.aspire:aspire-elasticsearchsolr-publisher-source",
"appTypedescription": "elasticsearch-publisherSolrPublisher",
"appName": "Elasticsearch Publisher",
"properties": {
"elasticNoUrl "useHost": truefalse,
"elasticHost "solrUrl": "myEShost",
"elasticPort": 9200,
"elasticIndex": "test-index",
"authType": "none",
http://localhost:8983/solr/test/update?commitWithin=30000",
"transformType": "JSON",
"transformFile": "${component.home}/config/groovy/transform.groovy",
"authType",
"processClear": false,
: "basic",
"user": "admin",
"password": "encrypted:100CCB558E536015B5765BA68A52E8C3F7EF16359153EFDE8282760EDA8B07D9",
"idleConnectionTimeout": 3600000,
"maxConnections": 100,
"maxConnectionsPerRoute": 10,
"sharedConnection": false,
"connectionTimeout": 15000,
"socketTimeout": 15000,
"useThrottling": false,
"maxRetries": 3,
"retryWaitTime": 5000,
"batchSize": 50,
"simultaneousBatches": 5,
"batchTimeout": 5000,
"debug": false
}
} |
Overview
Content Tools