Izara Wiki - User contributions [en]

2025-04-17 - LinkPath structure and examples

2026-04-30T03:08:54Z

Praew:

[[Service - Search Results]]

= requiredData normalize structure =
* component => requiredDataObjects , linkPathObjects, linkPathSteps

<syntaxhighlight lang="js">

{
requiredDataObjects: {
hash_requiredDataObjectA: { //* normal requiredData
fieldName: "fieldname if main objType or last fieldName for linkPath",
},
hash_requiredDataObjectB: { //* has LinkPath
fieldName: "fieldname if main objType or last fieldName for linkPath",
linkPathObjectId: "hash_linkPathA",
complexFilterCombinationIds: [ //* has applyCombinations
"xxxxx",
"xxxxx"
]
}
},
linkPathObjects: {
hash_linkPathA: {
initialObjType: {
serviceTag: "ProductManager",
objectType: "product"
},
linkSteps: [
"hash_linkStepB_1",
"hash_linkStepB_2"
]
},
ref_linkPathObjectC: {
initialObjType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
linkSteps: [
"hash_linkStepC_1",
"hash_linkStepC_2"
]
}
},
linkPathSteps: {
hash_linkStepB_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer"
},
direction: "from"
},

//------ conditions by link ------// : optional
filterObjectId: "ref_filterMainIdA",
aggregate: "max",
sortFields: [
{
fieldName: "xxx",
dataType: "string",
sortOrder: 'descending',
refFieldNameId: 'ref_fieldNameIdC'
}
],
requiredDataObjects: {
'ref_fieldNameIdC': {
fieldName: 'ccc',
linkPathObjectId: 'ref_linkPathObjectC'
}
},
},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "from"
},
//------ conditions by link ------//
filterObjectId: "ref_filterMainIdA",
aggregate: "max",
sortFields: [
{
fieldName: "xxx",
dataType: "string",
sortOrder: 'descending',
}
],
combine: "true",
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "50",
requestProperties: {
tag_xxxx: "value"
},
perParentCombinationIds: [
{
tag: "tag_xxxxx",
filterMainId: "xxxxx"
}
],
applyCombinations: [
{
tag: "tag_xxxxx",
filterMainId: "xxxxx"
}
]
},
"hash_linkStepC_1": {},
"hash_linkStepC_2": {}
}
}

</syntaxhighlight>

== ProcessSearchResultMessage ==
* Fetch and Sort Product Sizes by Language with Fallback
<syntaxhighlight lang="js">

Need to fetch all sizes, sorted by language order 'en', 'th'.
If a translation is missing for any language in sortArray: ['en', 'th'],
fallback to the defaultTranslationLink of that productAttribute.
ProductAttributeLabel with labelId = 'Id_X' represents a size.
identifiersIdArray contains all productAttributeIds linked to ProductAttributeLabel where labelId='Id_X'.
</syntaxhighlight>

<syntaxhighlight lang="js">

let processSearchResultMessage = {
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
},
requiredData: [
{
fieldName: 'text', //all sizes by languageId, where text is the identifiers of the translation objectType, which is the final link step of this requiredData
linkPath: [
{
link: {
relType: {
serviceTag: 'Translations',
relationshipTag: 'hasTranslationLink'
// Must use hasTranslationLink because it will be automatically added by inserting a filterElement with logicalType: "translateIds"
// where identifiers come from identifiersIdArray (Process-ComplexFilter), along with a filterElement of type: "logicalOperator" and operator: "and"
},
objType: {
serviceTag: 'Translations',
objectType: 'translationLink'
},
direction: 'from'
},
aggregate: 'min', //if 'min' sorts languages in order 'en', 'th', //if max sorts languages in order 'th', 'en
sortFields: {
fieldName: 'languageId',
dataType: 'array',
sortArray: ['en', 'th'] // sorts languages according to sortArray
},
filterElements: [
{
type: 'group',
elements: [
{
type: 'traversal',
traversals: [
{
fields: {
languageId: { anyValue: ['en', 'th'] },
textTag: 'productAttributeValue'
},
link: {
relationshipDirection: 'from',
relType: {
serviceTag: 'Translations',
relationshipTag: 'currentTranslationLink'
}
}
},
{
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
}
}
]
},
{
type: 'logicalOperator', operator: 'or'
},
{
type: 'traversal',
traversals: [
{
fields: {
textTag: 'productAttributeValue'
},
link: {
relationshipDirection: 'from',
relType: {
serviceTag: 'Translations',
relationshipTag: 'defaultTranslationLink'
}
}
},
{
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
}
}
]
}
]
}
]
},
{
link: {
relType: {
serviceTag: 'Translations',
relationshipTag: 'isTranslation'
},
objType: {
serviceTag: 'Translations',
objectType: 'translation'
},
direction: 'from'
}
}
]
}
],
filter: {
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
},
elements: [
{
type: 'complexFilter',
complexFilter: {
objType: {
serviceTag: 'ProductAttribute',
objectType: 'ProductAttributeLabel'
},
relType: {
serviceTag: 'ProductAttribute',
relationshipTag: 'isProductAttributeLabel'
},
direction: 'from',
elements: [
{
type: 'logical',
fieldName: 'labelId',
comparison: 'equals',
value: 'Id_X'
}
]
}
}
]
},
requestProperties: {},
identifiersIdArray: [
{
identifiersId: 'hashOfIdentifiersObject_1',
identifiers: {
productAttributeId: 'productAttributeId_uuid_1'
}
},
{
identifiersId: 'hashOfIdentifiersObject_2',
identifiers: {
productAttributeId: 'productAttributeId_uuid_2'
}
},
{
identifiersId: 'hashOfIdentifiersObject_3',
identifiers: {
productAttributeId: 'productAttributeId_uuid_3'
}
}
]
}

</syntaxhighlight>

== example search and sort request ==

<syntaxhighlight lang="js">

{
"objType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"searchResultId":"8e5fecd40a27e47f89cd2743916c0044f0f69bc6",
"searchDetailId":"3462d3248d3af9406554f1c218b63442d26ac2e5",
"requiredDataObjects":{
"4c8e7879d26e6fa7ab85ded25a79a541754c5a3c":{
"fieldName":"productId",
"linkPathObjectId":"1a8a3f9c2c3ea5eaad1f42385362de5dd11cde8a"
},
"c799f11507529f0fb6fa712568596d24b6507d40":{
"fieldName":"sellOfferHandlerServiceTag",
"linkPathObjectId":"5909f82f27bd6c1f921e95b88a65b6e4727a6532",
"complexFilterCombinationIds":[
"88d9c5b9ab36d8c3ebf17e8322541b9c64cae25b",
"51509dea0a7ba2746dbd24769b8e777f1411f3ff",
"d7a7f875254e856b4205075826631ec042b4c821",
"b96447ae98c95858694ca5ec407750c559825930"
]
}
},
"searchParams":{
"filterObjectId":"8e5fecd40a27e47f89cd2743916c0044f0f69bc6"
},
"filterElements":{
"8e5fecd40a27e47f89cd2743916c0044f0f69bc6":{
"objType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"filterElement":{
"filterType":"logical",
"fieldName":"sellOfferId",
"comparison":"equals",
"value":"sellOfferId_001"
}
},
"d92ca4f68dc0d474cfdc10a6c702a5c7224a822c":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"logical",
"fieldName":"rateTableId",
"comparison":"highLow",
"valueType":"perParentIdentifier",
"perParentIdentifierFieldname":"sellOfferId"
}
},
"cd378bc32fbc9a46929c9a9d590e7d77243a839c":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"logical",
"fieldName":"rateTableId",
"comparison":"lessThanEquals",
"value":"cccc"
}
},
"0c287df25d6ff203be7cc9faa2390f6ab0df3878":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"operation",
"filterElementLeft":"d92ca4f68dc0d474cfdc10a6c702a5c7224a822c",
"filterElementRight":"cd378bc32fbc9a46929c9a9d590e7d77243a839c",
"operator":"AND"
}
},
"e0b8534452e98796f144c83a221764ef32db5ab6":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"childComplexFilter",
"childFilterElementId":"0c287df25d6ff203be7cc9faa2390f6ab0df3878",
"pathLinkType":{
"relType":{
"serviceTag":"DeliveryMethodRAT",
"relationshipTag":"disabledDeliversTolocationNode"
},
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"direction":"to"
},
"requestProperties":{}
}
},
"88d9c5b9ab36d8c3ebf17e8322541b9c64cae25b":{
"objType":{
"serviceTag":"SellOfferPlan",
"objectType":"sellOfferPlan"
},
"filterElement":{
"filterType":"logical",
"fieldName":"currencyId",
"comparison":"lessThan",
"value":"bbbb"
}
},
"51509dea0a7ba2746dbd24769b8e777f1411f3ff":{
"objType":{
"serviceTag":"SellOfferPlan",
"objectType":"sellOfferPlanUserPaymentMethodLink"
},
"filterElement":{
"filterType":"logical",
"fieldName":"sellOfferPlanUserPaymentMethodLinkId",
"comparison":"lessThan",
"value":"bbbb"
}
},
"a5491ba3deb74e523741c8cfeb845f49db444a9c":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"logical",
"fieldName":"locationNodeId",
"comparison":"lessThan",
"value":"cccc"
}
},
"7820aef170ae6c3e723382d6bc81d7b12a674974":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"logical",
"fieldName":"rateTableId",
"comparison":"highLow",
"value":"aaaa"
}
},
"554fc368ec36c13a93e3c71c8081951060965bb2":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"childComplexFilter",
"childFilterElementId":"7820aef170ae6c3e723382d6bc81d7b12a674974",
"pathLinkType":{
"relType":{
"serviceTag":"DeliveryMethodRAT",
"relationshipTag":"deliversToLocationNode"
},
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"direction":"to"
},
"requestProperties":{}
}
},
"d7a7f875254e856b4205075826631ec042b4c821":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"operation",
"filterElementLeft":"a5491ba3deb74e523741c8cfeb845f49db444a9c",
"filterElementRight":"554fc368ec36c13a93e3c71c8081951060965bb2",
"operator":"OR"
}
},
"b96447ae98c95858694ca5ec407750c559825930":{
"objType":{
"serviceTag":"SellOfferPlan",
"objectType":"sellOfferPlanUserPaymentMethodLink"
},
"filterElement":{
"filterType":"operation",
"filterElementLeft":"5faa4000cfb72e7aa28603a7740c212f6d6db5e0",
"filterElementRight":"a1aa8d2907f8b6f24e7b66116129838e978bcaee",
"operator":"OR"
}
}
},
"linkPathObjects":{
"1a8a3f9c2c3ea5eaad1f42385362de5dd11cde8a":{
"initialObjType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"linkSteps":[
"fa9a637eb09df71d939b3d914eb9ee27ae83048e",
"d3e2d36cab6d9441db10a7c983834cf9196398b3",
"fa9a637eb09df71d939b3d914eb9ee27ae83048e"
]
},
"2794814ec253fc93496bfcb50ea18ebfe640bf4d":{
"initialObjType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"linkSteps":[
"fa9a637eb09df71d939b3d914eb9ee27ae83048e",
"11704ae9a828b4709300964e2e0361bad13db5c3",
"964050f23f92b45a1ea573a573c50ae3ca2bae18"
]
},
"5909f82f27bd6c1f921e95b88a65b6e4727a6532":{
"initialObjType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"linkSteps":[
"fa9a637eb09df71d939b3d914eb9ee27ae83048e",
"634dd9295fcb1834de0a6ed1f1ab8a9fa06c4d7f",
"d3fc84fa4444406cef2de49baf53d38ab86cd2e0",
"2b0537fa34ee1d259488fce12204dd549e1c98a3"
]
}
},
"linkPathSteps":{
"fa9a637eb09df71d939b3d914eb9ee27ae83048e":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"ProductManager",
"objectType":"product"
},
"direction":"to"
}
},
"d3e2d36cab6d9441db10a7c983834cf9196398b3":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"from"
},
"comparison":"lessThan",
"comparisonSortField":"productId",
"comparisonSortDataType":"string",
"comparisonValue":"eeee"
},
"634dd9295fcb1834de0a6ed1f1ab8a9fa06c4d7f":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"from"
},
"aggregate":"min",
"sortFields":[
{
"fieldName":"SellOfferManager_CalCombinedPricingUniqueRequestId",
"dataType":"string",
"sortOrder": 'descending',
"refFieldNameId": "ref_hash_SellOfferManager_CalCombinedPricingUniqueRequestId"
}
],
"requiredDataObjects":{
"ref_hash_SellOfferManager_CalCombinedPricingUniqueRequestId": {
"fieldName":"SellOfferManager_CalCombinedPricingUniqueRequestId",
"linkPathObjectId":"2794814ec253fc93496bfcb50ea18ebfe640bf4d"
}
}
},
"d3fc84fa4444406cef2de49baf53d38ab86cd2e0":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasOrderPrice"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"orderPrice"
},
"direction":"from"
},
"requestProperties":{
"tag_sellOfferPlan":"bbbb",
"tag_sellOfferPlanDeliveryMethodLink":"bbbb"
},
"perParentCombinationIds":[
{
"tag":"tag_deliverTo",
"filterMainId":"e0b8534452e98796f144c83a221764ef32db5ab6"
}
],
"applyCombinations":[
{
"tag":"tag_sellOfferPlanUserPaymentMethodLink",
"filterMainId":"51509dea0a7ba2746dbd24769b8e777f1411f3ff"
}
]
},
"2b0537fa34ee1d259488fce12204dd549e1c98a3":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasOrderPrice"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"to"
},
"requestProperties":{
"tag_deliverTo":"aaaa",
"tag_sellOfferPlanDeliveryMethodLink":"bbbb"
},
"applyCombinations":[
{
"tag":"tag_sellOfferPlan",
"filterMainId":"88d9c5b9ab36d8c3ebf17e8322541b9c64cae25b"
},
{
"tag":"tag_sellOfferPlanUserPaymentMethodLink",
"filterMainId":"51509dea0a7ba2746dbd24769b8e777f1411f3ff"
}
]
},
"11704ae9a828b4709300964e2e0361bad13db5c3":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"from"
},
"aggregate":"average",
"sortFields":[
{
"fieldName":"sellOfferHandlerServiceTag",
"dataType":"string",
"sortOrder": 'descending',
}
],
"combine":true
},
"964050f23f92b45a1ea573a573c50ae3ca2bae18":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasOrderPrice"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"orderPrice"
},
"direction":"from"
},
"requestProperties":{
"tag_sellOfferPlan":"aaaa",
"tag_sellOfferPlanDeliveryMethodLink":"bbbb"
},
"applyCombinations":[
{
"tag":"tag_deliverTo",
"filterMainId":"d7a7f875254e856b4205075826631ec042b4c821"
},
{
"tag":"tag_sellOfferPlanUserPaymentMethodLink",
"filterMainId":"b96447ae98c95858694ca5ec407750c559825930"
}
],
"comparison":"highLow",
"comparisonSortField":"sellOfferHandlerServiceTag",
"comparisonSortDataType": "string"
"comparisonValue":"aaaa"
}
},
"sortFields":[
{
"fieldName":"productId",
"dataType":"string",
"sortOrder": 'descending',
// refFieldNameId: '2fece71f6bb34f0163610caaec63981c8dfa9de8'
},
{
"fieldName":"productId",
"dataType":"array",
"sortOrder": 'descending',
"sortArray":[
"ffff",
"eeee"
],
// refFieldNameId: '2fece71f6bb34f0163610caaec63981c8dfa9de8'
}
]
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-17]]
[[Category:Working documents - Search Results| 2025-04-17]]

Service - Search Results

2026-04-22T05:11:59Z

Praew:

= Overview =

Service that handles search result requests, feeding work to [[Service - Search Result (handlers)]]. Takes results from Complex Filter service which are identifier ids only and adds additional fields of information ready for display to end consumer, either directly if no sorting required, or via Sort Result service.

Functions as a cache of Search Result data, so if subsequent matching requests come in they do not need to pass on to Complex Filter or find required data.

= Repository =

https://bitbucket.org/izara-core-search/izara-core-search-search-results/src/master/

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configKey: "SearchType",
configTag: "xx" // {eg: sellOffer/Product/VariantProduct etc..}
configValue: {
complexFilterServiceName: "xx" // {service name of complex filter that handles this type}
complexFilterType: "xx" // optional, if complexFilterType is different to searchType
dataHandlerServiceName: "xx" {service name used to create function/queue names for finding data results, often a Manager service for the object}
requireRequestProperties: {
{requiredData fieldName}: [ // dependant on what requiredData requested
"xx",
// .. {properties that must be received in the request for this searchType to process correctly}
]
},
parentDataIdentifierFields: [
"xx", // these are always found with any request for this SearchType to add into ParentDataId table for each found data
],
childSearchResults: {
{childSearchType}: { // searchType of child searchResult, matches filterType for building child complex filter
searchResultsServiceName: "xx", // allows for results to be saved by different deployed services
requiredData: { // requiredData we request from the child searchType depending on what requiredData fields are set in the parent's request
{parent requiredData fieldName}: [
"xx", // list of child requiredData fields to add
// ..
],
// ..
},
passOnRequestProperties: [ // parent requestProperties to pass on to the child searchResult request, if not received in parent request will error
"xx",
// ..
]
},
// ..
}
hookBeforeFindDataServiceName: "xx", // if set will send async request to external service before finding data
hookAfterFindDataServiceName: "xx", // if set will send async request to external service before finding data
}
},
</syntaxhighlight>

== SearchResultMain ==

<syntaxhighlight lang="JavaScript">
{
searchResultId: "xx" // main element for one set of search results
searchDetailId: "xx" // hashes of other values that affect result data
searchResultMainStatus: "processing",
requiredData: {} // same as request
childSearchIds: {
{childSearchType}: [{array of childSearchIds}], // array of childSearchIds for this parent searchResultMain, split out by childSearchType
// ..
}
createTime: currentTime.getTime(),
expiryTime: expiryTime.getTime(),
}
</syntaxhighlight>

* partition key: searchResultId
* sort key: searchDetailId
* searchResultId: for standard single filter searches is {searchType}_{filterMainId}
* searchDetailId: for standard single filter searches is {requestPropertiesHash}_{requiredDataHash}
* searchResultId: for combined search results is {searchType}_{searchParamsHash}
* searchDetailId: for combined search results is {requiredDataHash}

== SearchResultParents ==

<syntaxhighlight lang="JavaScript">
{
childSearchId: "xx", // {searchResultId}_{searchDetailId}
parentSearchId: "xx" // {searchResultId}_{searchDetailId}
searchResultParentStatus: "processing",
}
</syntaxhighlight>

* partition key: childSearchId
* sort key: parentSearchId
* when a SearchResultMain is finished it checks this table to see if any parents need to be processed

== SearchResultData ==

<syntaxhighlight lang="JavaScript">
{
searchId: "xx", // {searchResultId}_{searchDetailId}
dataId: "xx", // id of element (sellOfferId/productId/variantProduct(type and id))
// reconsider this field, does not scale: childData: {}, // only used when childId set in SearchResultMain, saves requiredData results for all matching child records
searchResultDataStatus: "processing",
}
</syntaxhighlight>

* partition key: searchId
* sort key: dataId

== RequiredData ==

<syntaxhighlight lang="JavaScript">
{
requiredDataId: "xx", // {searchType}_{dataId}_{requestPropertiesHash} OR maybe hash of object of these values?
fieldName: "xx",
requiredDataValue: "xx", // value found for this reqdata field
requiredDataStatus: "xx", // waitingExternalData | complete | invalid
createTime: currentTime.getTime(),
expiryTime: expiryTime.getTime(),
}
</syntaxhighlight>

* partition key: requiredDataId
* sort key: fieldName
* one record is one result we can calculate from external services, this can be shared by multiple SearchResultData records
* requiredDataId includes identifiers that can affect the data's value
* if keys too long for Dynamo we could hash an object containing all required fields and can add the values of each into the item separately, if needed
* primary key can be used when result comes back from external service, so that message must include all values needed to make requiredDataId
* can probably add fields during processing to store extra data for processing this SearchResultData record
* if we want to find all records for one SearchResultData we could search for just the partition key, but it might return additonal fields used by other searches with different requiredData

== RequiredDataSearchResultData ==

<syntaxhighlight lang="JavaScript">
{
requiredDataId_fieldName: "xx", // {requiredDataId}_{fieldName}
searchId: "xx"
}
</syntaxhighlight>

* partition key: requiredDataId_fieldName
* sort key: searchId
* can extract dataId from requiredDataId_fieldName to find primary key for SearchResultData
* used to create links between RequiredData results and all SearchResultData that need it

== ParentDataId ==

<syntaxhighlight lang="JavaScript">
{
parentId: "xx", // {parent searchType}_{parent dataId}_{child searchResultId (searchType and filterMainId)}_{requestPropertiesHash}
childDataId: "xx" // {child dataId}
}
</syntaxhighlight>

* partition key: parentId, identifies one parent dataId matching to a specific childSearchResult, excluding requiredData which is unimportant in this context, only need to specify child searchType/filterMainId/requestPropertiesHash to identify what matching one unique set of parent dataIds
* sort key: childDataId
* child filterMainId is required because we will have different ranges of childIds stored depending on what filter was used to find them

= requestProperties =

These are properties that are added to a Search Result request that affect the data found, they may be required or optional. Because these properties can affect the value of data they must be added to SearchResultMain identifiers to differentiate batches of results.

= requireRequestProperties =

Some requiredData fields will need additional properties to be received in the initial request.
* example: variant/product/sellOffer pricing fields will require locationNodeId/s and browseQuantity
* example: all translations require language/s

= Moving child SearchResult data to parent =
* eg: product searchType has sellOffer child searchType data
* eg: variantProduct searchType has product child searchType data
* parent must wait for child FindData to complete before can process parents FindData
* child SearchResult might already have completed before the parent request was received (ie by a different request), need to account for this
* (old design - can still use if have to, but would be best to separate results so can scale, eg if want to show details about child products, that could pass as a separate Search/Sort set of results including pagination) aggregate multiple child data into the parents data values, but also keep a record of all children in the parents data record

= Multiple Search Results services =

* design to allow for different implementations, eg catalogs can choose which Search Results service it uses
* could achieve this be having a setting in Catalog handlers or Catalog Manager that records which Search Result service the Catalog uses

= browseQuantity for calculating prices =

* when browsing, a user can define browseQuantity they want to buy (default 1), this would be injected into price calculation to obtain available price for each sellOffer
* different to filters, eg availableQuantity, which determines which sellOffers are returned. (we might have a method/hook that validates or updates the complex filter so these settings don't conflict, but not needed)
* added to requestProperties in request
* I think if we request prices for a SellOffer in a quantity it cannot handle, eg browseQuantity is 100 but selloffer only has 20 remaining, the pricing function should return an error, could then remove (or mark as not enough quantity available) such sellOffers, so they might still exist in search results and maybe sort results but show quantity not/available.

= Notes =

* Consider requests find all possible needed data, even if the current request does not use it, that way subsequent requests can feed off the same processed data, ie standardize requiredData at request level to use cache more often
* there might be a special case where we find all results with an empty filter, eg for a child Search Result request which is filtered only by the adult results and wants to not filter child results in any way, that would create a record for every item in the child request and include links to all parent dataIds, that data set could be used by any other request that matches searchType/requestPropertiesHash/requiredDataHash. Maybe work that in in the future as a separate check when processing parent requests so not need to send child request, or intentionally maintain that result set. Might be able to find other shared efficient results as well, however having cached results in RequiredData will also reduce a lot of work and maybe mitigate the need for this
* maybe could optimise querying data even further by copying final data for each RequiredData record into SearchResultData record, so not need to query RequiredData table, but maybe not needed as most consumer queries will point to SortResult

= Normalize Structure SearchResult Request =

<syntaxhighlight lang="JavaScript">
{
objType: {
serviceTag: "XX",
objectType: "xx"
},
searchResultId: "hash_filter_main",
searchDetailId: "hash_requiredData_main_all",
requiredDataObjects: {
hash_fieldNameObject_A: {
fieldName: "xxxx"
},
hash_fieldNameObject_B: {
fieldName: "xxxx",
linkPathObjectId: "hash_linkPathObject_A",
complexFilterCombinationIds: [ //* optional
"hash_filter_of_use_for_combination"
]
},
hash_fieldNameObject_B: {
requiredDataType: 'variantAndOrProductReqData',
xxxxRequiredData: 'hash_requiredData_of_xxxx',
yyyyRequiredData: 'hash_requirdData_of_yyyy'
}
},
searchParams: {
//* case this request use filter main
filterObjectId: "hash_filter_main",

//* case this request send identifiers and not send request to ComplexFilter Service
identifiersIds: [
{
xxId: "xxxx_1"
},
{
xxId: "xxxx_2"
},
],

//* case searchResult generated
searchResultGeneratedParam: { //* front end cannot create searchParams --> searchResultGeneratedParam
xxxx: { //* sort request of each objType
objType: {
serviceTag: "XXXX",
objectType: "xxxx"
},
searchResultId: "11111",
searchDetailId: "22222",
requiredDataObject: {
hash_requiredData_of_xxxx: {
fieldName: "xxxx"
}
},
searchParams: {
filterObjectId: "11111"
},
filterElements: {
11111: {
objType: {
serviceTag: "XXXX",
objectType: "xxxx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxxxId: {
value: "xxxx"
}
}
}
}
},
linkPathObjects: {},
linkPathSteps: {},
sortFields: [
{
fieldName: "yyyy",
dataType: "string",
sortOrder: "descending"
}
]
},
yyyy: { //* sort request of each objType
objType: {
serviceTag: "YYYY",
objectType: "yyyy"
},
searchResultId: "33333",
searchDetailId: "44444",
requiredDataObject: {
hash_requirdData_of_yyyy: {
fieldName: "xxxx",
linkPathObjectId: "hash_LinkPathObject_B"
}
},
searchParams: {
filterObjectId: "33333"
},
filterElements: {
33333: {
objType: {
serviceTag: "YYYY",
objectType: "yyyy"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
yyyyId: {
value: "yyyy"
}
}
}
}
},
linkPathObjects: {
hash_LinkPathObject_B: {
initialObjType: {
serviceTag: "YYYY",
objectType: "yyyy"
},
linkSteps: [
"linkStep_B_1",
"linkStep_B_2"
]
}
},
linkPathSteps: {
linkStep_B_1: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
},
linkStep_B_2: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
}
},
sortFields: [
{
fieldName: "yyyy",
dataType: "string",
sortOrder: "descending",
refFieldNameId: "hash_requirdData_of_yyyy"
}
]
}
}
},
filterElements: { //* other type can see in structure_complexFilter
hash_filter_main: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: {
value: "xxx"
}
}
}
},
hash_filter_of_use_for_combination: {
//* same filter element
},
hash_filter_of_use_for_perParent: {
//* has filter element special
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: {
valueType: "perParentIdentifiers", //* special for perParent to add parent identifiers of link from IntemediateIdentifiers table
perParentIdentifierFieldname: "xxId"
}
}
}
},
ref_filterMainIdA: {
//* same filter element
}
},
linkPathObjects: {
hash_linkPathObject_A: {
initialObjType: {
serviceTag: "XX",
objectType: "xx"
},
linkSteps: [
"linkStep_A_1",
"linkStep_A_2"
]
},
tttt: {
//* same linkPathObject
}
},
linkPathSteps: {
linkStep_A_1: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
requestProperties: {
tag_xxx: "cccc"
},
filterObjectId: "ref_filterMainIdA",
aggregate: 'max',
sortFields: [
{
fieldName: 'xxxx',
dataType: 'string',
sortOrder: 'descending',
},
{
fieldName: 'tttt',
dataType: 'string',
sortOrder: 'descending',
refFieldNameId: "d1b376c689a2de1370e30f7629edc0cefc8d29f0"
}
],
combine: "true",
requiredDataObjects: { //* use for linkPath has linkPath
d1b376c689a2de1370e30f7629edc0cefc8d29f0: {
fieldName: 'tttt',
linkPathObjectId: "tttt"
}
},
perParentCombinationIds: [
{
tag: 'tag_yyyy',
filterMainId: 'hash_filter_of_use_for_perParent'
}
],
applyCombinations: [
{
tag: 'tag_xxxx',
filterMainId: 'hash_filter_of_use_for_combination'
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: 20,
},
linkStep_A_2: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
}
}
}
</syntaxhighlight>

= hash linkPath =

<syntaxhighlight lang="JavaScript">

searchDetailId = 'all_requiredDataHash'

all_requiredDataHash = hash(
{
requiredDataObjects: { all_fieldNameObjects },
linkPathObjects: { all_linkPathObjects }, //*if not have, set default = {}
linkPathSteps: { all_linkPathSteps } //*if not have, set default = {}
}
)

requiredDataObjects = {
hash_fieldNameObject: {
fieldName: "A_fieldName"
},
hash_fieldNameObject2: {
fieldName: "C_fieldName",
linkPathObjectId: "hash_linkPathObject",
complexFilterCombinationIds: [
"hash_filter_element_for_complexFilterCombination"
]
}
}

hash_fieldNameObject = hash({
fieldName: {
fieldName: "fieldName",
linkPathObjectId: "hash_linkPathObject", //optional, if requiredData has linkPath
complexFilterCombinationIds: [
"hash_filter_element_for_complexFilterCombination"
] //optional, if requiredData has combination complexFilter
},
linkPathObjects: {
hash_linkPathObject: {
initialObjType: { A },
linkSteps: ["hash_linkStep1", "hash_linkStep2"]
}
},
linkPathSteps: {
hash_linkStep1: {
pathLinkType: {
objType: { B },
relType: { hasB },
direction: ""
},

//* other settings of each link //* optional
filterObjectId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
},
hash_linkStep2: {
pathLinkType: {
objType: { C },
relType: { hasC },
direction: ""
},

//* other settings of each link //* optional
filterObjectId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
}
}
})

linkPathObjects = {
hash_fieldNameObject2: {
initialObjType: {},
linkSteps: ["hash_linkStep1", "hash_linkStep2"]
}
};

hash_fieldNameObject2 = hash({
initialObjType: { A },
linkSteps: ["hash_linkStep1", "hash_linkStep2"]
})

linkPathSteps = {
hash_linkStep1: {
pathLinkType: {
objType: { B },
relType: { hasB },
direction: ""
},

//* other settings of each link //* optional
filterObjectId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
},
hash_linkStep2: {
pathLinkType: {
objType: { C },
relType: { hasC },
direction: ""
},

//* other settings of each link //* optional
filterObjectId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
}
}

hash_linkStep1 = hash({
pathLinkType: {
objType: { B },
relType: { hasB },
direction: ""
},

//* other settings of each link //* optional
filterObjectId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
});
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Search Results|Working_documents - Search Results]]

[[Category:Backend services| Search Results]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-04-22T03:54:52Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

"elements": {
// shared types
"elementId12":{
"elementType": "freetext",
"value": "aa"
}

// headerFooter types
"elementId1":{
"elementType": "valueUserTag",
"valueUserTag": "userTag_9",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId2":{
"elementType": "valueUserTag",
"inputType": "select",
"options": [
{
optionText:"option1",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"
},
{
optionText:"option2",
valueUserTag:{
userTag_9:"valueC"

},
],
},
"elementId21":{
"elementType": "valueUserTag",
"inputType": "checkbox",
"onSetting:{
optionText:"on",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"

},
},
"offSetting":{
optionText:"off",
valueUserTag:{
userTag_9:"valueC"

},
},

},
"elementId3":{
"elementType": "sort",
"display": "downArrow", // || upArrow
"requiredDataLinkStepObjectId": "userTag_LinkStepObjectC",
"dataType": "number", // "number" | "string"
"sortOrder": "ascending" // "ascending"|"descending" (default ascending)
},
"elementId4":{
"elementType": "numberOfRows",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId5":{
"elementType":"numberOfRows",
"inputType": "select",
"options": [
{
optionText:"page5",
value:5
},
{
optionText:"page7",
value:7
},
],
},
"elementId6":{
"elementType": "submit",
"display": "submit", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId7":{
"elementType": "reset",
"display": "reset rows", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId9":{
"elementType": "totalDatafield",
"requiredDataLinkStepObjectId": "link1",
"showIfNotAllRowsLoaded": true // || false
},
"elementId11":{
// will need to link to per record check box
"elementType": "bulkAction",
"action": "on" // on | off | switch
"bulkActionUserTag": "tagA", // have normalized list of bulkActionTags, with list of "bulkAction" and "bulkActionCheckBox" elements linked to it
},
"elementId8":{
"elementType": "pageNumbers",
"linksAfter": [
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": ">"
},
{
"action": "goToLastPage",
"hideWhenLastPageShown": true,
"string": ">>"
}
],
"linksBefore": [
{
"action": "goToFirstPage",
"hideWhenFirstPageShown": true,
"string": "<<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": "<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
}
],
"showPagesAfter": 3,
"showPagesBefore": 3
},

// records types
"elementId5":{
"elementType": "requiredDataLinkStepObject", // in record
"requiredDataLinkStepObjectId": "link1",
},
"elementIdxx":{
"elementType": "bulkActionCheckBox",
"bulkActionUserTag": "tagA",
},
},

valueUserTags: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
},

bulkActionUserTags: {
tagA:{
bulkActions: [
"elementId11",
// ...
],
bulkActionCheckBoxes: [
"elementIdxx",
// ...
],
},
// ...
},

}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_openBracket_1",
logicalElements: {
uuid_openBracket_1: {
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: "uuid_logical_1",
},
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: "uuid_openBracket_1",
nextLogicalElementId: "uuid_operation_1",

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
partitionKeyValueUserTags: {
productId: "valueUserTag_1",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},
uuid_operation_1: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_1",
nextLogicalElementId: "uuid_childComplexFilter_1",
operation: "OR"
},
uuid_childComplexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: "uuid_operation_1",
nextLogicalElementId: "uuid_closeBracket_1",

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
pathLinkType: {
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer",
},
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer",
},
direction: "to",
},
childLogicalElementId: "uuid_logical_2",
},
uuid_logical_2: {
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer",
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_2",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},
uuid_closeBracket_1: {
logicalElementType: "closeBracket",
previousLogicalElementId: "uuid_childComplexFilter_1",
nextLogicalElementId: "uuid_operation_2",
},
uuid_operation_2: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_closeBracket_1",
nextLogicalElementId: "uuid_translateIds_1",
operation: "AND"
},
uuid_translateIds_1: {
logicalElementType: "translateIds",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "uuid_operation_3",
objType: {
objectType: "product",
serviceTag: "ProductManager",
},
pathLinkType: {
objType: {
objectType: "sellOffer",
serviceTag: "SellOfferManager",
},
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "to"
},
requestProperties: {
tag_xxxx: "valueUserTag_5"
},
childIdentifiers: [
{
sellOfferId: "valueUserTag_3"
},
{
sellOfferId: "valueUserTag_4"
},
]
},
uuid_operation_3: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_translateIds_1",
nextLogicalElementId: "uuid_traversal_1",
operation: "AND"
},
uuid_traversal_1: {
logicalElementType: "traversal",
previousLogicalElementId: "uuid_operation_3",
nextLogicalElementId: null,

objType: {
objectType: "product",
serviceTag: "ProductManager",
},
traversalSteps: [
"hash_traversal_1",
"hash_traversal_2",
"hash_traversal_3",
]
}
},
traversalSteps: {
hash_traversal_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer"
},
direction: "to"
},

