Create Value Count Summarizer

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "application"“application”."application"	“application”
_type	Yes	-	No	The value must be "application"“application”."application"	“application”
appName	Yes	-	No	The name of the application	"ValCountSum"“ValCountSum”
appType	Yes	-	No	The value must be "valuecount“valuecount-summarizer"summarizer”."valuecount	“valuecount-summarizer"summarizer”
config	Yes	-	No	The value must be "com“com.accenture.aspire:app-valuecount-summarizer"summarizer”."com	“com.accenture.aspire:app-valuecount-summarizer"summarizer”
description	Yes	-	No	The description	"count“count-summarizer"summarizer”
properties	Yes	-	No	Configuration object
processIntegerTypes	Yes	true	No	If enabled, integer values will be counted.	true
addUniqueIntegerValues	Yes	true	No	If enabled, unique integer values will be processed as sub jobs.	true

Example

Code Block

theme	RDark
title	POST aspire/_api/credentials

{
    "type": "<Connector Type>",
    "description": "<Connector Name> Credential",
    "properties": {
		
    }
}

Update Credential

Field

Required

Default

Multiple

NotesExampleidYes-NoId of the credential to update."2f287669-d163-4e35-ad17-6bbfe9df3778"descriptionYes-NoName of the credential object.

"Value Count SummarizerCredential"

propertiesYes-NoConfiguration object

Example

Code Block

theme	RDark
title	PUT aspire/_api/credentials/2a5ca234-e328-4d40-bb2a-2df3e550b065

{
    "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
    "description": "<Connector Name> Credential",
    "properties": {
		
    }
}


uniqueIntegerThresholdType	Yes	percentage	No	Type of threshold (“percentage” or “maxCount”) to use to determine which unique values will be processed as sub jobs	“maxCount”
pctgIntegerThreshold	No	0.05	No	Only values whose count is above this threshold of the total values will be processed. Used only if the threshold type is “percentage”.	0.05
maxUniqueIntegerValues	No	1000	No	The number of unique values to process, after reaching the sample size, other values will be ignored. Used only if the threshold type is “maxCount”	1000
processFloatTypes	Yes	true	No	If enabled, float values will be counted.	true
addUniqueFloatValues	Yes	true	No	If enabled, unique float values will be processed as sub jobs.	true
uniqueFloatThresholdType	Yes	percentage	No	Type of threshold (“percentage” or “maxCount”) to use to determine which unique values will be processed as sub jobs	“maxCount”
pctgFloatThreshold	No	0.05	No	Only values whose count is above this threshold of the total values will be processed. Used only if the threshold type is “percentage”.	0.05
maxUniqueFloatValues	No	1000	No	The number of unique values to process, after reaching the sample size, other values will be ignored. Used only if the threshold type is “maxCount”	1000
processTextTypes	Yes	true	No	If enabled, text values will be counted.	true
addUniqueTextValues	Yes	true	No	If enabled, unique text values will be processed as sub jobs.	true
uniqueTextThresholdType	Yes	percentage	No	Type of threshold (“percentage” or “maxCount”) to use to determine which unique values will be processed as sub jobs	“maxCount”
pctgTextThreshold	No	0.05	No	Only values whose count is above this threshold of the total values will be processed. Used only if the threshold type is “percentage”.	0.05
maxUniqueFloatValues	No	1000	No	The number of unique values to process, after reaching the sample size other values will be ignored. Used only if the threshold type is “maxCount”	1000

Create Connection

Field

Required

Default

Multiple

Notes

Example

typeYes-No

The value must be

descriptionYes-NoName of the connection object.

"MyValue Count SummarizerConnection"