//* setting of traversal step
fieldValueUserTags: [
{
productId: "valueUserTag_6"
},
], //optional, if this step is not last step
relationshipProperties: {
// timestamp: 1231456 //or will ref value???? ====> not sure?
timestamp: "valueUserTag_7"
},
hopsPassObjType: true, //optional //* สามารถ hops ได้ทุก step ยกเว้น step สุดท้าย = traversal_5
hopsStart: 1, //optional default: 1
hopsEnd: 10, //optional
},
hash_traversal_2: {
pathLinkType: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
fieldValueUserTags: [
{
sellOfferId: "valueUserTag_8"
},
],//optional
//* traversal before last traversal cannot set hopsPassObjType = true
hopsEnd: 10, //optional
},
hash_traversal_3: {
fieldValueUserTags: [
{
sellOfferPlanId: "valueUserTag_9"
},
{
currencyId: "valueUserTag_10"
},
{
sellOfferPlanId: "valueUserTag_11"
}
]
},
hash_traversal_combinationComplexFilter_1: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "localtionLink"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasLocationLink"
},
direction: "to"
},
//* setting of traversal step
hopsPassObjType: true, //optional //* สามารถ hops ได้ทุก step ยกเว้น step สุดท้าย = traversal_5
hopsStart: 1, //optional default: 1
hopsEnd: 10, //optional

},
hash_traversal_combinationComplexFilter_2: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "isLocationNode"
},
direction: "to"
},
hopsEnd: 10, //optional
},
hash_traversal_combinationComplexFilter_3: {
fieldValueUserTags: [
{
locationNodeId: "valueUserTag_21"
},
{
locationNodeId: "valueUserTag_22"
}
]
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations: {
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "hash_traversal_combinationComplexFilter",
logicalElements: {
//*traversal
hash_traversal_combinationComplexFilter: {
logicalElementType: "traversal",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
objectType: "locationNode",
serviceTag: "Locations",
},
traversalSteps: [
"hash_traversal_combinationComplexFilter_1",
"hash_traversal_combinationComplexFilter_2",
"hash_traversal_combinationComplexFilter_3",
]
}
},
},
},
perParentCombinations: {
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "valueUserTag_13"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_14",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1: {
fieldName: "xxx"
},
hash_linkStepB_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_14",
},
// sortKeyValueUserTags: {
// productId: "valueUserTag_1",
// },
// comparison: "equals",
conditionalFieldValues: [
{
fieldName: "userId",
includeValueUserTags: ["valueUserTag_15"], //
// excludeValueUserTags: ["xx","sdd"]
}
]
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "valueUserTag_16",
tag_sellOfferPlan: "valueUserTag_17",
// tag_sellOfferPlanDeliveryMethodLink: "valueUserTag_18",
// tag_sellOfferPlanUserPaymentMethodLink: "valueUserTag_19"
},
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags: ["valueUserTag_1", "valueUserTag_2"],
sortOrder: "ascending" | "descending"
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "valueUserTag_20",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags: ["valueUserTag_1", "valueUserTag_2"],
sortOrder: "ascending" | "descending"
}
],
valueUserTags: {
valueUserTag_1: {
value: "1111",
},
valueUserTag_2: {
value: "2222",
},
valueUserTag_3: {
value: "3333",
},
valueUserTag_4: {
value: "4444",
},
valueUserTag_5: {
value: "5555",
},
valueUserTag_6: {
value: "6666",
},
valueUserTag_7: {
value: "7777",
},
valueUserTag_8: {
value: "8888",
},
valueUserTag_9: {
value: "9999",
},
valueUserTag_10: {
value: "1010",
},
valueUserTag_11: {
value: "1110",
},
valueUserTag_12: {
value: "1212",
},
valueUserTag_13: {
value: "1313",
},
valueUserTag_14: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
valueUserTag_15: {
value: "praewDev"
},
valueUserTag_16: {
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
valueUserTag_17: {
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
valueUserTag_20: {
value: 50
},
valueUserTag_21: {
value: "2121"
},
valueUserTag_22: {
value: "2221"
}
}
}

</syntaxhighlight>

= Future Ideas =
* requestProperties has tag_traversalType
* searchResult (backend) in searchParams that have identifiersIds. still not have in frontend.
* searchResult (backend) in searchParams that have searchResultGenerated. still not have in frontend (ex. variantProduct) //* will add requiredDataType in requiredDataObject, too.
* for logicalElementsType: traversal has many fieldValueUserTags that use in traversal (backend). still not have in frontend

<syntaxhighlight lang="JavaScript">

//* in traversal type for fields in backend idea

fields: { //* backend idea
feildName: "value",
status: {
anyValue: ["ACTIVE", "PENDING"]
},
price: { //* not have
comparison: "greaterThan",
value: 100
},
quantity: { //* not have
comparison: "between",
valueBetweenStart: 10,
valueBetweenEnd: 50
},
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-04-09T01:50:43Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

"elements": {
// shared types
"elementId12":{
"elementType": "freetext",
"value": "aa"
}

// headerFooter types
"elementId1":{
"elementType": "valueUserTag",
"valueUserTag": "userTag_9",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId2":{
"elementType": "valueUserTag",
"inputType": "select",
"options": [
{
optionText:"option1",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"
},
{
optionText:"option2",
valueUserTag:{
userTag_9:"valueC"

},
],
},
"elementId21":{
"elementType": "valueUserTag",
"inputType": "checkbox",
"onSetting:{
optionText:"on",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"

},
},
"offSetting":{
optionText:"off",
valueUserTag:{
userTag_9:"valueC"

},
},

},
"elementId3":{
"elementType": "sort",
"display": "downArrow", // || upArrow
"requiredDataLinkStepObjectId": "userTag_LinkStepObjectC",
"dataType": "number", // "number" | "string"
"sortOrder": "ascending" // "ascending"|"descending" (default ascending)
},
"elementId4":{
"elementType": "numberOfRows",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId5":{
"elementType":"numberOfRows",
"inputType": "select",
"options": [
{
optionText:"page5",
value:5
},
{
optionText:"page7",
value:7
},
],
},
"elementId6":{
"elementType": "submit",
"display": "submit", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId7":{
"elementType": "reset",
"display": "reset rows", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId9":{
"elementType": "totalDatafield",
"requiredDataLinkStepObjectId": "link1",
"showIfNotAllRowsLoaded": true // || false
},
"elementId11":{
// will need to link to per record check box
"elementType": "bulkAction",
"action": "on" // on | off | switch
"bulkActionUserTag": "tagA", // have normalized list of bulkActionTags, with list of "bulkAction" and "bulkActionCheckBox" elements linked to it
},
"elementId8":{
"elementType": "pageNumbers",
"linksAfter": [
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": ">"
},
{
"action": "goToLastPage",
"hideWhenLastPageShown": true,
"string": ">>"
}
],
"linksBefore": [
{
"action": "goToFirstPage",
"hideWhenFirstPageShown": true,
"string": "<<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": "<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
}
],
"showPagesAfter": 3,
"showPagesBefore": 3
},

// records types
"elementId5":{
"elementType": "requiredDataLinkStepObject", // in record
"requiredDataLinkStepObjectId": "link1",
},
"elementIdxx":{
"elementType": "bulkActionCheckBox",
"bulkActionUserTag": "tagA",
},
},

valueUserTags: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
},

bulkActionUserTags: {
tagA:{
bulkActions: [
"elementId11",
// ...
],
bulkActionCheckBoxes: [
"elementIdxx",
// ...
],
},
// ...
},

}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_openBracket_1",
logicalElements: {
uuid_openBracket_1: {
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: "uuid_logical_1",
},
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: "uuid_openBracket_1",
nextLogicalElementId: "uuid_operation_1",

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
partitionKeyValueUserTags: {
productId: "valueUserTag_1",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},
uuid_operation_1: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_1",
nextLogicalElementId: "uuid_childComplexFilter_1",
operation: "OR"
},
uuid_childComplexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: "uuid_operation_1",
nextLogicalElementId: "uuid_closeBracket_1",

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
pathLinkType: {
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer",
},
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer",
},
direction: "to",
},
childLogicalElementId: "uuid_logical_2",
},
uuid_logical_2: {
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer",
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_2",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},
uuid_closeBracket_1: {
logicalElementType: "closeBracket",
previousLogicalElementId: "uuid_childComplexFilter_1",
nextLogicalElementId: "uuid_operation_2",
},
uuid_operation_2: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_closeBracket_1",
nextLogicalElementId: "uuid_translateIds_1",
operation: "AND"
},
uuid_translateIds_1: {
logicalElementType: "translateIds",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "uuid_operation_3",
objType: {
objectType: "product",
serviceTag: "ProductManager",
},
pathLinkType: {
objType: {
objectType: "sellOffer",
serviceTag: "SellOfferManager",
},
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "to"
},
requestProperties: {
tag_xxxx: "valueUserTag_5"
},
childIdentifiers: [
{
sellOfferId: "valueUserTag_3"
},
{
sellOfferId: "valueUserTag_4"
},
]
},
uuid_operation_3: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_translateIds_1",
nextLogicalElementId: "uuid_traversal_1",
operation: "AND"
},
uuid_traversal_1: {
logicalElementType: "traversal",
previousLogicalElementId: "uuid_operation_3",
nextLogicalElementId: null,

objType: {
objectType: "product",
serviceTag: "ProductManager",
},
traversalSteps: [
"hash_traversal_1",
"hash_traversal_2",
"hash_traversal_3",
]
}
},
traversalSteps: {
hash_traversal_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer"
},
direction: "to"
},

//* setting of traversal step
fieldValueUserTags: [
{
productId: "valueUserTag_6"
},
], //optional, if this step is not last step
relationshipProperties: {
// timestamp: 1231456 //or will ref value???? ====> not sure?
timestamp: "valueUserTag_7"
},
hopsPassObjType: true, //optional //* สามารถ hops ได้ทุก step ยกเว้น step สุดท้าย = traversal_5
hopsStart: 1, //optional default: 1
hopsEnd: 10, //optional
},
hash_traversal_2: {
pathLinkType: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
fieldValueUserTags: [
{
sellOfferId: "valueUserTag_8"
},
],//optional
//* traversal before last traversal cannot set hopsPassObjType = true
hopsEnd: 10, //optional
},
hash_traversal_3: {
fieldValueUserTags: [
{
sellOfferPlanId: "valueUserTag_9"
},
{
currencyId: "valueUserTag_10"
},
{
sellOfferPlanId: "valueUserTag_11"
}
]
},
hash_traversal_combinationComplexFilter_1: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "localtionLink"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasLocationLink"
},
direction: "to"
},
//* setting of traversal step
hopsPassObjType: true, //optional //* สามารถ hops ได้ทุก step ยกเว้น step สุดท้าย = traversal_5
hopsStart: 1, //optional default: 1
hopsEnd: 10, //optional

},
hash_traversal_combinationComplexFilter_2: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "isLocationNode"
},
direction: "to"
},
hopsEnd: 10, //optional
},
hash_traversal_combinationComplexFilter_3: {
fieldValueUserTags: [
{
locationNodeId: "valueUserTag_21"
},
{
locationNodeId: "valueUserTag_22"
}
]
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations: {
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "hash_traversal_combinationComplexFilter",
logicalElements: {
//*traversal
hash_traversal_combinationComplexFilter: {
logicalElementType: "traversal",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
objectType: "locationNode",
serviceTag: "Locations",
},
traversalSteps: [
"hash_traversal_combinationComplexFilter_1",
"hash_traversal_combinationComplexFilter_2",
"hash_traversal_combinationComplexFilter_3",
]
}
},
},
},
perParentCombinations: {
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "valueUserTag_13"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_14",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1: {
fieldName: "xxx"
},
hash_linkStepB_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_14",
},
// sortKeyValueUserTags: {
// productId: "valueUserTag_1",
// },
// comparison: "equals",
conditionalFieldValues: [
{
fieldName: "userId",
includeValueUserTags: ["valueUserTag_15"], //
// excludeValueUserTags: ["xx","sdd"]
}
]
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "valueUserTag_16",
tag_sellOfferPlan: "valueUserTag_17",
// tag_sellOfferPlanDeliveryMethodLink: "valueUserTag_18",
// tag_sellOfferPlanUserPaymentMethodLink: "valueUserTag_19"
},
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags: ["valueUserTag_1", "valueUserTag_2"],
sortOrder: "ascending" | "descending"
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "valueUserTag_20",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags: ["valueUserTag_1", "valueUserTag_2"],
sortOrder: "ascending" | "descending"
}
],
valueUserTags: {
valueUserTag_1: {
value: "1111",
},
valueUserTag_2: {
value: "2222",
},
valueUserTag_3: {
value: "3333",
},
valueUserTag_4: {
value: "4444",
},
valueUserTag_5: {
value: "5555",
},
valueUserTag_6: {
value: "6666",
},
valueUserTag_7: {
value: "7777",
},
valueUserTag_8: {
value: "8888",
},
valueUserTag_9: {
value: "9999",
},
valueUserTag_10: {
value: "1010",
},
valueUserTag_11: {
value: "1110",
},
valueUserTag_12: {
value: "1212",
},
valueUserTag_13: {
value: "1313",
},
valueUserTag_14: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
valueUserTag_15: {
value: "praewDev"
},
valueUserTag_16: {
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
valueUserTag_17: {
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
valueUserTag_20: {
value: 50
},
valueUserTag_21: {
value: "2121"
},
valueUserTag_22: {
value: "2221"
}
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-04-08T06:08:28Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

"elements": {
// shared types
"elementId12":{
"elementType": "freetext",
"value": "aa"
}

// headerFooter types
"elementId1":{
"elementType": "valueUserTag",
"valueUserTag": "userTag_9",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId2":{
"elementType": "valueUserTag",
"inputType": "select",
"options": [
{
optionText:"option1",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"
},
{
optionText:"option2",
valueUserTag:{
userTag_9:"valueC"

},
],
},
"elementId21":{
"elementType": "valueUserTag",
"inputType": "checkbox",
"onSetting:{
optionText:"on",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"

},
},
"offSetting":{
optionText:"off",
valueUserTag:{
userTag_9:"valueC"

},
},

},
"elementId3":{
"elementType": "sort",
"display": "downArrow", // || upArrow
"requiredDataLinkStepObjectId": "userTag_LinkStepObjectC",
"dataType": "number", // "number" | "string"
"sortOrder": "ascending" // "ascending"|"descending" (default ascending)
},
"elementId4":{
"elementType": "numberOfRows",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId5":{
"elementType":"numberOfRows",
"inputType": "select",
"options": [
{
optionText:"page5",
value:5
},
{
optionText:"page7",
value:7
},
],
},
"elementId6":{
"elementType": "submit",
"display": "submit", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId7":{
"elementType": "reset",
"display": "reset rows", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId9":{
"elementType": "totalDatafield",
"requiredDataLinkStepObjectId": "link1",
"showIfNotAllRowsLoaded": true // || false
},
"elementId11":{
// will need to link to per record check box
"elementType": "bulkAction",
"action": "on" // on | off | switch
"bulkActionUserTag": "tagA", // have normalized list of bulkActionTags, with list of "bulkAction" and "bulkActionCheckBox" elements linked to it
},
"elementId8":{
"elementType": "pageNumbers",
"linksAfter": [
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": ">"
},
{
"action": "goToLastPage",
"hideWhenLastPageShown": true,
"string": ">>"
}
],
"linksBefore": [
{
"action": "goToFirstPage",
"hideWhenFirstPageShown": true,
"string": "<<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": "<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
}
],
"showPagesAfter": 3,
"showPagesBefore": 3
},

// records types
"elementId5":{
"elementType": "requiredDataLinkStepObject", // in record
"requiredDataLinkStepObjectId": "link1",
},
"elementIdxx":{
"elementType": "bulkActionCheckBox",
"bulkActionUserTag": "tagA",
},
},

valueUserTags: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
},

bulkActionUserTags: {
tagA:{
bulkActions: [
"elementId11",
// ...
],
bulkActionCheckBoxes: [
"elementIdxx",
// ...
],
},
// ...
},

}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_openBracket_1",
logicalElements: {
uuid_openBracket_1: {
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: "uuid_logical_1",
},
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: "uuid_openBracket_1",
nextLogicalElementId: "uuid_operation_1",

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
partitionKeyValueUserTags: {
productId: "valueUserTag_1",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},
uuid_operation_1: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_1",
nextLogicalElementId: "uuid_childComplexFilter_1",
operation: "OR"
},
uuid_childComplexFilter_1: {
logicalElementType: "logical",
previousLogicalElementId: "uuid_operation_1",
nextLogicalElementId: "uuid_closeBracket_1",

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
pathLinkType: {
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer",
},
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer",
},
direction: "to",
},
childLogicalElementId: "uuid_logical_2",
},
uuid_logical_2: {
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer",
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_2",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},
uuid_closeBracket_1: {
logicalElementType: "closeBracket",
previousLogicalElementId: "uuid_childComplexFilter_1",
nextLogicalElementId: "uuid_operation_2",
},
uuid_operation_2: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_closeBracket_1",
nextLogicalElementId: "uuid_translateIds_1",
operation: "AND"
},
uuid_translateIds_1: {
logicalElementType: "translateIds",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "uuid_operation_3",
objType: {
objectType: "product",
serviceTag: "ProductManager",
},
pathLinkType: {
objType: {
objectType: "sellOffer",
serviceTag: "SellOfferManager",
},
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "to"
},
requestProperties: {
tag_xxxx: "valueUserTag_5"
},
childIdentifiers: [
{
sellOfferId: "valueUserTag_3"
},
{
sellOfferId: "valueUserTag_4"
},
]
},
uuid_operation_3: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_translateIds_1",
nextLogicalElementId: "uuid_traversal_1",
operation: "AND"
},
uuid_traversal_1: {
logicalElementType: "traversal",
previousLogicalElementId: "uuid_operation_3",
nextLogicalElementId: null,

objType: {
objectType: "product",
serviceTag: "ProductManager",
},
traversalSteps: [
"hash_traversal_1",
"hash_traversal_2",
"hash_traversal_3",
]
}
},
traversalSteps: {
hash_traversal_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer"
},
direction: "to"
},

//* setting of traversal step
fieldValueUserTags: [
{
productId: "valueUserTag_6"
},
], //optional, if this step is not last step
relationshipProperties: {
// timestamp: 1231456 //or will ref value???? ====> not sure?
timestamp: "valueUserTag_7"
},
hopsPassObjType: true, //optional //* สามารถ hops ได้ทุก step ยกเว้น step สุดท้าย = traversal_5
hopsStart: 1, //optional default: 1
hopsEnd: 10, //optional
},
hash_traversal_2: {
pathLinkType: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
fieldValueUserTags: [
{
sellOfferId: "valueUserTag_8"
},
],//optional
//* traversal before last traversal cannot set hopsPassObjType = true
hopsEnd: 10, //optional
},
hash_traversal_3: {
fieldValueUserTags: [
{
sellOfferPlanId: "valueUserTag_9"
},
{
currencyId: "valueUserTag_10"
},
{
sellOfferPlanId: "valueUserTag_11"
}
]
},
hash_traversal_combinationComplexFilter_1: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "localtionLink"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasLocationLink"
},
direction: "to"
},
//* setting of traversal step
hopsPassObjType: true, //optional //* สามารถ hops ได้ทุก step ยกเว้น step สุดท้าย = traversal_5
hopsStart: 1, //optional default: 1
hopsEnd: 10, //optional

},
hash_traversal_combinationComplexFilter_2: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "isLocationNode"
},
direction: "to"
},
hopsEnd: 10, //optional
},
hash_traversal_combinationComplexFilter_3: {
fieldValueUserTags: [
{
locationNodeId: "valueUserTag_21"
},
{
locationNodeId: "valueUserTag_22"
}
]
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations: {
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "hash_traversal_combinationComplexFilter",
logicalElements: {
//*traversal
hash_traversal_combinationComplexFilter: {
logicalElementType: "traversal",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
objectType: "locationNode",
serviceTag: "Locations",
},
traversalSteps: [
"hash_traversal_combinationComplexFilter_1",
"hash_traversal_combinationComplexFilter_2",
"hash_traversal_combinationComplexFilter_3",
]
}
},
},
},
perParentCombinations: {
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "valueUserTag_13"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_14",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1: {
fieldName: "xxx"
},
hash_linkStepB_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_14",
},
// sortKeyValueUserTags: {
// productId: "valueUserTag_1",
// },
// comparison: "equals",
conditionalFieldValues: [
{
fieldName: "userId",
includeValueUserTags: ["valueUserTag_15"], //
// excludeValueUserTags: ["xx","sdd"]
}
]
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "valueUserTag_16",
tag_sellOfferPlan: "valueUserTag_17",
// tag_sellOfferPlanDeliveryMethodLink: "valueUserTag_18",
// tag_sellOfferPlanUserPaymentMethodLink: "valueUserTag_19"
},
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags: ["valueUserTag_1", "valueUserTag_2"],
sortOrder: "ascending" | "descending"
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "valueUserTag_20",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags: ["valueUserTag_1", "valueUserTag_2"],
sortOrder: "ascending" | "descending"
}
],
valueUserTags: {
valueUserTag_1: {
value: "1111",
},
valueUserTag_2: {
value: "2222",
},
valueUserTag_3: {
value: "3333",
},
valueUserTag_4: {
value: "4444",
},
valueUserTag_5: {
value: "5555",
},
valueUserTag_6: {
value: "6666",
},
valueUserTag_7: {
value: "7777",
},
valueUserTag_8: {
value: "8888",
},
valueUserTag_9: {
value: "9999",
},
valueUserTag_10: {
value: "1010",
},
valueUserTag_11: {
value: "1110",
},
valueUserTag_12: {
value: "1212",
},
valueUserTag_13: {
value: "1313",
},
valueUserTag_14: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
valueUserTag_15: {
value: "praewDev"
},
valueUserTag_16: {
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
valueUserTag_17: {
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
valueUserTag_20: {
value: 50
},
valueUserTag_21: {
value: "2121"
},
valueUserTag_22: {
value: "2221"
}
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-04-08T06:06:59Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

"elements": {
// shared types
"elementId12":{
"elementType": "freetext",
"value": "aa"
}

// headerFooter types
"elementId1":{
"elementType": "valueUserTag",
"valueUserTag": "userTag_9",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId2":{
"elementType": "valueUserTag",
"inputType": "select",
"options": [
{
optionText:"option1",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"
},
{
optionText:"option2",
valueUserTag:{
userTag_9:"valueC"

},
],
},
"elementId21":{
"elementType": "valueUserTag",
"inputType": "checkbox",
"onSetting:{
optionText:"on",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"

},
},
"offSetting":{
optionText:"off",
valueUserTag:{
userTag_9:"valueC"

},
},

},
"elementId3":{
"elementType": "sort",
"display": "downArrow", // || upArrow
"requiredDataLinkStepObjectId": "userTag_LinkStepObjectC",
"dataType": "number", // "number" | "string"
"sortOrder": "ascending" // "ascending"|"descending" (default ascending)
},
"elementId4":{
"elementType": "numberOfRows",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId5":{
"elementType":"numberOfRows",
"inputType": "select",
"options": [
{
optionText:"page5",
value:5
},
{
optionText:"page7",
value:7
},
],
},
"elementId6":{
"elementType": "submit",
"display": "submit", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId7":{
"elementType": "reset",
"display": "reset rows", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId9":{
"elementType": "totalDatafield",
"requiredDataLinkStepObjectId": "link1",
"showIfNotAllRowsLoaded": true // || false
},
"elementId11":{
// will need to link to per record check box
"elementType": "bulkAction",
"action": "on" // on | off | switch
"bulkActionUserTag": "tagA", // have normalized list of bulkActionTags, with list of "bulkAction" and "bulkActionCheckBox" elements linked to it
},
"elementId8":{
"elementType": "pageNumbers",
"linksAfter": [
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": ">"
},
{
"action": "goToLastPage",
"hideWhenLastPageShown": true,
"string": ">>"
}
],
"linksBefore": [
{
"action": "goToFirstPage",
"hideWhenFirstPageShown": true,
"string": "<<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": "<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
}
],
"showPagesAfter": 3,
"showPagesBefore": 3
},

// records types
"elementId5":{
"elementType": "requiredDataLinkStepObject", // in record
"requiredDataLinkStepObjectId": "link1",
},
"elementIdxx":{
"elementType": "bulkActionCheckBox",
"bulkActionUserTag": "tagA",
},
},

valueUserTags: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
},

bulkActionUserTags: {
tagA:{
bulkActions: [
"elementId11",
// ...
],
bulkActionCheckBoxes: [
"elementIdxx",
// ...
],
},
// ...
},

}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_openBracket_1",
logicalElements: {
uuid_openBracket_1: {
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: "uuid_logical_1",
},
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: "uuid_openBracket_1",
nextLogicalElementId: "uuid_operation_1",

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
partitionKeyValueUserTags: {
productId: "valueUserTag_1",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},
uuid_operation_1: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_1",
nextLogicalElementId: "uuid_childComplexFilter_1",
operation: "OR"
},
uuid_childComplexFilter_1: {
logicalElementType: "logical",
previousLogicalElementId: "uuid_operation_1",
nextLogicalElementId: "uuid_closeBracket_1",

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
pathLinkType: {
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer",
},
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer",
},
direction: "to",
},
childLogicalElementId: "uuid_logical_2",
},
uuid_logical_2: {
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer",
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_2",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},
uuid_closeBracket_1: {
logicalElementType: "closeBracket",
previousLogicalElementId: "uuid_childComplexFilter_1",
nextLogicalElementId: "uuid_operation_2",
},
uuid_operation_2: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_closeBracket_1",
nextLogicalElementId: "uuid_translateIds_1",
operation: "AND"
},
uuid_translateIds_1: {
logicalElementType: "translateIds",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "uuid_operation_3",
objType: {
objectType: "product",
serviceTag: "ProductManager",
},
pathLinkType: {
objType: {
objectType: "sellOffer",
serviceTag: "SellOfferManager",
},
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "to"
},
requestProperties: {
tag_xxxx: "valueUserTag_5"
},
childIdentifiers: [
{
sellOfferId: "valueUserTag_3"
},
{
sellOfferId: "valueUserTag_4"
},
]
},
uuid_operation_3: {
logicalElementType: "operation",
previousLogicalElementId: "uuid_translateIds_1",
nextLogicalElementId: "uuid_traversal_1",
operation: "AND"
},
uuid_traversal_1: {
logicalElementType: "traversal",
previousLogicalElementId: "uuid_operation_3",
nextLogicalElementId: null,

objType: {
objectType: "product",
serviceTag: "ProductManager",
},
traversalSteps: [
"hash_traversal_1",
"hash_traversal_2",
"hash_traversal_3",
]
}
},
traversalSteps: {
hash_traversal_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer"
},
direction: "to"
},

//* setting of traversal step
fieldValueUserTags: [
{
productId: "valueUserTag_6"
},
], //optional, if this step is not last step
relationshipProperties: {
// timestamp: 1231456 //or will ref value???? ====> not sure?
timestamp: "valueUserTag_7"
},
hopsPassObjType: true, //optional //* สามารถ hops ได้ทุก step ยกเว้น step สุดท้าย = traversal_5
hopsStart: 1, //optional default: 1
hopsEnd: 10, //optional
},
hash_traversal_2: {
pathLinkType: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
fieldValueUserTags: [
{
sellOfferId: "valueUserTag_8"
},
],//optional
//* traversal before last traversal cannot set hopsPassObjType = true
hopsEnd: 10, //optional
},
hash_traversal_3: {
fieldValueUserTags: [
{
sellOfferPlanId: "valueUserTag_9"
},
{
currencyId: "valueUserTag_10"
},
{
sellOfferPlanId: "valueUserTag_11"
}
]
},
hash_traversal_combinationComplexFilter_1: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "localtionLink"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasLocationLink"
},
direction: "to"
},
//* setting of traversal step
hopsPassObjType: true, //optional //* สามารถ hops ได้ทุก step ยกเว้น step สุดท้าย = traversal_5
hopsStart: 1, //optional default: 1
hopsEnd: 10, //optional

},
hash_traversal_combinationComplexFilter_2: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "isLocationNode"
},
direction: "to"
},
hopsEnd: 10, //optional
},
hash_traversal_combinationComplexFilter_3: {
fieldValueUserTags: [
{
locationNodeId: "valueUserTag_21"
},
{
locationNodeId: "valueUserTag_22"
}
]
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations: {
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "hash_traversal_combinationComplexFilter",
logicalElements: {
//*traversal
hash_traversal_combinationComplexFilter: {
logicalElementType: "traversal",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
objectType: "locationNode",
serviceTag: "Locations",
},
traversalSteps: [
"hash_traversal_combinationComplexFilter_1",
"hash_traversal_combinationComplexFilter_2",
"hash_traversal_combinationComplexFilter_3",
]
}
},
},
},
perParentCombinations: {
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "valueUserTag_13"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_14",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldName: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1: {
fieldName: "xxx"
},
hash_linkStepB_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "valueUserTag_14",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
conditionalFieldValues: [
{
fieldName: "userId",
includeValueUserTags: ["valueUserTag_15"], //
// excludeValueUserTags: ["xx","sdd"]
}
]
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "valueUserTag_16",
tag_sellOfferPlan: "valueUserTag_17",
// tag_sellOfferPlanDeliveryMethodLink: "valueUserTag_18",
// tag_sellOfferPlanUserPaymentMethodLink: "valueUserTag_19"
},
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags: ["valueUserTag_1", "valueUserTag_2"],
sortOrder: "ascending" | "descending"
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "valueUserTag_20",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string",
sortOrder: "ascending" | "descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags: ["userTag_1", "userTag_2"],
sortOrder: "ascending" | "descending"
}
],
valueUserTags: {
valueUserTag_1: {
value: "1111",
},
valueUserTag_2: {
value: "2222",
},
valueUserTag_3: {
value: "3333",
},
valueUserTag_4: {
value: "4444",
},
valueUserTag_5: {
value: "5555",
},
valueUserTag_6: {
value: "6666",
},
valueUserTag_7: {
value: "7777",
},
valueUserTag_8: {
value: "8888",
},
valueUserTag_9: {
value: "9999",
},
valueUserTag_10: {
value: "1010",
},
valueUserTag_11: {
value: "1110",
},
valueUserTag_12: {
value: "1212",
},
valueUserTag_13: {
value: "1313",
},
valueUserTag_14: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
valueUserTag_15: {
value: "praewDev"
},
valueUserTag_16: {
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
valueUserTag_17: {
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
valueUserTag_20: {
value: 50
},
valueUserTag_21: {
value: "2121"
},
valueUserTag_22: {
value: "2221"
}
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

Service - Catalog Standard

2026-04-07T01:56:00Z

Praew:

= Overview =

Handler service for the standard catalog type.

= Repository =

https://bitbucket.org/izara-market-services/izara-market-catalogs-catalog-standard

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configTag: "CatalogServiceNameTag"
configKey: "CatalogServiceNameTag"
configValue: xxx // this own services CatalogServiceTag, eg "CatalogStandard"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "CatalogGraphServiceName"
configKey: "CatalogGraphServiceName"
configValue: xxx // eg: "CatalogGraph"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "CatalogManagerServiceName"
configKey: "CatalogManagerServiceName"
configValue: xxx // eg: "CatalogManager"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "TranslationsServiceName"
configKey: "TranslationsServiceName"
configValue: xxx // eg: "Translations"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "CategoryTreeService"
configKey: xxx // categoryTreeServiceNameTag, eg: "CategoryTreeStandard", this is what is saved in each catalog record
configValue: {
serviceName: xxx // eg: "CategoryTreeStandard", this is the actual deployed service name}
}
}
</syntaxhighlight>

= Graph database =

== [[Service - Catalog Graph]]==

=== Nodes ===

==== catalog ====

Is an origin/home/top-level node, one per catalog, allows for top level categories in that catalog to be point to a single origin node.

* NodeIdentifierLabels: catalog
* NodeIdentifierProperties: catalogId (random uuid)

Properties:

# searchType: sellOffer|product|variantProduct, will match the setting in the catalog service
# filter: full filter for the catalog, will combine all child categoryNode filters with the setting in the catalog service
# requiredData: full requiredData for this catalog, will match the setting in the catalog service

==== catalogSettings ====

Versioned data Holding the editable settings for a catalog.

Properties:

# searchType: product|variant|variantProduct
# filter: stringified object containing default search result filter
# requiredData: stringified object containing default search result requiredData
# categoryTreeServiceName: eg: "CategoryTreeStandard"

== [[Service - Translations Graph]] ==

=== Nodes ===

==== CatalogName ====

* NodeIdentifierLabels: catalogName
* NodeIdentifierProperties: catalogId

= Ideas =

* One filter that will normally be on, but could be removed, is to only show items that have available quantity, this will tie into the locationtreenodeid.

= Structure from Normalize FrontEnd =

<syntaxhighlight lang="JavaScript">
//in versionedData
versionedData = {
objTypeSetting: {
serviceTag: "XX",
objectType: "xx"
},
filterSetting: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},
requiredDataSetting: {
fieldName: "xxx"
},

//* add more new ideas
//* traversalsStepSetting: {},
//* valueUserTagsSetting: {}
}

//* in properties of node
properties = {
objType: {
serviceTag: "XX",
objectType: "xx"
},
requiredData: [
{
fieldName: "xxx"
}
],
filterAwaiting: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},
filters: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},

//* add more new ideas
// traversalSteps: { //* maybe add more in this properties --> ref for type traversal
// 111: {
// pathLinkType: {
// objType: {
// serviceTag: "YY",
// objectType: "yy"
// },
// relType: {
// serviceTag: "YY",
// relationshipTag: "hasYY"
// },
// direction: "from"
// },

// //* other setting of traversal
// }
// },
// valueUserTags: { //* maybe add more in this properties
// ref_valueUserTag: {
// value: "cccc"
// }
// }
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Catalog Standard|Catalog Standard]]

[[Category:Backend services| Catalog Standard]]

Service - Catalog Standard

2026-04-07T01:54:52Z

Praew:

= Overview =

Handler service for the standard catalog type.

= Repository =

https://bitbucket.org/izara-market-services/izara-market-catalogs-catalog-standard

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configTag: "CatalogServiceNameTag"
configKey: "CatalogServiceNameTag"
configValue: xxx // this own services CatalogServiceTag, eg "CatalogStandard"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "CatalogGraphServiceName"
configKey: "CatalogGraphServiceName"
configValue: xxx // eg: "CatalogGraph"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "CatalogManagerServiceName"
configKey: "CatalogManagerServiceName"
configValue: xxx // eg: "CatalogManager"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "TranslationsServiceName"
configKey: "TranslationsServiceName"
configValue: xxx // eg: "Translations"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "CategoryTreeService"
configKey: xxx // categoryTreeServiceNameTag, eg: "CategoryTreeStandard", this is what is saved in each catalog record
configValue: {
serviceName: xxx // eg: "CategoryTreeStandard", this is the actual deployed service name}
}
}
</syntaxhighlight>

= Graph database =

== [[Service - Catalog Graph]]==

=== Nodes ===

==== catalog ====

Is an origin/home/top-level node, one per catalog, allows for top level categories in that catalog to be point to a single origin node.

* NodeIdentifierLabels: catalog
* NodeIdentifierProperties: catalogId (random uuid)

Properties:

# searchType: sellOffer|product|variantProduct, will match the setting in the catalog service
# filter: full filter for the catalog, will combine all child categoryNode filters with the setting in the catalog service
# requiredData: full requiredData for this catalog, will match the setting in the catalog service

==== catalogSettings ====

Versioned data Holding the editable settings for a catalog.

Properties:

# searchType: product|variant|variantProduct
# filter: stringified object containing default search result filter
# requiredData: stringified object containing default search result requiredData
# categoryTreeServiceName: eg: "CategoryTreeStandard"

== [[Service - Translations Graph]] ==

=== Nodes ===

==== CatalogName ====

* NodeIdentifierLabels: catalogName
* NodeIdentifierProperties: catalogId

= Ideas =

* One filter that will normally be on, but could be removed, is to only show items that have available quantity, this will tie into the locationtreenodeid.

= Structure from Normalize FrontEnd =

<syntaxhighlight lang="JavaScript">
//in versionedData
versionedData = {
objTypeSetting: {
serviceTag: "XX",
objectType: "xx"
},
objTypeSettingMatchParent: true | false,
filterSetting: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},
filterSettingMatchParent: "none" | "match" | "append",
requiredDataSetting: {
fieldName: "xxx"
},
requiredDataSettingMAtchParent: "none" | "match" | "append",

//* add more new ideas
//* traversalsStepSetting: {},
//* valueUserTagsSetting: {}
}

//* in properties of node
properties = {
objType: {
serviceTag: "XX",
objectType: "xx"
},
requiredData: [
{
fieldName: "xxx"
}
],
filterAwaiting: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},
filters: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},

//* add more new ideas
// traversalSteps: { //* maybe add more in this properties --> ref for type traversal
// 111: {
// pathLinkType: {
// objType: {
// serviceTag: "YY",
// objectType: "yy"
// },
// relType: {
// serviceTag: "YY",
// relationshipTag: "hasYY"
// },
// direction: "from"
// },

// //* other setting of traversal
// }
// },
// valueUserTags: { //* maybe add more in this properties
// ref_valueUserTag: {
// value: "cccc"
// }
// }
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Catalog Standard|Catalog Standard]]

[[Category:Backend services| Catalog Standard]]

Service - Category Tree Standard

2026-04-06T23:47:49Z

Praew:

= Overview =

Handler service for the standard category tree type.

= Repository =

https://bitbucket.org/izara-market-services/izara-market-catalogs-category-tree-standard

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configTag: "CategoryTreeServiceNameTag"
configKey: "CategoryTreeServiceNameTag"
configValue: xxx // this own services CategoryTreeServiceNameTag, eg "CategoryTreeStandard"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "CatalogGraphServiceName"
configKey: "CatalogGraphServiceName"
configValue: xxx // eg: "CatalogGraph"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "CategoryTreeService"
configKey: xxx // categoryTreeServiceNameTag, eg: "CategoryTreeStandard", this is what is saved in each catalog record
configValue: {
serviceName: xxx // eg: "CategoryTreeStandard", this is the actual deployed service name}
}
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "defaultValue"
configKey: "locationTreeAreaNodeId"
configValue: {eg: id for USA, or international?}
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "defaultValue"
configKey: "browseQuantity"
configValue: {eg: 1}
}
</syntaxhighlight>

= Graph database =

== [[Service - Catalog Graph]] ==

* Structure allows for one category to be found at the same level of the graph (same parent) multiple times, but eg with different filters
* Structure keeps a record of all changes, so can be rolled back eg if a user makes changes incorrectly

=== Nodes ===

==== catalogNode ====

[[Service - Catalog Standard#catalogNode]]

==== categoryNode ====

Represents one parent-child relationship in the graph, is never edited or removed from the graph. One category can have any number of categoryNodes

* NodeIdentifierLabels: categoryNode
* NodeIdentifierProperties: categoryNodeId - random uuid

Properties:

# catalogId (maybe not needed but maybe more efficient if have)
# categoryId (maybe not needed but maybe more efficient if have)
# searchType: sellOffer|product|variantProduct, will often match catalog's default unless specifically set not to, is the current generated setting and can change regularly
# filter: full filter for this node, will often match catalog's default unless specifically set not to, is the current generated setting and can change regularly
# requiredData: full requiredData for this node, will often match catalog's default unless specifically set not to, is the current generated setting and can change regularly

==== categoryNodeSettings ====

Versioned data Holding the editable settings for a categoryNode.

see [[2021-02-22 - Maintaining change history using graph database#Situation 2: Editable settings]]

Properties:

# searchType: sellOffer|product|variantProduct
# searchTypeMatchParent: boolean, if true will be updated to always match the parent node's searchType setting, if false must manually update
# filter: full or additional filter set for this node, will be empty if matching parent categoryNode's filter
# filterMatchParent: none|match|append, if none does not update when parent updates, if match will always match parent, if append will add this node's filter to the parent's
# requiredData
# requiredDataMatchParent: none|match|append, if none does not update when parent updates, if match will always match parent, if append will add this node's requiredData to the parent's

==== user ====

One userId, is never edited or removed from the graph.

* NodeIdentifierLabels: user
* NodeIdentifierProperties: userId

==== category ====

[[Service - Category Standard#category]]

=== Relationships ===

==== hasChildCategoryNode / hasDisabledChildCategoryNode ====

Creates a link between two categoryNode vertices or catalogNode > categoryNode vertices, relationship can be enabled or disabled, one of these relationships will always exist linking the same parent to the same child.

One categoryNode can have multiple child categoryNodes but only one parent categoryNode, traversing up the parents will reach the final catalog node.

==== changedBy ====

Creates a link between categoryNode > user nodes, is never edited or removed from the graph. Each time a categoryNode is disabled or enabled a new relationship is created linking the userId and saving the date, so have record of changes

Handled automatically in [[2021-02-16 - Graph Handler - Functions#Relationship/ChangeRelationshipType]]

==== isCategory ====

Creates a link between categoryNode > category nodes, is never edited or removed from the graph.

= calculating categoryNode's requiredData and searchType =

* In most cases all categoryNodes will share the same settings as the catalog's requiredData and searchType, but we allow for per categoryNode settings.
* Each categoryNode maintains it's own final setting so can be efficiently pulled when browsing
* If a categoryNode sets {setting}MatchParent = match it inherits the parent categoryNode's setting, if traversing up the tree to the catalog node all parents inherit, then any changes to the catalog's setting will propagate down to all categoryNodes

== Initial settings ==

* searchType can only be match or not match (no append)
* If {setting}MatchParent = none: the setting cannot be empty, and is saved in both the categoryNodeSettings and categoryNode nodes
* If {setting}MatchParent = match: no requiredData data is saved in categoryNodeSettings and the parent categoryNode's settings value is saved in this categoryNode node
* If {setting}MatchParent = append: the requiredData cannot be empty and is saved into the categoryNodeSettings node, then appended to the parent's setting and saved in the categoryNode node
* If the parent is a catalog node the same rules apply but the catalog's filter is used

= calculating categoryNode's filter =

The categoryNode's stored/active filter uses MatchParent the same as requiredData above, however child categories might include products that are not part of a parent category, when browsing the parent category we want to show all results from the parent's filter as well as all children's combined.

If child categoryNode's match parent then we not need to add them into the parents final filter. If not we can chaing them using ''or'' statements to create the parent's final filter.

Processing these large filters can be efficient due to cached results.

== When a categoryNode's filter changes ==

If a categoryNode or catalog's filter changes, just like requiredData we need to traverse down the tree checking for any filterMatchParent = match|append and rebuild the child node's filter setting accordingly, whenever a categoryNode is found that has no child nodes with filterMatchParent = match|append we can stop traversing down, but need to re-trace back up the tree recalculating the final combined filter that adds in all children filters.

=== When creating a new categoryNode ===

A new categoryNode also needs to traverse up the tree recalculating the filter for all parents

= Adding client submitted settings =

* client (or requesting service) can overwrite or adjust these settings

== searchType ==

* client submitted setting overwrites categoryNode's

== filter ==

* would get added as an ''and'' grouped filter

== requiredData ==

* client setting overwrites categoryNode's if set

= Top level results =

* Each catalog has a top level record saved into CategoryNode table, categoryId = 0, this will be a combination of catalog filter, and all child categoryIds

= Ideas =

* This service could hold a list of Products for each category and do things like record popularity etc.. partial lists would be OK, anything we want to add. For features like popularity might not want to remove products when they no longer match the catagory, might want to maintain their details in case get added again. This type of idea might be served through the graph database.

= Structure from Normalize FrontEnd =

<syntaxhighlight lang="JavaScript">
//in versionedData
versionedData = {
objTypeSetting: {
serviceTag: "XX",
objectType: "xx"
},
objTypeSettingMatchParent: true | false,
filterSetting: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},
filterSettingMatchParent: "none" | "match" | "append",
requiredDataSetting: {
fieldName: "xxx"
},
requiredDataSettingMAtchParent: "none" | "match" | "append",

//* add more new ideas
//* traversalsStepSetting: {},
//* valueUserTagsSetting: {}
}

//* in properties of node
properties = {
objType: {
serviceTag: "XX",
objectType: "xx"
},
requiredData: [
{
fieldName: "xxx"
}
],
filterAwaiting: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},
filters: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},

//* add more new ideas
// traversalSteps: { //* maybe add more in this properties --> ref for type traversal
// 111: {
// pathLinkType: {
// objType: {
// serviceTag: "YY",
// objectType: "yy"
// },
// relType: {
// serviceTag: "YY",
// relationshipTag: "hasYY"
// },
// direction: "from"
// },

// //* other setting of traversal
// }
// },
// valueUserTags: { //* maybe add more in this properties
// ref_valueUserTag: {
// value: "cccc"
// }
// }
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Category Tree Standard|Category Tree Standard]]

[[Category:Backend services| Category Tree Standard]]

Service - Category Tree Standard

2026-04-06T01:07:41Z

Praew:

= Overview =

Handler service for the standard category tree type.

= Repository =

https://bitbucket.org/izara-market-services/izara-market-catalogs-category-tree-standard

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configTag: "CategoryTreeServiceNameTag"
configKey: "CategoryTreeServiceNameTag"
configValue: xxx // this own services CategoryTreeServiceNameTag, eg "CategoryTreeStandard"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "CatalogGraphServiceName"
configKey: "CatalogGraphServiceName"
configValue: xxx // eg: "CatalogGraph"
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "CategoryTreeService"
configKey: xxx // categoryTreeServiceNameTag, eg: "CategoryTreeStandard", this is what is saved in each catalog record
configValue: {
serviceName: xxx // eg: "CategoryTreeStandard", this is the actual deployed service name}
}
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "defaultValue"
configKey: "locationTreeAreaNodeId"
configValue: {eg: id for USA, or international?}
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configTag: "defaultValue"
configKey: "browseQuantity"
configValue: {eg: 1}
}
</syntaxhighlight>

= Graph database =

== [[Service - Catalog Graph]] ==

* Structure allows for one category to be found at the same level of the graph (same parent) multiple times, but eg with different filters
* Structure keeps a record of all changes, so can be rolled back eg if a user makes changes incorrectly

=== Nodes ===

==== catalogNode ====

[[Service - Catalog Standard#catalogNode]]

==== categoryNode ====

Represents one parent-child relationship in the graph, is never edited or removed from the graph. One category can have any number of categoryNodes

* NodeIdentifierLabels: categoryNode
* NodeIdentifierProperties: categoryNodeId - random uuid

Properties:

# catalogId (maybe not needed but maybe more efficient if have)
# categoryId (maybe not needed but maybe more efficient if have)
# searchType: sellOffer|product|variantProduct, will often match catalog's default unless specifically set not to, is the current generated setting and can change regularly
# filter: full filter for this node, will often match catalog's default unless specifically set not to, is the current generated setting and can change regularly
# requiredData: full requiredData for this node, will often match catalog's default unless specifically set not to, is the current generated setting and can change regularly

==== categoryNodeSettings ====

Versioned data Holding the editable settings for a categoryNode.

see [[2021-02-22 - Maintaining change history using graph database#Situation 2: Editable settings]]

Properties:

# searchType: sellOffer|product|variantProduct
# searchTypeMatchParent: boolean, if true will be updated to always match the parent node's searchType setting, if false must manually update
# filter: full or additional filter set for this node, will be empty if matching parent categoryNode's filter
# filterMatchParent: none|match|append, if none does not update when parent updates, if match will always match parent, if append will add this node's filter to the parent's
# requiredData
# requiredDataMatchParent: none|match|append, if none does not update when parent updates, if match will always match parent, if append will add this node's requiredData to the parent's

==== user ====

One userId, is never edited or removed from the graph.

* NodeIdentifierLabels: user
* NodeIdentifierProperties: userId

==== category ====

[[Service - Category Standard#category]]

=== Relationships ===

==== hasChildCategoryNode / hasDisabledChildCategoryNode ====

Creates a link between two categoryNode vertices or catalogNode > categoryNode vertices, relationship can be enabled or disabled, one of these relationships will always exist linking the same parent to the same child.

One categoryNode can have multiple child categoryNodes but only one parent categoryNode, traversing up the parents will reach the final catalog node.

==== changedBy ====

Creates a link between categoryNode > user nodes, is never edited or removed from the graph. Each time a categoryNode is disabled or enabled a new relationship is created linking the userId and saving the date, so have record of changes

Handled automatically in [[2021-02-16 - Graph Handler - Functions#Relationship/ChangeRelationshipType]]

==== isCategory ====

Creates a link between categoryNode > category nodes, is never edited or removed from the graph.

= calculating categoryNode's requiredData and searchType =

* In most cases all categoryNodes will share the same settings as the catalog's requiredData and searchType, but we allow for per categoryNode settings.
* Each categoryNode maintains it's own final setting so can be efficiently pulled when browsing
* If a categoryNode sets {setting}MatchParent = match it inherits the parent categoryNode's setting, if traversing up the tree to the catalog node all parents inherit, then any changes to the catalog's setting will propagate down to all categoryNodes

== Initial settings ==

* searchType can only be match or not match (no append)
* If {setting}MatchParent = none: the setting cannot be empty, and is saved in both the categoryNodeSettings and categoryNode nodes
* If {setting}MatchParent = match: no requiredData data is saved in categoryNodeSettings and the parent categoryNode's settings value is saved in this categoryNode node
* If {setting}MatchParent = append: the requiredData cannot be empty and is saved into the categoryNodeSettings node, then appended to the parent's setting and saved in the categoryNode node
* If the parent is a catalog node the same rules apply but the catalog's filter is used

= calculating categoryNode's filter =

The categoryNode's stored/active filter uses MatchParent the same as requiredData above, however child categories might include products that are not part of a parent category, when browsing the parent category we want to show all results from the parent's filter as well as all children's combined.

If child categoryNode's match parent then we not need to add them into the parents final filter. If not we can chaing them using ''or'' statements to create the parent's final filter.

Processing these large filters can be efficient due to cached results.

== When a categoryNode's filter changes ==

If a categoryNode or catalog's filter changes, just like requiredData we need to traverse down the tree checking for any filterMatchParent = match|append and rebuild the child node's filter setting accordingly, whenever a categoryNode is found that has no child nodes with filterMatchParent = match|append we can stop traversing down, but need to re-trace back up the tree recalculating the final combined filter that adds in all children filters.

=== When creating a new categoryNode ===

A new categoryNode also needs to traverse up the tree recalculating the filter for all parents

= Adding client submitted settings =

* client (or requesting service) can overwrite or adjust these settings

== searchType ==

* client submitted setting overwrites categoryNode's

== filter ==

* would get added as an ''and'' grouped filter

== requiredData ==

* client setting overwrites categoryNode's if set

= Top level results =

* Each catalog has a top level record saved into CategoryNode table, categoryId = 0, this will be a combination of catalog filter, and all child categoryIds

= Ideas =

* This service could hold a list of Products for each category and do things like record popularity etc.. partial lists would be OK, anything we want to add. For features like popularity might not want to remove products when they no longer match the catagory, might want to maintain their details in case get added again. This type of idea might be served through the graph database.

= Structure from Normalize FrontEnd =

<syntaxhighlight lang="JavaScript">
//in versionedData
versionedData = {
objTypeSetting: {
serviceTag: "XX",
objectType: "xx"
},
objTypeSettingMatchParent: true | false,
filterSetting: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},
filterSettingMatchParent: "none" | "match" | "append",
requiredDataSetting: {
fieldName: "xxx"
},
requiredDataSettingMAtchParent: "none" | "match" | "append",

//* add more new ideas
//* traversalsStepSetting: {},
//* valueUserTagsSetting: {}
}

properties = {
objType: {
serviceTag: "XX",
objectType: "xx"
},
requiredData: [
{
fieldName: "xxx"
}
],
filterAwaiting: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},
filters: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
initialLogicalElementId: "xxxx",
logicalElements: {
xxxx: {
logicalElementType: "logical" | "childComplexFilter" | etc,
previousLogicalElmentId: null | "xxxx",
nextLogicalElementId: null | "xxxx",

// other params depend on logicalElementType
}
}
},

//* add more new ideas
// traversalSteps: { //* maybe add more in this properties --> ref for type traversal
// 111: {
// pathLinkType: {
// objType: {
// serviceTag: "YY",
// objectType: "yy"
// },
// relType: {
// serviceTag: "YY",
// relationshipTag: "hasYY"
// },
// direction: "from"
// },

// //* other setting of traversal
// }
// },
// valueUserTags: { //* maybe add more in this properties
// ref_valueUserTag: {
// value: "cccc"
// }
// }
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Category Tree Standard|Category Tree Standard]]

[[Category:Backend services| Category Tree Standard]]

Service - Sort Result

2026-03-18T04:15:55Z

Praew:

= Overview =

Service that handles sorted results that come from the [[Service - Search Result]] service. Sorted results are stored/cached so subsequent requests do not need to generate the sorted results again.

= Repository =

https://bitbucket.org/stb_vit/sortresult_main/src/master/

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configKey: "SearchType",
configTag: "xx" // {eg: sellOffer/Product/VariantProduct etc..}
configValue: {
searchResultServiceName: "xx" // {service name of searchResult service that handles this type}
}
},
</syntaxhighlight>

== [[Standard WebSocketTask Per Service]] ==

== SortResultMain ==

<syntaxhighlight lang="JavaScript">
{
sortResultId: "xx", // main element for one set of search results, comes from {searchType}_{filterMainId}
requiredData: {}, // same as request
sortFields: [], // same as request
requestProperties: {}, // same as request
createTime: currentTime.getTime(),
expiryTime: expiryTime.getTime(),
}
</syntaxhighlight>

* partition key: sortResultId
* sort key: {none}
* sortResultId: searchId + "_" + sortFieldsHash
* sortFieldsHash: Strip out any sortFields elements after a random element is found, as they are unused. can have multiple sort fields, so we hash them to create the sortFieldsHash unique key

== SortResultData ==

<syntaxhighlight lang="JavaScript">
{
sortResultId: "xx",
sortId: ##, // numeric increment for sorting
dataId: "xx", unique id for the data record, from Search Result service
data: {}, // all required data from Search Result service
}
</syntaxhighlight>

* partition key: sortResultId
* sort key: sortId

== TempStringSort ==

<syntaxhighlight lang="JavaScript">
{
sortResultIdLevelOrd: "xx",
value: "xx",
}
</syntaxhighlight>

* partition key: sortResultIdLevelOrd
* sort key: value
* sortResultIdLevelOrd: is {sortResultId}_{sortLevel}_{previous sort levels order}

== TempNumericSort ==

<syntaxhighlight lang="JavaScript">
{
sortResultIdLevelOrd: "xx",
value: "xx"
}
</syntaxhighlight>

* partition key: sortResultIdLevelOrd
* sort key: value
* sortResultIdLevelOrd: is {sortResultId}_{sortLevel}_{previous sort levels order}

== TempSortDataId ==

<syntaxhighlight lang="JavaScript">
{
sortResultIdLevelOrdValue: "xx",
dataId: "xx"
}
</syntaxhighlight>

* partition key: sortResultIdLevelOrdValue
* sort key: dataId
* sortResultIdLevelOrdValue: is {sortResultIdLevelOrd}_{value}
* links multiple dataIds with the same value to their sorted record in TempStringSort/TempNumericSort

= Sorting Data That Has a Currency =

* We want sortResult service to be able to sort by a converted amount, so client cannot perform conversions
* Have a find data field that returns the base value and currency, another findData that returns conversion to a set currency, this will allow for sorting etc

= Notes =

* The data stored here should include everything the client request might need to render results to the user, so no additional calls are needed (eg all possible media that might be shown as a thumbnail, and how likely that thumbnail would be shown)(eg pricing info min price/max price/most common sold price/etc)
* Client uses sortResultId to pull results, can also request ascending or descending
* This service handles pagination of results
* ComplexFilter stores unique ids only for a filter, [[Service - Search Result]] takes results from ComplexFilter and adds all data client might need. Sort Result service copies the data from Search Result and structures it for sorted results

= Ideas =

* date is an interesting sort field, not really used in browse results but would be used a lot in other datasets, it is a filter so could be placed in the complexfilter, but is also something that might change regularly and is based on ordered results, so might be more efficient applied as a sort field in the SortResults, and could filter it there -> my thinking is just treat as a filter and sort separately, could limit changes in filters using date fields so not too many sets of data get generated, eg by fixing requests to set day timestamps.
* There is some large scale put into DynamoDB commands in this service, might be improved using BatchWriteItem, or improving async code.
* SortResults defines its own expiry date (might not match ComplexFilter/Search Result expiry dates), so Search Result service must query Sort Result to see if have active results, if expired Sort Result removes its data, Search Result then checks its data/expiry. More fancy: Sort Result returns date expired but does not delete data until Search Result finishes its tasks, if Search Result fails could return Sort Result's old data, and/or push back Sort Result's expiry date.

= Normalize Structure SortResult Request =

<syntaxhighlight lang="JavaScript">
{
objType: {
serviceTag: "XX",
objectType: "xx"
},
searchResultId: "hash_filters_main", //* hash filter element of main
searchDetailId: "hash_requiredData_main_all",
requiredDataObjects: { //* keep all requiredData that need to find fieldName that required
},
searchParams: {},
filterElements: { //* other type can see in back_end_structure_complexFilter
},
linkPathObjects: {},
linkPathSteps: {},
sortFields: [
{
fieldName: "xxxx",
dataType: "string",
sortOrder: "descending",
refFieldNameId: "hash_linkPathObject_A"
}
]
}
</syntaxhighlight>

= See also =

* https://www.reddit.com/r/aws/comments/7ugukg/dynamodb_not_a_great_option_for_sorting/ - Efficient sorting DynamoDB structure

= Working documents =

[[:Category:Working_documents - Sort Result|Working_documents - Sort Result]]

[[Category:Backend services| Sort Result]]

Service - Search Results

2026-03-18T02:33:34Z

Praew:

= Overview =

Service that handles search result requests, feeding work to [[Service - Search Result (handlers)]]. Takes results from Complex Filter service which are identifier ids only and adds additional fields of information ready for display to end consumer, either directly if no sorting required, or via Sort Result service.

Functions as a cache of Search Result data, so if subsequent matching requests come in they do not need to pass on to Complex Filter or find required data.

= Repository =

https://bitbucket.org/izara-core-search/izara-core-search-search-results/src/master/

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configKey: "SearchType",
configTag: "xx" // {eg: sellOffer/Product/VariantProduct etc..}
configValue: {
complexFilterServiceName: "xx" // {service name of complex filter that handles this type}
complexFilterType: "xx" // optional, if complexFilterType is different to searchType
dataHandlerServiceName: "xx" {service name used to create function/queue names for finding data results, often a Manager service for the object}
requireRequestProperties: {
{requiredData fieldName}: [ // dependant on what requiredData requested
"xx",
// .. {properties that must be received in the request for this searchType to process correctly}
]
},
parentDataIdentifierFields: [
"xx", // these are always found with any request for this SearchType to add into ParentDataId table for each found data
],
childSearchResults: {
{childSearchType}: { // searchType of child searchResult, matches filterType for building child complex filter
searchResultsServiceName: "xx", // allows for results to be saved by different deployed services
requiredData: { // requiredData we request from the child searchType depending on what requiredData fields are set in the parent's request
{parent requiredData fieldName}: [
"xx", // list of child requiredData fields to add
// ..
],
// ..
},
passOnRequestProperties: [ // parent requestProperties to pass on to the child searchResult request, if not received in parent request will error
"xx",
// ..
]
},
// ..
}
hookBeforeFindDataServiceName: "xx", // if set will send async request to external service before finding data
hookAfterFindDataServiceName: "xx", // if set will send async request to external service before finding data
}
},
</syntaxhighlight>

== SearchResultMain ==

<syntaxhighlight lang="JavaScript">
{
searchResultId: "xx" // main element for one set of search results
searchDetailId: "xx" // hashes of other values that affect result data
searchResultMainStatus: "processing",
requiredData: {} // same as request
childSearchIds: {
{childSearchType}: [{array of childSearchIds}], // array of childSearchIds for this parent searchResultMain, split out by childSearchType
// ..
}
createTime: currentTime.getTime(),
expiryTime: expiryTime.getTime(),
}
</syntaxhighlight>

* partition key: searchResultId
* sort key: searchDetailId
* searchResultId: for standard single filter searches is {searchType}_{filterMainId}
* searchDetailId: for standard single filter searches is {requestPropertiesHash}_{requiredDataHash}
* searchResultId: for combined search results is {searchType}_{searchParamsHash}
* searchDetailId: for combined search results is {requiredDataHash}

== SearchResultParents ==

<syntaxhighlight lang="JavaScript">
{
childSearchId: "xx", // {searchResultId}_{searchDetailId}
parentSearchId: "xx" // {searchResultId}_{searchDetailId}
searchResultParentStatus: "processing",
}
</syntaxhighlight>

* partition key: childSearchId
* sort key: parentSearchId
* when a SearchResultMain is finished it checks this table to see if any parents need to be processed

== SearchResultData ==

<syntaxhighlight lang="JavaScript">
{
searchId: "xx", // {searchResultId}_{searchDetailId}
dataId: "xx", // id of element (sellOfferId/productId/variantProduct(type and id))
// reconsider this field, does not scale: childData: {}, // only used when childId set in SearchResultMain, saves requiredData results for all matching child records
searchResultDataStatus: "processing",
}
</syntaxhighlight>

* partition key: searchId
* sort key: dataId

== RequiredData ==

<syntaxhighlight lang="JavaScript">
{
requiredDataId: "xx", // {searchType}_{dataId}_{requestPropertiesHash} OR maybe hash of object of these values?
fieldName: "xx",
requiredDataValue: "xx", // value found for this reqdata field
requiredDataStatus: "xx", // waitingExternalData | complete | invalid
createTime: currentTime.getTime(),
expiryTime: expiryTime.getTime(),
}
</syntaxhighlight>

* partition key: requiredDataId
* sort key: fieldName
* one record is one result we can calculate from external services, this can be shared by multiple SearchResultData records
* requiredDataId includes identifiers that can affect the data's value
* if keys too long for Dynamo we could hash an object containing all required fields and can add the values of each into the item separately, if needed
* primary key can be used when result comes back from external service, so that message must include all values needed to make requiredDataId
* can probably add fields during processing to store extra data for processing this SearchResultData record
* if we want to find all records for one SearchResultData we could search for just the partition key, but it might return additonal fields used by other searches with different requiredData

== RequiredDataSearchResultData ==

<syntaxhighlight lang="JavaScript">
{
requiredDataId_fieldName: "xx", // {requiredDataId}_{fieldName}
searchId: "xx"
}
</syntaxhighlight>

* partition key: requiredDataId_fieldName
* sort key: searchId
* can extract dataId from requiredDataId_fieldName to find primary key for SearchResultData
* used to create links between RequiredData results and all SearchResultData that need it

== ParentDataId ==

<syntaxhighlight lang="JavaScript">
{
parentId: "xx", // {parent searchType}_{parent dataId}_{child searchResultId (searchType and filterMainId)}_{requestPropertiesHash}
childDataId: "xx" // {child dataId}
}
</syntaxhighlight>

* partition key: parentId, identifies one parent dataId matching to a specific childSearchResult, excluding requiredData which is unimportant in this context, only need to specify child searchType/filterMainId/requestPropertiesHash to identify what matching one unique set of parent dataIds
* sort key: childDataId
* child filterMainId is required because we will have different ranges of childIds stored depending on what filter was used to find them

= requestProperties =

These are properties that are added to a Search Result request that affect the data found, they may be required or optional. Because these properties can affect the value of data they must be added to SearchResultMain identifiers to differentiate batches of results.

= requireRequestProperties =

Some requiredData fields will need additional properties to be received in the initial request.
* example: variant/product/sellOffer pricing fields will require locationNodeId/s and browseQuantity
* example: all translations require language/s

= Moving child SearchResult data to parent =
* eg: product searchType has sellOffer child searchType data
* eg: variantProduct searchType has product child searchType data
* parent must wait for child FindData to complete before can process parents FindData
* child SearchResult might already have completed before the parent request was received (ie by a different request), need to account for this
* (old design - can still use if have to, but would be best to separate results so can scale, eg if want to show details about child products, that could pass as a separate Search/Sort set of results including pagination) aggregate multiple child data into the parents data values, but also keep a record of all children in the parents data record

= Multiple Search Results services =

* design to allow for different implementations, eg catalogs can choose which Search Results service it uses
* could achieve this be having a setting in Catalog handlers or Catalog Manager that records which Search Result service the Catalog uses

= browseQuantity for calculating prices =

* when browsing, a user can define browseQuantity they want to buy (default 1), this would be injected into price calculation to obtain available price for each sellOffer
* different to filters, eg availableQuantity, which determines which sellOffers are returned. (we might have a method/hook that validates or updates the complex filter so these settings don't conflict, but not needed)
* added to requestProperties in request
* I think if we request prices for a SellOffer in a quantity it cannot handle, eg browseQuantity is 100 but selloffer only has 20 remaining, the pricing function should return an error, could then remove (or mark as not enough quantity available) such sellOffers, so they might still exist in search results and maybe sort results but show quantity not/available.

= Notes =

* Consider requests find all possible needed data, even if the current request does not use it, that way subsequent requests can feed off the same processed data, ie standardize requiredData at request level to use cache more often
* there might be a special case where we find all results with an empty filter, eg for a child Search Result request which is filtered only by the adult results and wants to not filter child results in any way, that would create a record for every item in the child request and include links to all parent dataIds, that data set could be used by any other request that matches searchType/requestPropertiesHash/requiredDataHash. Maybe work that in in the future as a separate check when processing parent requests so not need to send child request, or intentionally maintain that result set. Might be able to find other shared efficient results as well, however having cached results in RequiredData will also reduce a lot of work and maybe mitigate the need for this
* maybe could optimise querying data even further by copying final data for each RequiredData record into SearchResultData record, so not need to query RequiredData table, but maybe not needed as most consumer queries will point to SortResult

= Normalize Structure SearchResult Request =

<syntaxhighlight lang="JavaScript">
{
objType: {
serviceTag: "XX",
objectType: "xx"
},
searchResultId: "hash_filter_main",
searchDetailId: "hash_requiredData_main_all",
requiredDataObjects: {
hash_fieldNameObject_A: {
fieldName: "xxxx"
},
hash_fieldNameObject_B: {
fieldName: "xxxx",
linkPathObjectId: "hash_linkPathObject_A",
complexFilterCombinationIds: [ //* optional
"hash_filter_of_use_for_combination"
]
},
hash_fieldNameObject_B: {
requiredDataType: 'variantAndOrProductReqData',
xxxxRequiredData: 'hash_requiredData_of_xxxx',
yyyyRequiredData: 'hash_requirdData_of_yyyy'
}
},
searchParams: {
//* case this request use filter main
filterObjectId: "hash_filter_main",

//* case this request send identifiers and not send request to ComplexFilter Service
identifiersIds: [
{
xxId: "xxxx_1"
},
{
xxId: "xxxx_2"
},
],

//* case searchResult generated
searchResultGeneratedParam: { //* front end cannot create searchParams --> searchResultGeneratedParam
xxxx: { //* sort request of each objType
objType: {
serviceTag: "XXXX",
objectType: "xxxx"
},
searchResultId: "11111",
searchDetailId: "22222",
requiredDataObject: {
hash_requiredData_of_xxxx: {
fieldName: "xxxx"
}
},
searchParams: {
filterObjectId: "11111"
},
filterElements: {
11111: {
objType: {
serviceTag: "XXXX",
objectType: "xxxx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxxxId: {
value: "xxxx"
}
}
}
}
},
linkPathObjects: {},
linkPathSteps: {},
sortFields: [
{
fieldName: "yyyy",
dataType: "string",
sortOrder: "descending"
}
]
},
yyyy: { //* sort request of each objType
objType: {
serviceTag: "YYYY",
objectType: "yyyy"
},
searchResultId: "33333",
searchDetailId: "44444",
requiredDataObject: {
hash_requirdData_of_yyyy: {
fieldName: "xxxx",
linkPathObjectId: "hash_LinkPathObject_B"
}
},
searchParams: {
filterObjectId: "33333"
},
filterElements: {
33333: {
objType: {
serviceTag: "YYYY",
objectType: "yyyy"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
yyyyId: {
value: "yyyy"
}
}
}
}
},
linkPathObjects: {
hash_LinkPathObject_B: {
initialObjType: {
serviceTag: "YYYY",
objectType: "yyyy"
},
linkSteps: [
"linkStep_B_1",
"linkStep_B_2"
]
}
},
linkPathSteps: {
linkStep_B_1: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
},
linkStep_B_2: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
}
},
sortFields: [
{
fieldName: "yyyy",
dataType: "string",
sortOrder: "descending",
refFieldNameId: "hash_requirdData_of_yyyy"
}
]
}
}
},
filterElements: { //* other type can see in structure_complexFilter
hash_filter_main: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: {
value: "xxx"
}
}
}
},
hash_filter_of_use_for_combination: {
//* same filter element
},
hash_filter_of_use_for_perParent: {
//* has filter element special
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: {
valueType: "perParentIdentifiers", //* special for perParent to add parent identifiers of link from IntemediateIdentifiers table
perParentIdentifierFieldname: "xxId"
}
}
}
},
ref_filterMainIdA: {
//* same filter element
}
},
linkPathObjects: {
hash_linkPathObject_A: {
initialObjType: {
serviceTag: "XX",
objectType: "xx"
},
linkSteps: [
"linkStep_A_1",
"linkStep_A_2"
]
},
tttt: {
//* same linkPathObject
}
},
linkPathSteps: {
linkStep_A_1: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
requestProperties: {
tag_xxx: "cccc"
},
filterElementId: "ref_filterMainIdA",
aggregate: 'max',
sortFields: [
{
fieldName: 'xxxx',
dataType: 'string',
sortOrder: 'descending',
},
{
fieldName: 'tttt',
dataType: 'string',
sortOrder: 'descending',
refFieldNameId: "d1b376c689a2de1370e30f7629edc0cefc8d29f0"
}
],
combine: "true",
requiredDataObjects: { //* use for linkPath has linkPath
d1b376c689a2de1370e30f7629edc0cefc8d29f0: {
fieldName: 'tttt',
linkPathObjectId: "tttt"
}
},
perParentCombinationIds: [
{
tag: 'tag_yyyy',
filterMainId: 'hash_filter_of_use_for_perParent'
}
],
applyCombinations: [
{
tag: 'tag_xxxx',
filterMainId: 'hash_filter_of_use_for_combination'
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: 20,
},
linkStep_A_2: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
}
}
}
</syntaxhighlight>

= hash linkPath =

<syntaxhighlight lang="JavaScript">

searchDetailId = 'all_requiredDataHash'

all_requiredDataHash = hash(
{
requiredDataObjects: { all_fieldNameObjects },
linkPathObjects: { all_linkPathObjects }, //*if not have, set default = {}
linkPathSteps: { all_linkPathSteps } //*if not have, set default = {}
}
)