throttlePolicyNo-NoId of the throttle policy that applies to this connection object."f5587cee-9116-4011-b3a9-6b235b333a1b"routingPoliciesNo[ ]YesThe ids of the routing policies that this connection will use.["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]propertiesYes-NoConfiguration object

Example

Code Block

theme	RDark
title	POST /aspire/_api/connections/workflows/{workflow}/rules

{
    "type": "<Connector Type>application",
    "description_type": "<Connector Name> Test Connectorapplication",
    "propertiesappName": {
         
    }
}

Update Connection

Field

Required

Default

Multiple

Notes

Example

idYes-NoId of the connection to update"89d6632a-a296-426c-adb0-d442adcab4b0",descriptionNo-NoName of the connection object.

"MyImage RemovedConnection"

throttlePolicyNo-NoId of the throttle policy that applies to this connection object."f5587cee-9116-4011-b3a9-6b235b333a1b"routingPoliciesNo[ ]YesThe ids of the routing policies that this connection will use.["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]propertiesYes-NoConfiguration object

Example

Code Block

theme	RDark

{
    "id": "89d6632a-a296-426c-adb0-d442adcab4b0",
    "description": "<Connector Name> Test Connector",
    "Valuecount_Summarizer",
  "appType": "valuecount-summarizer",
  "config": "com.accenture.aspire:app-valuecount-summarizer",
  "description": "count-summarizers",
  "properties": {
        "processIntegerTypes": true,
    }
}

Create Connector Instance

For the creation of the Connector object using the Rest API check this page

Update Connector Instance

For the update of the Connector object using the Rest API check this page

Create Seed

Field

Required

Default

Multiple

Notes

Example

seedYes-No<seed description>typeYes-No

The value must be .

descriptionYes-NoName of the seed object.

"My Value Count Summarizer Seed"

connectorYes-NoThe id of the connector to be used with this seed. The connector type must match the seed type."82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"connectionYes-NoThe id of the connection to be used with this seed. The connection type must match the seed type."602d3700-28dd-4a6a-8b51-e4a663fe9ee6"workflowsNo[ ]YesThe ids of the workflows that will be executed for the documents crawled.["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]throttlePolicyNo-NoId of the throttle policy that applies to this connection object."f5587cee-9116-4011-b3a9-6b235b333a1b"routingPoliciesNo[ ]YesThe ids of the routing policies that this seed will use.["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]tagsNo[ ]YesThe tags of the seed. These can be used to filter the seed["tag1", "tag2"]propertiesYes-NoConfiguration object

Example

Code Block

theme	RDark
title	POST aspire/_api/seeds

{"addUniqueIntegerValues": true,
    "typeuniqueIntegerThresholdType": "<Connector Type>percentage",
    "seedpctgIntegerThreshold": "directory"0.05,
    "connectorprocessFloatTypes": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"true,
    "descriptionaddUniqueFloatValues": "<connector>_Test_Seed"true,
    "throttlePolicyuniqueFloatThresholdType": "6b8b5f23-fc77-47a1-9b58-106577162e7bpercentage",
    "routingPoliciespctgFloatThreshold": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],0.05,
    "connectionprocessTextTypes": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6"true,
    "workflowsaddUniqueTextValues": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]true,
    "tagsuniqueTextThresholdType": ["tag1percentage", "tag2"],
    "propertiespctgTextThreshold": {0.05,
        "debug": false
    }
}

Update

Seed

Value Count Summarizer

Field

Required

Default

Multiple

Notes

Example

id

Yes

-

No

Id

ID of the

seed

application to update

.

"2f287669

“61014782-

d163

442a-

4e35

4587-

ad17

ab85-

6bbfe9df3778"

ba1439a7f7b5”

seed

type

No

Yes

-

No

<seed description>description

The value must be “application”.	“application”
_type	Yes

No

-

No

Name of the seed object.

"MyValue Count SummarizerSeed"

connector

The value must be “application”.	“application”
appName	Yes

No

-

No

The

id of the connector to be used with this seed. The connector type must match the seed type."82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"

name of the application	“ValCountSum”
appType	Yes	-	No	The value must be “valuecount-summarizer”.	“valuecount-summarizer”
config	Yes

connectionNo

-

No

The

id of the connection to be used with this seed. The connection type must match the seed type."602d3700-28dd-4a6a-8b51-e4a663fe9ee6"