requiredDataObjects = {
hash_fieldNameObject: {
fieldName: "A_fieldName"
},
hash_fieldNameObject2: {
fieldName: "C_fieldName",
linkPathObjectId: "hash_linkPathObject",
complexFilterCombinationIds: [
"hash_filter_element_for_complexFilterCombination"
]
}
}

hash_fieldNameObject = hash({
fieldName: {
fieldName: "fieldName",
linkPathObjectId: "hash_linkPathObject", //optional, if requiredData has linkPath
complexFilterCombinationIds: [
"hash_filter_element_for_complexFilterCombination"
] //optional, if requiredData has combination complexFilter
},
linkPathObjects: {
hash_linkPathObject: {
initialObjType: { A },
linkSteps: ["hash_linkStep1", "hash_linkStep2"]
}
},
linkPathSteps: {
hash_linkStep1: {
pathLinkType: {
objType: { B },
relType: { hasB },
direction: ""
},

//* other settings of each link //* optional
filterElementId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
},
hash_linkStep2: {
pathLinkType: {
objType: { C },
relType: { hasC },
direction: ""
},

//* other settings of each link //* optional
filterElementId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
}
}
})

linkPathObjects = {
hash_fieldNameObject2: {
initialObjType: {},
linkSteps: ["hash_linkStep1", "hash_linkStep2"]
}
};

hash_fieldNameObject2 = hash({
initialObjType: { A },
linkSteps: ["hash_linkStep1", "hash_linkStep2"]
})

linkPathSteps = {
hash_linkStep1: {
pathLinkType: {
objType: { B },
relType: { hasB },
direction: ""
},

//* other settings of each link //* optional
filterElementId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
},
hash_linkStep2: {
pathLinkType: {
objType: { C },
relType: { hasC },
direction: ""
},

//* other settings of each link //* optional
filterElementId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
}
}

hash_linkStep1 = hash({
pathLinkType: {
objType: { B },
relType: { hasB },
direction: ""
},

//* other settings of each link //* optional
filterElementId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
});
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Search Results|Working_documents - Search Results]]

[[Category:Backend services| Search Results]]

Service - Search Results

2026-03-18T02:30:43Z

Praew:

= Overview =

Service that handles search result requests, feeding work to [[Service - Search Result (handlers)]]. Takes results from Complex Filter service which are identifier ids only and adds additional fields of information ready for display to end consumer, either directly if no sorting required, or via Sort Result service.

Functions as a cache of Search Result data, so if subsequent matching requests come in they do not need to pass on to Complex Filter or find required data.

= Repository =

https://bitbucket.org/izara-core-search/izara-core-search-search-results/src/master/

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configKey: "SearchType",
configTag: "xx" // {eg: sellOffer/Product/VariantProduct etc..}
configValue: {
complexFilterServiceName: "xx" // {service name of complex filter that handles this type}
complexFilterType: "xx" // optional, if complexFilterType is different to searchType
dataHandlerServiceName: "xx" {service name used to create function/queue names for finding data results, often a Manager service for the object}
requireRequestProperties: {
{requiredData fieldName}: [ // dependant on what requiredData requested
"xx",
// .. {properties that must be received in the request for this searchType to process correctly}
]
},
parentDataIdentifierFields: [
"xx", // these are always found with any request for this SearchType to add into ParentDataId table for each found data
],
childSearchResults: {
{childSearchType}: { // searchType of child searchResult, matches filterType for building child complex filter
searchResultsServiceName: "xx", // allows for results to be saved by different deployed services
requiredData: { // requiredData we request from the child searchType depending on what requiredData fields are set in the parent's request
{parent requiredData fieldName}: [
"xx", // list of child requiredData fields to add
// ..
],
// ..
},
passOnRequestProperties: [ // parent requestProperties to pass on to the child searchResult request, if not received in parent request will error
"xx",
// ..
]
},
// ..
}
hookBeforeFindDataServiceName: "xx", // if set will send async request to external service before finding data
hookAfterFindDataServiceName: "xx", // if set will send async request to external service before finding data
}
},
</syntaxhighlight>

== SearchResultMain ==

<syntaxhighlight lang="JavaScript">
{
searchResultId: "xx" // main element for one set of search results
searchDetailId: "xx" // hashes of other values that affect result data
searchResultMainStatus: "processing",
requiredData: {} // same as request
childSearchIds: {
{childSearchType}: [{array of childSearchIds}], // array of childSearchIds for this parent searchResultMain, split out by childSearchType
// ..
}
createTime: currentTime.getTime(),
expiryTime: expiryTime.getTime(),
}
</syntaxhighlight>

* partition key: searchResultId
* sort key: searchDetailId
* searchResultId: for standard single filter searches is {searchType}_{filterMainId}
* searchDetailId: for standard single filter searches is {requestPropertiesHash}_{requiredDataHash}
* searchResultId: for combined search results is {searchType}_{searchParamsHash}
* searchDetailId: for combined search results is {requiredDataHash}

== SearchResultParents ==

<syntaxhighlight lang="JavaScript">
{
childSearchId: "xx", // {searchResultId}_{searchDetailId}
parentSearchId: "xx" // {searchResultId}_{searchDetailId}
searchResultParentStatus: "processing",
}
</syntaxhighlight>

* partition key: childSearchId
* sort key: parentSearchId
* when a SearchResultMain is finished it checks this table to see if any parents need to be processed

== SearchResultData ==

<syntaxhighlight lang="JavaScript">
{
searchId: "xx", // {searchResultId}_{searchDetailId}
dataId: "xx", // id of element (sellOfferId/productId/variantProduct(type and id))
// reconsider this field, does not scale: childData: {}, // only used when childId set in SearchResultMain, saves requiredData results for all matching child records
searchResultDataStatus: "processing",
}
</syntaxhighlight>

* partition key: searchId
* sort key: dataId

== RequiredData ==

<syntaxhighlight lang="JavaScript">
{
requiredDataId: "xx", // {searchType}_{dataId}_{requestPropertiesHash} OR maybe hash of object of these values?
fieldName: "xx",
requiredDataValue: "xx", // value found for this reqdata field
requiredDataStatus: "xx", // waitingExternalData | complete | invalid
createTime: currentTime.getTime(),
expiryTime: expiryTime.getTime(),
}
</syntaxhighlight>

* partition key: requiredDataId
* sort key: fieldName
* one record is one result we can calculate from external services, this can be shared by multiple SearchResultData records
* requiredDataId includes identifiers that can affect the data's value
* if keys too long for Dynamo we could hash an object containing all required fields and can add the values of each into the item separately, if needed
* primary key can be used when result comes back from external service, so that message must include all values needed to make requiredDataId
* can probably add fields during processing to store extra data for processing this SearchResultData record
* if we want to find all records for one SearchResultData we could search for just the partition key, but it might return additonal fields used by other searches with different requiredData

== RequiredDataSearchResultData ==

<syntaxhighlight lang="JavaScript">
{
requiredDataId_fieldName: "xx", // {requiredDataId}_{fieldName}
searchId: "xx"
}
</syntaxhighlight>

* partition key: requiredDataId_fieldName
* sort key: searchId
* can extract dataId from requiredDataId_fieldName to find primary key for SearchResultData
* used to create links between RequiredData results and all SearchResultData that need it

== ParentDataId ==

<syntaxhighlight lang="JavaScript">
{
parentId: "xx", // {parent searchType}_{parent dataId}_{child searchResultId (searchType and filterMainId)}_{requestPropertiesHash}
childDataId: "xx" // {child dataId}
}
</syntaxhighlight>

* partition key: parentId, identifies one parent dataId matching to a specific childSearchResult, excluding requiredData which is unimportant in this context, only need to specify child searchType/filterMainId/requestPropertiesHash to identify what matching one unique set of parent dataIds
* sort key: childDataId
* child filterMainId is required because we will have different ranges of childIds stored depending on what filter was used to find them

= requestProperties =

These are properties that are added to a Search Result request that affect the data found, they may be required or optional. Because these properties can affect the value of data they must be added to SearchResultMain identifiers to differentiate batches of results.

= requireRequestProperties =

Some requiredData fields will need additional properties to be received in the initial request.
* example: variant/product/sellOffer pricing fields will require locationNodeId/s and browseQuantity
* example: all translations require language/s

= Moving child SearchResult data to parent =
* eg: product searchType has sellOffer child searchType data
* eg: variantProduct searchType has product child searchType data
* parent must wait for child FindData to complete before can process parents FindData
* child SearchResult might already have completed before the parent request was received (ie by a different request), need to account for this
* (old design - can still use if have to, but would be best to separate results so can scale, eg if want to show details about child products, that could pass as a separate Search/Sort set of results including pagination) aggregate multiple child data into the parents data values, but also keep a record of all children in the parents data record

= Multiple Search Results services =

* design to allow for different implementations, eg catalogs can choose which Search Results service it uses
* could achieve this be having a setting in Catalog handlers or Catalog Manager that records which Search Result service the Catalog uses

= browseQuantity for calculating prices =

* when browsing, a user can define browseQuantity they want to buy (default 1), this would be injected into price calculation to obtain available price for each sellOffer
* different to filters, eg availableQuantity, which determines which sellOffers are returned. (we might have a method/hook that validates or updates the complex filter so these settings don't conflict, but not needed)
* added to requestProperties in request
* I think if we request prices for a SellOffer in a quantity it cannot handle, eg browseQuantity is 100 but selloffer only has 20 remaining, the pricing function should return an error, could then remove (or mark as not enough quantity available) such sellOffers, so they might still exist in search results and maybe sort results but show quantity not/available.

= Notes =

* Consider requests find all possible needed data, even if the current request does not use it, that way subsequent requests can feed off the same processed data, ie standardize requiredData at request level to use cache more often
* there might be a special case where we find all results with an empty filter, eg for a child Search Result request which is filtered only by the adult results and wants to not filter child results in any way, that would create a record for every item in the child request and include links to all parent dataIds, that data set could be used by any other request that matches searchType/requestPropertiesHash/requiredDataHash. Maybe work that in in the future as a separate check when processing parent requests so not need to send child request, or intentionally maintain that result set. Might be able to find other shared efficient results as well, however having cached results in RequiredData will also reduce a lot of work and maybe mitigate the need for this
* maybe could optimise querying data even further by copying final data for each RequiredData record into SearchResultData record, so not need to query RequiredData table, but maybe not needed as most consumer queries will point to SortResult

= Normalize Structure SearchResult Request =

<syntaxhighlight lang="JavaScript">
{
objType: {
serviceTag: "XX",
objectType: "xx"
},
searchResultId: "hash_filter_main",
searchDetailId: "hash_requiredData_main_all",
requiredDataObjects: {
hash_fieldNameObject_A: {
fieldName: "xxxx"
},
hash_fieldNameObject_B: {
fieldName: "xxxx",
linkPathObjectId: "hash_linkPathObject_A",
complexFilterCombinationIds: [ //* optional
"hash_filter_of_use_for_combination"
]
},
hash_fieldNameObject_B: {
requiredDataType: 'variantAndOrProductReqData',
xxxxRequiredData: 'hash_requiredData_of_xxxx',
yyyyRequiredData: 'hash_requirdData_of_yyyy'
}
},
searchParams: {
//* case this request use filter main
filterObjectId: "hash_filter_main",

//* case this request send identifiers and not send request to ComplexFilter Service
identifiersIds: [
{
xxId: "xxxx_1"
},
{
xxId: "xxxx_2"
},
],

//* case searchResult generated
searchResultGeneratedParam: {
xxxx: { //* sort request of each objType
objType: {
serviceTag: "XXXX",
objectType: "xxxx"
},
searchResultId: "11111",
searchDetailId: "22222",
requiredDataObject: {
hash_requiredData_of_xxxx: {
fieldName: "xxxx"
}
},
searchParams: {
filterObjectId: "11111"
},
filterElements: {
11111: {
objType: {
serviceTag: "XXXX",
objectType: "xxxx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxxxId: {
value: "xxxx"
}
}
}
}
},
linkPathObjects: {},
linkPathSteps: {},
sortFields: [
{
fieldName: "yyyy",
dataType: "string",
sortOrder: "descending"
}
]
},
yyyy: { //* sort request of each objType
objType: {
serviceTag: "YYYY",
objectType: "yyyy"
},
searchResultId: "33333",
searchDetailId: "44444",
requiredDataObject: {
hash_requirdData_of_yyyy: {
fieldName: "xxxx",
linkPathObjectId: "hash_LinkPathObject_B"
}
},
searchParams: {
filterObjectId: "33333"
},
filterElements: {
33333: {
objType: {
serviceTag: "YYYY",
objectType: "yyyy"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
yyyyId: {
value: "yyyy"
}
}
}
}
},
linkPathObjects: {
hash_LinkPathObject_B: {
initialObjType: {
serviceTag: "YYYY",
objectType: "yyyy"
},
linkSteps: [
"linkStep_B_1",
"linkStep_B_2"
]
}
},
linkPathSteps: {
linkStep_B_1: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
},
linkStep_B_2: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
}
},
sortFields: [
{
fieldName: "yyyy",
dataType: "string",
sortOrder: "descending",
refFieldNameId: "hash_requirdData_of_yyyy"
}
]
}
}
},
filterElements: { //* other type can see in structure_complexFilter
hash_filter_main: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: {
value: "xxx"
}
}
}
},
hash_filter_of_use_for_combination: {
//* same filter element
},
hash_filter_of_use_for_perParent: {
//* has filter element special
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: {
valueType: "perParentIdentifiers", //* special for perParent to add parent identifiers of link from IntemediateIdentifiers table
perParentIdentifierFieldname: "xxId"
}
}
}
},
ref_filterMainIdA: {
//* same filter element
}
},
linkPathObjects: {
hash_linkPathObject_A: {
initialObjType: {
serviceTag: "XX",
objectType: "xx"
},
linkSteps: [
"linkStep_A_1",
"linkStep_A_2"
]
},
tttt: {
//* same linkPathObject
}
},
linkPathSteps: {
linkStep_A_1: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
requestProperties: {
tag_xxx: "cccc"
},
filterElementId: "ref_filterMainIdA",
aggregate: 'max',
sortFields: [
{
fieldName: 'xxxx',
dataType: 'string',
sortOrder: 'descending',
},
{
fieldName: 'tttt',
dataType: 'string',
sortOrder: 'descending',
refFieldNameId: "d1b376c689a2de1370e30f7629edc0cefc8d29f0"
}
],
combine: "true",
requiredDataObjects: { //* use for linkPath has linkPath
d1b376c689a2de1370e30f7629edc0cefc8d29f0: {
fieldName: 'tttt',
linkPathObjectId: "tttt"
}
},
perParentCombinationIds: [
{
tag: 'tag_yyyy',
filterMainId: 'hash_filter_of_use_for_perParent'
}
],
applyCombinations: [
{
tag: 'tag_xxxx',
filterMainId: 'hash_filter_of_use_for_combination'
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: 20,
},
linkStep_A_2: {
pathLinkType: {
objType: {
serviceTag: "X",
objectType: "x"
},
relType: {
serviceTag: "X",
relationshipTag: "hasX"
},
direction: "from"
},
//* setting of links
}
}
}
</syntaxhighlight>

= hash linkPath =

<syntaxhighlight lang="JavaScript">

searchDetailId = 'all_requiredDataHash'

all_requiredDataHash = hash(
{
requiredDataObjects: { all_fieldNameObjects },
linkPathObjects: { all_linkPathObjects }, //*if not have, set default = {}
linkPathSteps: { all_linkPathSteps } //*if not have, set default = {}
}
)

requiredDataObjects = {
hash_fieldNameObject: {
fieldName: "A_fieldName"
},
hash_fieldNameObject2: {
fieldName: "C_fieldName",
linkPathObjectId: "hash_linkPathObject",
complexFilterCombinationIds: [
"hash_filter_element_for_complexFilterCombination"
]
}
}

hash_fieldNameObject = hash({
fieldName: {
fieldName: "fieldName",
linkPathObjectId: "hash_linkPathObject", //optional, if requiredData has linkPath
complexFilterCombinationIds: [
"hash_filter_element_for_complexFilterCombination"
] //optional, if requiredData has combination complexFilter
},
linkPathObjects: {
hash_linkPathObject: {
initialObjType: { A },
linkSteps: ["hash_linkStep1", "hash_linkStep2"]
}
},
linkPathSteps: {
hash_linkStep1: {
pathLinkType: {
objType: { B },
relType: { hasB },
direction: ""
},

//* other settings of each link //* optional
filterElementId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
},
hash_linkStep2: {
pathLinkType: {
objType: { C },
relType: { hasC },
direction: ""
},

//* other settings of each link //* optional
filterElementId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
}
}
})

linkPathObjects = {
hash_fieldNameObject2: {
initialObjType: {},
linkSteps: ["hash_linkStep1", "hash_linkStep2"]
}
};

hash_fieldNameObject2 = hash({
initialObjType: { A },
linkSteps: ["hash_linkStep1", "hash_linkStep2"]
})

linkPathSteps = {
hash_linkStep1: {
pathLinkType: {
objType: { B },
relType: { hasB },
direction: ""
},

//* other settings of each link //* optional
filterElementId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
},
hash_linkStep2: {
pathLinkType: {
objType: { C },
relType: { hasC },
direction: ""
},

//* other settings of each link //* optional
filterElementId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
}
}

hash_linkStep1 = hash({
pathLinkType: {
objType: { B },
relType: { hasB },
direction: ""
},

//* other settings of each link //* optional
filterElementId: "",
requestProperties: {},
aggregate: "",
sortFields: [],
requiredDataObjects: {},
combine: true | false,
perParentCombinationIds: [],
applyCombinations: [],
comparison: "",
comparisonSortField: "",
comparisonSortDataType: "",
comparisonValue: ""
});
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Search Results|Working_documents - Search Results]]

[[Category:Backend services| Search Results]]

Service - Complex Filter

2026-03-18T01:32:50Z

Praew:

= Overview =

Allows for filters that span nested levels of related entities

= Repository =

https://bitbucket.org/izara-core-search/izara-core-search-complex-filters

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configKey: "FilterType"
configTag: "xx" // eg: variant / product / sellOffer
configValue: {
childComplexFilterTypes: {
{child filterType}: {
"translateIdsServiceName": "xx" // eg: variantManager / sellOfferManager, service than converts child id to parent id
},
},
logicalServiceNames : ["xx", "yy"] // eg: "ProductStandard", "ProductCustom"
}
}
</syntaxhighlight>

* logicalServiceNames should not duplicate over mulitiple FilterType's, because we use this setting to match a Logical Service response to a FilterMain record, need it to uniquely identify one filterMain record

<syntaxhighlight lang="JavaScript">
{
configKey: "ComplexFilterServiceName"
configTag: "xx" // eg: product / sellOffer
configValue: "yy" // eg: ComplexFilterProducts
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configKey: "ExpiryInterval"
configTag: "ExpiryInterval"
configValue: xx // minutes(?) complexfilter ttl
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configKey: "MaxProcessInvocationCount"
configTag: "MaxProcessInvocationCount"
configValue: 10 // maximum number of invocations allowed for large operation complex filter processing
}
</syntaxhighlight>

= complexFilter request =
<syntaxhighlight lang="JavaScript">
{
filterType: "xx" // eg: "mediaLink",
type: "group",
elements:
[
{
type: "complexFilter",
complexFilter: {
filterType: "xx", //eg: mediaLinkProperty
type: "group",
elements:
[
{
type: "logical",
logicalTag: "propertyLabelId", // is used by the logical service/s to decide how to find data

// the below properties are up to the logicalTag what is needed, but these are common:
comparison: "equals",
value: "lksdflkfldfgldfkgjldfg"
},
]
}
},
{
type: "logicalOperator",
operator: "and"
},
{
type: "complexFilter",
complexFilter: {
filterType: "xx", //eg: mediaLinkPropertyTranslation
type: "group",
elements:
[
{
type: "logical",
logicalTag: "textTag_languageId_text",

//example for matching to specific translation text:
textTag: "mediaLinkPropertyValue",
languageId: "en",
text: "Blue",
subjectIdentifierPropertyName: "propertyId",
caseSensitive: true
},
]
}
},
...
]
}
</syntaxhighlight>

= How to request Complex Filter =

* invoke shared library function createFilterMainId which iterates through elements and builds filterMainId by applying operators. There are no database requests in this function so it can be run from any service and can trust the filterMainId will be standardized
* No cleaning of the filter object is performed, so additional unused properties would result in a different filterMainId, even if the underlying filter is the same
* calling function saves filterMainId in pending table waiting for filter complete, this needs to be done before calling ProcessComplexFilter to protect against race condition of complex filter completing before pending record saved (probably use AwaitingStep process)
* All requests to ProcessComplexFilter will send a message out, even if cache exists
* CallingFlow param allows Complex Filter service to pass a message back to only the calling flow when a request hits cached results

== How is filterMainId generated ==

* cannot hash entire request elements without iterating through the elements because a final filterMainId of multiple elements is actually the final operation filterMainId (hash of the last element joined with the previous culmination of operation elements)
* this does not match a hash of the original request object
* needs to be done this way so we can back track through parent operations in a standardized way when receiving results for each element

= Normal Structure ComplexFilter Request =

<syntaxhighlight lang="JavaScript">
{ //* type: "logical" structure
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterMainId: "hash_operation",
filterElements: { //* this is top filterElements that keep all filterElement of request
hash_ref_filterElement_A: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: "xx",
yyId: "yy"
},
sortKeyValues: {
zzId: "zz",
},
comparison: "equals",
conditionalFieldValues: [
{
fieldname: "language",
includeValues: ["th"],
// excludeValues: ["en","jp"]
}
]
}
},
hash_childComplexFilter: {
objType: {},
filterElement: {
filterType: "childComplexFilter",
pathLinkType: {
objType: {
serviceTag: "YY",
objectType: "yy"
},
relType: {
serviceTag: "YY",
relationshipTag: "hasYY"
},
direction: "from"
},
childFilterElementId: "hash_ref_filterElement_A",
requestProperties: {
tag_xxxxx: "xxxxx"
}
}
},
hash_ref_filterElement_B: {
//* normalize structure
},
hash_operation: {
objType: {},
filterElement: {
filterType: "operation",
filterElementLeft: "hash_childComplexFilter",
filterElementRight: "hash_ref_filterElement_B",
operator: "AND" | "OR"
}
}
}
}
</syntaxhighlight>

= example pattern each filterType structure in filterElement =
<syntaxhighlight lang="JavaScript">
[
{
filterType: "logical",
partitionKeyValues: {
xxId: "xx",
yyId: "yy"
},
sortKeyValues: {
zzId: "zz",
},
comparison: "equals",
conditionalFieldValues: [
{
fieldname: "language",
includeValues: ["th"],
// excludeValues: ["en","jp"]
}
]
},
{
filterType: "childComplexFilter",
filterElements: { //* use when hash own filterMainId, but when keep in top filterElmenets must delete
ref_filterElement_A: {
//* normalize structure
}
},
pathLinkType: {
objType: {
serviceTag: "YY",
objectType: "yy"
},
relType: {
serviceTag: "YY",
relationshipTag: "hasYY"
},
direction: "from"
},
childFilterElementId: "ref_filterElement_A",
requestProperties: {
tag_xxxxx: "xxxxx"
}
},
{
filterType: "operation",
filterElements: { //* use when hash own filterMainId, but when keep in top filterElmenets must delete
ref_filterElement_A: {
//* normalize structure
},
ref_filterElement_B: {
//* normalize structure
}
},
filterElementLeft: "ref_filterElement_A",
filterElementRight: "ref_filterElement_B",
operator: "AND"
},
{
filterType: "translateIds ",
childIdentifiers: [
{
xxId: "111"
},
{
xxId: "222"
}
],
pathLinkType: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
relType: {
serviceTag: "yy",
objectType: "hasYY"
},
direction: ""
},
requesetProperties: {
tag_quantity: 20
}
},
{ //* traversal has hopsPassObjType
filterType: "traversal",
traversals: [
{
links: [
{
relType: {},
direction: ""
},
{
relType: {},
direction: ""
}
],
//* other settings
fields: { //* optional
categoryId: 'sellOfferId_value',
productId: 'sellOfferId_value'
},
relationshipProperties: { timestamp: 'sellOfferId_value' }, //* optional
hopsStart: 1, //* optional default = 1
hopsEnd: 10, //* optional
hopsPassObjType: {
serviceTag: "",
objectType: ""
},
objType: {
serviceTag: "",
objectType: ""
}
},
{
fields: {
name: { //fieldName
anyValue: [
'alice',
'john',
//...
]
},
xxId_fieldname: "xxxx"
}
//example other fields pattern: //* front end not yet.
// fields: {
// fieldName: {
// comparison: "greaterThan", // greaterThan | lessThan | lessThanOrEqual | greaterThanOrEqual
// value: 100
// }
// }

// fields: {
// fieldName: {
// comparison: "between",
// valueBetweenStart: 100,
// valueBetweenEnd: 200
// }
// }
}
]
},
{ //* traversal no hopsPassObjType
filterType: "traversal",
traversals: [
{
links: [
{
relType: {},
direction: ""
},
{
relType: {},
direction: ""
}
],
//* other settings
hopsPassObjType: {
serviceTag: "",
objectType: ""
},
objType: {
serviceTag: "",
objectType: ""
}
},
{
fields: {
xxId: "xxxx"
}
}
]
}
]
</syntaxhighlight>

= example hash filterElement of each filterType =

<syntaxhighlight lang="JavaScript">

let hash_ref_filterElement_A = hash({
objType: {
serviceTag: "",
objectType: ""
},
filterElement: {
filterType: "logical" | "childComplexFilter" | "operation" | "translateIds" | "traversal",
filterElements: { //* use in filterType: "childComplexFilter" | "operation"
//* all ref filterElement that this filterElement ref
},
//* other parameters depend on the filterType.
//..
//..
}
};

</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Complex Filter|Complex Filter]]

[[Category:Backend services| Complex Filter]]

Service - Complex Filter

2026-03-18T01:30:09Z

Praew:

= Overview =

Allows for filters that span nested levels of related entities

= Repository =

https://bitbucket.org/izara-core-search/izara-core-search-complex-filters

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configKey: "FilterType"
configTag: "xx" // eg: variant / product / sellOffer
configValue: {
childComplexFilterTypes: {
{child filterType}: {
"translateIdsServiceName": "xx" // eg: variantManager / sellOfferManager, service than converts child id to parent id
},
},
logicalServiceNames : ["xx", "yy"] // eg: "ProductStandard", "ProductCustom"
}
}
</syntaxhighlight>

* logicalServiceNames should not duplicate over mulitiple FilterType's, because we use this setting to match a Logical Service response to a FilterMain record, need it to uniquely identify one filterMain record

<syntaxhighlight lang="JavaScript">
{
configKey: "ComplexFilterServiceName"
configTag: "xx" // eg: product / sellOffer
configValue: "yy" // eg: ComplexFilterProducts
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configKey: "ExpiryInterval"
configTag: "ExpiryInterval"
configValue: xx // minutes(?) complexfilter ttl
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configKey: "MaxProcessInvocationCount"
configTag: "MaxProcessInvocationCount"
configValue: 10 // maximum number of invocations allowed for large operation complex filter processing
}
</syntaxhighlight>

= complexFilter request =
<syntaxhighlight lang="JavaScript">
{
filterType: "xx" // eg: "mediaLink",
type: "group",
elements:
[
{
type: "complexFilter",
complexFilter: {
filterType: "xx", //eg: mediaLinkProperty
type: "group",
elements:
[
{
type: "logical",
logicalTag: "propertyLabelId", // is used by the logical service/s to decide how to find data

// the below properties are up to the logicalTag what is needed, but these are common:
comparison: "equals",
value: "lksdflkfldfgldfkgjldfg"
},
]
}
},
{
type: "logicalOperator",
operator: "and"
},
{
type: "complexFilter",
complexFilter: {
filterType: "xx", //eg: mediaLinkPropertyTranslation
type: "group",
elements:
[
{
type: "logical",
logicalTag: "textTag_languageId_text",

//example for matching to specific translation text:
textTag: "mediaLinkPropertyValue",
languageId: "en",
text: "Blue",
subjectIdentifierPropertyName: "propertyId",
caseSensitive: true
},
]
}
},
...
]
}
</syntaxhighlight>

= How to request Complex Filter =

* invoke shared library function createFilterMainId which iterates through elements and builds filterMainId by applying operators. There are no database requests in this function so it can be run from any service and can trust the filterMainId will be standardized
* No cleaning of the filter object is performed, so additional unused properties would result in a different filterMainId, even if the underlying filter is the same
* calling function saves filterMainId in pending table waiting for filter complete, this needs to be done before calling ProcessComplexFilter to protect against race condition of complex filter completing before pending record saved (probably use AwaitingStep process)
* All requests to ProcessComplexFilter will send a message out, even if cache exists
* CallingFlow param allows Complex Filter service to pass a message back to only the calling flow when a request hits cached results

== How is filterMainId generated ==

* cannot hash entire request elements without iterating through the elements because a final filterMainId of multiple elements is actually the final operation filterMainId (hash of the last element joined with the previous culmination of operation elements)
* this does not match a hash of the original request object
* needs to be done this way so we can back track through parent operations in a standardized way when receiving results for each element

= Normal Structure ComplexFilter Request =

<syntaxhighlight lang="JavaScript">
{ //* type: "logical" structure
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterMainId: "hash_operation",
filterElements: { //* this is top filterElements that keep all filterElement of request
hash_ref_filterElement_A: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: "xx",
yyId: "yy"
},
sortKeyValues: {
zzId: "zz",
},
comparison: "equals",
conditionalFieldValues: [
{
fieldname: "language",
includeValues: ["th"],
// excludeValues: ["en","jp"]
}
]
}
},
hash_childComplexFilter: {
objType: {},
filterElement: {
filterType: "childComplexFilter",
pathLinkType: {
objType: {
serviceTag: "YY",
objectType: "yy"
},
relType: {
serviceTag: "YY",
relationshipTag: "hasYY"
},
direction: "from"
},
childFilterElementId: "hash_ref_filterElement_A",
requestProperties: {
tag_xxxxx: "xxxxx"
}
}
},
hash_ref_filterElement_B: {
//* normalize structure
},
hash_operation: {
objType: {},
filterElement: {
filterType: "operation",
filterElementLeft: "hash_childComplexFilter",
filterElementRight: "hash_ref_filterElement_B",
operator: "AND" | "OR"
}
}
}
}
</syntaxhighlight>

= example pattern each filterType structure in filterElement =
<syntaxhighlight lang="JavaScript">
[
{
filterType: "logical",
partitionKeyValues: {
xxId: "xx",
yyId: "yy"
},
sortKeyValues: {
zzId: "zz",
},
comparison: "equals",
conditionalFieldValues: [
{
fieldname: "language",
includeValues: ["th"],
// excludeValues: ["en","jp"]
}
]
},
{
filterType: "childComplexFilter",
filterElements: { //* use when hash own filterMainId, but when keep in top filterElmenets must delete
ref_filterElement_A: {
//* normalize structure
}
},
pathLinkType: {
objType: {
serviceTag: "YY",
objectType: "yy"
},
relType: {
serviceTag: "YY",
relationshipTag: "hasYY"
},
direction: "from"
},
childFilterElementId: "ref_filterElement_A",
requestProperties: {
tag_xxxxx: "xxxxx"
}
},
{
filterType: "operation",
filterElements: { //* use when hash own filterMainId, but when keep in top filterElmenets must delete
ref_filterElement_A: {
//* normalize structure
},
ref_filterElement_B: {
//* normalize structure
}
},
filterElementLeft: "ref_filterElement_A",
filterElementRight: "ref_filterElement_B",
operator: "AND"
},
{
filterType: "translateIds ",
childIdentifiers: [
{
xxId: "111"
},
{
xxId: "222"
}
],
pathLinkType: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
relType: {
serviceTag: "yy",
objectType: "hasYY"
},
direction: ""
},
requesetProperties: {
tag_quantity: 20
}
},
{ //* traversal has hopsPassObjType
filterType: "traversal",
traversals: [
{
links: [
{
relType: {},
direction: ""
},
{
relType: {},
direction: ""
}
],
//* other settings
fields: { //* optional
categoryId: 'sellOfferId_value',
productId: 'sellOfferId_value'
},
relationshipProperties: { timestamp: 'sellOfferId_value' }, //* optional
hopsStart: 1, //* optional default = 1
hopsEnd: 10, //* optional
hopsPassObjType: {
serviceTag: "",
objectType: ""
},
objType: {
serviceTag: "",
objectType: ""
}
},
{
fields: {
name: { //fieldName
anyValue: [
'alice',
'john',
//...
]
},
xxId_fieldname: "xxxx"
}
//example other fields pattern: //* front end not yet.
// fields: {
// fieldName: {
// comparison: "greaterThan", // greaterThan | lessThan | lessThanOrEqual | greaterThanOrEqual
// value: 100
// }
// }

// fields: {
// fieldName: {
// comparison: "between",
// valueBetweenStart: 100,
// valueBetweenEnd: 200
// }
// }
}
]
},
{ //* traversal no hopsPassObjType
filterType: "traversal",
traversals: [
{
links: [
{
relType: {},
direction: ""
},
{
relType: {},
direction: ""
}
],
//* other settings
hopsPassObjType: {
serviceTag: "",
objectType: ""
},
objType: {
serviceTag: "",
objectType: ""
}
},
{
fields: {
xxId: "xxxx"
}
}
]
}
]
</syntaxhighlight>

= example hash filterElement of each filterType =

<syntaxhighlight lang="JavaScript">

let hash_ref_filterElement_A = hash({
objType: {
serviceTag: "",
objectType: ""
},
filterElement: {
filterType: "logical" | "childComplexFilter" | "operation" | "translateIds" | "traversal",
filterElements: { //* use in filterType: "childComplexFilter" | "operation"
//* all ref filterElement that this filterElement ref
},
//* parameters depend on the filterType.
}
};

</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Complex Filter|Complex Filter]]

[[Category:Backend services| Complex Filter]]

Service - Complex Filter

2026-03-18T01:15:01Z

Praew:

= Overview =

Allows for filters that span nested levels of related entities

= Repository =

https://bitbucket.org/izara-core-search/izara-core-search-complex-filters

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configKey: "FilterType"
configTag: "xx" // eg: variant / product / sellOffer
configValue: {
childComplexFilterTypes: {
{child filterType}: {
"translateIdsServiceName": "xx" // eg: variantManager / sellOfferManager, service than converts child id to parent id
},
},
logicalServiceNames : ["xx", "yy"] // eg: "ProductStandard", "ProductCustom"
}
}
</syntaxhighlight>

* logicalServiceNames should not duplicate over mulitiple FilterType's, because we use this setting to match a Logical Service response to a FilterMain record, need it to uniquely identify one filterMain record

<syntaxhighlight lang="JavaScript">
{
configKey: "ComplexFilterServiceName"
configTag: "xx" // eg: product / sellOffer
configValue: "yy" // eg: ComplexFilterProducts
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configKey: "ExpiryInterval"
configTag: "ExpiryInterval"
configValue: xx // minutes(?) complexfilter ttl
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configKey: "MaxProcessInvocationCount"
configTag: "MaxProcessInvocationCount"
configValue: 10 // maximum number of invocations allowed for large operation complex filter processing
}
</syntaxhighlight>

= complexFilter request =
<syntaxhighlight lang="JavaScript">
{
filterType: "xx" // eg: "mediaLink",
type: "group",
elements:
[
{
type: "complexFilter",
complexFilter: {
filterType: "xx", //eg: mediaLinkProperty
type: "group",
elements:
[
{
type: "logical",
logicalTag: "propertyLabelId", // is used by the logical service/s to decide how to find data

// the below properties are up to the logicalTag what is needed, but these are common:
comparison: "equals",
value: "lksdflkfldfgldfkgjldfg"
},
]
}
},
{
type: "logicalOperator",
operator: "and"
},
{
type: "complexFilter",
complexFilter: {
filterType: "xx", //eg: mediaLinkPropertyTranslation
type: "group",
elements:
[
{
type: "logical",
logicalTag: "textTag_languageId_text",

//example for matching to specific translation text:
textTag: "mediaLinkPropertyValue",
languageId: "en",
text: "Blue",
subjectIdentifierPropertyName: "propertyId",
caseSensitive: true
},
]
}
},
...
]
}
</syntaxhighlight>

= How to request Complex Filter =

* invoke shared library function createFilterMainId which iterates through elements and builds filterMainId by applying operators. There are no database requests in this function so it can be run from any service and can trust the filterMainId will be standardized
* No cleaning of the filter object is performed, so additional unused properties would result in a different filterMainId, even if the underlying filter is the same
* calling function saves filterMainId in pending table waiting for filter complete, this needs to be done before calling ProcessComplexFilter to protect against race condition of complex filter completing before pending record saved (probably use AwaitingStep process)
* All requests to ProcessComplexFilter will send a message out, even if cache exists
* CallingFlow param allows Complex Filter service to pass a message back to only the calling flow when a request hits cached results

== How is filterMainId generated ==

* cannot hash entire request elements without iterating through the elements because a final filterMainId of multiple elements is actually the final operation filterMainId (hash of the last element joined with the previous culmination of operation elements)
* this does not match a hash of the original request object
* needs to be done this way so we can back track through parent operations in a standardized way when receiving results for each element

= Normal Structure ComplexFilter Request =

<syntaxhighlight lang="JavaScript">
{ //* type: "logical" structure
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterMainId: "hash_operation",
filterElements: { //* this is top filterElements that keep all filterElement of request
hash_ref_filterElement_A: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: "xx",
yyId: "yy"
},
sortKeyValues: {
zzId: "zz",
},
comparison: "equals",
conditionalFieldValues: [
{
fieldname: "language",
includeValues: ["th"],
// excludeValues: ["en","jp"]
}
]
}
},
hash_childComplexFilter: {
objType: {},
filterElement: {
filterType: "childComplexFilter",
pathLinkType: {
objType: {
serviceTag: "YY",
objectType: "yy"
},
relType: {
serviceTag: "YY",
relationshipTag: "hasYY"
},
direction: "from"
},
childFilterElementId: "hash_ref_filterElement_A",
requestProperties: {
tag_xxxxx: "xxxxx"
}
}
},
hash_ref_filterElement_B: {
//* normalize structure
},
hash_operation: {
objType: {},
filterElement: {
filterType: "operation",
filterElementLeft: "hash_childComplexFilter",
filterElementRight: "hash_ref_filterElement_B",
operator: "AND" | "OR"
}
}
}
}
</syntaxhighlight>

= example pattern each filterType structure in filterElement =
<syntaxhighlight lang="JavaScript">
[
{
filterType: "logical",
partitionKeyValues: {
xxId: "xx",
yyId: "yy"
},
sortKeyValues: {
zzId: "zz",
},
comparison: "equals",
conditionalFieldValues: [
{
fieldname: "language",
includeValues: ["th"],
// excludeValues: ["en","jp"]
}
]
},
{
filterType: "childComplexFilter",
filterElements: { //* use when hash own filterMainId, but when keep in top filterElmenets must delete
ref_filterElement_A: {
//* normalize structure
}
},
pathLinkType: {
objType: {
serviceTag: "YY",
objectType: "yy"
},
relType: {
serviceTag: "YY",
relationshipTag: "hasYY"
},
direction: "from"
},
childFilterElementId: "ref_filterElement_A",
requestProperties: {
tag_xxxxx: "xxxxx"
}
},
{
filterType: "operation",
filterElements: { //* use when hash own filterMainId, but when keep in top filterElmenets must delete
ref_filterElement_A: {
//* normalize structure
},
ref_filterElement_B: {
//* normalize structure
}
},
filterElementLeft: "ref_filterElement_A",
filterElementRight: "ref_filterElement_B",
operator: "AND"
},
{
filterType: "translateIds ",
childIdentifiers: [
{
xxId: "111"
},
{
xxId: "222"
}
],
pathLinkType: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
relType: {
serviceTag: "yy",
objectType: "hasYY"
},
direction: ""
},
requesetProperties: {
tag_quantity: 20
}
},
{ //* traversal has hopsPassObjType
filterType: "traversal",
traversals: [
{
links: [
{
relType: {},
direction: ""
},
{
relType: {},
direction: ""
}
],
//* other settings
fields: { //* optional
categoryId: 'sellOfferId_value',
productId: 'sellOfferId_value'
},
relationshipProperties: { timestamp: 'sellOfferId_value' }, //* optional
hopsStart: 1, //* optional default = 1
hopsEnd: 10, //* optional
hopsPassObjType: {
serviceTag: "",
objectType: ""
},
objType: {
serviceTag: "",
objectType: ""
}
},
{
fields: {
name: { //fieldName
anyValue: [
'alice',
'john',
//...
]
},
xxId_fieldname: "xxxx"
}
//example other fields pattern: //* front end not yet.
// fields: {
// fieldName: {
// comparison: "greaterThan", // greaterThan | lessThan | lessThanOrEqual | greaterThanOrEqual
// value: 100
// }
// }

// fields: {
// fieldName: {
// comparison: "between",
// valueBetweenStart: 100,
// valueBetweenEnd: 200
// }
// }
}
]
},
{ //* traversal no hopsPassObjType
filterType: "traversal",
traversals: [
{
links: [
{
relType: {},
direction: ""
},
{
relType: {},
direction: ""
}
],
//* other settings
hopsPassObjType: {
serviceTag: "",
objectType: ""
},
objType: {
serviceTag: "",
objectType: ""
}
},
{
fields: {
xxId: "xxxx"
}
}
]
}
]
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Complex Filter|Complex Filter]]

[[Category:Backend services| Complex Filter]]

Service - Complex Filter

2026-03-18T01:13:23Z

Praew:

= Overview =

Allows for filters that span nested levels of related entities

= Repository =

https://bitbucket.org/izara-core-search/izara-core-search-complex-filters

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configKey: "FilterType"
configTag: "xx" // eg: variant / product / sellOffer
configValue: {
childComplexFilterTypes: {
{child filterType}: {
"translateIdsServiceName": "xx" // eg: variantManager / sellOfferManager, service than converts child id to parent id
},
},
logicalServiceNames : ["xx", "yy"] // eg: "ProductStandard", "ProductCustom"
}
}
</syntaxhighlight>

* logicalServiceNames should not duplicate over mulitiple FilterType's, because we use this setting to match a Logical Service response to a FilterMain record, need it to uniquely identify one filterMain record

<syntaxhighlight lang="JavaScript">
{
configKey: "ComplexFilterServiceName"
configTag: "xx" // eg: product / sellOffer
configValue: "yy" // eg: ComplexFilterProducts
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configKey: "ExpiryInterval"
configTag: "ExpiryInterval"
configValue: xx // minutes(?) complexfilter ttl
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configKey: "MaxProcessInvocationCount"
configTag: "MaxProcessInvocationCount"
configValue: 10 // maximum number of invocations allowed for large operation complex filter processing
}
</syntaxhighlight>

= complexFilter request =
<syntaxhighlight lang="JavaScript">
{
filterType: "xx" // eg: "mediaLink",
type: "group",
elements:
[
{
type: "complexFilter",
complexFilter: {
filterType: "xx", //eg: mediaLinkProperty
type: "group",
elements:
[
{
type: "logical",
logicalTag: "propertyLabelId", // is used by the logical service/s to decide how to find data

// the below properties are up to the logicalTag what is needed, but these are common:
comparison: "equals",
value: "lksdflkfldfgldfkgjldfg"
},
]
}
},
{
type: "logicalOperator",
operator: "and"
},
{
type: "complexFilter",
complexFilter: {
filterType: "xx", //eg: mediaLinkPropertyTranslation
type: "group",
elements:
[
{
type: "logical",
logicalTag: "textTag_languageId_text",

//example for matching to specific translation text:
textTag: "mediaLinkPropertyValue",
languageId: "en",
text: "Blue",
subjectIdentifierPropertyName: "propertyId",
caseSensitive: true
},
]
}
},
...
]
}
</syntaxhighlight>

= How to request Complex Filter =

* invoke shared library function createFilterMainId which iterates through elements and builds filterMainId by applying operators. There are no database requests in this function so it can be run from any service and can trust the filterMainId will be standardized
* No cleaning of the filter object is performed, so additional unused properties would result in a different filterMainId, even if the underlying filter is the same
* calling function saves filterMainId in pending table waiting for filter complete, this needs to be done before calling ProcessComplexFilter to protect against race condition of complex filter completing before pending record saved (probably use AwaitingStep process)
* All requests to ProcessComplexFilter will send a message out, even if cache exists
* CallingFlow param allows Complex Filter service to pass a message back to only the calling flow when a request hits cached results

== How is filterMainId generated ==

* cannot hash entire request elements without iterating through the elements because a final filterMainId of multiple elements is actually the final operation filterMainId (hash of the last element joined with the previous culmination of operation elements)
* this does not match a hash of the original request object
* needs to be done this way so we can back track through parent operations in a standardized way when receiving results for each element

= Normal Structure ComplexFilter Request =

<syntaxhighlight lang="JavaScript">
{ //* type: "logical" structure
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterMainId: "hash_logical_1",
filterElements: { //* this is top filterElements that keep all filterElement of request
hash_ref_filterElement_A: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: "xx",
yyId: "yy"
},
sortKeyValues: {
zzId: "zz",
},
comparison: "equals",
conditionalFieldValues: [
{
fieldname: "language",
includeValues: ["th"],
// excludeValues: ["en","jp"]
}
]
}
},
hash_childComplexFilter: {
objType: {},
filterElement: {
filterType: "childComplexFilter",
pathLinkType: {
objType: {
serviceTag: "YY",
objectType: "yy"
},
relType: {
serviceTag: "YY",
relationshipTag: "hasYY"
},
direction: "from"
},
childFilterElementId: "hash_ref_filterElement_A",
requestProperties: {
tag_xxxxx: "xxxxx"
}
}
},
hash_ref_filterElement_B: {
//* normalize structure
},
hash_operation: {
objType: {},
filterElement: {
filterType: "operation",
filterElementLeft: "hash_childComplexFilter",
filterElementRight: "hash_ref_filterElement_B",
operator: "AND" | "OR"
}
}
}
}
</syntaxhighlight>

= example pattern each filterType structure in filterElement =
<syntaxhighlight lang="JavaScript">
[
{
filterType: "logical",
partitionKeyValues: {
xxId: "xx",
yyId: "yy"
},
sortKeyValues: {
zzId: "zz",
},
comparison: "equals",
conditionalFieldValues: [
{
fieldname: "language",
includeValues: ["th"],
// excludeValues: ["en","jp"]
}
]
},
{
filterType: "childComplexFilter",
filterElements: { //* use when hash own filterMainId, but when keep in top filterElmenets must delete
ref_filterElement_A: {
//* normalize structure
}
},
pathLinkType: {
objType: {
serviceTag: "YY",
objectType: "yy"
},
relType: {
serviceTag: "YY",
relationshipTag: "hasYY"
},
direction: "from"
},
childFilterElementId: "ref_filterElement_A",
requestProperties: {
tag_xxxxx: "xxxxx"
}
},
{
filterType: "operation",
filterElements: { //* use when hash own filterMainId, but when keep in top filterElmenets must delete
ref_filterElement_A: {
//* normalize structure
},
ref_filterElement_B: {
//* normalize structure
}
},
filterElementLeft: "ref_filterElement_A",
filterElementRight: "ref_filterElement_B",
operator: "AND"
},
{
filterType: "translateIds ",
childIdentifiers: [
{
xxId: "111"
},
{
xxId: "222"
}
],
pathLinkType: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
relType: {
serviceTag: "yy",
objectType: "hasYY"
},
direction: ""
},
requesetProperties: {
tag_quantity: 20
}
},
{ //* traversal has hopsPassObjType
filterType: "traversal",
traversals: [
{
links: [
{
relType: {},
direction: ""
},
{
relType: {},
direction: ""
}
],
//* other settings
fields: { //* optional
categoryId: 'sellOfferId_value',
productId: 'sellOfferId_value'
},
relationshipProperties: { timestamp: 'sellOfferId_value' }, //* optional
hopsStart: 1, //* optional default = 1
hopsEnd: 10, //* optional
hopsPassObjType: {
serviceTag: "",
objectType: ""
},
objType: {
serviceTag: "",
objectType: ""
}
},
{
fields: {
name: { //fieldName
anyValue: [
'alice',
'john',
//...
]
},
xxId_fieldname: "xxxx"
}
//example other fields pattern: //* front end not yet.
// fields: {
// fieldName: {
// comparison: "greaterThan", // greaterThan | lessThan | lessThanOrEqual | greaterThanOrEqual
// value: 100
// }
// }

// fields: {
// fieldName: {
// comparison: "between",
// valueBetweenStart: 100,
// valueBetweenEnd: 200
// }
// }
}
]
},
{ //* traversal no hopsPassObjType
filterType: "traversal",
traversals: [
{
links: [
{
relType: {},
direction: ""
},
{
relType: {},
direction: ""
}
],
//* other settings
hopsPassObjType: {
serviceTag: "",
objectType: ""
},
objType: {
serviceTag: "",
objectType: ""
}
},
{
fields: {
xxId: "xxxx"
}
}
]
}
]
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Complex Filter|Complex Filter]]

[[Category:Backend services| Complex Filter]]

Service - Complex Filter

2026-03-18T01:02:56Z

Praew:

= Overview =

Allows for filters that span nested levels of related entities

= Repository =

https://bitbucket.org/izara-core-search/izara-core-search-complex-filters

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configKey: "FilterType"
configTag: "xx" // eg: variant / product / sellOffer
configValue: {
childComplexFilterTypes: {
{child filterType}: {
"translateIdsServiceName": "xx" // eg: variantManager / sellOfferManager, service than converts child id to parent id
},
},
logicalServiceNames : ["xx", "yy"] // eg: "ProductStandard", "ProductCustom"
}
}
</syntaxhighlight>

* logicalServiceNames should not duplicate over mulitiple FilterType's, because we use this setting to match a Logical Service response to a FilterMain record, need it to uniquely identify one filterMain record

<syntaxhighlight lang="JavaScript">
{
configKey: "ComplexFilterServiceName"
configTag: "xx" // eg: product / sellOffer
configValue: "yy" // eg: ComplexFilterProducts
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configKey: "ExpiryInterval"
configTag: "ExpiryInterval"
configValue: xx // minutes(?) complexfilter ttl
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
configKey: "MaxProcessInvocationCount"
configTag: "MaxProcessInvocationCount"
configValue: 10 // maximum number of invocations allowed for large operation complex filter processing
}
</syntaxhighlight>

= complexFilter request =
<syntaxhighlight lang="JavaScript">
{
filterType: "xx" // eg: "mediaLink",
type: "group",
elements:
[
{
type: "complexFilter",
complexFilter: {
filterType: "xx", //eg: mediaLinkProperty
type: "group",
elements:
[
{
type: "logical",
logicalTag: "propertyLabelId", // is used by the logical service/s to decide how to find data

// the below properties are up to the logicalTag what is needed, but these are common:
comparison: "equals",
value: "lksdflkfldfgldfkgjldfg"
},
]
}
},
{
type: "logicalOperator",
operator: "and"
},
{
type: "complexFilter",
complexFilter: {
filterType: "xx", //eg: mediaLinkPropertyTranslation
type: "group",
elements:
[
{
type: "logical",
logicalTag: "textTag_languageId_text",

//example for matching to specific translation text:
textTag: "mediaLinkPropertyValue",
languageId: "en",
text: "Blue",
subjectIdentifierPropertyName: "propertyId",
caseSensitive: true
},
]
}
},
...
]
}
</syntaxhighlight>

= How to request Complex Filter =

* invoke shared library function createFilterMainId which iterates through elements and builds filterMainId by applying operators. There are no database requests in this function so it can be run from any service and can trust the filterMainId will be standardized
* No cleaning of the filter object is performed, so additional unused properties would result in a different filterMainId, even if the underlying filter is the same
* calling function saves filterMainId in pending table waiting for filter complete, this needs to be done before calling ProcessComplexFilter to protect against race condition of complex filter completing before pending record saved (probably use AwaitingStep process)
* All requests to ProcessComplexFilter will send a message out, even if cache exists
* CallingFlow param allows Complex Filter service to pass a message back to only the calling flow when a request hits cached results

== How is filterMainId generated ==

* cannot hash entire request elements without iterating through the elements because a final filterMainId of multiple elements is actually the final operation filterMainId (hash of the last element joined with the previous culmination of operation elements)
* this does not match a hash of the original request object
* needs to be done this way so we can back track through parent operations in a standardized way when receiving results for each element

= Normal Structure ComplexFilter Request =

<syntaxhighlight lang="JavaScript">
{ //* type: "logical" structure
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterMainId: "hash_logical_1",
filterElements: { //* this is top filterElements that keep all filterElement of request
hash_logical_1: {
objType: {
serviceTag: "XX",
objectType: "xx"
},
filterElement: {
filterType: "logical",
partitionKeyValues: {
xxId: "xx",
yyId: "yy"
},
sortKeyValues: {
zzId: "zz",
},
comparison: "equals",
conditionalFieldValues: [
{
fieldname: "language",
includeValues: ["th"],
// excludeValues: ["en","jp"]
}
]
}
}
}
}
</syntaxhighlight>

= example pattern each filterType structure in filterElement =
<syntaxhighlight lang="JavaScript">
[
{
filterType: "logical",
partitionKeyValues: {
xxId: "xx",
yyId: "yy"
},
sortKeyValues: {
zzId: "zz",
},
comparison: "equals",
conditionalFieldValues: [
{
fieldname: "language",
includeValues: ["th"],
// excludeValues: ["en","jp"]
}
]
},
{
filterType: "childComplexFilter",
filterElements: { //* use when hash own filterMainId, but when keep in top filterElmenets must delete
ref_filterElement_A: {
//* normalize structure
}
},
pathLinkType: {
objType: {
serviceTag: "YY",
objectType: "yy"
},
relType: {
serviceTag: "YY",
relationshipTag: "hasYY"
},
direction: "from"
},
childFilterElementId: "ref_filterElement_A",
requestProperties: {
tag_xxxxx: "xxxxx"
}
},
{
filterType: "operation",
filterElements: { //* use when hash own filterMainId, but when keep in top filterElmenets must delete
ref_filterElement_A: {
//* normalize structure
},
ref_filterElement_B: {
//* normalize structure
}
},
filterElementLeft: "ref_filterElement_A",
filterElementRight: "ref_filterElement_B",
operator: "AND"
},
{
filterType: "translateIds ",
childIdentifiers: [
{
xxId: "111"
},
{
xxId: "222"
}
],
pathLinkType: {
objType: {
serviceTag: "yy",
objectType: "yy"
},
relType: {
serviceTag: "yy",
objectType: "hasYY"
},
direction: ""
},
requesetProperties: {
tag_quantity: 20
}
},
{ //* traversal has hopsPassObjType
filterType: "traversal",
traversals: [
{
links: [
{
relType: {},
direction: ""
},
{
relType: {},
direction: ""
}
],
//* other settings
fields: { //* optional
categoryId: 'sellOfferId_value',
productId: 'sellOfferId_value'
},
relationshipProperties: { timestamp: 'sellOfferId_value' }, //* optional
hopsStart: 1, //* optional default = 1
hopsEnd: 10, //* optional
hopsPassObjType: {
serviceTag: "",
objectType: ""
},
objType: {
serviceTag: "",
objectType: ""
}
},
{
fields: {
name: { //fieldName
anyValue: [
'alice',
'john',
//...
]
},
xxId_fieldname: "xxxx"
}
//example other fields pattern: //* front end not yet.
// fields: {
// fieldName: {
// comparison: "greaterThan", // greaterThan | lessThan | lessThanOrEqual | greaterThanOrEqual
// value: 100
// }
// }

// fields: {
// fieldName: {
// comparison: "between",
// valueBetweenStart: 100,
// valueBetweenEnd: 200
// }
// }
}
]
},
{ //* traversal no hopsPassObjType
filterType: "traversal",
traversals: [
{
links: [
{
relType: {},
direction: ""
},
{
relType: {},
direction: ""
}
],
//* other settings
hopsPassObjType: {
serviceTag: "",
objectType: ""
},
objType: {
serviceTag: "",
objectType: ""
}
},
{
fields: {
xxId: "xxxx"
}
}
]
}
]
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Complex Filter|Complex Filter]]

[[Category:Backend services| Complex Filter]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-03-18T00:07:43Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

"elements": {
// shared types
"elementId12":{
"elementType": "freetext",
"value": "aa"
}

// headerFooter types
"elementId1":{
"elementType": "valueUserTag",
"valueUserTag": "userTag_9",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId2":{
"elementType": "valueUserTag",
"inputType": "select",
"options": [
{
optionText:"option1",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"
},
{
optionText:"option2",
valueUserTag:{
userTag_9:"valueC"

},
],
},
"elementId21":{
"elementType": "valueUserTag",
"inputType": "checkbox",
"onSetting:{
optionText:"on",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"

},
},
"offSetting":{
optionText:"off",
valueUserTag:{
userTag_9:"valueC"

},
},

},
"elementId3":{
"elementType": "sort",
"display": "downArrow", // || upArrow
"requiredDataLinkStepObjectId": "userTag_LinkStepObjectC",
"dataType": "number", // "number" | "string"
"sortOrder": "ascending" // "ascending"|"descending" (default ascending)
},
"elementId4":{
"elementType": "numberOfRows",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId5":{
"elementType":"numberOfRows",
"inputType": "select",
"options": [
{
optionText:"page5",
value:5
},
{
optionText:"page7",
value:7
},
],
},
"elementId6":{
"elementType": "submit",
"display": "submit", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId7":{
"elementType": "reset",
"display": "reset rows", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId9":{
"elementType": "totalDatafield",
"requiredDataLinkStepObjectId": "link1",
"showIfNotAllRowsLoaded": true // || false
},
"elementId11":{
// will need to link to per record check box
"elementType": "bulkAction",
"action": "on" // on | off | switch
"bulkActionUserTag": "tagA", // have normalized list of bulkActionTags, with list of "bulkAction" and "bulkActionCheckBox" elements linked to it
},
"elementId8":{
"elementType": "pageNumbers",
"linksAfter": [
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": ">"
},
{
"action": "goToLastPage",
"hideWhenLastPageShown": true,
"string": ">>"
}
],
"linksBefore": [
{
"action": "goToFirstPage",
"hideWhenFirstPageShown": true,
"string": "<<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": "<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
}
],
"showPagesAfter": 3,
"showPagesBefore": 3
},

// records types
"elementId5":{
"elementType": "requiredDataLinkStepObject", // in record
"requiredDataLinkStepObjectId": "link1",
},
"elementIdxx":{
"elementType": "bulkActionCheckBox",
"bulkActionUserTag": "tagA",
},
},

valueUserTags: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
},

bulkActionUserTags: {
tagA:{
bulkActions: [
"elementId11",
// ...
],
bulkActionCheckBoxes: [
"elementIdxx",
// ...
],
},
// ...
},

}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
partitionKeyValueUserTags: {
productId: "userTag_1",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},

// ex. traversal type
// hash_traversal: {
// logicalElementType: "traversal",
// previousLogicalElementId: null,
// nextLogicalElementId: null,

// objType: {
// objectType: "locationNode",
// serviceTag: "Locations",
// },
// traversalSteps: [
// "hash_traversal_1",
// "hash_traversal_2",
// "hash_traversal_3",
// ]
// }
},
traversalSteps: {
hash_traversal_1: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "localtionLink"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasLocationLink"
},
direction: "to"
},

//* setting of traversal step
fieldValueUserTags: [...] //optional, if this step is not last step
relationshipProperties: {
// timestamp: 1231456 //or will ref value???? ====> not sure?
timestamp: "valueUserTag_A"
},
hopsPassObjType: true, //optional //* สามารถ hops ได้ทุก step ยกเว้น step สุดท้าย = traversal_5
hopsStart: 1, //optional default: 1
hopsEnd: 10, //optional

},
hash_traversal_2: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "isLocationNode"
},
direction: "to"
},
fieldValueUserTags: [...],//optional
hopsEnd: 10, //optional
},
hash_traversal_3:{
fieldValueUserTags: [
{
categoryId: "valueD"
},
{
categoryId: "valueA"
},
{
price: "valueF"
},
{
categoryId: "valueA"
},
{
categoryId: "valueB"
},
]
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
partitionKeyValueUserTags: {
locationNodeId: "userTag_7",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "userTag_8",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "userTag_8",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
conditionalFieldValues: [
{
fieldname: "userId",
includeValueUserTags: ["userTag_2"], //
// excludeValueUserTags: ["xx","sdd"]
}
]
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"],
sortOrder: "ascending"|"descending"
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "userTag_2",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"],
sortOrder: "ascending"|"descending"
}
],
valueUserTags: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-02-12T07:43:05Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

"elements": {
// shared types
"elementId12":{
"elementType": "freetext",
"value": "aa"
}

// headerFooter types
"elementId1":{
"elementType": "valueUserTag",
"valueUserTag": "userTag_9",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId2":{
"elementType": "valueUserTag",
"inputType": "select",
"options": [
{
optionText:"option1",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"
},
{
optionText:"option2",
valueUserTag:{
userTag_9:"valueC"

},
],
},
"elementId21":{
"elementType": "valueUserTag",
"inputType": "checkbox",
"onSetting:{
optionText:"on",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"

},
},
"offSetting":{
optionText:"off",
valueUserTag:{
userTag_9:"valueC"

},
},

},
"elementId3":{
"elementType": "sort",
"display": "downArrow", // || upArrow
"requiredDataLinkStepObjectId": "userTag_LinkStepObjectC",
"dataType": "number", // "number" | "string"
"sortOrder": "ascending" // "ascending"|"descending" (default ascending)
},
"elementId4":{
"elementType": "numberOfRows",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId5":{
"elementType":"numberOfRows",
"inputType": "select",
"options": [
{
optionText:"page5",
value:5
},
{
optionText:"page7",
value:7
},
],
},
"elementId6":{
"elementType": "submit",
"display": "submit", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId7":{
"elementType": "reset",
"display": "reset rows", // any text to be shown
"sendRequest": ["sort", "numberOfRows", "filter"]
},
"elementId9":{
"elementType": "totalDatafield",
"requiredDataLinkStepObjectId": "link1",
"showIfNotAllRowsLoaded": true // || false
},
"elementId11":{
// will need to link to per record check box
"elementType": "bulkAction",
"action": "on" // on | off | switch
"bulkActionUserTag": "tagA", // have normalized list of bulkActionTags, with list of "bulkAction" and "bulkActionCheckBox" elements linked to it
},
"elementId8":{
"elementType": "pageNumbers",
"linksAfter": [
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": ">"
},
{
"action": "goToLastPage",
"hideWhenLastPageShown": true,
"string": ">>"
}
],
"linksBefore": [
{
"action": "goToFirstPage",
"hideWhenFirstPageShown": true,
"string": "<<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": "<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
}
],
"showPagesAfter": 3,
"showPagesBefore": 3
},

// records types
"elementId5":{
"elementType": "requiredDataLinkStepObject", // in record
"requiredDataLinkStepObjectId": "link1",
},
"elementIdxx":{
"elementType": "bulkActionCheckBox",
"bulkActionUserTag": "tagA",
},
},

values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
},

bulkActionUserTags: {
tagA:{
bulkActions: [
"elementId11",
// ...
],
bulkActionCheckBoxes: [
"elementIdxx",
// ...
],
},
// ...
},

}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
partitionKeyValueUserTags: {
productId: "userTag_1",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},

// ex. traversal type
// uuid_traversal: {
// logicalElementType: "traversal",
// previousLogicalElementId: null,
// nextLogicalElementId: null,

// objType: {
// objectType: "locationNode",
// serviceTag: "Locations",
// },
// traversalSteps: [
// "uuid_traversal_1",
// "uuid_traversal_2",
// "uuid_traversal_3",
// ]
// }
},
traversalSteps: {
uuid_traversal_1: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "localtionLink"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasLocationLink"
},
direction: "to"
},
hopsPassObjType: true, //optional
hopsEnd: 10, //optional
},
uuid_traversal_2: {
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "isLocationNode"
},
direction: "to"
},
//* last traversal cannot set hopPassObjType
hopsEnd: 10, //optional
},
uuid_traversal_3:{
fieldValueUserTags: [
{
categoryId: "valueD"
},
{
categoryId: "valueA"
},
{
price: "valueF"
},
{
categoryId: "valueA"
},
{
categoryId: "valueB"
},
]
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
partitionKeyValueUserTags: {
locationNodeId: "userTag_7",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "userTag_8",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "userTag_8",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
conditionalFieldValues: [
{
fieldname: "userId",
includeValueUserTags: ["userTag_2"], //
// excludeValueUserTags: ["xx","sdd"]
}
]
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"],
sortOrder: "ascending"|"descending"
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "userTag_2",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"],
sortOrder: "ascending"|"descending"
}
],
valueUserTags: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-02-05T08:03:39Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

"elements": {
// shared types
"elementId12":{
"elementType": "freetext",
"value": "aa"
}

// headerFooter types
"elementId1":{
"elementType": "valueUserTag",
"valueUserTag": "userTag_9",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId2":{
"elementType": "valueUserTag",
"inputType": "select",
"options": [
{
optionText:"option1",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"
},
{
optionText:"option2",
valueUserTag:{
userTag_9:"valueC"

},
],
},
"elementId21":{
"elementType": "valueUserTag",
"inputType": "checkbox",
"onSetting:{
optionText:"on",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"

},
},
"offSetting":{
optionText:"off",
valueUserTag:{
userTag_9:"valueC"

},
},

},
"elementId3":{
"elementType": "sort",
"display": "downArrow", // || upArrow
"requiredDataLinkStepObjectId": "userTag_LinkStepObjectC",
"dataType": "number", // "number" | "string"
"sortOrder": "ascending" // "ascending"|"descending" (default ascending)
},
"elementId4":{
"elementType": "numberOfRows",
"selection": "input" // || list
},
"elementId6":{
"elementType": "submit",
"display": "submit", // any text to be shown
"sendRequest": "all" // numberOfRows || all || filters
},
"elementId7":{
"elementType": "reset",
"display": "reset rows", // any text to be shown
"sendRequest": "numberOfRows" // numberOfRows || all || filters
},
"elementId9":{
"elementType": "totalDatafield",
"requiredDataLinkStepObjectId": "link1",
"showIfNotAllRowsLoaded": true // || false
},
"elementId11":{
// will need to link to per record check box
"elementType": "bulkAction",
"action": "on" // on | off | switch
"bulkActionUserTag": "tagA", // have normalized list of bulkActionTags, with list of "bulkAction" and "bulkActionCheckBox" elements linked to it
},
"elementId8":{
"elementType": "pageNumbers",
"linksAfter": [
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": ">"
},
{
"action": "goToLastPage",
"hideWhenLastPageShown": true,
"string": ">>"
}
],
"linksBefore": [
{
"action": "goToFirstPage",
"hideWhenFirstPageShown": true,
"string": "<<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": "<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
}
],
"showPagesAfter": 3,
"showPagesBefore": 3
},

// records types
"elementId5":{
"elementType": "requiredDataLinkStepObject", // in record
"requiredDataLinkStepObjectId": "link1",
},
"elementIdxx":{
"elementType": "bulkActionCheckBox",
"bulkActionUserTag": "tagA",
},
},

values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
},

bulkActionUserTags: {
tagA:{
bulkActions: [
"elementId11",
// ...
],
bulkActionCheckBoxes: [
"elementIdxx",
// ...
],
},
// ...
},

}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
partitionKeyValueUserTags: {
productId: "userTag_1",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},

// ex. traversal type
// uuid_traversal: {
// logicalElementType: "traversal",
// previousLogicalElementId: null,
// nextLogicalElementId: null,

// objType: {
// objectType: "locationNode",
// serviceTag: "Locations",
// },
// traversalSteps: [
// "uuid_traversal_1",
// "uuid_traversal_2",
// ]
// }
},
traversalSteps: {
uuid_traversal_1: {
objType: {
serviceTag: "Locations",
objectType: "localtionLink"
},
link: {
relType: {
serviceTag: "Locations",
relationshipTag: "hasLocationLink"
},
relationshipDirection: "to"
},
hopsPassObjType: true, //optional
hopsEnd: 10, //optional
},
uuid_traversal_2: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
link: {
relType: {
serviceTag: "Locations",
relationshipTag: "isLocationNode"
},
relationshipDirection: "to"
},
//* last traversal cannot set hopPassObjType
hopsEnd: 10, //optional
fieldValueUserTags: [
{
categoryId: "valueD"
},
{
categoryId: "valueA"
},
{
price: "valueF"
},
{
categoryId: "valueA"
},
{
categoryId: "valueB"
},
]
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
partitionKeyValueUserTags: {
locationNodeId: "userTag_7",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "userTag_8",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "userTag_8",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
conditionalFieldValues: [
{
fieldname: "userId",
includeValueUserTags: ["userTag_2"], //
// excludeValueUserTags: ["xx","sdd"]
}
]
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"],
sortOrder: "ascending"|"descending"
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "userTag_2",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"],
sortOrder: "ascending"|"descending"
}
],
valueUserTags: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-02-05T06:54:32Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

"elements": {
// shared types
"elementId12":{
"elementType": "freetext",
"value": "aa"
}

// headerFooter types
"elementId1":{
"elementType": "valueUserTag",
"valueUserTag": "userTag_9",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId2":{
"elementType": "valueUserTag",
"inputType": "select",
"options": [
{
optionText:"option1",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"
},
{
optionText:"option2",
valueUserTag:{
userTag_9:"valueC"

},
],
},
"elementId21":{
"elementType": "valueUserTag",
"inputType": "checkbox",
"onSetting:{
optionText:"on",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"

},
},
"offSetting":{
optionText:"off",
valueUserTag:{
userTag_9:"valueC"

},
},

},
"elementId3":{
"elementType": "sort",
"display": "downArrow", // || upArrow
"requiredDataLinkStepObjectId": "userTag_LinkStepObjectC",
"dataType": "number", // "number" | "string"
"sortOrder": "ascending" // "ascending"|"descending" (default ascending)
},
"elementId4":{
"elementType": "numberOfRows",
"selection": "input" // || list
},
"elementId6":{
"elementType": "submit",
"display": "submit", // any text to be shown
"sendRequest": "all" // numberOfRows || all || filters
},
"elementId7":{
"elementType": "reset",
"display": "reset rows", // any text to be shown
"sendRequest": "numberOfRows" // numberOfRows || all || filters
},
"elementId9":{
"elementType": "totalDatafield",
"requiredDataLinkStepObjectId": "link1",
"showIfNotAllRowsLoaded": true // || false
},
"elementId11":{
// will need to link to per record check box
"elementType": "bulkAction",
"action": "on" // on | off | switch
"bulkActionUserTag": "tagA", // have normalized list of bulkActionTags, with list of "bulkAction" and "bulkActionCheckBox" elements linked to it
},
"elementId8":{
"elementType": "pageNumbers",
"linksAfter": [
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": ">"
},
{
"action": "goToLastPage",
"hideWhenLastPageShown": true,
"string": ">>"
}
],
"linksBefore": [
{
"action": "goToFirstPage",
"hideWhenFirstPageShown": true,
"string": "<<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": "<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
}
],
"showPagesAfter": 3,
"showPagesBefore": 3
},