properties	Yes	-	No	Configuration object
value must be “com.accenture.aspire:app-valuecount-summarizer”.	“com.accenture.aspire:app-valuecount-summarizer”
description	Yes	-	No	The description	“count-summarizer”
processIntegerTypes	Yes	true	No	If enabled, integer values will be counted.	true
addUniqueIntegerValues	Yes	true	No	If enabled, unique integer values will be processed as sub jobs.	true
uniqueIntegerThresholdType	Yes	percentage	No	Type of threshold (“percentage” or “maxCount”) to use to determine which unique values will be processed as sub jobs	“maxCount”
pctgIntegerThreshold	No	0.05	No	Only values whose count is above this threshold of the total values will be processed. Used only if the threshold type is “percentage”.	0.05
maxUniqueIntegerValues	No	1000	No	The number of unique values to process, after reaching the sample size, other values will be ignored. Used only if the threshold type is “maxCount”.	1000
processFloatTypes	Yes	true	No	If enabled, float values will be counted.	true
addUniqueFloatValues	Yes	true	No	If enabled, unique float values will be processed as sub jobs.	true
uniqueFloatThresholdType	Yes	percentage	No	Type of threshold (“percentage” or “maxCount”) to use to determine which unique values will be processed as sub jobs	“maxCount”
pctgFloatThreshold	No	0.05	No	Only values whose count is above this threshold of the total values will be processed. Used only if the threshold type is “percentage”.	0.05
maxUniqueFloatValues	No	1000	No	The number of unique values to process, after reaching the sample size, other values will be ignored. Used only if the threshold type is “maxCount”.	1000
processTextTypes	Yes	true	No	If enabled, text values will be counted.	true
addUniqueTextValues	Yes	true	No	If enabled, unique text values will be processed as sub jobs.	true
uniqueTextThresholdType	Yes	percentage	No	Type of threshold (“percentage” or “maxCount”) to use to determine which unique values will be processed as sub jobs	“maxCount”
pctgTextThreshold	No	0.05	No	Only values whose count is above this threshold of the total values will be processed. Used only if the threshold type is “percentage”.	0.05
maxUniqueFloatValues	No	1000	No	The number of unique values to process, after reaching the sample size, other values will be ignored. Used only if the threshold type is “maxCount”.	1000

workflowsNo[ ]YesThe ids of the workflows that will be executed for the documents crawled.["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]workflows.addNo[ ]YesThe ids of the workflows to add.["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]workflows.removeNo[ ]YesThe ids of the workflows to remove.["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]throttlePolicyNo-NoId of the throttle policy that applies to this connection object."f5587cee-9116-4011-b3a9-6b235b333a1b"routingPoliciesNo[ ]YesThe ids of the routing policies that this seed will use.["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]routingPolicies.addNo[ ]YesThe ids of the routingPolicies to add.["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]routingPolicies.removeNo[ ]YesThe ids of the routingPolicies to remove.["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"]tagsNo[ ]YesThe tags of the seed. These can be used to filter the seed["tag1", "tag3"]tags.addNo[ ]YesThe tags to add["tag4"]tags.removeNo[ ]YesThe tags to remove["tag2"]propertiesYes-NoConfiguration object

Example

Code Block

theme	RDark
title	PUT /aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778/workflows/{workflow}/rules/{id}

{
    "id": "2f28766961014782-d163442a-4e354587-ad17ab85-6bbfe9df3778ba1439a7f7b5",
  "type": "application",
  "seed_type": "<seed example>application",
  "appName": "Valuecount_Summarizer",
  "appType": "valuecount-summarizer",
  "connectorconfig": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31com.accenture.aspire:app-valuecount-summarizer",
    "description": "<connector>_Test_Seed",count-summarizers",
  "properties": {
    "throttlePolicyprocessIntegerTypes": true,
 "6b8b5f23-fc77-47a1-9b58-106577162e7b"   "addUniqueIntegerValues": true,
    "routingPoliciesuniqueIntegerThresholdType": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"percentage",
    "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]pctgIntegerThreshold": 0.05,
    "connectionprocessFloatTypes": true,
 "602d3700-28dd-4a6a-8b51-e4a663fe9ee6"   "addUniqueFloatValues": true,
    "workflowsuniqueFloatThresholdType": ["b255e950-1dac-46dc-8f86-1238b2fbdf27"percentage",
 "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]   "pctgFloatThreshold": 0.05,
    "tagsprocessTextTypes": ["tag"true,
    "tag2addUniqueTextValues"]: true,
    "propertiesuniqueTextThresholdType": {"percentage",
    "pctgTextThreshold": 0.05,
   
 "debug": false
  }
}

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Create Value Count Summarizer

Example

Update Credential

Example

Create Connection

Example

Update Connection

Example

Create Connector Instance

Update Connector Instance

Create Seed

Example

Update

Value Count Summarizer

Example

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

Key

Create Value Count Summarizer

Example

Update Credential

Example

Create Connection

Example

Update Connection

Example

Create Connector Instance

Update Connector Instance

Create Seed

Example

Update

Value Count Summarizer

Example