// records types
"elementId5":{
"elementType": "requiredDataLinkStepObject", // in record
"requiredDataLinkStepObjectId": "link1",
},
"elementIdxx":{
"elementType": "bulkActionCheckBox",
"bulkActionUserTag": "tagA",
},
},

values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
},

bulkActionUserTags: {
tagA:{
bulkActions: [
"elementId11",
// ...
],
bulkActionCheckBoxes: [
"elementIdxx",
// ...
],
},
// ...
},

}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
partitionKeyValueUserTags: {
productId: "userTag_1",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},

// ex. traversal type
// uuid_traversal: {
// logicalElementType: "traversal",
// previousLogicalElementId: null,
// nextLogicalElementId: null,

// objType: {
// objectType: "locationNode",
// serviceTag: "Locations",
// },
// traversalSteps: [
// "uuid_traversal_1",
// "uuid_traversal_2",
// ]
// }
},
traversalSteps: {
uuid_traversal_1: {
objType: {
serviceTag: "Locations",
objectType: "localtionLink"
},
link: {
relType: {
serviceTag: "Locations",
relationshipTag: "hasLocationLink"
},
relationshipDirection: "to"
},
hopsPassObjType: true, //optional
hopsEnd: 10, //optional
},
uuid_traversal_2: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
link: {
relType: {
serviceTag: "Locations",
relationshipTag: "isLocationNode"
},
relationshipDirection: "to"
},
//* last traversal cannot set hopPassObjType
hopsEnd: 10, //optional
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
partitionKeyValueUserTags: {
locationNodeId: "userTag_7",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "userTag_8",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "userTag_8",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
conditionalFieldValues: [
{
fieldname: "userId",
includeValueUserTags: ["userTag_2"], //
// excludeValueUserTags: ["xx","sdd"]
}
]
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"],
sortOrder: "ascending"|"descending"
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "userTag_2",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"],
sortOrder: "ascending"|"descending"
}
],
valueUserTags: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-02-05T06:53:55Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

"elements": {
// shared types
"elementId12":{
"elementType": "freetext",
"value": "aa"
}

// headerFooter types
"elementId1":{
"elementType": "valueUserTag",
"valueUserTag": "userTag_9",
"inputType": "text" // || "select" || "checkbox" || "radio" ,
},
"elementId2":{
"elementType": "valueUserTag",
"inputType": "select",
"options": [
{
optionText:"option1",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"
},
{
optionText:"option2",
valueUserTag:{
userTag_9:"valueC"

},
],
},
"elementId21":{
"elementType": "valueUserTag",
"inputType": "checkbox",
"onSetting:{
optionText:"on",
valueUserTag:{
userTag_1:"valueA", //value not ref valueUserTag
userTag_2:"valueB"

},
},
"offSetting":{
optionText:"off",
valueUserTag:{
userTag_9:"valueC"

},
},

},
"elementId3":{
"elementType": "sort",
"display": "downArrow", // || upArrow
"requiredDataLinkStepObjectId": "userTag_LinkStepObjectC",
"dataType": "number", // "number" | "string"
"sortOrder": "ascending" // "ascending"|"descending" (default ascending)
},
"elementId4":{
"elementType": "numberOfRows",
"selection": "input" // || list
},
"elementId6":{
"elementType": "submit",
"display": "submit", // any text to be shown
"sendRequest": "all" // numberOfRows || all || filters
},
"elementId7":{
"elementType": "reset",
"display": "reset rows", // any text to be shown
"sendRequest": "numberOfRows" // numberOfRows || all || filters
},
"elementId9":{
"elementType": "totalDatafield",
"requiredDataLinkStepObjectId": "link1",
"showIfNotAllRowsLoaded": true // || false
},
"elementId11":{
// will need to link to per record check box
"elementType": "bulkAction",
"action": "on" // on | off | switch
"bulkActionUserTag": "tagA", // have normalized list of bulkActionTags, with list of "bulkAction" and "bulkActionCheckBox" elements linked to it
},
"elementId8":{
"elementType": "pageNumbers",
"linksAfter": [
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": ">"
},
{
"action": "goToLastPage",
"hideWhenLastPageShown": true,
"string": ">>"
}
],
"linksBefore": [
{
"action": "goToFirstPage",
"hideWhenFirstPageShown": true,
"string": "<<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 1,
"string": "<"
},
{
"action": "jumpNumberOfPages",
"jumpPages": 7,
"string": ".."
}
],
"showPagesAfter": 3,
"showPagesBefore": 3
},

// records types
"elementId5":{
"elementType": "requiredDataLinkStepObject", // in record
"requiredDataLinkStepObjectId": "link1",
},
"elementIdxx":{
"elementType": "bulkActionCheckBox",
"bulkActionUserTag": "tagA",
},
},

values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
},

bulkActionUserTags: {
tagA:{
bulkActions: [
"elementId11",
// ...
],
bulkActionCheckBoxes: [
"elementIdxx",
// ...
],
},
// ...
},

}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
partitionKeyValueUserTags: {
productId: "userTag_1",
},
sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
},

// ex. traversal type
// uuid_traversal: {
// logicalElementType: "traversal",
// previousLogicalElementId: null,
// nextLogicalElementId: null,

// objType: {
// objectType: "locationNode",
// serviceTag: "Locations",
// },
// traversalSteps: [
// "uuid_traversal_1",
// "uuid_traversal_2",
// ]
// }
},
traversalSteps: {
uuid_traversal_1: {
objType: {
serviceTag: "Locations",
objectType: "localtionLink"
},
link: {
relType: {
serviceTag: "Locations",
relationshipTag: "hasLocationLink"
},
relationshipDirection: "to"
},
hopsPassObjType: true, //optional
hopsEnd: 10, //optional
},
uuid_traversal_2: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
link: {
relType: {
serviceTag: "Locations",
relationshipTag: "isLocationNode"
},
relationshipDirection: "to"
},
//* last traversal cannot set hopPassObjType
hopsEnd: 10, //optional
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
partitionKeyValueUserTags: {
locationNodeId: "userTag_7",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "userTag_8",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
// conditionalFieldValues: [
// {
// fieldname: "language",
// includeValueUserTags: ["th"],
// // excludeValueUserTags: ["xx","sdd"]
// }
// ]
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
partitionKeyValueUserTags: {
sellOfferId: "userTag_8",
},
// sortKeyValueUserTags: {
// productId: "valueB",
// },
// comparison: "equals",
conditionalFieldValues: [
{
fieldname: "userId",
includeValueUserTags: ["userTag_2"], //
// excludeValueUserTags: ["xx","sdd"]
}
]
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"],
sortOrder: "ascending"|"descending"
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "userTag_2",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string",
sortOrder: "ascending"|"descending"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"],
sortOrder: "ascending"|"descending"
}
],
valueUserTags: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-02-05T06:37:39Z

Praew:

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-02-05T06:33:51Z

Praew:

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-01-19T01:59:08Z

Praew:

2025-04-17 - LinkPath structure and examples

2026-01-12T01:01:21Z

Praew:

[[Service - Search Results]]

= requiredData normalize structure =
* component => requiredDataObjects , linkPathObjects, linkPathSteps

<syntaxhighlight lang="js">

{
requiredDataObjects: {
hash_requiredDataObjectA: { //* normal requiredData
fieldName: "fieldname if main objType or last fieldName for linkPath",
},
hash_requiredDataObjectB: { //* has LinkPath
fieldName: "fieldname if main objType or last fieldName for linkPath",
linkPathObjectId: "hash_linkPathA",
complexFilterCombinationIds: [ //* has applyCombinations
"xxxxx",
"xxxxx"
]
}
},
linkPathObjects: {
hash_linkPathA: {
initialObjType: {
serviceTag: "ProductManager",
objectType: "product"
},
linkSteps: [
"hash_linkStepB_1",
"hash_linkStepB_2"
]
}
},
linkPathSteps: {
hash_linkStepB_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer"
},
direction: "from"
},

//------ conditions by link ------// : optional
filterElementId: "ref_filterMainIdA",
aggregate: "max",
sortFields: [
{
fieldName: "xxx",
dataType: "string"
}
],
},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "from"
},
//------ conditions by link ------//
filterElementId: "ref_filterMainIdA",
aggregate: "max",
sortFields: [
{
fieldName: "xxx",
dataType: "string"
}
],
requiredDataObjects: [ //* for use to create linkPath in linkPath
{
fieldName: "xxx",
}
]
combine: "true",
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "50",
requestProperties: {
tag_xxxx: "value"
},
perParentCombinationIds: [
{
tag: "tag_xxxxx",
filterMainId: "xxxxx"
}
],
applyCombinations: [
{
tag: "tag_xxxxx",
filterMainId: "xxxxx"
}
]
}
}
}

== ProcessSearchResultMessage ==
* Fetch and Sort Product Sizes by Language with Fallback
<syntaxhighlight lang="js">

Need to fetch all sizes, sorted by language order 'en', 'th'.
If a translation is missing for any language in sortArray: ['en', 'th'],
fallback to the defaultTranslationLink of that productAttribute.
ProductAttributeLabel with labelId = 'Id_X' represents a size.
identifiersIdArray contains all productAttributeIds linked to ProductAttributeLabel where labelId='Id_X'.
</syntaxhighlight>

<syntaxhighlight lang="js">

let processSearchResultMessage = {
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
},
requiredData: [
{
fieldName: 'text', //all sizes by languageId, where text is the identifiers of the translation objectType, which is the final link step of this requiredData
linkPath: [
{
link: {
relType: {
serviceTag: 'Translations',
relationshipTag: 'hasTranslationLink'
// Must use hasTranslationLink because it will be automatically added by inserting a filterElement with logicalType: "translateIds"
// where identifiers come from identifiersIdArray (Process-ComplexFilter), along with a filterElement of type: "logicalOperator" and operator: "and"
},
objType: {
serviceTag: 'Translations',
objectType: 'translationLink'
},
direction: 'from'
},
aggregate: 'min', //if 'min' sorts languages in order 'en', 'th', //if max sorts languages in order 'th', 'en
sortFields: {
fieldName: 'languageId',
dataType: 'array',
sortArray: ['en', 'th'] // sorts languages according to sortArray
},
filterElements: [
{
type: 'group',
elements: [
{
type: 'traversal',
traversals: [
{
fields: {
languageId: { anyValue: ['en', 'th'] },
textTag: 'productAttributeValue'
},
link: {
relationshipDirection: 'from',
relType: {
serviceTag: 'Translations',
relationshipTag: 'currentTranslationLink'
}
}
},
{
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
}
}
]
},
{
type: 'logicalOperator', operator: 'or'
},
{
type: 'traversal',
traversals: [
{
fields: {
textTag: 'productAttributeValue'
},
link: {
relationshipDirection: 'from',
relType: {
serviceTag: 'Translations',
relationshipTag: 'defaultTranslationLink'
}
}
},
{
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
}
}
]
}
]
}
]
},
{
link: {
relType: {
serviceTag: 'Translations',
relationshipTag: 'isTranslation'
},
objType: {
serviceTag: 'Translations',
objectType: 'translation'
},
direction: 'from'
}
}
]
}
],
filter: {
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
},
elements: [
{
type: 'complexFilter',
complexFilter: {
objType: {
serviceTag: 'ProductAttribute',
objectType: 'ProductAttributeLabel'
},
relType: {
serviceTag: 'ProductAttribute',
relationshipTag: 'isProductAttributeLabel'
},
direction: 'from',
elements: [
{
type: 'logical',
fieldName: 'labelId',
comparison: 'equals',
value: 'Id_X'
}
]
}
}
]
},
requestProperties: {},
identifiersIdArray: [
{
identifiersId: 'hashOfIdentifiersObject_1',
identifiers: {
productAttributeId: 'productAttributeId_uuid_1'
}
},
{
identifiersId: 'hashOfIdentifiersObject_2',
identifiers: {
productAttributeId: 'productAttributeId_uuid_2'
}
},
{
identifiersId: 'hashOfIdentifiersObject_3',
identifiers: {
productAttributeId: 'productAttributeId_uuid_3'
}
}
]
}

</syntaxhighlight>

== example search and sort request ==

<syntaxhighlight lang="js">

{
"objType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"searchResultId":"8e5fecd40a27e47f89cd2743916c0044f0f69bc6",
"searchDetailId":"3462d3248d3af9406554f1c218b63442d26ac2e5",
"requiredDataObjects":{
"4c8e7879d26e6fa7ab85ded25a79a541754c5a3c":{
"fieldName":"productId",
"linkPathObjectId":"1a8a3f9c2c3ea5eaad1f42385362de5dd11cde8a"
},
"c799f11507529f0fb6fa712568596d24b6507d40":{
"fieldName":"sellOfferHandlerServiceTag",
"linkPathObjectId":"5909f82f27bd6c1f921e95b88a65b6e4727a6532",
"complexFilterCombinationIds":[
"88d9c5b9ab36d8c3ebf17e8322541b9c64cae25b",
"51509dea0a7ba2746dbd24769b8e777f1411f3ff",
"d7a7f875254e856b4205075826631ec042b4c821",
"b96447ae98c95858694ca5ec407750c559825930"
]
}
},
"searchParams":{
"filterObjectId":"8e5fecd40a27e47f89cd2743916c0044f0f69bc6"
},
"filterElements":{
"8e5fecd40a27e47f89cd2743916c0044f0f69bc6":{
"objType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"filterElement":{
"filterType":"logical",
"fieldName":"sellOfferId",
"comparison":"equals",
"value":"sellOfferId_001"
}
},
"d92ca4f68dc0d474cfdc10a6c702a5c7224a822c":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"logical",
"fieldName":"rateTableId",
"comparison":"highLow",
"valueType":"perParentIdentifier",
"perParentIdentifierFieldname":"sellOfferId"
}
},
"cd378bc32fbc9a46929c9a9d590e7d77243a839c":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"logical",
"fieldName":"rateTableId",
"comparison":"lessThanEquals",
"value":"cccc"
}
},
"0c287df25d6ff203be7cc9faa2390f6ab0df3878":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"operation",
"filterElementLeft":"d92ca4f68dc0d474cfdc10a6c702a5c7224a822c",
"filterElementRight":"cd378bc32fbc9a46929c9a9d590e7d77243a839c",
"operator":"AND"
}
},
"e0b8534452e98796f144c83a221764ef32db5ab6":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"childComplexFilter",
"childFilterElementId":"0c287df25d6ff203be7cc9faa2390f6ab0df3878",
"pathLinkType":{
"relType":{
"serviceTag":"DeliveryMethodRAT",
"relationshipTag":"disabledDeliversTolocationNode"
},
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"direction":"to"
},
"requestProperties":{}
}
},
"88d9c5b9ab36d8c3ebf17e8322541b9c64cae25b":{
"objType":{
"serviceTag":"SellOfferPlan",
"objectType":"sellOfferPlan"
},
"filterElement":{
"filterType":"logical",
"fieldName":"currencyId",
"comparison":"lessThan",
"value":"bbbb"
}
},
"51509dea0a7ba2746dbd24769b8e777f1411f3ff":{
"objType":{
"serviceTag":"SellOfferPlan",
"objectType":"sellOfferPlanUserPaymentMethodLink"
},
"filterElement":{
"filterType":"logical",
"fieldName":"sellOfferPlanUserPaymentMethodLinkId",
"comparison":"lessThan",
"value":"bbbb"
}
},
"a5491ba3deb74e523741c8cfeb845f49db444a9c":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"logical",
"fieldName":"locationNodeId",
"comparison":"lessThan",
"value":"cccc"
}
},
"7820aef170ae6c3e723382d6bc81d7b12a674974":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"logical",
"fieldName":"rateTableId",
"comparison":"highLow",
"value":"aaaa"
}
},
"554fc368ec36c13a93e3c71c8081951060965bb2":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"childComplexFilter",
"childFilterElementId":"7820aef170ae6c3e723382d6bc81d7b12a674974",
"pathLinkType":{
"relType":{
"serviceTag":"DeliveryMethodRAT",
"relationshipTag":"deliversToLocationNode"
},
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"direction":"to"
},
"requestProperties":{}
}
},
"d7a7f875254e856b4205075826631ec042b4c821":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"operation",
"filterElementLeft":"a5491ba3deb74e523741c8cfeb845f49db444a9c",
"filterElementRight":"554fc368ec36c13a93e3c71c8081951060965bb2",
"operator":"OR"
}
},
"b96447ae98c95858694ca5ec407750c559825930":{
"objType":{
"serviceTag":"SellOfferPlan",
"objectType":"sellOfferPlanUserPaymentMethodLink"
},
"filterElement":{
"filterType":"operation",
"filterElementLeft":"5faa4000cfb72e7aa28603a7740c212f6d6db5e0",
"filterElementRight":"a1aa8d2907f8b6f24e7b66116129838e978bcaee",
"operator":"OR"
}
}
},
"linkPathObjects":{
"1a8a3f9c2c3ea5eaad1f42385362de5dd11cde8a":{
"initialObjType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"linkSteps":[
"fa9a637eb09df71d939b3d914eb9ee27ae83048e",
"d3e2d36cab6d9441db10a7c983834cf9196398b3",
"fa9a637eb09df71d939b3d914eb9ee27ae83048e"
]
},
"2794814ec253fc93496bfcb50ea18ebfe640bf4d":{
"initialObjType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"linkSteps":[
"fa9a637eb09df71d939b3d914eb9ee27ae83048e",
"11704ae9a828b4709300964e2e0361bad13db5c3",
"964050f23f92b45a1ea573a573c50ae3ca2bae18"
]
},
"5909f82f27bd6c1f921e95b88a65b6e4727a6532":{
"initialObjType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"linkSteps":[
"fa9a637eb09df71d939b3d914eb9ee27ae83048e",
"634dd9295fcb1834de0a6ed1f1ab8a9fa06c4d7f",
"d3fc84fa4444406cef2de49baf53d38ab86cd2e0",
"2b0537fa34ee1d259488fce12204dd549e1c98a3"
]
}
},
"linkPathSteps":{
"fa9a637eb09df71d939b3d914eb9ee27ae83048e":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"ProductManager",
"objectType":"product"
},
"direction":"to"
}
},
"d3e2d36cab6d9441db10a7c983834cf9196398b3":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"from"
},
"comparison":"lessThan",
"comparisonSortField":"productId",
"comparisonSortDataType":"string",
"comparisonValue":"eeee"
},
"634dd9295fcb1834de0a6ed1f1ab8a9fa06c4d7f":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"from"
},
"aggregate":"min",
"sortFields":[
{
"fieldName":"SellOfferManager_CalCombinedPricingUniqueRequestId",
"dataType":"string"
}
],
"requiredDataObjects":[
{
"fieldName":"SellOfferManager_CalCombinedPricingUniqueRequestId",
"linkPathObjectId":"2794814ec253fc93496bfcb50ea18ebfe640bf4d"
}
]
},
"d3fc84fa4444406cef2de49baf53d38ab86cd2e0":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasOrderPrice"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"orderPrice"
},
"direction":"from"
},
"requestProperties":{
"tag_sellOfferPlan":"bbbb",
"tag_sellOfferPlanDeliveryMethodLink":"bbbb"
},
"perParentCombinationIds":[
{
"tag":"tag_deliverTo",
"filterMainId":"e0b8534452e98796f144c83a221764ef32db5ab6"
}
],
"applyCombinations":[
{
"tag":"tag_sellOfferPlanUserPaymentMethodLink",
"filterMainId":"51509dea0a7ba2746dbd24769b8e777f1411f3ff"
}
]
},
"2b0537fa34ee1d259488fce12204dd549e1c98a3":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasOrderPrice"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"to"
},
"requestProperties":{
"tag_deliverTo":"aaaa",
"tag_sellOfferPlanDeliveryMethodLink":"bbbb"
},
"applyCombinations":[
{
"tag":"tag_sellOfferPlan",
"filterMainId":"88d9c5b9ab36d8c3ebf17e8322541b9c64cae25b"
},
{
"tag":"tag_sellOfferPlanUserPaymentMethodLink",
"filterMainId":"51509dea0a7ba2746dbd24769b8e777f1411f3ff"
}
]
},
"11704ae9a828b4709300964e2e0361bad13db5c3":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"from"
},
"aggregate":"average",
"sortFields":[
{
"fieldName":"sellOfferHandlerServiceTag",
"dataType":"string"
}
],
"requiredDataObjects":[
{
"fieldName":"sellOfferHandlerServiceTag",
"linkPathObjectId":"cae7f8604e62fd4ac09146f5bdd512d9db668c70"
}
],
"combine":true
},
"964050f23f92b45a1ea573a573c50ae3ca2bae18":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasOrderPrice"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"orderPrice"
},
"direction":"from"
},
"requestProperties":{
"tag_sellOfferPlan":"aaaa",
"tag_sellOfferPlanDeliveryMethodLink":"bbbb"
},
"applyCombinations":[
{
"tag":"tag_deliverTo",
"filterMainId":"d7a7f875254e856b4205075826631ec042b4c821"
},
{
"tag":"tag_sellOfferPlanUserPaymentMethodLink",
"filterMainId":"b96447ae98c95858694ca5ec407750c559825930"
}
],
"comparison":"highLow",
"comparisonSortField":"sellOfferHandlerServiceTag",
"comparisonSortDataType": "string"
"comparisonValue":"aaaa"
}
},
"sortFields":[
{
"fieldName":"productId",
"dataType":"string"
},
{
"fieldName":"productId",
"dataType":"array",
"sortArray":[
"ffff",
"eeee"
]
}
]
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-17]]
[[Category:Working documents - Search Results| 2025-04-17]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-01-09T00:11:00Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

elements: {
// add example of pageOutput element that references requiredDataLinkStepObjects and valueUserTags
},
values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
valueUserTag: "userTag_1"
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
valueUserTag: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
valueUserTag: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
valueUserTag: "userTag_2"
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string"
},

{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"]
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "userTag_2",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"]
}
],
valueUserTags: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-01-09T00:09:53Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

elements: {
// add example of pageOutput element that references requiredDataLinkStepObjects and valueUserTags
},
values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
valueUserTag: "userTag_1"
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
valueUserTag: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
valueUserTag: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
valueUserTag: "userTag_2"
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string"
},

{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"]
}
],
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonSortDataType: "string",
comparisonValue: "50",
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"]
}
],
valueUserTags: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-17 - LinkPath structure and examples

2026-01-06T02:40:39Z

Praew:

[[Service - Search Results]]

= reqiuredData normalize structure =
* component => requiredDataObjects , linkPathObjects, linkPathSteps

<syntaxhighlight lang="js">

{
requiredDataObjects: {
hash_requiredDataObjectA: { //* normal requiredData
fieldName: "fieldname if main objType or last fieldName for linkPath",
},
hash_requiredDataObjectB: { //* has LinkPath
fieldName: "fieldname if main objType or last fieldName for linkPath",
linkPathObjectId: "hash_linkPathA",
complexFilterCombinationIds: [ //* has applyCombinations
"xxxxx",
"xxxxx"
]
}
},
linkPathObjects: {
hash_linkPathA: {
initialObjType: {
serviceTag: "ProductManager",
objectType: "product"
},
linkSteps: [
"hash_linkStepB_1",
"hash_linkStepB_2"
]
}
},
linkPathSteps: {
hash_linkStepB_1: {
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "hasSellOffer"
},
direction: "from"
},

//------ conditions by link ------// : optional
filterElementId: "ref_filterMainIdA",
aggregate: "max",
sortFields: [
{
fieldName: "xxx",
dataType: "string"
}
],
},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "from"
},
//------ conditions by link ------//
filterElementId: "ref_filterMainIdA",
aggregate: "max",
sortFields: [
{
fieldName: "xxx",
dataType: "string"
}
],
requiredDataObjects: [ //* for use to create linkPath in linkPath
{
fieldName: "xxx",
}
]
combine: "true",
comparison: "greaterThan",
comparisonSortField: "upToValue",
comparisonValue: "50",
requestProperties: {
tag_xxxx: "value"
},
perParentCombinationIds: [
{
tag: "tag_xxxxx",
filterMainId: "xxxxx"
}
],
applyCombinations: [
{
tag: "tag_xxxxx",
filterMainId: "xxxxx"
}
]
}
}
}

== ProcessSearchResultMessage ==
* Fetch and Sort Product Sizes by Language with Fallback
<syntaxhighlight lang="js">

Need to fetch all sizes, sorted by language order 'en', 'th'.
If a translation is missing for any language in sortArray: ['en', 'th'],
fallback to the defaultTranslationLink of that productAttribute.
ProductAttributeLabel with labelId = 'Id_X' represents a size.
identifiersIdArray contains all productAttributeIds linked to ProductAttributeLabel where labelId='Id_X'.
</syntaxhighlight>

<syntaxhighlight lang="js">

let processSearchResultMessage = {
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
},
requiredData: [
{
fieldName: 'text', //all sizes by languageId, where text is the identifiers of the translation objectType, which is the final link step of this requiredData
linkPath: [
{
link: {
relType: {
serviceTag: 'Translations',
relationshipTag: 'hasTranslationLink'
// Must use hasTranslationLink because it will be automatically added by inserting a filterElement with logicalType: "translateIds"
// where identifiers come from identifiersIdArray (Process-ComplexFilter), along with a filterElement of type: "logicalOperator" and operator: "and"
},
objType: {
serviceTag: 'Translations',
objectType: 'translationLink'
},
direction: 'from'
},
aggregate: 'min', //if 'min' sorts languages in order 'en', 'th', //if max sorts languages in order 'th', 'en
sortFields: {
fieldName: 'languageId',
dataType: 'array',
sortArray: ['en', 'th'] // sorts languages according to sortArray
},
filterElements: [
{
type: 'group',
elements: [
{
type: 'traversal',
traversals: [
{
fields: {
languageId: { anyValue: ['en', 'th'] },
textTag: 'productAttributeValue'
},
link: {
relationshipDirection: 'from',
relType: {
serviceTag: 'Translations',
relationshipTag: 'currentTranslationLink'
}
}
},
{
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
}
}
]
},
{
type: 'logicalOperator', operator: 'or'
},
{
type: 'traversal',
traversals: [
{
fields: {
textTag: 'productAttributeValue'
},
link: {
relationshipDirection: 'from',
relType: {
serviceTag: 'Translations',
relationshipTag: 'defaultTranslationLink'
}
}
},
{
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
}
}
]
}
]
}
]
},
{
link: {
relType: {
serviceTag: 'Translations',
relationshipTag: 'isTranslation'
},
objType: {
serviceTag: 'Translations',
objectType: 'translation'
},
direction: 'from'
}
}
]
}
],
filter: {
objType: {
serviceTag: 'ProductAttribute',
objectType: 'productAttribute'
},
elements: [
{
type: 'complexFilter',
complexFilter: {
objType: {
serviceTag: 'ProductAttribute',
objectType: 'ProductAttributeLabel'
},
relType: {
serviceTag: 'ProductAttribute',
relationshipTag: 'isProductAttributeLabel'
},
direction: 'from',
elements: [
{
type: 'logical',
fieldName: 'labelId',
comparison: 'equals',
value: 'Id_X'
}
]
}
}
]
},
requestProperties: {},
identifiersIdArray: [
{
identifiersId: 'hashOfIdentifiersObject_1',
identifiers: {
productAttributeId: 'productAttributeId_uuid_1'
}
},
{
identifiersId: 'hashOfIdentifiersObject_2',
identifiers: {
productAttributeId: 'productAttributeId_uuid_2'
}
},
{
identifiersId: 'hashOfIdentifiersObject_3',
identifiers: {
productAttributeId: 'productAttributeId_uuid_3'
}
}
]
}

</syntaxhighlight>

== example search and sort request ==

<syntaxhighlight lang="js">

{
"objType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"searchResultId":"8e5fecd40a27e47f89cd2743916c0044f0f69bc6",
"searchDetailId":"3462d3248d3af9406554f1c218b63442d26ac2e5",
"requiredDataObjects":{
"4c8e7879d26e6fa7ab85ded25a79a541754c5a3c":{
"fieldName":"productId",
"linkPathObjectId":"1a8a3f9c2c3ea5eaad1f42385362de5dd11cde8a"
},
"c799f11507529f0fb6fa712568596d24b6507d40":{
"fieldName":"sellOfferHandlerServiceTag",
"linkPathObjectId":"5909f82f27bd6c1f921e95b88a65b6e4727a6532",
"complexFilterCombinationIds":[
"88d9c5b9ab36d8c3ebf17e8322541b9c64cae25b",
"51509dea0a7ba2746dbd24769b8e777f1411f3ff",
"d7a7f875254e856b4205075826631ec042b4c821",
"b96447ae98c95858694ca5ec407750c559825930"
]
}
},
"searchParams":{
"filterObjectId":"8e5fecd40a27e47f89cd2743916c0044f0f69bc6"
},
"filterElements":{
"8e5fecd40a27e47f89cd2743916c0044f0f69bc6":{
"objType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"filterElement":{
"filterType":"logical",
"fieldName":"sellOfferId",
"comparison":"equals",
"value":"sellOfferId_001"
}
},
"d92ca4f68dc0d474cfdc10a6c702a5c7224a822c":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"logical",
"fieldName":"rateTableId",
"comparison":"highLow",
"valueType":"perParentIdentifier",
"perParentIdentifierFieldname":"sellOfferId"
}
},
"cd378bc32fbc9a46929c9a9d590e7d77243a839c":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"logical",
"fieldName":"rateTableId",
"comparison":"lessThanEquals",
"value":"cccc"
}
},
"0c287df25d6ff203be7cc9faa2390f6ab0df3878":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"operation",
"filterElementLeft":"d92ca4f68dc0d474cfdc10a6c702a5c7224a822c",
"filterElementRight":"cd378bc32fbc9a46929c9a9d590e7d77243a839c",
"operator":"AND"
}
},
"e0b8534452e98796f144c83a221764ef32db5ab6":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"childComplexFilter",
"childFilterElementId":"0c287df25d6ff203be7cc9faa2390f6ab0df3878",
"pathLinkType":{
"relType":{
"serviceTag":"DeliveryMethodRAT",
"relationshipTag":"disabledDeliversTolocationNode"
},
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"direction":"to"
},
"requestProperties":{}
}
},
"88d9c5b9ab36d8c3ebf17e8322541b9c64cae25b":{
"objType":{
"serviceTag":"SellOfferPlan",
"objectType":"sellOfferPlan"
},
"filterElement":{
"filterType":"logical",
"fieldName":"currencyId",
"comparison":"lessThan",
"value":"bbbb"
}
},
"51509dea0a7ba2746dbd24769b8e777f1411f3ff":{
"objType":{
"serviceTag":"SellOfferPlan",
"objectType":"sellOfferPlanUserPaymentMethodLink"
},
"filterElement":{
"filterType":"logical",
"fieldName":"sellOfferPlanUserPaymentMethodLinkId",
"comparison":"lessThan",
"value":"bbbb"
}
},
"a5491ba3deb74e523741c8cfeb845f49db444a9c":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"logical",
"fieldName":"locationNodeId",
"comparison":"lessThan",
"value":"cccc"
}
},
"7820aef170ae6c3e723382d6bc81d7b12a674974":{
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"filterElement":{
"filterType":"logical",
"fieldName":"rateTableId",
"comparison":"highLow",
"value":"aaaa"
}
},
"554fc368ec36c13a93e3c71c8081951060965bb2":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"childComplexFilter",
"childFilterElementId":"7820aef170ae6c3e723382d6bc81d7b12a674974",
"pathLinkType":{
"relType":{
"serviceTag":"DeliveryMethodRAT",
"relationshipTag":"deliversToLocationNode"
},
"objType":{
"serviceTag":"DeliveryMethodRAT",
"objectType":"rateTable"
},
"direction":"to"
},
"requestProperties":{}
}
},
"d7a7f875254e856b4205075826631ec042b4c821":{
"objType":{
"serviceTag":"Locations",
"objectType":"locationNode"
},
"filterElement":{
"filterType":"operation",
"filterElementLeft":"a5491ba3deb74e523741c8cfeb845f49db444a9c",
"filterElementRight":"554fc368ec36c13a93e3c71c8081951060965bb2",
"operator":"OR"
}
},
"b96447ae98c95858694ca5ec407750c559825930":{
"objType":{
"serviceTag":"SellOfferPlan",
"objectType":"sellOfferPlanUserPaymentMethodLink"
},
"filterElement":{
"filterType":"operation",
"filterElementLeft":"5faa4000cfb72e7aa28603a7740c212f6d6db5e0",
"filterElementRight":"a1aa8d2907f8b6f24e7b66116129838e978bcaee",
"operator":"OR"
}
}
},
"linkPathObjects":{
"1a8a3f9c2c3ea5eaad1f42385362de5dd11cde8a":{
"initialObjType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"linkSteps":[
"fa9a637eb09df71d939b3d914eb9ee27ae83048e",
"d3e2d36cab6d9441db10a7c983834cf9196398b3",
"fa9a637eb09df71d939b3d914eb9ee27ae83048e"
]
},
"2794814ec253fc93496bfcb50ea18ebfe640bf4d":{
"initialObjType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"linkSteps":[
"fa9a637eb09df71d939b3d914eb9ee27ae83048e",
"11704ae9a828b4709300964e2e0361bad13db5c3",
"964050f23f92b45a1ea573a573c50ae3ca2bae18"
]
},
"5909f82f27bd6c1f921e95b88a65b6e4727a6532":{
"initialObjType":{
"objectType":"sellOffer",
"serviceTag":"SellOfferManager"
},
"linkSteps":[
"fa9a637eb09df71d939b3d914eb9ee27ae83048e",
"634dd9295fcb1834de0a6ed1f1ab8a9fa06c4d7f",
"d3fc84fa4444406cef2de49baf53d38ab86cd2e0",
"2b0537fa34ee1d259488fce12204dd549e1c98a3"
]
}
},
"linkPathSteps":{
"fa9a637eb09df71d939b3d914eb9ee27ae83048e":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"ProductManager",
"objectType":"product"
},
"direction":"to"
}
},
"d3e2d36cab6d9441db10a7c983834cf9196398b3":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"from"
},
"comparison":"lessThan",
"comparisonSortField":"productId",
"comparisonValue":"eeee"
},
"634dd9295fcb1834de0a6ed1f1ab8a9fa06c4d7f":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"from"
},
"aggregate":"min",
"sortFields":[
{
"fieldName":"SellOfferManager_CalCombinedPricingUniqueRequestId",
"dataType":"string"
}
],
"requiredDataObjects":[
{
"fieldName":"SellOfferManager_CalCombinedPricingUniqueRequestId",
"linkPathObjectId":"2794814ec253fc93496bfcb50ea18ebfe640bf4d"
}
]
},
"d3fc84fa4444406cef2de49baf53d38ab86cd2e0":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasOrderPrice"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"orderPrice"
},
"direction":"from"
},
"requestProperties":{
"tag_sellOfferPlan":"bbbb",
"tag_sellOfferPlanDeliveryMethodLink":"bbbb"
},
"perParentCombinationIds":[
{
"tag":"tag_deliverTo",
"filterMainId":"e0b8534452e98796f144c83a221764ef32db5ab6"
}
],
"applyCombinations":[
{
"tag":"tag_sellOfferPlanUserPaymentMethodLink",
"filterMainId":"51509dea0a7ba2746dbd24769b8e777f1411f3ff"
}
]
},
"2b0537fa34ee1d259488fce12204dd549e1c98a3":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasOrderPrice"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"to"
},
"requestProperties":{
"tag_deliverTo":"aaaa",
"tag_sellOfferPlanDeliveryMethodLink":"bbbb"
},
"applyCombinations":[
{
"tag":"tag_sellOfferPlan",
"filterMainId":"88d9c5b9ab36d8c3ebf17e8322541b9c64cae25b"
},
{
"tag":"tag_sellOfferPlanUserPaymentMethodLink",
"filterMainId":"51509dea0a7ba2746dbd24769b8e777f1411f3ff"
}
]
},
"11704ae9a828b4709300964e2e0361bad13db5c3":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasSellOffer"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"sellOffer"
},
"direction":"from"
},
"aggregate":"average",
"sortFields":[
{
"fieldName":"sellOfferHandlerServiceTag",
"dataType":"string"
}
],
"requiredDataObjects":[
{
"fieldName":"sellOfferHandlerServiceTag",
"linkPathObjectId":"cae7f8604e62fd4ac09146f5bdd512d9db668c70"
}
],
"combine":true
},
"964050f23f92b45a1ea573a573c50ae3ca2bae18":{
"pathLinkType":{
"relType":{
"serviceTag":"SellOfferManager",
"relationshipTag":"hasOrderPrice"
},
"objType":{
"serviceTag":"SellOfferManager",
"objectType":"orderPrice"
},
"direction":"from"
},
"requestProperties":{
"tag_sellOfferPlan":"aaaa",
"tag_sellOfferPlanDeliveryMethodLink":"bbbb"
},
"applyCombinations":[
{
"tag":"tag_deliverTo",
"filterMainId":"d7a7f875254e856b4205075826631ec042b4c821"
},
{
"tag":"tag_sellOfferPlanUserPaymentMethodLink",
"filterMainId":"b96447ae98c95858694ca5ec407750c559825930"
}
],
"comparison":"highLow",
"comparisonSortField":"sellOfferHandlerServiceTag",
"comparisonValue":"aaaa"
}
},
"sortFields":[
{
"fieldName":"productId",
"dataType":"string"
},
{
"fieldName":"productId",
"dataType":"array",
"values":[
"ffff",
"eeee"
]
}
]
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-17]]
[[Category:Working documents - Search Results| 2025-04-17]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-01-01T02:53:36Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

elements: {
// add example of pageOutput element that references requiredDataLinkStepObjects and valueUserTags
},
values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
valueUserTag: "userTag_1"
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
valueUserTag: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
valueUserTag: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
valueUserTag: "userTag_2"
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string"
},

{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"]
}
],
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"]
}
],
valueUserTags: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2026-01-01T01:05:07Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as params sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields
// header/footer filterDataField elements reference valueUserTag

elements: {
// add example of pageOutput element that references requiredDataLinkStepObjects and valueUserTags
},
values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
valueUserTag: "userTag_1"
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
valueUserTag: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
valueUserTag: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
valueUserTag: "userTag_2"
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string"
},

{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "array",
sortByValueUserTags:["userTag_1","userTag_2"]
}
],
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string"
}
],
valueUserTags: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-11-19T23:52:55Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields

elements: {
// add example of pageOutput element that references requiredDataLinkStepObjects
},
values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
value: "userTag_1"
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
value: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
value: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
addFilterMain: true, //default: false => need to add filterMain set = true
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
value: "userTag_2"
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string"
}
],
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string"
}
],
values: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-11-10T04:16:13Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields

elements: {
// add example of pageOutput element that references requiredDataLinkStepObjects
},
values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
value: "userTag_1"
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
value: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
value: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
value: "userTag_2"
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string"
}
],
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string"
}
],
values: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-11-10T00:48:48Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields

elements: {
// add example of pageOutput element that references requiredDataLinkStepObjects
},
values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
value: "userTag_1"
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
value: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
value: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
value: "userTag_2"
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string"
}
],
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string"
}
],
values: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanId"
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-11-10T00:37:08Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields

elements: {
// add example of pageOutput element that references requiredDataLinkStepObjects
},
values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
userTag_8: {
valueType: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
value: "userTag_1"
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
value: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
value: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
value: "userTag_2"
}
}
},

},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string"
}
],
},
hash_linkStepB_3: {
fieldName: "zzz",
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string"
}
],
values: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanId"
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-11-10T00:27:08Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields

elements: {
// add example of pageOutput element that references requiredDataLinkStepObjects
},
values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
userTag_8: {
valueType: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
value: "userTag_1"
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
value: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
value: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
// userTag_LinkStepObjectC
// userTag_LinkStepObjectD
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
value: "userTag_2"
}
}
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
},
hash_linkStepB_3: {
fieldName: "zzz",
aggregate: "max",
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectC",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectD",
dataType: "string"
}
],
}
},
sortFields: [
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number"
},
{
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string"
}
],
values: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanId"
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-11-09T23:59:24Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as sent to backend
// requiredDataFields not needed in tableConfig as referenced in elements and sortFields

elements: {
// add example of pageOutput element that references requiredDataLinkStepObjects
},
values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
userTag_8: {
valueType: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
value: "userTag_1"
}
},
requiredDataFields: [ //* linkStepObjects to create main sort result's requiredData and sortFields
// not needed at tableConfig level because can be built from table's elements and sortFields before sending to lib that converts to backend structure
"userTag_LinkStepObjectA", // no link, field in main objType (structure same linkPath but only one step)
"userTag_LinkStepObjectB", // has link
],
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
value: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
value: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
userTag_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
userTag_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
value: "userTag_2"
}
}
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
},
hash_linkStepB_3: {
fieldName: "zzz",
aggregate: "max",
sortFields: [ //* not sure
"hash_sortFieldC"
],
}
},
sortFields: [
"hash_sortFieldA",
"hash_sortFieldB"
],
sortFieldObjects: {
hash_sortFieldA: {
requiredDataLinkStepObjectId: "userTag_LinkStepObjectB",
dataType: "number"
},
hash_sortFieldB: {
requiredDataLinkStepObjectId: "userTag_LinkStepObjectA",
dataType: "string"
},
},
values: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanId"
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueSource: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Injecting requestProperties into LinkPath and ComplexFilters

2025-11-05T10:38:20Z

Praew:

[[Service - Search Results]]

= Overview =

A standardized schema based method of adding requestProperties and combination filters into LinkPaths, for example for frontend table submission.

Both top level combinationComplexFilters (eg parent location nodes for orderPrices) and perParentComplexFilter that are applied to each parent intermediate id record (eg delMethLink and payMethLink for orderPrices).

* requestProperties can optionally be applied as filters in the main complexFilter, and also used when finding output fields (requiredData linkPaths)
* frontend sets whether a requestProperty table filter is applied or ignored for the main complexFilter (if ignored is only used in calculating output fields)
* allow for multiple requestProperty table filters for the same requestProperty, these can be used in different places, such as output fields that calculate the same field but with different requestProperties, or one value used for main complexFilter and another used to calculate output field value
* some requestProperty values come from the table's filter values, some come from the parent linkStep's intermediateIds
* requestProperties must be added at any linkStep where linkConfig is storageType=lambda and has requestProperties

= Preparation tasks =

== Backend ==

* normalize filterElements
* do we send direction to linkConfig storageType=Lambda function, must send
* can we send different requestProperties per childComplexFilter translateIds process (if the linkConfig has requestProperties)?
* can we send different requestProperties per linkStep?
* side note: make sure SellOffer>OrderPrice link can handle both directions for relationship, if is OrderPrice>SellOffer then orderPriceId must exist and is a to-one relationship to sellOfferId

== FrontEnd ==

* each filter has a setting whether it combines with other filters with an AND or OR logicalOperator, OR filters also specify what orGroupId they are grouped together (separate group filterElements)
* (not sure already done) tableElements should have a fixed uuid elementId so for example we can reference a requestProperty filter inside the settings of a linkPath output field
* freeText element for header/footer table elements can set to displayOnly or can edit, also allow radio/select/checkbox options. These are not used in generating filters but can be used as the source for requestPropertyType=value requestProperties

= Solution =

== Backend ==

linkConfigs of the storageType "lambda" eg SellOffer>OrderPrice can add requestProperties property that specifies what properties are sent/needed to the translateIds lambda function.
<syntaxhighlight lang="JavaScript">
links: [
{
storageResourceTags: ["aLambdaType"],
from: {
objType: {
serviceTag: "SellOfferStandard",
objectType: "SellOfferStandard"
},
},
to: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
}
requestProperties: {
// to calculate orderPrices we need one identifier for each of the below objTypes
tag_deliverTo: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "Locations",
objectType: "locationNode" // deliversToLocationNode
},
identifiersFieldName: "locationNodeId"
},
tag_sellOfferPlan: {
requestPropertyType: "objectIdentifier",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
identifiersFieldName: "sellOfferPlanId"
},
tag_sellOfferPlanDeliveryMethodLink: {
requestPropertyType: "objectIdentifier",
objType:
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlanDeliveryMethodLink"
},
identifiersFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
tag_sellOfferPlanUserPaymentMethodLink: {
requestPropertyType: "objectIdentifier",
objType:
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlanUserPaymentMethodLink"
},
identifiersFieldName: "sellOfferPlanUserPaymentMethodLinkId"
},
}
}, //..
]
</syntaxhighlight>

Make findParentLocationNodeIds a custom translateIds flow by adding a LocationNode<>LocationNode linkConfig with storageType "lambda".
<syntaxhighlight lang="JavaScript">
links: [
{
storageResourceTags: ["aLambdaType"],
from: {
objType: {
serviceTag: "Locations",
objectType: "LocationNode"
},
},
to: {
objType: {
serviceTag: "Locations",
objectType: "LocationNode"
},
}
requestProperties: {
tag_traversalType: { // maybe remove requestPropertyTag and use this main tag as name of the requestProperty sent to translateIds
requestPropertyType: "value",
requestPropertyTag: "traversalType", // because name of the requestProperty sent to translateIds
fixedOptions: ["parentNodes", "childNodes"] // can add other types of traversals.
},
}
}, //..
]
</syntaxhighlight>
* if link direction swaps can swap "parentNodes"|"childNodes" in translateIds flow, this allows translateIds both directions, example fixedOptions=parentNodes and direction "to" finds parent locationNodes, if direction swaps to "from" finds child locationNodes

=== requestProperties used by main ComplexFilter ===

requestProperties are used by complexFilter for translateIds requests. Set this per childComplexFilter would be best, then for each table filter that passes a linkConfig that has requestProperties we select which filter sets the requestProperty value (same as output fields below).

If cannot set per childComplexFilter, probably need to set it for the main complexFilter request, so frontend tableConfig page will need to record all requestProperties used from all table filters and select which filter sets the requestProperty value.

== Backend lib ==

When building the filter from the frontend's array of filters, consider "orGroupId" groupings.

== Frontend ==

=== Additional filter types ===

The leaf setting of table filters that have links currently uses fieldname which filters by a field in the final objType. Add an "identifiers" setting, when chosen the value of the filter is considered the identifier value, and will be added to the filterElements as an "identifiers" type.

=== Table filter config ===

Use table filters to set values for requestProperties, normally these will filter the main complexFilter to only return main results that match the requestProperty values but allow filters to be ignored, when set to ignore they are not sent as filters for the main complexFilter.

A table filter can then be applied within output field linkPaths by referencing the filters elementId.

=== Table output field config ===

When output field selects a linkConfig that has requestProperties we select where the requestPropertySource comes from, the top level options are requestPropertyValue, combinationComplexFilter, or perParentComplexFilter.

==== requestPropertyValue ====

If the requestPropertyType=objectIdentifier, for each requestProperties objType identifier fields iterate filter elements for any that match, need to select a filter elementId for all of the requestProperties identifier fields.

If the requestPropertyType=value reference any table element that has a value.

Example: LocationNode<>LocationNode link's traversalType requestProperty is set using a freeText editable table element.

==== combinationComplexFilter ====

Select initial objType from all objTypes.

Build array of filters in the same structure as table filters, each filter has a path to the field being filtered, these get combined in new backend/frontend lib same as table filters to create filter elements.

Values come from requestProperties rather than submitted filter values.

Each filter element that passes a storageType "lambda" linkConfig sets where requestProperties come from same [[#Table output field config]].

Example: to find parent locationNodes for SellOffer>OrderPrice linkStep we set the requestPropertySource=combinationComplexFilter, the initial objType is LocationNode, with one link to LocationNode using LocationNode<>LocationNode link. traversalType requestPropertySource=requestProperty pointing to a freeText editable filter in the main table.

This link to LocationNode is the final step and sets it's value as an "identifiers" and points to a table level filter element to find the deliversTo LocationNodeId.

The complexFilter will enter the first and only filter element which is a childComplexFilter, so it passes down to that filterElement. Inside the childComplexFilter is one filterElement that sets the one "identifiers". The childComplexFilter then translates up to the top level complexFilter which performs the traversal to find parents starting from the childComplexFilter's locationNodeId as the source indentifier and traversalType from freeText filter.

==== perParentComplexFilter ====

Similar to combinationComplexFilter, create a complexFilter with array of filters.

Has additional "parentIdentifier" leaf setting when the linkConfig target objType matches the main output fields parent objType, this is how we add the parentIdentifier anywhere into the complexFilter.

Example: to find sellOfferPlanDeliveryMethodLinkIds create perParentComplexFilter with initial objType=sellOfferPlanDeliveryMethodLink.

The main output field is using linkConfig sellOffers>OrderPrice, the main output field's parent objType is sellOffer.

First filter for sellOfferPlanDeliveryMethodLink goes sellOfferPlanDeliveryMethodLink > SellOfferPlan > SellOffer, at this point the linkConfig target (SellOffer) matches the main output fields parent objType, so "parentIdentifier" becomes an option, this is selected, ensuring only sellOfferPlanDeliveryMethodLinks that connect to the parent sellOfferId will be returned.

Second filter for sellOfferPlanDeliveryMethodLink goes sellOfferPlanDeliveryMethodLink > deliveryMethodStandard, and sets it's value as an "identifiers" and points to a table level filter element to find the deliversMethodId (try to allow array of deliversMethodIds).

Third filter for sellOfferPlanDeliveryMethodLink goes sellOfferPlanDeliveryMethodLink > deliveryMethodStandard > rateTable > locationNode > locationNode, and is setup same as combinationComplexFilter example. This returns list of parent LocationNodeIds, rateTables that deliver there, and so on.

Backend/frontend lib will combine the sections of Second and Third filters so they are separated by an "and" operator at the deliveryMethod level.

= Optional =

* (try to get this done) tableConfig has hidden/fixed filters that do not present as outputted table Elements (also outputted table Elements that cannot be edited)
* could add hops and weight requestProperties to LocationNode<>LocationNode translateIds request
* build in environment defaults, so for example shipTo locationNodeId comes from the lowest level locationNodeId in the current users primary address

[[Category:Working documents| 2025-04-13]]
[[Category:Working documents - Search Results| 2025-04-13]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-10-20T01:47:34Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as sent to backend

values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
userTag_8: {
valueType: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},,
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
value: "userTag_1"
}
},
requiredDataFields: { //* fields to create requiredData including linkPaths
//* no link, field in main objType
hash_requiredDataFieldA: {
linkStepObject: "hash_LinkStepObjectA",
},

//* has link
hash_requiredDataFieldB: {
linkStepObject: "hash_LinkStepObjectB",
complexFilterCombinations: ["hash_complexFilterCombinationA"],
}

},
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
value: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
value: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
hash_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
hash_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
value: "userTag_2"
}
}
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
},
hash_linkStepB_3: {
fieldName: "zzz",
aggregate: "max",
sortFields: [ //* not sure
"hash_sortFieldC"
],
}
},
sortFields: [ //* sortField main ==> not sure
"hash_sortFieldA",
"hash_sortFieldB"
],
sortFieldObjects: { //* not sure
hash_sortFieldA: {
fieldName: "xxx",
dataType: "number"
},
hash_sortFieldB: {
fieldName: "yyy",
dataType: "number"
},
hash_sortFieldC: {
fieldName: "zzz",
dataType: "string"
}
},
values: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanId"
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueType: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-10-17T00:53:10Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as sent to backend

values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
userTag_8:{
defaultValue: "xx",
},
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
value: "userTag_1"
}
},
requiredDataFields: { //* fields to create requiredData including linkPaths
//* no link, field in main objType
hash_requiredDataFieldA: {
linkStepObject: "hash_LinkStepObjectA",
},

//* has link
hash_requiredDataFieldB: {
linkStepObject: "hash_LinkStepObjectB",
complexFilterCombinations: ["hash_complexFilterCombinationA"],
}

},
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
value: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
value: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
hash_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
hash_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
value: "userTag_2"
}
}
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
},
hash_linkStepB_3: {
fieldName: "zzz",
aggregate: "max",
sortFields: [ //* not sure
"hash_sortFieldC"
],
}
},
sortFields: [ //* sortField main ==> not sure
"hash_sortFieldA",
"hash_sortFieldB"
],
sortFieldObjects: { //* not sure
hash_sortFieldA: {
fieldName: "xxx",
dataType: "number"
},
hash_sortFieldB: {
fieldName: "yyy",
dataType: "number"
},
hash_sortFieldC: {
fieldName: "zzz",
dataType: "string"
}
},
values: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanId"
},
userTag_7: {
value: "zz",
},
userTag_8: {
valueType: 'perParentIdentifier',
perParentIdentifierFieldname: 'sellOfferId'
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-09-30T09:53:46Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as sent to backend

values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
userTag_8:{
defaultValue: "xx",
},
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
value: "userTag_1"
}
},
requiredDataFields: { //* fields to create requiredData including linkPaths
//* no link, field in main objType
hash_requiredDataFieldA: {
linkStepObject: "hash_LinkStepObjectA",
},

//* has link
hash_requiredDataFieldB: {
linkStepObject: "hash_LinkStepObjectB",
complexFilterCombinations: ["hash_complexFilterCombinationA"],
}

},
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
value: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
value: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
hash_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
hash_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
direction: "to",
},
},
hash_linkStepB_2: {
pathLinkType: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
direction: "to",
},
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
value: "userTag_2"
}
}
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
},
hash_linkStepB_3: {
fieldName: "zzz",
aggregate: "max",
sortFields: [ //* not sure
"hash_sortFieldC"
],
}
},
sortFields: [ //* sortField main ==> not sure
"hash_sortFieldA",
"hash_sortFieldB"
],
sortFieldObjects: { //* not sure
hash_sortFieldA: {
fieldName: "xxx",
dataType: "number"
},
hash_sortFieldB: {
fieldName: "yyy",
dataType: "number"
},
hash_sortFieldC: {
fieldName: "zzz",
dataType: "string"
}
},
values: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanId"
},
userTag_7: {
value: "zz",
},
userTag_8: {
value: null,
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-09-30T08:12:28Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params in tableConfig =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {

// .. other properties same as sent to backend

values: {
// values are shared between requestProperties and filter values. This set can be iterated to overwrite values using userTag to identify
userTag_1:{
defaultValue: "xx",
},
userTag_2:{
defaultValue: "xx",
},
userTag_3:{
defaultValue: "xx",
},
userTag_4:{
defaultValue: "xx",
},
userTag_5:{
defaultValue: "xx",
},
userTag_6:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_7:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
userTag_8:{
defaultValue: "xx",
},
userTag_9:{
defaultValue: "xx",
},
userTag_10:{
defaultValue: "xx",
},
userTag_11:{
defaultValue: "xx",
},
}
}

</syntaxhighlight>

= Example params sent to backend =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLogicalElementId: "uuid_logical_1",
logicalElements: {
uuid_logical_1: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "ProductManager",
objectType: "product"
},
fieldName: "productId",
comparison: "equals",
value: "userTag_1"
}
},
requiredDataFields: { //* fields to create requiredData including linkPaths
//* no link, field in main objType
hash_requiredDataFieldA: {
linkStepObject: "hash_LinkStepObjectA",
},

//* has link
hash_requiredDataFieldB: {
linkStepObject: "hash_LinkStepObjectB",
complexFilterCombinations: ["hash_complexFilterCombinationA"],
}

},
complexFilterCombinations:{
hash_complexFilterCombinationA: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
initialLogicalElementId: "child_complexFilter_localtionNode",
logicalElements: {
child_complexFilter_localtionNode: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_locationNode",
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
pathLinkType: {
objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "hasParentLocationNode"
},
direction: "to"
},
},
logical_locationNode: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_localtionNode",
nextLogicalElementId: null,

objType: {
serviceTag: "Locations",
objectType: "locationNode"
},
fieldName: "locationNodeId",
comparison: "equals",
value: "userTag_7"
}
}
},
},
perParentCombinations:{
hash_perParentCombinationA: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
initialLogicalElementId: "child_complexFilter_1",
logicalElements: {
child_complexFilter_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: null,
nextLogicalElementId: null,

childLogicalElementId: "logical_sellOffer",
objType: {
serviceTag: "SellOfferPlan",
objectType: "sellOfferPlan"
},
pathLinkType: {
objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
direction: "to"
},
requestProperties: {
tag_orderQuantity: "userTag_9"
}
},
logical_sellOffer: {
logicalElementType: "logical",
previousLogicalElementId: "child_complexFilter_1",
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "sellOffer"
},
fieldName: "sellOfferId",
comparison: "equals",
value: "userTag_8"
}
}
},
},
requiredDataLinkStepObjects: {
hash_LinkStepObjectA: { //* requiredData no linkPath
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_1"],
},
hash_LinkStepObjectB: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepB_1", "hash_linkStepB_2", "hash_linkStepB_3"],
}
},
requiredDataLinkSteps: {
hash_linkStepA_1:{
fieldName: "xxx"
},
hash_linkStepB_1:{
link: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
relationshipDirection: "to",
},
},
hash_linkStepB_2: {
link: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
relationshipDirection: "to",
},
filterElements: { //* filter in linkPath
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
initialLogicalElementId: "logical_sellOffer_in_link",
logicalElements: {
logical_sellOffer_in_link: {
logicalElementType: "logical",
previousLogicalElementId: null,
nextLogicalElementId: null,

objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
fieldName: "userId",
comparison: "equals",
value: "userTag_2"
}
}
},
requestProperties: {
tag_deliverTo: "userTag_3",
tag_sellOfferPlan: "userTag_4",
// tag_sellOfferPlanDeliveryMethodLink: "userTag_5",
// tag_sellOfferPlanUserPaymentMethodLink: "userTag_6"
}
},
hash_linkStepB_3: {
fieldName: "zzz",
aggregate: "max",
sortFields: [ //* not sure
"hash_sortFieldC"
],
}
},
sortFields: [ //* sortField main ==> not sure
"hash_sortFieldA",
"hash_sortFieldB"
],
sortFieldObjects: { //* not sure
hash_sortFieldA: {
fieldName: "xxx",
dataType: "number"
},
hash_sortFieldB: {
fieldName: "yyy",
dataType: "number"
},
hash_sortFieldC: {
fieldName: "zzz",
dataType: "string"
}
},
values: {
userTag_1:{
value: "xx",
},
userTag_2:{
value: "yy",
},
userTag_3:{
valueSource: "complexFilterCombination",
complexFilterCombinationId: "hash_complexFilterCombinationA",
identifierFieldName: "xxId"
},
userTag_4:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanId"
},
userTag_7: {
value: "zz",
},
userTag_8: {
value: null,
},
userTag_9: {
value: 2,
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-09-30T08:07:15Z

Praew:

2025-08-21 - ComplexFilter SearchResult Frontend structure

2025-08-29T00:17:30Z

Praew:

[[Service - Complex Filter]]

[[Service - Search Results]]

[[2024-06-26 - SearchResult linkpath]]

[[2024-11-28 - OrderPrice using linkPath flows]]

= Overview =

Creating visual representation of ComplexFilters for allowing frontend to create and manage.

= Examples =

* Main complex filter used in tableData
* filters used at each level of LinkSteps in requiredData/Linkpaths
* perParentComplexFilters and combinationComplexFilters used in LinkPaths
* complexFilters used in categoryLinks

= Considerations =

* Want to be able to achieve all features of complexFilters including childComplexFilters, grouping and (and/or) operations
* all elementTypes such as identifier/translateIds/traversals
* tableOutput currently separates each filterDataField to have it's own filter path
* operations and grouping or operations can happen at any childComplexFilter level and between filters

= Option 1: OrGroups =

Attempted this approach but became too complex and messy when creating multiple levels of grouped and/or statements.

* have an array of filters, each is a single path with an optional array of filterElements at each step
* each filter path sets its orGroup
* orGroups can be child of another orGroup, child orGroups only exist/group underneath their parent hierarchy
* orGroups group all filter paths using an OR operator
* however multiple filters at the same level within an orGroup (with a single filter path are considered the same orGroup) use AND operator
* if same level filters need to be separated by OR need to be separate *****check with Praew*****

== Implementation ==

Every frontend complexFilter case must:

* allow adding multiple filter paths
* have orGroup hierarchy for filter paths

= Option 2: OperationFilters =

An alternative method of building and editing complexFilters on frontend could be building up a chain of operationFilters, this will closely resembe the request structure of processComplexFilter

* starts with the initial filter, choose type, eg logical or operation
* operation filter must go into each side and set with filter type and settings to use
* each side can then be an operation or a childComplexFilter
* adding operations chain filters at the same level
* childComplexFilters create a new level with a link
* Each operation sets it's operator (or/and)
* can open a new group (opening bracket) and close a group (closing bracket) at any point
* validate all groups at each level are opened and closed
* probably validate have at least one filterElement before closing

== tableConfig ==

* Build a single filter structure
* filterDataFields point to a filterElement, with additional settings if needed (eg identifying a value inside a traversal filterElement)
* defaultValue is moved from filterDataField to filterElement, if a filterDataField sets the value then the default filterElement value is shown first and the filterDataField can adjust it after loading
* if adjust the filter structure, need to go through all filterDataFields to see if they need to be updated, eg filterElement they link to is removed, maybe set to null and validate when saving tableConfig

== notes ==

* separate validate uiFilter from saving final filterElement structure, so can validate while building the filter
* have a breadcrumb or other representation of the childComplexFilter steps that can be navigated through
* each childComplexFilter step have a list of the added uiFilterElements, each can be clicked on to edit (or list them all)
* when click on a childComplexFilter move to it's level of uiFilterElements
* whenever adding a component we input the previous element which allows us to shuffle references
* cannot add closeBracket when previousLogicalElementId type openBracket, childComplexFilter, or null
* must choose operator when previousLogicalElementId type not openBracket, childComplexFilter, or null

Validate:
* all opening brackets at each level have equal number of closing brackets
* all element types have required data
* all childComplexFilters have at least 1 uiFilterElement (childLogicalElementId != null)

== Example ==

* Click to buildFilter, no filterElements exists

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: null,
logicalElements: {
}
}
</syntaxhighlight>

* add uuid_openBracket_1
* previousLogicalElementId = null

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: {
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: null,
},
}
}
</syntaxhighlight>

* add uuid_childComplex_1
* previousLogicalElementId = uuid_openBracket_1
* must choose link detail when adding childComplexFilter (relType/direction)

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: {
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: null,
childLogicalElementId: null,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
}
}
</syntaxhighlight>

* add uuid_childComplex_2
* OR operator
* previousLogicalElementId = uuid_childComplex_1

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: null,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: null,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
}
}
</syntaxhighlight>

* add uuid_logical_1
* previousLogicalElementId = uuid_childComplex_1

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: null,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
}
}
</syntaxhighlight>

* add uuid_logical_2
* previousLogicalElementId = uuid_childComplex_1

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
}
}
</syntaxhighlight>

* add uuid_childComplex_3
* previousLogicalElementId = uuid_childComplex_2

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: null,
childLogicalElementId: null,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
}
}
</syntaxhighlight>

* add uuid_childComplex_4 and add uuid_logical_3
* previousLogicalElementId = uuid_childComplex_3

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: null,
childLogicalElementId: uuid_childComplex_4,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_4: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_3,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_3,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_logical_3: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_4",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
}
}
</syntaxhighlight>

* add uuid_logical_4
* OR operator
* previousLogicalElementId = uuid_logical_3

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: null,
childLogicalElementId: uuid_childComplex_4,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_4: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_3,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_3,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_3: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_4",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_3: { // level: deliveryMethodLink
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_3",
nextLogicalElementId: "uuid_logical_4",
operation: "or"
},
uuid_logical_4: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
}
}
</syntaxhighlight>

* add uuid_childComplex_5 and uuid_childComplex_6 and uuid_logical_5
* AND operator
* previousLogicalElementId = uuid_childComplex_3

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: uuid_operation_4,
childLogicalElementId: uuid_childComplex_4,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_4: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_3,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_3,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_3: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_4",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_3: { // level: deliveryMethodLink
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_3",
nextLogicalElementId: "uuid_logical_4",
operation: "or"
},
uuid_logical_4: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},

uuid_operation_4: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_3",
nextLogicalElementId: "uuid_childComplex_5",
operation: "or"
},
uuid_childComplex_5: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_4,
nextLogicalElementId: null,
childLogicalElementId: uuid_childComplex_6,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_6: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_5,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_5,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_5: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_6",
nextLogicalElementId: null,
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},

}
}
</syntaxhighlight>

* add closeBracket
* previousLogicalElementId = uuid_childComplex_2

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: uuid_closeBracket_1,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: uuid_operation_4,
childLogicalElementId: uuid_childComplex_4,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_4: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_3,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_3,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_3: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_4",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_3: { // level: deliveryMethodLink
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_3",
nextLogicalElementId: "uuid_logical_4",
operation: "or"
},
uuid_logical_4: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},

uuid_operation_4: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_3",
nextLogicalElementId: "uuid_childComplex_5",
operation: "or"
},
uuid_childComplex_5: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_4,
nextLogicalElementId: null,
childLogicalElementId: uuid_childComplex_6,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_6: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_5,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_5,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_5: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_6",
nextLogicalElementId: null,
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_closeBracket_1: { // level: product
logicalElementType: "closeBracket",
previousLogicalElementId: uuid_childComplex_2,
nextLogicalElementId: null,
},

}
}
</syntaxhighlight>

* add uuid_childComplex_7 and uuid_logical_6
* AND operator
* previousLogicalElementId = uuid_closeBracket_1

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
objTyp: {
objectType: "product",
serviceTag: "ProductManager"
},
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
pathLinkType: {
objTyp: {
objectType: "sellOffer",
serviceTag: "SellOfferManager"
},
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
}
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
objTyp: {
objectType: "product",
serviceTag: "ProductManager"
},
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: uuid_closeBracket_1,
childLogicalElementId: uuid_logical_2,
pathLinkType: {
objTyp: {
objectType: "sellOffer",
serviceTag: "SellOfferManager"
},
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
}
},
uuid_logical_1: { // level: sellOffer
objType: {
objectType: "sellOffer",
serviceTag: "SellOfferManager"
},
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
objType: {
objectType: "sellOffer",
serviceTag: "SellOfferManager"
},
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
objTyp: {
objectType: "sellOffer",
serviceTag: "SellOfferManager"
},
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: uuid_operation_4,
childLogicalElementId: uuid_childComplex_4,
pathLinkType: {
objTyp: {
objectType: "sellOfferPlan",
serviceTag: "SellOfferPlan"
},
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
}
},
uuid_childComplex_4: { // level: sellOfferPlan
objTyp: {
objectType: "sellOfferPlan",
serviceTag: "SellOfferPlan"
},
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_3,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_3,
pathLinkType: {
objTyp: {
objectType: "deliveryMethodLink",
serviceTag: "SellOfferPlan"
},
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
}
},
uuid_logical_3: { // level: deliveryMethodLink
objTyp: {
objectType: "deliveryMethodLink",
serviceTag: "SellOfferPlan"
},
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_4",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_3: { // level: deliveryMethodLink
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_3",
nextLogicalElementId: "uuid_logical_4",
operation: "or"
},
uuid_logical_4: { // level: deliveryMethodLink
objTyp: {
objectType: "deliveryMethodLink",
serviceTag: "SellOfferPlan"
},
logicalElementType: "logical",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},

uuid_operation_4: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_3",
nextLogicalElementId: "uuid_childComplex_5",
operation: "or"
},
uuid_childComplex_5: { // level: sellOffer
objTyp: {
objectType: "sellOffer",
serviceTag: "SellOfferManager"
},
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_4,
nextLogicalElementId: null,
childLogicalElementId: uuid_childComplex_6,
pathLinkType: {
objTyp: {
objectType: "sellOfferPlan",
serviceTag: "SellOfferPlan"
},
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
}
},
uuid_childComplex_6: { // level: sellOfferPlan
objTyp: {
objectType: "sellOfferPlan",
serviceTag: "SellOfferPlan"
},
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_5,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_5,
pathLinkType: {
objTyp: {
objectType: "deliveryMethodLink",
serviceTag: "SellOfferPlan"
},
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
}
},
uuid_logical_5: { // level: deliveryMethodLink
objTyp: {
objectType: "deliveryMethodLink",
serviceTag: "SellOfferPlan"
},
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_6",
nextLogicalElementId: null,
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_closeBracket_1: { // level: product
logicalElementType: "closeBracket",
previousLogicalElementId: uuid_childComplex_2,
nextLogicalElementId: null,
},

uuid_operation_5: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_closeBracket_1",
nextLogicalElementId: "uuid_childComplex_7",
operation: "or"
},
uuid_childComplex_7: { // level: product
objTyp: {
objectType: "product",
serviceTag: "ProductManager"
},
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_5,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_6,
pathLinkType: {
objTyp: {
objectType: "sellOffer",
serviceTag: "SellOfferManager"
},
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
}

},
uuid_logical_6: { // level: sellOffer
objTyp: {
objectType: "sellOffer",
serviceTag: "SellOfferManager"
},
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_7",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},

}
}
</syntaxhighlight>

[[Category:Working documents| 2025-08-21]]
[[Category:Working_documents - Complex Filter| 2025-08-21]]
[[Category:Working_documents - Search Results| 2025-08-21]]

2025-08-21 - ComplexFilter SearchResult Frontend structure

2025-08-27T02:57:40Z

Praew:

[[Service - Complex Filter]]

[[Service - Search Results]]

[[2024-06-26 - SearchResult linkpath]]

[[2024-11-28 - OrderPrice using linkPath flows]]

= Overview =

Creating visual representation of ComplexFilters for allowing frontend to create and manage.

= Examples =

* Main complex filter used in tableData
* filters used at each level of LinkSteps in requiredData/Linkpaths
* perParentComplexFilters and combinationComplexFilters used in LinkPaths
* complexFilters used in categoryLinks

= Considerations =

* Want to be able to achieve all features of complexFilters including childComplexFilters, grouping and (and/or) operations
* all elementTypes such as identifier/translateIds/traversals
* tableOutput currently separates each filterDataField to have it's own filter path
* operations and grouping or operations can happen at any childComplexFilter level and between filters

= Option 1: OrGroups =

Attempted this approach but became too complex and messy when creating multiple levels of grouped and/or statements.

* have an array of filters, each is a single path with an optional array of filterElements at each step
* each filter path sets its orGroup
* orGroups can be child of another orGroup, child orGroups only exist/group underneath their parent hierarchy
* orGroups group all filter paths using an OR operator
* however multiple filters at the same level within an orGroup (with a single filter path are considered the same orGroup) use AND operator
* if same level filters need to be separated by OR need to be separate *****check with Praew*****

== Implementation ==

Every frontend complexFilter case must:

* allow adding multiple filter paths
* have orGroup hierarchy for filter paths

= Option 2: OperationFilters =

An alternative method of building and editing complexFilters on frontend could be building up a chain of operationFilters, this will closely resembe the request structure of processComplexFilter

* starts with the initial filter, choose type, eg logical or operation
* operation filter must go into each side and set with filter type and settings to use
* each side can then be an operation or a childComplexFilter
* adding operations chain filters at the same level
* childComplexFilters create a new level with a link
* Each operation sets it's operator (or/and)
* can open a new group (opening bracket) and close a group (closing bracket) at any point
* validate all groups at each level are opened and closed
* probably validate have at least one filterElement before closing

== tableConfig ==

* Build a single filter structure
* filterDataFields point to a filterElement, with additional settings if needed (eg identifying a value inside a traversal filterElement)
* defaultValue is moved from filterDataField to filterElement, if a filterDataField sets the value then the default filterElement value is shown first and the filterDataField can adjust it after loading
* if adjust the filter structure, need to go through all filterDataFields to see if they need to be updated, eg filterElement they link to is removed, maybe set to null and validate when saving tableConfig

== notes ==

* separate validate uiFilter from saving final filterElement structure, so can validate while building the filter
* have a breadcrumb or other representation of the childComplexFilter steps that can be navigated through
* each childComplexFilter step have a list of the added uiFilterElements, each can be clicked on to edit (or list them all)
* when click on a childComplexFilter move to it's level of uiFilterElements
* whenever adding a component we input the previous element which allows us to shuffle references
* cannot add closeBracket when previousLogicalElementId type openBracket, childComplexFilter, or null
* must choose operator when previousLogicalElementId type not openBracket, childComplexFilter, or null

Validate:
* all opening brackets at each level have equal number of closing brackets
* all element types have required data
* all childComplexFilters have at least 1 uiFilterElement (childLogicalElementId != null)

== Example ==

* Click to buildFilter, no filterElements exists

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: null,
logicalElements: {
}
}
</syntaxhighlight>

* add uuid_openBracket_1
* previousLogicalElementId = null

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: {
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: null,
},
}
}
</syntaxhighlight>

* add uuid_childComplex_1
* previousLogicalElementId = uuid_openBracket_1
* must choose link detail when adding childComplexFilter (relType/direction)

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: {
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: {
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: null,
childLogicalElementId: null,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
}
}
</syntaxhighlight>

* add uuid_childComplex_2
* OR operator
* previousLogicalElementId = uuid_childComplex_1

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: null,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: null,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
}
}
</syntaxhighlight>

* add uuid_logical_1
* previousLogicalElementId = uuid_childComplex_1

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: null,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
}
}
</syntaxhighlight>

* add uuid_logical_2
* previousLogicalElementId = uuid_childComplex_1

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
}
}
</syntaxhighlight>

* add uuid_childComplex_3
* previousLogicalElementId = uuid_childComplex_2

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: null,
childLogicalElementId: null,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
}
}
</syntaxhighlight>

* add uuid_childComplex_4 and add uuid_logical_3
* previousLogicalElementId = uuid_childComplex_3

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: null,
childLogicalElementId: uuid_childComplex_4,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_4: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_3,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_3,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_logical_3: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_4",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
}
}
</syntaxhighlight>

* add uuid_logical_4
* OR operator
* previousLogicalElementId = uuid_logical_3

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: null,
childLogicalElementId: uuid_childComplex_4,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_4: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_3,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_3,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_3: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_4",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_3: { // level: deliveryMethodLink
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_3",
nextLogicalElementId: "uuid_logical_4",
operation: "or"
},
uuid_logical_4: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
}
}
</syntaxhighlight>

* add uuid_childComplex_5 and uuid_childComplex_6 and uuid_logical_5
* AND operator
* previousLogicalElementId = uuid_childComplex_3

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: uuid_operation_4,
childLogicalElementId: uuid_childComplex_4,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_4: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_3,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_3,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_3: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_4",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_3: { // level: deliveryMethodLink
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_3",
nextLogicalElementId: "uuid_logical_4",
operation: "or"
},
uuid_logical_4: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},

uuid_operation_4: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_3",
nextLogicalElementId: "uuid_childComplex_5",
operation: "or"
},
uuid_childComplex_5: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_4,
nextLogicalElementId: null,
childLogicalElementId: uuid_childComplex_6,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_6: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_5,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_5,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_5: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_6",
nextLogicalElementId: null,
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},

}
}
</syntaxhighlight>

* add closeBracket
* previousLogicalElementId = uuid_childComplex_2

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: uuid_closeBracket_1,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: uuid_operation_4,
childLogicalElementId: uuid_childComplex_4,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_4: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_3,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_3,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_3: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_4",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_3: { // level: deliveryMethodLink
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_3",
nextLogicalElementId: "uuid_logical_4",
operation: "or"
},
uuid_logical_4: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},

uuid_operation_4: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_3",
nextLogicalElementId: "uuid_childComplex_5",
operation: "or"
},
uuid_childComplex_5: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_4,
nextLogicalElementId: null,
childLogicalElementId: uuid_childComplex_6,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_6: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_5,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_5,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_5: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_6",
nextLogicalElementId: null,
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_closeBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: uuid_childComplex_2,
nextLogicalElementId: null,
},

}
}
</syntaxhighlight>

* add uuid_childComplex_7 and uuid_logical_6
* AND operator
* previousLogicalElementId = uuid_closeBracket_1

<syntaxhighlight lang="js">
let exampleData = {
objType {
objectType: "product",
serviceTag: "productManager"
},

initialLogicalElementId: uuid_openBracket_1,
logicalElements: {
uuid_openBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: null,
nextLogicalElementId: uuid_childComplex_1,
},
uuid_childComplex_1: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_openBracket_1,
nextLogicalElementId: uuid_operation_1,
childLogicalElementId: uuid_logical_1,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_operation_1: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "uuid_childComplex_2",
operation: "or"
},
uuid_childComplex_2: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_1,
nextLogicalElementId: uuid_closeBracket_1,
childLogicalElementId: uuid_logical_2,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_1: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_1",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_logical_2: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_2",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_2: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_2",
nextLogicalElementId: "uuid_childComplex_3",
operation: "or"
},
uuid_childComplex_3: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_2,
nextLogicalElementId: uuid_operation_4,
childLogicalElementId: uuid_childComplex_4,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_4: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_3,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_3,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_3: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_4",
nextLogicalElementId: "uuid_operation_2",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_operation_3: { // level: deliveryMethodLink
logicalElementType: "operation",
previousLogicalElementId: "uuid_logical_3",
nextLogicalElementId: "uuid_logical_4",
operation: "or"
},
uuid_logical_4: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_operation_2",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},

uuid_operation_4: { // level: sellOffer
logicalElementType: "operation",
previousLogicalElementId: "uuid_childComplex_3",
nextLogicalElementId: "uuid_childComplex_5",
operation: "or"
},
uuid_childComplex_5: { // level: sellOffer
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_4,
nextLogicalElementId: null,
childLogicalElementId: uuid_childComplex_6,
relType: {
relationshipTag: "hasSellOfferPlan",
serviceTag: "sellOfferPlan"
},
direction: "from"
},
uuid_childComplex_6: { // level: sellOfferPlan
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_childComplex_5,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_5,
relType: {
relationshipTag: "hasDeliveryMethodLink",
serviceTag: "deliveryMethodLink"
},
direction: "from"
},
uuid_logical_5: { // level: deliveryMethodLink
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_6",
nextLogicalElementId: null,
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},
uuid_closeBracket_1: { // level: product
logicalElementType: "openBracket",
previousLogicalElementId: uuid_childComplex_2,
nextLogicalElementId: null,
},

uuid_operation_5: { // level: product
logicalElementType: "operation",
previousLogicalElementId: "uuid_closeBracket_1",
nextLogicalElementId: "uuid_childComplex_7",
operation: "or"
},
uuid_childComplex_7: { // level: product
logicalElementType: "childComplexFilter",
previousLogicalElementId: uuid_operation_5,
nextLogicalElementId: null,
childLogicalElementId: uuid_logical_6,
relType: {
relationshipTag: "hasSellOffer",
serviceTag: "SellOfferManager"
},
direction: "from"
},
uuid_logical_6: { // level: sellOffer
logicalElementType: "logical",
previousLogicalElementId: "uuid_childComplex_7",
nextLogicalElementId: "null",
fieldName: "fieldx",
comparison: "greaterThan",
defaultValue: 50
},

}
}
</syntaxhighlight>

[[Category:Working documents| 2025-08-21]]
[[Category:Working_documents - Complex Filter| 2025-08-21]]
[[Category:Working_documents - Search Reasults| 2025-08-21]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-07-22T05:08:59Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},

mainComplexFilterUnits: { // used to create main complexFilter
uuid_FilterUnitA: { // select link step from main objType
linkStepObject: "hash_LinkStepObjectA",
parentOrGroup: "uuid_OrGroupA"
},
uuid_FilterUnitB: { // select own fieldname of main objType
linkStepObject: "hash_LinkStepObjectD",
parentOrGtoup: "uuid_orGroupA"
}

},
mainComplexFilterOrGroups: { //* group and operation filters for each mainComplexFilterUnits
uuid_OrGroupA: {
filterUnitIds: ["uuid_FilterUnitA", "uuid_FilterUnitB"],
parentOrGroup: "",
childOrGroups: []
}
},
filterLinkStepObjects: {
hash_LinkStepObjectA: { // main complexFilter find orderPrice
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_A", "hash_linkStepA_B", "hash_linkStepA_C"],
},
hash_LinkStepObjectB: { // complexFilterCombinations for parentLocationNodes
initialObjType: { //* main objType
serviceTag: "locatons",
objectType: "LocationNode"
},
linkSteps: ["hash_linkStepB_A","hash_linkStepB_B"],
},
hash_LinkStepObjectC: { // perParentCombinations
initialObjType: { //* main objType
serviceTag: "SellOffer",
objectType: "SellOffer"
},
linkSteps: ["hash_linkStepC_A", "hash_linkStepC_B", "hash_linkStepC_C", "hash_linkStepC_D"],
},
hash_LinkStepObjectD:{
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepD_A"],
}
},
filterLinkSteps: {
hash_linkStepA_A: { //one step: Product > SellOffer
link: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
relationshipDirection: "to",
},
},
hash_linkStepA_B: { //one step: SellOffer > OrderPrice
link: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
relationshipDirection: "to",
},
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_deliverTo: hash_requestPropertyA,
tag_sellOfferPlan: hash_requestPropertyB,
tag_sellOfferPlanDeliveryMethodLink: hash_requestPropertyC,
tag_sellOfferPlanUserPaymentMethodLink: hash_requestPropertyD,
},
filterElementUnitIds: ["hash_filterElementUnitF"]
},
hash_linkStepA_C: { //final OrderPrice step
filterElementUnitIds: ["hash_filterElementUnitA"]
},
hash_linkStepB_A: { //one step: LocationNode > LocationNode
link: {
objType: {
serviceTag: "Locations",
objectType: "LocationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "isParentLocationNode"
},
relationshipDirection: "to",
},
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_traversalType: hash_requestPropertyE,
}
},
hash_linkStepB_B: { //final parent LocationNodes step
},
hash_linkStepC_A: { //one step: SellOffer > SellOfferPlan
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "SellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
relationshipDirection: "to",
},
},
hash_linkStepC_B: { //one step: SellOfferPlan > DeliveryMethodLink
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "DeliveryMethodLink"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "hasDeliveryMethodLink"
},
relationshipDirection: "to",
},
},
hash_linkStepC_C: { //one step: SellOfferPlan > DeliveryMethodLink
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "DeliveryMethodLink"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "hasDeliveryMethodLink"
},
relationshipDirection: "to",
},
},
hash_linkStepC_D: { //one step: DeliveryMethodLink > DeliveryMethod
link: {
objType: {
serviceTag: "DeliveryMethodManager",
objectType: "DeliveryMethod"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "isDeliveryMethod"
},
relationshipDirection: "to",
},
filterElementUnitIds: ["hash_filterElementUnitB"]
},
hash_linkStepD_A:{
filterElementUnitIds: ["hash_filterElementUnitE"]
}
},

requiredDataFields: { //* fields to create requiredData including linkPaths
//* no link, field in main objType
hash_requiredDataFieldA: {
fieldname: ""
},

//* has link
hash_requiredDataFieldB: {
linkStepObject: "hash_LinkStepObjectD",
fieldname: " ",
complexFilterCombinations: ["hash_complexFilterCombinationA"],
}

},
complexFilterCombinations:{
hash_complexFilterCombinationA: {
linkStepObjectA: "hash_LinkStepObjectB",
initialIdentifiers: { // tableConfig sets "defaultInitialIdentifiers, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultInitialIdentifiers
"locationNodeId": "xxxx"
},
},
},
perParentCombinations:{
hash_perParentCombinationA: {
linkStepObjectA: "hash_LinkStepObjectC",
},
},
requiredDataLinkStepObjects: {
hash_LinkStepObjectD: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepD_A", "hash_linkStepD_B", "hash_linkStepA_C"],
}
},
requiredDataLinkSteps: {
hash_linkStepD_A: { //one step: Product > SellOffer
link: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
relationshipDirection: "to",
},
},
hash_linkStepD_B: { //one step: SellOffer > OrderPrice
link: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
relationshipDirection: "to",
},
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_deliverTo: hash_requestPropertyF,
tag_sellOfferPlanDeliveryMethodLink: hash_requestPropertyG,
}
},
hash_linkStepA_C: { //final OrderPrice step
filterElementUnitIds: ["hash_filterElementUnitA"]
aggregate: "max",
sortFields: "hash_sortFieldA",
// ... other linkPath.linkStep settings here
}
},
sortFields:{
hash_sortFieldA: {
// ..
}
}

filterElementUnits: {
hash_filterElementUnitA:{
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
fieldname: "orderTotal",
comparison: "greaterThan",
value: "xxx", // tableConfig sets "defaultFilterElementUnitValue", tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultFilterElementUnitValue
},
hash_filterElementUnitB:{
objType: {
serviceTag: "DeliveryMethodManager",
objectType: "deliveryMethod"
},
fieldname: "deliveryMethodId",
comparison: "equals",
value: "xxx",
},
hash_filterElementUnitD: {
objType: {
serviceTag: "ProductManager",
objectType: "Product"
},
fieldname: "productId",
comparison: "equals",
value: "xxx",
},
hash_filterElementUnitE: {
objType: {
serviceTag: "ProductManager",
objectType: "Product"
},
fieldname: "productId",
comparison: "equals",
value: "xxx",
}
},

requestProperties: {
hash_requestPropertyA:{
value: "xx",
},
hash_requestPropertyB:{
value: "xx",
},
hash_requestPropertyC:{
value: "xx",
},
hash_requestPropertyD:{
value: "xx",
},
hash_requestPropertyE:{
value: "xx",
},
hash_requestPropertyF:{
value: "xx",
},
hash_requestPropertyG:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-07-18T04:27:47Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},

mainComplexFilterUnits: { // used to create main complexFilter
uuid_FilterUnitA: { // select link step from main objType
linkStepObject: "hash_LinkStepObjectA",
parentOrGroup: "uuid_OrGroupA"
},
uuid_FilterUnitB: { // select own fieldname of main objType
linkStepObject: "hash_LinkStepObjectD",
parentOrGtoup: "uuid_orGroupA"
}

},
mainComplexFilterOrGroups: { //* group and operation filters for each mainComplexFilterUnits
uuid_OrGroupA: {
filterElementUnitIds: ["uuid_FilterA", "uuid_FilterUnitB"],
parentOrGroup: "",
childOrGroup: []
}
},
filterLinkStepObjects: {
hash_LinkStepObjectA: { // main complexFilter find orderPrice
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepA_A", "hash_linkStepA_B", "hash_linkStepA_C"],
},
hash_LinkStepObjectB: { // complexFilterCombinations for parentLocationNodes
initialObjType: { //* main objType
serviceTag: "locatons",
objectType: "LocationNode"
},
linkSteps: ["hash_linkStepB_A","hash_linkStepB_B"],
},
hash_LinkStepObjectC: { // perParentCombinations
initialObjType: { //* main objType
serviceTag: "SellOffer",
objectType: "SellOffer"
},
linkSteps: ["hash_linkStepC_A", "hash_linkStepC_B", "hash_linkStepC_C", "hash_linkStepC_D"],
},
hash_LinkStepObjectD:{
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepD_A"],
}
},
filterLinkSteps: {
hash_linkStepA_A: { //one step: Product > SellOffer
link: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
relationshipDirection: "to",
},
},
hash_linkStepA_B: { //one step: SellOffer > OrderPrice
link: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
relationshipDirection: "to",
},
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_deliverTo: hash_requestPropertyA,
tag_sellOfferPlan: hash_requestPropertyB,
tag_sellOfferPlanDeliveryMethodLink: hash_requestPropertyC,
tag_sellOfferPlanUserPaymentMethodLink: hash_requestPropertyD,
},
filterElementUnitIds: ["hash_filterElementUnitF"]
},
hash_linkStepA_C: { //final OrderPrice step
filterElementUnitIds: ["hash_filterElementUnitA"]
},
hash_linkStepB_A: { //one step: LocationNode > LocationNode
link: {
objType: {
serviceTag: "Locations",
objectType: "LocationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "isParentLocationNode"
},
relationshipDirection: "to",
},
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_traversalType: hash_requestPropertyE,
}
},
hash_linkStepB_B: { //final parent LocationNodes step
},
hash_linkStepC_A: { //one step: SellOffer > SellOfferPlan
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "SellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
relationshipDirection: "to",
},
},
hash_linkStepC_B: { //one step: SellOfferPlan > DeliveryMethodLink
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "DeliveryMethodLink"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "hasDeliveryMethodLink"
},
relationshipDirection: "to",
},
},
hash_linkStepC_C: { //one step: SellOfferPlan > DeliveryMethodLink
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "DeliveryMethodLink"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "hasDeliveryMethodLink"
},
relationshipDirection: "to",
},
},
hash_linkStepC_D: { //one step: DeliveryMethodLink > DeliveryMethod
link: {
objType: {
serviceTag: "DeliveryMethodManager",
objectType: "DeliveryMethod"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "isDeliveryMethod"
},
relationshipDirection: "to",
},
filterElementUnitIds: ["hash_filterElementUnitB"]
},
hash_linkStepD_A:{
filterElementUnitIds: ["hash_filterElementUnitE"]
}
},

requiredDataFields: { //* fields to create requiredData including linkPaths
//* no link, field in main objType
hash_requiredDataFieldA: {
fieldname: ""
},

//* has link
hash_requiredDataFieldB: {
linkStepObject: "hash_LinkStepObjectD",
fieldname: " ",
complexFilterCombinations: ["hash_complexFilterCombinationA"],
}

},
complexFilterCombinations:{
hash_complexFilterCombinationA: {
linkStepObjectA: "hash_LinkStepObjectB",
initialIdentifiers: { // tableConfig sets "defaultInitialIdentifiers, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultInitialIdentifiers
"locationNodeId": "xxxx"
},
},
},
perParentCombinations:{
hash_perParentCombinationA: {
linkStepObjectA: "hash_LinkStepObjectC",
},
},
requiredDataLinkStepObjects: {
hash_LinkStepObjectD: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
linkSteps: ["hash_linkStepD_A", "hash_linkStepD_B", "hash_linkStepA_C"],
}
},
requiredDataLinkSteps: {
hash_linkStepD_A: { //one step: Product > SellOffer
link: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
relationshipDirection: "to",
},
},
hash_linkStepD_B: { //one step: SellOffer > OrderPrice
link: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
relationshipDirection: "to",
},
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_deliverTo: hash_requestPropertyF,
tag_sellOfferPlanDeliveryMethodLink: hash_requestPropertyG,
}
},
hash_linkStepA_C: { //final OrderPrice step
filterElementUnitIds: ["hash_filterElementUnitA"]
aggregate: "max",
sortFields: "hash_sortFieldA",
// ... other linkPath.linkStep settings here
}
},
sortFields:{
hash_sortFieldA: {
// ..
}
}

filterElementUnits: {
hash_filterElementUnitA:{
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
fieldname: "orderTotal",
comparison: "greaterThan",
value: "xxx", // tableConfig sets "defaultFilterElementUnitValue", tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultFilterElementUnitValue
},
hash_filterElementUnitB:{
objType: {
serviceTag: "DeliveryMethodManager",
objectType: "deliveryMethod"
},
fieldname: "deliveryMethodId",
comparison: "equals",
value: "xxx",
},
hash_filterElementUnitD: {
objType: {
serviceTag: "ProductManager",
objectType: "Product"
},
fieldname: "productId",
comparison: "equals",
value: "xxx",
},
hash_filterElementUnitE: {
objType: {
serviceTag: "ProductManager",
objectType: "Product"
},
fieldname: "productId",
comparison: "equals",
value: "xxx",
}
},

requestProperties: {
hash_requestPropertyA:{
value: "xx",
},
hash_requestPropertyB:{
value: "xx",
},
hash_requestPropertyC:{
value: "xx",
},
hash_requestPropertyD:{
value: "xx",
},
hash_requestPropertyE:{
value: "xx",
},
hash_requestPropertyF:{
value: "xx",
},
hash_requestPropertyG:{
valueSource: "perParentCombination",
perParentCombinationId: "hash_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
}
}

</syntaxhighlight>

[[Category:Working documents| 2025-04-14]]
[[Category:Working documents - Search Results| 2025-04-14]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-07-02T06:45:28Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},

mainComplexFilterUnits: { // used to create main complexFilter
uuid_FilterUnitA: { // select link step from main objType
linkStepObject: "uuid_LinkStepObjectA",
parentOrGroup: "uuid_OrGroupA"
},
uuid_FilterUnitB: { // select own fieldname of main objType
filterElementUnits: [ "uuid_filterElementUnitD" ],
parentOrGtoup: "uuid_orGroupA"
}

},
mainComplexFilterOrGroups: { //* group and operation filters for each mainComplexFilterUnits
uuid_OrGroupA: {
FilterIds: ["uuid_FilterA"],
parentOrGroup: "",
childOrGroup: []
}
},
filterLinkStepObjects: {
uuid_LinkStepObjectA: { // main complexFilter find orderPrice
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLinkStep: "uuid_linkStepA_A",
linkSteps: {
uuid_linkStepA_A: { //one step: Product > SellOffer
link: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
relationshipDirection: "to",
},
childLinkStep: "uuid_linkStepA_B",
},
uuid_linkStepA_B: { //one step: SellOffer > OrderPrice
link: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
relationshipDirection: "to",
},
parentLinkStep: "uuid_linkStepA_A",
childLinkStep: "uuid_linkStepA_C",
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_deliverTo: {// tag_deliverTo comes from linkConfig
valueSource: "value",
value: "xx",
},
tag_sellOfferPlan: {
valueSource: "value",
value: "xx",
},
tag_sellOfferPlanDeliveryMethodLink: {
valueSource: "value",
value: "xx",
},
tag_sellOfferPlanUserPaymentMethodLink: {
valueSource: "value",
value: "xx",
},
}
},
uuid_linkStepA_C: { //final OrderPrice step
parentLinkStep: "uuid_linkStepA_B",
filterElementUnits: ["uuid_filterElementUnitA"]
}
}
},
uuid_LinkStepObjectB: { // complexFilterCombinations for parentLocationNodes
initialObjType: { //* main objType
serviceTag: "locatons",
objectType: "LocationNode"
},
initialLinkStep: "uuid_linkStepB_A",
linkSteps: {
uuid_linkStepB_A: { //one step: LocationNode > LocationNode
link: {
objType: {
serviceTag: "Locations",
objectType: "LocationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "isParentLocationNode"
},
relationshipDirection: "to",
},
childLinkStep: "uuid_linkStepB_B",
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_traversalType: {
valueSource: "value",
value: "parentNodes",
},
}
},
uuid_linkStepB_B: { //final parent LocationNodes step
parentLinkStep: "uuid_linkStepB_A"
}
}
},
uuid_LinkStepObjectC: { // perParentCombinations
initialObjType: { //* main objType
serviceTag: "SellOffer",
objectType: "SellOffer"
},
initialLinkStep: "uuid_linkStepC_A",
linkSteps: {
uuid_linkStepC_A: { //one step: SellOffer > SellOfferPlan
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "SellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
relationshipDirection: "to",
},
childLinkStep: "uuid_linkStepC_B",
},
uuid_linkStepC_B: { //one step: SellOfferPlan > DeliveryMethodLink
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "DeliveryMethodLink"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "hasDeliveryMethodLink"
},
relationshipDirection: "to",
},
parentLinkStep: "uuid_linkStepC_A",
childLinkStep: "uuid_linkStepC_C",
},
uuid_linkStepC_C: { //one step: SellOfferPlan > DeliveryMethodLink
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "DeliveryMethodLink"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "hasDeliveryMethodLink"
},
relationshipDirection: "to",
},
parentLinkStep: "uuid_linkStepC_B",
childLinkStep: "uuid_linkStepC_E",
},
uuid_linkStepC_D: { //one step: DeliveryMethodLink > DeliveryMethod
link: {
objType: {
serviceTag: "DeliveryMethodManager",
objectType: "DeliveryMethod"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "isDeliveryMethod"
},
relationshipDirection: "to",
},
parentLinkStep: "uuid_linkStepC_C",
childLinkStep: "uuid_linkStepC_E",
filterElementUnits: ["uuid_filterElementUnitB"]
},
}
},
},

requiredDataFields: { //* fields to create requiredData including linkPaths
//* no link, field in main objType
uuid_requiredDataFieldA: {
fieldname: ""
},

//* has link
uuid_requiredDataFieldB: {
linkStepObject: "uuid_LinkStepObjectD",
complexFilterCombinations: ["uuid_complexFilterCombinationA"],
}

},
complexFilterCombinations:{
uuid_complexFilterCombinationA: {
linkStepObjectA: "uuid_LinkStepObjectB",
initialIdentifiers: { // tableConfig sets "defaultInitialIdentifiers, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultInitialIdentifiers
"locationNodeId": "xxxx"
},
},
},
perParentCombinations:{
uuid_perParentCombinationA: {
linkStepObjectA: "uuid_LinkStepObjectC",
},
},
requiredDataLinkStepObjects: {
uuid_LinkStepObjectD: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLinkStep: "uuid_linkStepD_A",
linkSteps: {
uuid_linkStepD_A: { //one step: Product > SellOffer
link: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
relationshipDirection: "to",
},
childLinkStep: "uuid_linkStepD_B",
},
uuid_linkStepD_B: { //one step: SellOffer > OrderPrice
link: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
relationshipDirection: "to",
},
parentLinkStep: "uuid_linkStepD_A",
childLinkStep: "uuid_linkStepD_C",
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_deliverTo: {
valueSource: "complexFilterCombination",
complexFilterCombinationId: "uuid_complexFilterCombinationA",
identifierFieldName: "locationNodeId"
},
tag_sellOfferPlanDeliveryMethodLink: {
valueSource: "perParentCombination",
perParentCombinationId: "uuid_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
}
},
uuid_linkStepA_C: { //final OrderPrice step
parentLinkStep: "uuid_linkStepD_B",
filterElementUnits: ["uuid_filterElementUnitA"]
aggregate: "max",
sortFields: "uuid_sortFieldA",
// ... other linkPath.linkStep settings here
}
}
}
},
sortFields:{
uuid_sortFieldA: {
// ..
}
}

filterElementUnits: {
uuid_filterElementUnitA:{
fieldname: "orderTotal",
comparison: "greaterThan",
value: "xxx", // tableConfig sets "defaultFilterElementUnitValue", tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultFilterElementUnitValue
},
uuid_filterElementUnitB:{
fieldname: "deliveryMethodId",
comparison: "equals",
value: "xxx",
},
uuid_filterElementUnitD: {
fieldname: "productId",
comparison: "equals",
value: "xxx",
}
}

}

</syntaxhighlight>

[[Category:Working documents| 2025-07-01]]
[[Category:Working documents - Search Results| 2025-07-01]]

2025-04-14 - Frontend LinkPath structure for tableOutput

2025-07-01T10:41:55Z

Praew:

[[Service - Search Results]]

= Overview =

Structure frontend TableConfig and Output prepare for shared library that creates complexFilter and requestProperties

= Example params =

<syntaxhighlight lang="JavaScript">

let paramFromTableOutput = {
objType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},

mainComplexFilterUnits: { // used to create main complexFilter
uuid_FilterUnitA: {
linkStepObject: "uuid_LinkStepObjectA",
parentOrGroup: "uuid_OrGroupA"
},

},
mainComplexFilterOrGroups: { //* group and operation filters for each mainComplexFilterUnits
uuid_OrGroupA: {
FilterIds: ["uuid_FilterA"],
parentOrGroup: "",
childOrGroup: []
}
},

requiredDataFields: { //* fields to create requiredData including linkPaths
//* no link, field in main objType
uuid_requiredDataFieldA: {
fieldname: ""
},

//* has link
uuid_requiredDataFieldB: {
linkStepObject: "uuid_LinkStepObjectD",
complexFilterCombinations: ["uuid_complexFilterCombinationA"],
}

},

complexFilterCombinations:{
uuid_complexFilterCombinationA: {
linkStepObjectA: "uuid_LinkStepObjectB",
initialIdentifiers: { // tableConfig sets "defaultInitialIdentifiers, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultInitialIdentifiers
"locationNodeId": "xxxx"
},
},
},
perParentCombinations:{
uuid_perParentCombinationA: {
linkStepObjectA: "uuid_LinkStepObjectC",
},
},

linkStepObjects: { // all links used in this request
uuid_LinkStepObjectA: { // main complexFilter find orderPrice
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLinkStep: "uuid_linkStepA_A",
linkSteps: {
uuid_linkStepA_A: { //one step: Product > SellOffer
link: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
relationshipDirection: "to",
},
childLinkStep: "uuid_linkStepA_B",
},
uuid_linkStepA_B: { //one step: SellOffer > OrderPrice
link: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
relationshipDirection: "to",
},
parentLinkStep: "uuid_linkStepA_A",
childLinkStep: "uuid_linkStepA_C",
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_deliverTo: {// tag_deliverTo comes from linkConfig
valueSource: "value",
value: "xx",
},
tag_sellOfferPlan: {
valueSource: "value",
value: "xx",
},
tag_sellOfferPlanDeliveryMethodLink: {
valueSource: "value",
value: "xx",
},
tag_sellOfferPlanUserPaymentMethodLink: {
valueSource: "value",
value: "xx",
},
}
},
uuid_linkStepA_C: { //final OrderPrice step
parentLinkStep: "uuid_linkStepA_B",
filterElementUnits: ["uuid_filterElementUnitA"]
}
}
},

// linkStepObjects used in requiredDataFields
uuid_LinkStepObjectB: { // complexFilterCombinations for parentLocationNodes
initialObjType: { //* main objType
serviceTag: "locatons",
objectType: "LocationNode"
},
initialLinkStep: "uuid_linkStepB_A",
linkSteps: {
uuid_linkStepB_A: { //one step: LocationNode > LocationNode
link: {
objType: {
serviceTag: "Locations",
objectType: "LocationNode"
},
relType: {
serviceTag: "Locations",
relationshipTag: "isParentLocationNode"
},
relationshipDirection: "to",
},
childLinkStep: "uuid_linkStepB_B",
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_traversalType: {
valueSource: "value",
value: "parentNodes",
},
}
},
uuid_linkStepB_B: { //final parent LocationNodes step
parentLinkStep: "uuid_linkStepB_A"
}
}
},
uuid_LinkStepObjectC: { // perParentCombinations
initialObjType: { //* main objType
serviceTag: "SellOffer",
objectType: "SellOffer"
},
initialLinkStep: "uuid_linkStepC_A",
linkSteps: {
uuid_linkStepC_A: { //one step: SellOffer > SellOfferPlan
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "SellOfferPlan"
},
relType: {
serviceTag: "SellOfferManager",
relationshipTag: "usesSellOfferPlan"
},
relationshipDirection: "to",
},
childLinkStep: "uuid_linkStepC_B",
},
uuid_linkStepC_B: { //one step: SellOfferPlan > DeliveryMethodLink
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "DeliveryMethodLink"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "hasDeliveryMethodLink"
},
relationshipDirection: "to",
},
parentLinkStep: "uuid_linkStepC_A",
childLinkStep: "uuid_linkStepC_C",
},
uuid_linkStepC_C: { //one step: SellOfferPlan > DeliveryMethodLink
link: {
objType: {
serviceTag: "SellOfferPlan",
objectType: "DeliveryMethodLink"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "hasDeliveryMethodLink"
},
relationshipDirection: "to",
},
parentLinkStep: "uuid_linkStepC_B",
childLinkStep: "uuid_linkStepC_E",
},
uuid_linkStepC_D: { //one step: DeliveryMethodLink > DeliveryMethod
link: {
objType: {
serviceTag: "DeliveryMethodManager",
objectType: "DeliveryMethod"
},
relType: {
serviceTag: "SellOfferPlan",
relationshipTag: "isDeliveryMethod"
},
relationshipDirection: "to",
},
parentLinkStep: "uuid_linkStepC_C",
childLinkStep: "uuid_linkStepC_E",
filterElementUnits: ["uuid_filterElementUnitB"]
},
uuid_linkStepA_C: { //final OrderPrice step
parentLinkStep: "uuid_linkStepA_B"
}
}
},
uuid_LinkStepObjectD: { // requiredDataFields for finding max orderTotal
initialObjType: { //* main objType
serviceTag: "ProductManager",
objectType: "Product"
},
initialLinkStep: "uuid_linkStepD_A",
linkSteps: {
uuid_linkStepD_A: { //one step: Product > SellOffer
link: {
objType: {
serviceTag: "SellOfferManager",
objectType: "SellOffer"
},
relType: {
serviceTag: "ProductManager",
relationshipTag: "hasSellOffer"
},
relationshipDirection: "to",
},
childLinkStep: "uuid_linkStepD_B",
},
uuid_linkStepD_B: { //one step: SellOffer > OrderPrice
link: {
objType: {
serviceTag: "OrderPrice",
objectType: "OrderPrice"
},
relType: {
serviceTag: "sellOfferStandard",
relationshipTag: "hasOrderPrice"
},
relationshipDirection: "to",
},
parentLinkStep: "uuid_linkStepD_A",
childLinkStep: "uuid_linkStepD_C",
// tableConfig sets "defaultRequestPropertyValues" for each, tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultRequestPropertyValues
requestProperties:{
tag_deliverTo: {
valueSource: "complexFilterCombination",
complexFilterCombinationId: "uuid_complexFilterCombinationA",
identifierFieldName: "locationNodeId"
},
tag_sellOfferPlanDeliveryMethodLink: {
valueSource: "perParentCombination",
perParentCombinationId: "uuid_perParentCombinationA",
identifierFieldName: "sellOfferPlanDeliveryMethodLinkId"
},
}
},
uuid_linkStepA_C: { //final OrderPrice step
parentLinkStep: "uuid_linkStepD_B",
filterElementUnits: ["uuid_filterElementUnitA"]
aggregate: "max",
sortFields: "uuid_sortFieldA",
// ... other linkPath.linkStep settings here
}
}
}
},

filterElementUnits: {
uuid_filterElementUnitA:{
parentOrGroup: "uuid_OrGroupA",
fieldname: "orderTotal",
comparison: "greaterThan",
value: "xxx", // tableConfig sets "defaultFilterElementUnitValue", tableOutput finds from 1. filter objects set to overwrite it, 2. prop sent (eg from sitePage), 3. defaultFilterElementUnitValue
},
uuid_filterElementUnitB:{
parentOrGroup: "uuid_OrGroupA",
fieldname: "deliveryMethodId",
comparison: "equals",
value: "xxx",
}
}

sortFields:{
uuid_sortFieldA: {
// ..
}
}

}

</syntaxhighlight>

[[Category:Working documents| 2025-07-01]]
[[Category:Working documents - Search Results| 2025-07-01]]