Izara Wiki - User contributions [en]

2026-02-26 - ImportData CsvImportConfig

2026-02-27T08:46:19Z

Jammy:

= CsvImportConfig =
== CsvImportConfig ==
<syntaxhighlight lang="JavaScript">
{
"csvImportConfigId": "xxxxx",
"recordDeliminator": "\n",
"useUserReference": true,
"fieldDeliminator": ",",
"escapeString": "\\",
"removeFloatingEscapeString": true,
"removeWhiteSpace": true,
"fieldNames": {
"titleRow": 1,
"titleRowOpenEnclose": "\"",
"titleRowCloseEnclose": "\"",
"replacefieldNames": {}
},
"ignoreRows": [4,5],
"overwriteColumnName": {
"fieldName": "{replaceToValue}"
},
"objectTypes": [],
"floatingRelationships": []
}

</syntaxhighlight>
*csvImportConfigId (required) = The ID of the CsvImportConfig

*recordDelimiter (required) = The row delimiter

*fieldDelimiter (required) = The column delimiter

*escapeString (required) = The character used to escape delimiters (e.g., " to indicate that this is a quotation mark, not a column delimiter)

*removeFloatingEscapeString (required) = Remove any standalone (floating) escape characters

*removeWhiteSpace (required) = Remove whitespace within the column

*titleRow (required) = Specify which row (x) of the CSV is the header row

*ignoreRows (required) = Ignore the specified rows

==objectTypes==

<syntaxhighlight lang="JavaScript">
"objectTypes": [
{
"setObjectTypeFieldNames": {},
"objType": {
"serviceTag": "Translations",
"objectType": "translationLink"
},
"searchPattern": "^translationLink.*:",
"instancePattern": "(?<=translationLink)(.*)(?=:)",
"fieldNamePatterns": [
{
"fieldNamePattern": "(?<=:translationLink-A)",
"fieldName": "translationLink"
}
],
"fieldNameSearchPattern": "(?<=:)(.*)",
"referenceFieldNames": [
"userRef",
"ref"
],
"referenceLinks": {
"linkTagetToTL": {
"relType": {
"serviceTag": "Translation",
"relationshipTag": "hasTranslationLink"
},
"direction": "from"
}
},
"defaultActionField": "create",
"actionField": {
"fieldName": "actionField",
"createValue": "c",
"updateValue": "u",
"referenceValue": "r"
},
"defaultEnclose": {
"openEnclose": "\"",
"closeEnclose": "\""
},
"enclose": [
{
"openEnclose": "\"",
"closeEnclose": "\"",
"alwaysEnclose": "always",
"fieldNames": [
"weight",
"textTag",
"languageId",
"userRef"
]
}
],
"emptyDataFieldNames": [],
"overwriteValues": {}
}
]
</syntaxhighlight>
*setObjectTypeFieldNames (optional) = Specify the objType for each instancePattern (used when the same searchPattern is shared but the instancePattern differs). For example:
<syntaxhighlight lang="JavaScript">
"setObjectTypeFieldNames": {
 "subObjectTypeX": {
 "serviceDeliverySTD1": {
 "serviceTag": "DelivMethodSTD",
 "objectType": "deliveryMethod"
 },
 "rateTable001": {
 "serviceTag": "DeliveryMethodRAT",
 "objectType": "rates"
 }
 }
 }
</syntaxhighlight>

{| class="wikitable"
! deliveryDELIVERYSTD:actionField !! deliveryDELIVERYSTD:subObjectTypeX !! deliveryRATETABLE:actionField !! deliveryRATETABLE:subObjectTypeX
|-
| c || serviceDeliverySTD1 || c || rateTable001
|-
|}
By defining "searchPattern": "^delivery.*:",

the instancePattern is DELIVERYSTD, the objType will be set accordingly
<syntaxhighlight lang="JavaScript">
{
 "serviceTag": "DelivMethodSTD",
 "objectType": "deliveryMethod"
}

</syntaxhighlight>

the instancePattern is RATETABLE, the objType will be set accordingly.
<syntaxhighlight lang="JavaScript">
{
 "serviceTag": "DeliveryMethodRAT",
 "objectType": "rates"
}

</syntaxhighlight>
*searchPattern (required) = The system will look for column names that start with the value of searchPattern, followed by :

*referenceLinks (optional) = Used in the case of a ReferenceLink to specify the targetObject and which Relationship to use

*instancePattern (required) = Extract the Instance name (e.g., if searchPattern = translationLink, then translationLinkA will extract A as the Instance)

*referenceFieldNames (required) = The fields used as references

*actionField (required) = Define the action abbreviation in the CSV (e.g., c = create, u = update, r = reference)

*defaultActionField (optional) = If no Action is specified, the system will use the Action defined here

*enclose (required) = The fields specified in fieldNames must be enclosed

*defaultEnclose (required) = Fields not specified in enclose will use the defaultEnclose value

=Feed CSV=
When creating a CSV, the fieldName values will be defined according to the schemas of the object to be created, and referenceFieldNames will always be included as well. For example, when creating a rate.

rate have a fieldNames

<syntaxhighlight lang="JavaScript">
{
"objectType": "rates",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"ratesId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"minLength": 1
}
},
"storageResourceTags": [
"graph"
]
},
"upToValue": {
"type": "number",
"randomOnCreate": false,
"optionalOnCreate": false,
"requiredOnCreate": true,
"canUpdate": false,
"validation": {},
"storageResourceTags": [
"graph"
]
},
"rate": {
"type": "number",
"randomOnCreate": false,
"optionalOnCreate": true,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "ratesId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

By specifying it in the CsvImportConfig as follows.
<syntaxhighlight lang="JavaScript">
"searchPattern": "^DeliverRate.*:",
</syntaxhighlight>

{| class="wikitable"
! style="text-align:center;" |
! DeliverRate:actionField !! DeliverRate:ratesId !! DeliverRate:upToValue !! DeliverRate:rate !! DeliverRate:userRef
|-
| style="text-align:center;" | 1 || || || 100 || 10 || rate001
|-
| style="text-align:center;" | 2 || || rate1234567 || || ||
|-
| style="text-align:center;" | 3 || || rate1234567 || 50 || 5 ||
|-
| style="text-align:center;" | 4 || d || rate1234567 || || || rate001
|}

1.Create case: Send the fieldNames defined in the Schemas along with the referenceFieldNames (excluding fieldNames that are identifiers).

2.Get case: Send only the fieldNames that are identifiers.

3.Update case: Send all fieldNames defined in the Schemas (fieldNames must have canUpdate set to true).

4.Delete case: Send the fieldNames that are identifiers along with the referenceFieldNames.

=FloatingRelationShip=
Handling Feed and CsvImportConfig in the case of FloatingRelationship

CsvImportConfig will additionally include:
<syntaxhighlight lang="JavaScript">

"floatingRelationships": [
{
"setRelationshipTagFieldNames": {
"setRelationshipA": {
"isLocationType": {
"relType": {
"serviceTag": "Locations",
"relationshipTag": "isLocationType"
},
"direction": "to"
},
"hasTranslationLink": {
"relType": {
"serviceTag": "Translations",
"relationshipTag": "hasTranslationLink"
},
"direction": "from"
}
}
},
"relationshipTag": {
"relType": {
"serviceTag": "Locations",
"relationshipTag": "isLocationType"
},
"direction": "to"
},
"searchPattern": "^RELATIONSHIP.*:",
"instancePattern": "(?<=RELATIONSHIP)(.*)(?=:)",
"relationshipPropertyPatterns": [
{
"relationshipPropertyPattern": "originTimestamp",
"relationshipProperty": {
"settings": {
"encoding": "Number"
}
}
}
],
"relationshipPropertySearchPattern": "(?<=:)(.*)",
"objectAReferenceLinks": [
"objectAReference"
],
"objectBReferenceLinks": [
"objectBReference"
],
"actionRelationship": {
"fieldName": "actionRelationship",
"createValue": "c",
"deleteValue": "d",
"updateValue": "u"
},
"relIdPatterns": [
"relId"
],
"enclose": [
{
"openEnclose": "\"",
"closeEnclose": "\"",
"alwaysEnclose": "always",
"fieldNames": []
}
]
}
]
</syntaxhighlight>
*setRelationshipTagFieldNames (required) = Defines how Relationships are selected for linking (if the header specifies setRelationshipA, only the values defined in setRelationshipA within the CsvImportConfig can be used).

*relationshipTag (required) = If the specified Relationship value is not provided, the value defined here will be used as the default Relationship.

*objectAReferenceLinks / objectBReferenceLinks (required) = Used to specify the source object and the target object (these values must match the referenceFieldNames of the corresponding objectTypes).

*relIdPatterns (required) = The values defined here will be treated as the identifiers of the Relationships.

Handling Feed for FloatingRelationships

{| class="wikitable"
! locatiosType:locatiosTypeId !! locatiosType:uesrRef !! locatiosNode:userRef !! Relationship:setRelationshipA !! Relationship:objectAReference !! Relationship:objectBReference !! Relationship:actionRelationship
|-
| 123abcdef || TYPE || NODE || isLocationType || TYPE || NODE || c
|-
|}
Creating a Feed for FloatingRelationships will include additional fieldName entries in the Relationship section.
{| class="wikitable"
! Relationship:setRelationshipA !! Relationship:objectAReference !! Relationship:objectBReference !! Relationship:actionRelationship !! Relationship:relId
|-
| isLocationType || TYPE || NODE || c ||
|-
| isLocationType || TYPE || NODE || u || xxxxxxxx
|-
|}

Column 1 setRelationshipA: isLocationType means that the value isLocationType defined in the CsvImportConfig will be used.
<syntaxhighlight lang="JavaScript">
{
"relType": {
"serviceTag": "Locations",
"relationshipTag": "isLocationType"
},
"direction": "to"
}</syntaxhighlight>
Columns 2–3 objectAReference / objectBReference refer to the firstObject and secondObject that need to be linked together.

Column 4 actionRelationship refers to the action of that Relationship (c = create, u = update).

Column 5 relId refers to the identifier of the Relationship (used for update).

= ReferenceLink =
Handling Feed and CsvImportConfig in the case of ReferenceLink

In the CsvImportConfig, within the objectTypes: [ ] section, the following will be added:
<syntaxhighlight lang="JavaScript">
"referenceLinks": {
 "linkTagetToTL": {
 "relType": {
 "serviceTag": "Translation",
 "relationshipTag": "hasTranslationLink"
 },
 "direction": "from"
 }
 },
</syntaxhighlight>

'''linkTagetToTL'''
is key for mapping relationship to TranslationLink

There will be no FloatingRelationship: [ ] section.

For linking via ReferenceLink, the values defined in referenceLinks within the CsvImportConfig will be used as fieldName. The value in that fieldName must match the value in the corresponding referenceFieldNames field in order to specify which object to link to. For example:

{| class="wikitable"
! locationType:userRef
! translationLink:languageId
! translationLink:textTag
! translationLink:weight
! translationLink:linkTagetToTL
! translationLink:userRef
! TS:actionField
! TS:text
! TS:linkTagetToTS
! TS:userRef
|-
| AA || TH || Locations || 10 || AA || BB || c || Country || BB || CC
|}

In the table, it specifies that translationLink is linked to locationType by using the fieldName linkTagetToTL to determine the relType and direction as defined in the CsvImportConfig.
<syntaxhighlight lang="JavaScript">

{
"relType": {
"serviceTag": "Translation",
"relationshipTag": "hasTranslationLink"
},
"direction": "from"
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Import Data|Working_documents - Import Data]]

[[Category:Backend services| Import Data]]

2026-02-26 - ImportData CsvImportConfig

2026-02-27T08:43:36Z

Jammy:

2026-02-26 - ImportData CsvImportConfig

2026-02-26T11:07:31Z

Jammy: Created page with "= CsvImportConfig = <syntaxhighlight lang="JavaScript"> { "csvImportConfigId": "xxxxx", "recordDeliminator": "\n", "useUserReference": true, "fieldDeliminator": ",", "escapeString": "\\", "removeFloatingEscapeString": true, "removeWhiteSpace": true, "fieldNames": { "titleRow": 1, "titleRowOpenEnclose": "\"", "titleRowCloseEnclose": "\"", "replacefieldNames": {} }, "ignoreRows": [4,5], "overwriteColumnNam..."

= CsvImportConfig =
<syntaxhighlight lang="JavaScript">
{
"csvImportConfigId": "xxxxx",
"recordDeliminator": "\n",
"useUserReference": true,
"fieldDeliminator": ",",
"escapeString": "\\",
"removeFloatingEscapeString": true,
"removeWhiteSpace": true,
"fieldNames": {
"titleRow": 1,
"titleRowOpenEnclose": "\"",
"titleRowCloseEnclose": "\"",
"replacefieldNames": {}
},
"ignoreRows": [4,5],
"overwriteColumnName": {
"fieldName": "{replaceToValue}"
},
"objectTypes": [],
"floatingRelationships": []
}

</syntaxhighlight>
*csvImportConfigId (required) = The ID of the CsvImportConfig

*recordDelimiter (required) = The row delimiter

*fieldDelimiter (required) = The column delimiter

*escapeString (required) = The character used to escape delimiters (e.g., " to indicate that this is a quotation mark, not a column delimiter)

*removeFloatingEscapeString (required) = Remove any standalone (floating) escape characters

*removeWhiteSpace (required) = Remove whitespace within the column

*titleRow (required) = Specify which row (x) of the CSV is the header row

*ignoreRows (required) = Ignore the specified rows

=objectTypes=

<syntaxhighlight lang="JavaScript">
"objectTypes": [
{
"setObjectTypeFieldNames": {},
"objType": {
"serviceTag": "Translations",
"objectType": "translationLink"
},
"searchPattern": "^translationLink.*:",
"instancePattern": "(?<=translationLink)(.*)(?=:)",
"fieldNamePatterns": [
{
"fieldNamePattern": "(?<=:translationLink-A)",
"fieldName": "translationLink"
}
],
"fieldNameSearchPattern": "(?<=:)(.*)",
"referenceFieldNames": [
"userRef",
"ref"
],
"referenceLinks": {
"linkTagetToTL": {
"relType": {
"serviceTag": "Translation",
"relationshipTag": "hasTranslationLink"
},
"direction": "from"
}
},
"defaultActionField": "create",
"actionField": {
"fieldName": "actionField",
"createValue": "c",
"updateValue": "u",
"referenceValue": "r"
},
"defaultEnclose": {
"openEnclose": "\"",
"closeEnclose": "\""
},
"enclose": [
{
"openEnclose": "\"",
"closeEnclose": "\"",
"alwaysEnclose": "always",
"fieldNames": [
"weight",
"textTag",
"languageId",
"userRef"
]
}
],
"emptyDataFieldNames": [],
"overwriteValues": {}
}
]
</syntaxhighlight>
*setObjectTypeFieldNames (optional) = Specify the objType for each instancePattern (used when the same searchPattern is shared but the instancePattern differs). For example:
<syntaxhighlight lang="JavaScript">
"setObjectTypeFieldNames": {
 "subObjectTypeX": {
 "serviceDeliverySTD1": {
 "serviceTag": "DelivMethodSTD",
 "objectType": "deliveryMethod"
 },
 "rateTable001": {
 "serviceTag": "DeliveryMethodRAT",
 "objectType": "rates"
 }
 }
 }
</syntaxhighlight>

{| class="wikitable"
! deliveryDELIVERYSTD:actionField !! deliveryDELIVERYSTD:subObjectTypeX !! deliveryRATETABLE:actionField !! deliveryRATETABLE:subObjectTypeX
|-
| c || serviceDeliverySTD1 || c || rateTable001
|-
|}
By defining "searchPattern": "^delivery.*:",

the instancePattern is DELIVERYSTD, the objType will be set accordingly
<syntaxhighlight lang="JavaScript">
{
 "serviceTag": "DelivMethodSTD",
 "objectType": "deliveryMethod"
}

</syntaxhighlight>

the instancePattern is RATETABLE, the objType will be set accordingly.
<syntaxhighlight lang="JavaScript">
{
 "serviceTag": "DeliveryMethodRAT",
 "objectType": "rates"
}

</syntaxhighlight>
*searchPattern (required) = The system will look for column names that start with the value of searchPattern, followed by :

*referenceLinks (optional) = Used in the case of a ReferenceLink to specify the targetObject and which Relationship to use

*instancePattern (required) = Extract the Instance name (e.g., if searchPattern = translationLink, then translationLinkA will extract A as the Instance)

*referenceFieldNames (required) = The fields used as references

*actionField (required) = Define the action abbreviation in the CSV (e.g., c = create, u = update, r = reference)

*defaultActionField (optional) = If no Action is specified, the system will use the Action defined here

*enclose (required) = The fields specified in fieldNames must be enclosed

*defaultEnclose (required) = Fields not specified in enclose will use the defaultEnclose value

=FloatingRelationShip=

Service - Delivery Method Standard

2026-01-13T09:30:40Z

Jammy:

= Overview =

Handler service for basic delivery methods that use [[Service - Delivery Method Rate Table]] for pricing.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-delivery-method-standard
= Schemas =
==ObjectSchemas==
extendObjType:deliveryMethod
===deliveryMethodStandard===
<syntaxhighlight lang="JavaScript">
{
"objectType": "deliveryMethodStandard",
"extendObjType": {
"serviceTag": "DeliveryMethodMgr",
"objectType": "deliveryMethod"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "DeliveryMethodRecord",
"serviceTag": "DeliveryMethodMgr"
}
},
"addOnDataStructure": [
{
"type": "versionedData",
"versionedDataLabel": "deliveryMethodSettings",
"storageResourceTag": "graph",
"fieldNames": {
"defaultValueType": {
"type": "string",
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": true,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"defaultValueId": {
"type": "string",
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": true,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"defaultValueLanguageId": {
"type": "string",
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": true,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"defaultAccumulateValue": {
"type": "boolean",
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": true,
"validation": {

}
}
}
},
{
"type": "propertyValue"
}
],
"fieldNames": {},
"generatedBy": "userGenerated"
}
</syntaxhighlight>

*Property
=== deliveryMethodStandardPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "deliveryMethodStandardPropertyLabel",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"deliveryMethodStandardPropertyLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "deliveryMethodStandardPropertyLabelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== deliveryMethodStandardPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "deliveryMethodStandardPropertyValue",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"deliveryMethodStandardPropertyValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "deliveryMethodStandardPropertyValueId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

==relationshipSchemas==
*'''RelationshipTags'''

===fromLocationNode===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DelivMethodSTD",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": true
},
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationNode"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "DelivMethodSTD",
"objectType": "deliveryMethodStandard"
},
"linkType": "many",
"requiredOnCreate": true,
"handler": true
},
"canDelete": false
}
],
"canMove": false
}

</syntaxhighlight>

===ownsDeliveryMethodRateTable===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DelivMethodSTD",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DelivMethodSTD",
"objectType": "deliveryMethodStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"requiredOnCreate": true,
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isDeliveryMethodStandardPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DelivMethodSTD",
"fieldNames": {
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "deliveryMethodStandardPropertyValue",
"serviceTag": "DelivMethodSTD"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "deliveryMethodStandardPropertyLabel",
"serviceTag": "DelivMethodSTD"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasDeliveryMethodStandardPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DelivMethodSTD",
"fieldNames": {
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "deliveryMethodStandard",
"serviceTag": "DelivMethodSTD"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "deliveryMethodStandardPropertyValue",
"serviceTag": "DelivMethodSTD"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
canChangeToRelTypes: [
{
serviceTag:"deliveryMethodStandard",
relationshipTag: "disabledDeliveryMethodStandardPropertyValue"
},
],
canMove:true
}
</syntaxhighlight>

=== hasDeliveryMethodRateTable ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DelivMethodSTD",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DelivMethodSTD",
"objectType": "deliveryMethodStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"requiredOnCreate": true,
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
serviceTag:"deliveryMethodStandard",
relationshipTag: "disabledDeliveryMethodRateTable"
},
],
"canMove": true
}
</syntaxhighlight>

=== disabledDeliveryMethodStandardPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DelivMethodSTD",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "deliveryMethodStandard",
"serviceTag": "DelivMethodSTD"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "deliveryMethodStandardPropertyValue",
"serviceTag": "DelivMethodSTD"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
canChangeToRelTypes: [
{
serviceTag:"deliveryMethodStandard",
relationshipTag: "hasDeliveryMethodStandardPropertyValue"
},
],
canMove:true
}
</syntaxhighlight>

=== disabledDeliveryMethodRateTable ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DelivMethodSTD",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DelivMethodSTD",
"objectType": "deliveryMethodStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
serviceTag:"deliveryMethodStandard",
relationshipTag: "hasDeliveryMethodRateTable"
},
],
"canMove": true
}
</syntaxhighlight>

= DynamoDB tables =

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

=== Configuration tags ===

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

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

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

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

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

= Graph database =

== [[Service - Products Graph]]==

=== Nodes ===

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{deliveryMethodSharedLib.consts.DELIVERYMETHOD_GRAPH_NODE_LABEL}",
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{DeliveryMethodStandardLib.DELIVERYMETHOD_GRAPH_NODE_LABEL}PropertyLabel",
}
{
nodeLabel: "{DeliveryMethodStandardLib.DELIVERYMETHOD_GRAPH_NODE_LABEL}Property",
}
</syntaxhighlight>
* see [[NPM module - Izara Core - Property Node|DataSchemaLib]]

=== Versioned data ===

==== deliveryMethodSettings ====

<syntaxhighlight lang="JavaScript">
{
properties: {
defaultValueType: {}, // orderQuantity|orderSubtotal|productAttributeId|sellOfferTermId
defaultValueId: {}, //(optinalOnCreate) used for productAttributeId|sellOfferTermId
defaultValueLanguageId: {}, // (optinalOnCreate) used for productAttributeId|sellOfferTermId, when finding attribute value need to set language to find
defaultAccumulateValue: true //(optinalOnCreate) default: true, if set to false will find the largest value out of all sellOffers in the order
},
}
</syntaxhighlight>

=== Relationships ===

<syntaxhighlight lang="JavaScript">
{
relationshipType: "{DeliveryMethodStandardLib.createfromLocationNodeRelationshipType()}", // "from_LocationNode"
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
* currently this is set when creating the deliveryMethod and cannot be changed, if in future we allow to be changed, will need to validate all sellOffers that link to this deliveryMethod and ensure sellOffer's stock location still slots into the deliveryMethods new from_LocationNode

<syntaxhighlight lang="JavaScript">
{
relationshipType: "{DeliveryMethodStandardLib.createHasDeliveryMethodRateTableGraphRelationshipType()}", // "has_deliveryMethodRateTable"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{DeliveryMethodStandardLib.createDisabledDeliveryMethodRateTableGraphRelationshipType()}", // "disabled_deliveryMethodRateTable"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{DeliveryMethodStandardLib.createHasDeliveryMethodRateTableGraphRelationshipType()}", // "owns_deliveryMethodRateTable"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
* controls ownership of a rateTable, many deliveryMethods can point to one rateTable but only one deliveryMethod controls it (RBAC for that deliveryMethods allows control over the rateTable)

<syntaxhighlight lang="JavaScript">
{
relationshipType: "has_{DeliveryMethodStandardLib.DELIVERYMETHOD_GRAPH_NODE_LABEL}Property",
}
{
relationshipType: "disabled_{DeliveryMethodStandardLib.DELIVERYMETHOD_GRAPH_NODE_LABEL}Property",
}
{
relationshipType: "is_{DeliveryMethodStandardLib.DELIVERYMETHOD_GRAPH_NODE_LABEL}PropertyLabel",
}
</syntaxhighlight>
* see [[NPM module - Izara Core - Property Node|DataSchemaLib]]

= Complex Filter requests =

<syntaxhighlight lang="JavaScript">
{
filterType: "handlerDeliveryMethod" //unique id is deliveryMethodId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "currencyId",
comparison: "equals",
value: "xx"
},
{
type: "logical",
logicalTag: "fromLocationNodeId",
comparison: "equals",
value: "xx"
},
{
type: "complexFilter",
complexFilter: {
filterType: "deliveryMethodRateTable",
// see [[Service - Delivery Method Rate Table|Complex Filter requests]]
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "deliveryMethodProperty",
// see [[NPM module - Izara Core - Property Node|Complex Filter requests]]
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "deliveryMethodNameTranslation" //unique id is deliveryMethodId
type: "group",
elements:
[
{
// see [[Service - Translations|Complex Filter requests]]
type: "logical",
logicalTag: "textTag_languageId_text",
resultType: "deliveryMethod",
textTag: "deliveryMethodName",
languageId: "en",
text: "Is a great term",
subjectIdentifierPropertyName: "deliveryMethodId",
caseSensitive: true
},
]
}
},
...
]
}
</syntaxhighlight>

== Translate Ids - deliveryMethodRateTable to deliveryMethod ==

* only find deliveryMethodIds that are enabled

= Data structure notes =

* Users can create new deliveryMethods which are uniquely identified by their translation
* deliveryMethods have RBAC structure, default to creator having admin permissions, but admin can add other roles etc..
* Any user can attach any deliveryMethod to a SellOfferPlan

= Working documents =

[[:Category:Working_documents - Delivery Method Standard|Delivery Method Standard]]

[[Category:Backend services| Delivery Method Standard]]

Service - Locations

2026-01-13T08:57:17Z

Jammy:

Service - Payment Method Generic

2026-01-13T08:54:45Z

Jammy:

= Overview =

Handler service for generic payment methods that give text instruction to buyer at completion of sale. userPaymentMethod is also handled by each Payment Method Handler because there will be unique settings depending on the Payment Method.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-payment-method-generic/src/master/
= Schemas =
==ObjectSchemas==
===paymentMethodGeneric===
*ExtendObjType:paymentMethod
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethodGeneric",
"extendObjType": {
"serviceTag": "PaymentMethodManager",
"objectType": "paymentMethod"
},
"addOnDataStructure": [
{
"type": "propertyValue"
}
],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "PaymentMethodRecords",
"serviceTag": "PaymentMethodManager"
}
},
"fieldNames": {},
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== userPaymentMethodGeneric ===
*ExtendObjType:userPaymentMethod
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGeneric",
"extendObjType": {
"serviceTag": "PaymentMethodManager",
"objectType": "userPaymentMethod"
},
"addOnDataStructure": [
{
"type": "propertyValue"
}
],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "UserPaymentMethodsRecords",
"serviceTag": "PaymentMethodManager"
}
},
"fieldNames": {},
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericSalePropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericSalePropertyValue",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericSalePropertyValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericSalePropertyValueId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericSalePropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericSalePropertyLabel",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericSalePropertyLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericSalePropertyLabelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
'''property'''
=== paymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethodGenericPropertyLabel",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"paymentMethodGenericPropertyLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "paymentMethodGenericPropertyLabelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== paymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethodGenericPropertyValue",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"paymentMethodGenericPropertyValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "paymentMethodGenericPropertyValueId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericPropertyLabel",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericPropertyLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericPropertyLabelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericPropertyValue",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericPropertyValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericPropertyValueId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

==RelationshipSchemas==

=== disabledPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "paymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "paymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": true
"canChangeToRelTypes": [
{
serviceTag:"PaymentMethodGeneric",
relationshipTag: "hasPaymentMethodGenericPropertyValue"
},
]
}
</syntaxhighlight>

=== disabledUserPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],

"canMove": true
}
</syntaxhighlight>

=== disabledUserPaymentMethodGenericSalePropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "hasUserPaymentMethodGenericSalePropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== hasPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "paymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "paymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "disabledPaymentMethodGenericPropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== hasUserPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "disabledUserPaymentMethodGenericPropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== hasUserPaymentMethodGenericSalePropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "disabledUserPaymentMethodGenericSalePropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== isPaymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "paymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "paymentMethodGenericPropertyLabel",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>
=== isUserPaymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyLabel",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>
=== isUserPaymentMethodGenericSalePropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyLabel",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

== Basic node schemas ==

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{PaymentMethodGenericLib.PAYMENTMETHOD_GRAPH_NODE_LABEL}", // "paymentMethod"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
paymentMethodId: {
identifier: true,
},
paymentMethodHandlerServiceNameTag: {
immutable: true,
},
},
}
}
</syntaxhighlight>
* [[Service - Translations Graph]]
* [[Service - Orders Graph]]

=== Schema comes from [[NPM module - Izara Core - Property Node|BasicNodeSchemaLib]] ===

# paymentMethodPropertyLabel
#* [[Service - Translations Graph]]
# paymentMethodProperty
#* [[Service - Translations Graph]]
# paymentMethodSalePropertyLabel
#* [[Service - Translations Graph]]
# paymentMethodSaleProperty
#* [[Service - Translations Graph]]

= Complex Filter requests =

<syntaxhighlight lang="JavaScript">
{
filterType: "handlerPaymentMethod" //unique id is paymentMethodId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "currencyId",
comparison: "equals",
value: "xx"
},
{
type: "complexFilter",
complexFilter: {
filterType: "paymentMethodProperty",
// see [[NPM module - Izara Core - Property Node|Complex Filter requests]]
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "paymentMethodNameTranslation" //unique id is paymentMethodId
type: "group",
elements:
[
{
// see [[Service - Translations|Complex Filter requests]]
type: "logical",
logicalTag: "textTag_languageId_text",
resultType: "paymentMethod",
textTag: "paymentMethodName",
languageId: "en",
text: "Is a great term",
subjectIdentifierPropertyName: "paymentMethodId",
caseSensitive: true
},
]
}
},
...
]
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
filterType: "handlerUserPaymentMethod" //unique id is userPaymentMethodId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "paymentMethodId",
comparison: "equals",
value: "xx"
},
{
type: "complexFilter",
complexFilter: {
filterType: "paymentMethod",
// see above
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "userPaymentMethodProperty",
// see [[NPM module - Izara Core - Property Node|Complex Filter requests]]
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "userPaymentMethodSaleProperty",
// see [[NPM module - Izara Core - Property Node|Complex Filter requests]]
}
},
...
]
}
</syntaxhighlight>

= Data structure notes =

* Users can create new paymentMethods which are uniquely identified by their translation
* Users can create userPaymentMethod nodes for their account which connect to paymentMethods, one user can have multiple userPaymentMethod links to the same paymentMethod, eg different Bank Transfer nodes for different bank accounts, which can be applied to sell offers in any combination

= Working documents =

[[:Category:Working_documents - Payment Method Generic|Payment Method Generic]]

[[Category:Backend services| Payment Method Generic]]

Service - Payment Method Manager

2026-01-13T08:49:42Z

Jammy: /* isPaymentMethod */

= Overview =

Each payment method is handled by a [[Service - Payment Method (handlers)]] service, with [[Service - Payment Method Generic]] taking all new/simple payment methods.

The Payment Method Manager service handles shared orchestration of the Payment Method Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-payment-method-manager/src/master/

= Schemas =
==ObjectSchemas==
===paymentMethod===
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethod",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "PaymentMethodRecords",
"serviceTag": "PaymentMethodManager"
}
},
"fieldNames": {
"paymentMethodId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"storageResourceTags": ["dynamoDB","graph"],
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"}
},
"paymentMethodHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": false,
"storageResourceTags": ["dynamoDB"],
"validation": { "pattern": "^[a-zA-Z0-9-_]+$"}}
},
"currencyId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"storageResourceTags": ["dynamoDB"],
"validation": { "pattern": "^[a-zA-Z0-9-_]+$"}}
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "paymentMethodId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript" inline>currencyId</syntaxhighlight>:is uuid and connect translations declere currency eg:"THB" ect.

=== userPaymentMethod ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethod",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "UserPaymentMethodsRecords",
"serviceTag": "PaymentMethodManager"
}
},
"fieldNames": {
"userPaymentMethodId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"storageResourceTags": [
"dynamoDB",
"graph"
],
"validation": {"pattern": "^[a-zA-Z0-9-_]+$"}
},
"paymentMethodHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": true,
"storageResourceTags": [
"dynamoDB"
],
"validation": {"pattern": "^[a-zA-Z0-9-_]+$"}
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isPaymentMethod ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodManager",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "PaymentMethodManager",
"objectType": "userPaymentMethod"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"to": {
"objType": {
"serviceTag": "PaymentMethodManager",
"objectType": "paymentMethod"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Payment Method Manager|Payment Method Manager]]

[[Category:Backend services| Payment Method Manager]]

Service - Delivery Method Rate Table

2026-01-13T08:47:31Z

Jammy:

= Overview =

Manages delivery rate tables for delivery methods (possible other objects). Rate tables combine set rates at a certain value with increment settings to easily maintain rate table calculations.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-delivery-method-rate-table

= Schemas =

==ObjectSchemas==
=== rates ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "rates",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"ratesId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"minLength": 1
}
},
"storageResourceTags": [
"graph"
]
},
"upToValue": {
"type": "number",
"randomOnCreate": false,
"optionalOnCreate": false,
"requiredOnCreate": true,
"canUpdate": false,
"validation": {

},
"storageResourceTags": [
"graph"
]
},
"rate": {
"type": "number",
"randomOnCreate": false,
"optionalOnCreate": true,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {

},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "ratesId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== rateTable ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "rateTable",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"rateTableId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"minLength": 1
}
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "rateTableId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

==RelationshipSchemas==

=== hasRates ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DeliveryMethodRAT",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},

},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rates"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disableRates ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DeliveryMethodRAT",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rates"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== deliversToLocationNode ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DeliveryMethodRAT",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationNode"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledDeliversTolocationNode ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DeliveryMethodRAT",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationNode"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= DynamoDB tables =

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

=== Configuration tags ===

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

== LogicalResultsMain ==
[[Standard LogicalResults Per Service|LogicalResultsMain]]

== LogicalResultsData ==
[[Standard LogicalResults Per Service|LogicalResultsData]]

== LogicalAwaitingStep ==
[[Standard LogicalResults Per Service|LogicalAwaitingStep]]

= Graph database =

== [[Service - Products Graph]]==

=== Nodes ===

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{DeliveryMethodRateTableLib.RATETABLE_GRAPH_NODE_LABEL}", // "rateTable"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
rateTableId: {
identifier: true, // create unique id from request params and uniqueMessageId
},
},
}
}
</syntaxhighlight>

=== Versioned data ===

==== rateTableRates ====

<syntaxhighlight lang="JavaScript">
{
properties: {
rates: [
{
type: "setRate",
upToValue: xx, // numeric value that this setRate goes up to
rate: xx, // numeric rate
},
{
type: "increment",
upToValue: xx, // numeric value that this setRate goes up to
ratePerIncrement: xx, // numeric amount that rate increases per increment
increment: xx, // numeric incremental amount
},
// ..
],
},
}
</syntaxhighlight>

=== Relationships ===

<syntaxhighlight lang="JavaScript">
{
relationshipType: "{DeliveryMethodStandardLib.createHasDeliveryMethodRateTableGraphRelationshipType()}", // "deliversTo_locationNode"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{DeliveryMethodStandardLib.createDisabledDeliveryMethodRateTableGraphRelationshipType()}", // "disabledDeliversTo_locationNode"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>

* enable/disable links to locationNodes
* after a locationNode relationship is added to a RateTable it always remains as either one of the above relationships, in order to maintain history of changes

<syntaxhighlight lang="JavaScript">
{
relationshipType: "adjustDeliversTo_performedBy"
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
locationNodeId:
action: // "added"|"enabled"|"disabled"
},
}
}
</syntaxhighlight>

* adds a relationship record between rateTable node and user whenever delivers to relationship added or removed

= Data structure notes =

* multiple deliveryMethods could point to a single rateTable

= Complex Filter requests =

<syntaxhighlight lang="JavaScript">
{
filterType: "deliveryMethodRateTable" //unique id is rateTableId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "deliverToLocationId",
comparison: "equals",
value: "xx"
},
{
// finds all rateTables that has at >=1 has_deliveryMethodRateTable incomming relationship from give sellOfferPlanDeliveryMethodLinkId
type: "logical",
logicalTag: "activeSellOfferPlanDeliveryMethodLinkId",
comparison: "equals",
value: "xx"
},
{
// finds all rateTables that has at >=1 has_deliveryMethodRateTable incomming relationship
type: "logical",
logicalTag: "isEnabled",
comparison: "true",
},
...
]
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Delivery Method Rate Table|Delivery Method Rate Table]]

[[Category:Backend services| Delivery Method Rate Table]]

Service - Variant Standard

2026-01-13T08:40:19Z

Jammy: /* disabledVariantProductLink */

Service - Variant Standard

2026-01-13T08:39:50Z

Jammy: /* hasVariantProductLink */

Service - Variant Manager

2026-01-13T08:37:20Z

Jammy: /* disabledVariantAttributeLink */

= Overview =

Each product is handled by a [[Service - Variant (handlers)]] service.

The Variant Manager service handles shared orchestration of Variant Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-variant-manager/src/master/

= Schemas =
==ObjectSchemas==
=== variant ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variant",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"addOnDataStructure": [],
"storageResources": {
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "VariantRecord",
"serviceTag": "VariantManager"
},
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
},
"variantHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "variantId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== variantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLabel",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLabelId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLink",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLinkId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLinkId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeValue",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeValueId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isVariantAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isVariantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLabel",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {

},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

== TranslateIdsCache ==

Stores a record for any unique translateId process

<syntaxhighlight lang="JavaScript">
{
cacheId // fromType + "_" + fromDataId + "_" + toType
toDataId
expireTime
}
</syntaxhighlight>

* partition key: cacheId
* sort key: toDataId
* expireTime is set as an automatic DynamoDB TTL attibute

= Working documents =

[[:Category:Working_documents - Variant Manager|Variant Manager]]

[[Category:Backend services| Variant Manager]]

Service - Variant Manager

2026-01-13T08:36:48Z

Jammy: /* hasVariantAttributeLink */

= Overview =

Each product is handled by a [[Service - Variant (handlers)]] service.

The Variant Manager service handles shared orchestration of Variant Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-variant-manager/src/master/

= Schemas =
==ObjectSchemas==
=== variant ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variant",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"addOnDataStructure": [],
"storageResources": {
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "VariantRecord",
"serviceTag": "VariantManager"
},
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
},
"variantHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "variantId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== variantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLabel",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLabelId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLink",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLinkId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLinkId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeValue",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeValueId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isVariantAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isVariantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLabel",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

== TranslateIdsCache ==

Stores a record for any unique translateId process

<syntaxhighlight lang="JavaScript">
{
cacheId // fromType + "_" + fromDataId + "_" + toType
toDataId
expireTime
}
</syntaxhighlight>

* partition key: cacheId
* sort key: toDataId
* expireTime is set as an automatic DynamoDB TTL attibute

= Working documents =

[[:Category:Working_documents - Variant Manager|Variant Manager]]

[[Category:Backend services| Variant Manager]]

Service - Variant Manager

2026-01-13T08:36:20Z

Jammy: /* isVariantAttributeLabel */

= Overview =

Each product is handled by a [[Service - Variant (handlers)]] service.

The Variant Manager service handles shared orchestration of Variant Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-variant-manager/src/master/

= Schemas =
==ObjectSchemas==
=== variant ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variant",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"addOnDataStructure": [],
"storageResources": {
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "VariantRecord",
"serviceTag": "VariantManager"
},
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
},
"variantHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "variantId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== variantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLabel",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLabelId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLink",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLinkId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLinkId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeValue",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeValueId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isVariantAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isVariantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLabel",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

== TranslateIdsCache ==

Stores a record for any unique translateId process

<syntaxhighlight lang="JavaScript">
{
cacheId // fromType + "_" + fromDataId + "_" + toType
toDataId
expireTime
}
</syntaxhighlight>

* partition key: cacheId
* sort key: toDataId
* expireTime is set as an automatic DynamoDB TTL attibute

= Working documents =

[[:Category:Working_documents - Variant Manager|Variant Manager]]

[[Category:Backend services| Variant Manager]]

Service - Variant Manager

2026-01-13T08:35:55Z

Jammy: /* isVariantAttribute */

= Overview =

Each product is handled by a [[Service - Variant (handlers)]] service.

The Variant Manager service handles shared orchestration of Variant Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-variant-manager/src/master/

= Schemas =
==ObjectSchemas==
=== variant ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variant",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"addOnDataStructure": [],
"storageResources": {
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "VariantRecord",
"serviceTag": "VariantManager"
},
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
},
"variantHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "variantId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== variantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLabel",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLabelId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLink",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLinkId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLinkId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeValue",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeValueId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isVariantAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isVariantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLabel",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

== TranslateIdsCache ==

Stores a record for any unique translateId process

<syntaxhighlight lang="JavaScript">
{
cacheId // fromType + "_" + fromDataId + "_" + toType
toDataId
expireTime
}
</syntaxhighlight>

* partition key: cacheId
* sort key: toDataId
* expireTime is set as an automatic DynamoDB TTL attibute

= Working documents =

[[:Category:Working_documents - Variant Manager|Variant Manager]]

[[Category:Backend services| Variant Manager]]

Service - Product Attributes

2026-01-13T08:34:37Z

Jammy: /* disabledProductAttributeLink */

Service - Product Attributes

2026-01-13T08:34:15Z

Jammy: /* hasProductAttributeLink */

Service - Product Attributes

2026-01-13T08:33:54Z

Jammy: /* isProductAttributeLabel */

= Overview =

Manages Product Attributes and ProductAttributeLinks. Product Attributes can be shared by many Products, ProductAttributeLinks are used to create an attribute tree for one Product.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-product-attributes/src/master/

= Schemas =
==ObjectSchemas==
=== productAttribute ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttribute",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"productAttributeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productAttributeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttributeLink",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"productAttributeLinkId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productAttributeLinkId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttributeLabel",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"labelId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "labelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isProductAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttribute"
},
"requiredOnCreate": false,
"linkType": "one",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isProductAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttribute"
},
"linkType": "many",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLabel"
},
"requiredOnCreate": false,
"linkType": "one",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasProductAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

},
"requiredOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
},
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "ProductAttribute",
"relationshipTag": "disabledProductAttributeLink"
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledProductAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": true,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": false,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "ProductAttribute",
"relationshipTag": "hasProductAttributeLink"
}
],
"canMove": false
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Product Attributes|Product Attributes]]

[[Category:Backend services| Product Attributes]]

Service - Product Attributes

2026-01-13T08:33:29Z

Jammy: /* isProductAttribute */

= Overview =

Manages Product Attributes and ProductAttributeLinks. Product Attributes can be shared by many Products, ProductAttributeLinks are used to create an attribute tree for one Product.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-product-attributes/src/master/

= Schemas =
==ObjectSchemas==
=== productAttribute ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttribute",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"productAttributeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productAttributeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttributeLink",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"productAttributeLinkId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productAttributeLinkId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttributeLabel",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"labelId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "labelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isProductAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttribute"
},
"requiredOnCreate": false,
"linkType": "one",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isProductAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttribute"
},
"linkType": "many",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLabel"
},
"requiredOnCreate": false,
"linkType": "one",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasProductAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

},
"requiredOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
},
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "ProductAttribute",
"relationshipTag": "disabledProductAttributeLink"
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledProductAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": true,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": false,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "ProductAttribute",
"relationshipTag": "hasProductAttributeLink"
}
],
"canMove": false
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Product Attributes|Product Attributes]]

[[Category:Backend services| Product Attributes]]

Service - Product Standard

2026-01-13T08:29:10Z

Jammy: /* isProduct */

Service - Product Manager

2026-01-13T08:28:05Z

Jammy: /* isProduct */

= Overview =

Each product is handled by a [[Service - Product (handlers)]] service.

The Product Manager service handles shared orchestration of the Product Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-product-manager/src/master/

= Schemas =
==ObjectSchemas==
=== product ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "product",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"addOnDataStructure": [],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"productId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productRecord ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productRecord",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"storageResources": {
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "ProductStandard",
"serviceTag": "ProductManager"
},
"myGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "propertyValue"
}
],
"fieldNames": {
"productId": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB"
]
},
"productHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "partitionKey",
"fieldName": "productId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isProduct ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductManager",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "VariantStandard",
"objectType": "variantProductLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": true
},
"to": {
"objType": {
"serviceTag": "ProductStandard",
"objectType": "productStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Product Manager|Product Manager]]

[[Category:Backend services| Product Manager]]

Service - Product Attributes

2026-01-07T03:50:48Z

Jammy:

= Overview =

Manages Product Attributes and ProductAttributeLinks. Product Attributes can be shared by many Products, ProductAttributeLinks are used to create an attribute tree for one Product.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-product-attributes/src/master/

= Schemas =
==ObjectSchemas==
=== productAttribute ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttribute",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"productAttributeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productAttributeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttributeLink",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"productAttributeLinkId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productAttributeLinkId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttributeLabel",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"labelId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "labelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isProductAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttribute"
},
"requiredOnCreate": false,
"linkType": "one",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isProductAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttribute"
},
"linkType": "many",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLabel"
},
"requiredOnCreate": false,
"linkType": "one",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasProductAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

},
"requiredOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
},
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "ProductAttribute",
"relationshipTag": "disabledProductAttributeLink"
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledProductAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": true,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": false,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "ProductAttribute",
"relationshipTag": "hasProductAttributeLink"
}
],
"canMove": false
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Product Attributes|Product Attributes]]

[[Category:Backend services| Product Attributes]]

Service - Delivery Method Pickup Table

2026-01-06T09:45:23Z

Jammy:

= Overview =

Handler service for pickup location tables, works similar to rateTable, the same values can be used to calculate value for price ladder, each pickupTable instance has a list of locationIds which is where the order can be picked up from.

This allows a seller with multiple branches to charge delivery fee depending on which branch the order gets picked up from.

When doing deepPath search for matching locationIds use the buyer supplied locationIds to find all children locationIds to find matching pickupLocation tables.

= Repository =

https://bitbucket.org/izara-market-services/izara-market-products-delivery-method-pickup-table

= Schemas =
== Object Schemas ==
=== deliveryMethodPickupTable ===

<syntaxhighlight lang="JavaScript">
{
"objectType": "deliveryMethodPickupTable",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"pickupTableId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"minLength": 1
}
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "pickupTableId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

; Additional Information: [[Per Service Schemas]]

== Object Relationships ==

=== atLocation ===

<syntaxhighlight lang="JavaScript">
{
"atLocation": {
canChangeToRelTypes: [
{
serviceTag:"deliveryMethodPickupTable",
relationshipTag: "disabledAtLocation"
},
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "deliveryMethodPickupTable",
objectType: "deliveryMethodPickupTable"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "locations",
objectType: "location"
},
linkType: "many",
handler: true
}
},
]
}
}
</syntaxhighlight>
=== disabledAtLocation ===
<syntaxhighlight lang="JavaScript">
{
"disabledAtLocation": {
canChangeToRelTypes: [
{
serviceTag:"deliveryMethodPickupTable",
relationshipTag: "atLocation"
},
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "deliveryMethodPickupTable",
objectType: "deliveryMethodPickupTable"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "locations",
objectType: "location"
},
linkType: "many",
handler: true
}
},
]
}
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Delivery Method Pickup Table|Delivery Method Pickup Table]]

[[Category:Backend services| Delivery Method Pickup Table]]

Service - Delivery Method Pickup

2026-01-06T09:42:49Z

Jammy:

= Overview =

Handler service for basic pickup that use [[Service - Delivery Method Pickup Table]] for pricing and specifying pickup locations.

= Repository =

https://bitbucket.org/izara-market-services/izara-market-products-delivery-method-pickup

= Schemas =

== ObjectSchemas ==

=== deliveryMethodPickup ===

<syntaxhighlight lang="JavaScript">
{
"objectType": "deliveryMethodPickup",
"extendObjType": {
"serviceTag": "DeliveryMethodMgr",
"objectType": "deliveryMethod"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "DeliveryMethodRecord",
"serviceTag": "DeliveryMethodMgr"
}
},
"addOnDataStructure": [
{
"type": "versionedData",
"versionedDataLabel": "deliveryMethodSettings",
"storageResourceTag": "graph",
"fieldNames": {
"defaultValueType": {
"type": "string",
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": true,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"defaultValueId": {
"type": "string",
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": true,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"defaultValueLanguageId": {
"type": "string",
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": true,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
}
},
"defaultAccumulateValue": {
"type": "boolean",
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": true,
"validation": {

}
}
}
},
{
"type": "propertyValue"
}
],
"fieldNames": {

},
"generatedBy": "userGenerated"
}
</syntaxhighlight>
; Additional Information: [[Per Service Schemas]]
* extends deliveryMethod
* has versionData similar to deliveryMethodStandard to add costs and set value for pickupTables

== Object Relationships ==
=== hasDeliveryMethodPickupTable ===
<syntaxhighlight lang="JavaScript">
{
"hasDeliveryMethodPickupTable": {
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "deliveryMethodPickup",
objectType: "deliveryMethodPickup"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "deliveryMethodPickupTable",
objectType: "deliveryMethodPickupTable"
},
linkType: "many",
handler: true
}
},
]
}
}
</syntaxhighlight>

=== disabledDeliveryMethodPickupTable ===
<syntaxhighlight lang="JavaScript">
{
"disabledDeliveryMethodPickupTable": {
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "deliveryMethodPickup",
objectType: "deliveryMethodPickup"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "deliveryMethodPickupTable",
objectType: "deliveryMethodPickupTable"
},
linkType: "many",
handler: true
}
},
]
}
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Delivery Method Pickup|Delivery Method Pickup]]

[[Category:Backend services| Delivery Method Pickup]]

Service - Delivery Method Pickup Table

2026-01-06T09:24:23Z

Jammy:

= Overview =

Handler service for pickup location tables, works similar to rateTable, the same values can be used to calculate value for price ladder, each pickupTable instance has a list of locationIds which is where the order can be picked up from.

This allows a seller with multiple branches to charge delivery fee depending on which branch the order gets picked up from.

When doing deepPath search for matching locationIds use the buyer supplied locationIds to find all children locationIds to find matching pickupLocation tables.

= Repository =

https://bitbucket.org/izara-market-services/izara-market-products-delivery-method-pickup-table

= Object Schemas =

=== deliveryMethodPickupTable ===

<syntaxhighlight lang="JavaScript">
{
"objectType": "deliveryMethodPickupTable",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"pickupTableId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"minLength": 1
}
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "pickupTableId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

; Additional Information: [[Per Service Schemas]]

== Object Relationships ==

=== atLocation ===

<syntaxhighlight lang="JavaScript">
{
"atLocation": {
canChangeToRelTypes: [
{
serviceTag:"deliveryMethodPickupTable",
relationshipTag: "disabledAtLocation"
},
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "deliveryMethodPickupTable",
objectType: "deliveryMethodPickupTable"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "locations",
objectType: "location"
},
linkType: "many",
handler: true
}
},
]
}
}
</syntaxhighlight>
=== disabledAtLocation ===
<syntaxhighlight lang="JavaScript">
{
"disabledAtLocation": {
canChangeToRelTypes: [
{
serviceTag:"deliveryMethodPickupTable",
relationshipTag: "atLocation"
},
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "deliveryMethodPickupTable",
objectType: "deliveryMethodPickupTable"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "locations",
objectType: "location"
},
linkType: "many",
handler: true
}
},
]
}
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Delivery Method Pickup Table|Delivery Method Pickup Table]]

[[Category:Backend services| Delivery Method Pickup Table]]

Service - Delivery Method Pickup Table

2026-01-06T09:08:23Z

Jammy:

= Overview =

Handler service for pickup location tables, works similar to rateTable, the same values can be used to calculate value for price ladder, each pickupTable instance has a list of locationIds which is where the order can be picked up from.

This allows a seller with multiple branches to charge delivery fee depending on which branch the order gets picked up from.

When doing deepPath search for matching locationIds use the buyer supplied locationIds to find all children locationIds to find matching pickupLocation tables.

= Repository =

https://bitbucket.org/izara-market-services/izara-market-products-delivery-method-pickup-table

= Object Schemas =

; Additional Information: [[Per Service Schemas]]

== objType ==

=== deliveryMethodPickupTable ===

* has ladder of prices same as rateTable

== Object Relationships ==

=== atLocation ===

<syntaxhighlight lang="JavaScript">
{
"atLocation": {
canChangeToRelTypes: [
{
serviceTag:"deliveryMethodPickupTable",
relationshipTag: "disabledAtLocation"
},
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "deliveryMethodPickupTable",
objectType: "deliveryMethodPickupTable"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "locations",
objectType: "location"
},
linkType: "many",
handler: true
}
},
]
}
}
</syntaxhighlight>
=== disabledAtLocation ===
<syntaxhighlight lang="JavaScript">
{
"disabledAtLocation": {
canChangeToRelTypes: [
{
serviceTag:"deliveryMethodPickupTable",
relationshipTag: "atLocation"
},
],
storageResources: {
myGraph: {
storageType: "graph",
graphServerTag: "graphHandler"
}
},
links: [
{
storageResourceTags: ["myGraph"],
from: {
objType: {
serviceTag: "deliveryMethodPickupTable",
objectType: "deliveryMethodPickupTable"
},
linkType: "many",
},
to: {
objType: {
serviceTag: "locations",
objectType: "location"
},
linkType: "many",
handler: true
}
},
]
}
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Delivery Method Pickup Table|Delivery Method Pickup Table]]

[[Category:Backend services| Delivery Method Pickup Table]]

Service - Variant Standard

2026-01-06T09:05:21Z

Jammy:

Service - Variant Manager

2026-01-06T08:39:15Z

Jammy:

= Overview =

Each product is handled by a [[Service - Variant (handlers)]] service.

The Variant Manager service handles shared orchestration of Variant Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-variant-manager/src/master/

= Schemas =
==ObjectSchemas==
=== variant ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variant",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"addOnDataStructure": [],
"storageResources": {
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "VariantRecord",
"serviceTag": "VariantManager"
},
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
},
"variantHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "variantId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== variantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLabel",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLabelId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLink",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLinkId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLinkId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeValue",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeValueId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isVariantAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isVariantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLabel",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

== TranslateIdsCache ==

Stores a record for any unique translateId process

<syntaxhighlight lang="JavaScript">
{
cacheId // fromType + "_" + fromDataId + "_" + toType
toDataId
expireTime
}
</syntaxhighlight>

* partition key: cacheId
* sort key: toDataId
* expireTime is set as an automatic DynamoDB TTL attibute

= Working documents =

[[:Category:Working_documents - Variant Manager|Variant Manager]]

[[Category:Backend services| Variant Manager]]

Service - Payment Method Generic

2026-01-06T08:31:25Z

Jammy:

= Overview =

Handler service for generic payment methods that give text instruction to buyer at completion of sale. userPaymentMethod is also handled by each Payment Method Handler because there will be unique settings depending on the Payment Method.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-payment-method-generic/src/master/
= Schemas =
==ObjectSchemas==
===paymentMethodGeneric===
*ExtendObjType:paymentMethod
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethodGeneric",
"extendObjType": {
"serviceTag": "PaymentMethodManager",
"objectType": "paymentMethod"
},
"addOnDataStructure": [
{
"type": "propertyValue"
}
],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "PaymentMethodRecords",
"serviceTag": "PaymentMethodManager"
}
},
"fieldNames": {},
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== userPaymentMethodGeneric ===
*ExtendObjType:userPaymentMethod
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGeneric",
"extendObjType": {
"serviceTag": "PaymentMethodManager",
"objectType": "userPaymentMethod"
},
"addOnDataStructure": [
{
"type": "propertyValue"
}
],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "UserPaymentMethodsRecords",
"serviceTag": "PaymentMethodManager"
}
},
"fieldNames": {},
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericSalePropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericSalePropertyValue",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericSalePropertyValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericSalePropertyValueId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericSalePropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericSalePropertyLabel",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericSalePropertyLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericSalePropertyLabelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
'''property'''
=== paymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethodGenericPropertyLabel",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"paymentMethodGenericPropertyLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "paymentMethodGenericPropertyLabelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== paymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethodGenericPropertyValue",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"paymentMethodGenericPropertyValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "paymentMethodGenericPropertyValueId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericPropertyLabel",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericPropertyLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericPropertyLabelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericPropertyValue",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericPropertyValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericPropertyValueId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

==RelationshipSchemas==

=== disabledPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "paymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "paymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": true
"canChangeToRelTypes": [
{
serviceTag:"PaymentMethodGeneric",
relationshipTag: "hasPaymentMethodGenericPropertyValue"
},
]
}
</syntaxhighlight>

=== disabledUserPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],

"canMove": true
}
</syntaxhighlight>

=== disabledUserPaymentMethodGenericSalePropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "hasUserPaymentMethodGenericSalePropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== hasPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "paymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "paymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "disabledPaymentMethodGenericPropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== hasUserPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "disabledUserPaymentMethodGenericPropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== hasUserPaymentMethodGenericSalePropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "disabledUserPaymentMethodGenericSalePropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== isPaymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "paymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "paymentMethodGenericPropertyLabel",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>
=== isUserPaymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyLabel",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>
=== isUserPaymentMethodGenericSalePropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyLabel",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

== Basic node schemas ==

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{PaymentMethodGenericLib.PAYMENTMETHOD_GRAPH_NODE_LABEL}", // "paymentMethod"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
paymentMethodId: {
identifier: true,
},
paymentMethodHandlerServiceNameTag: {
immutable: true,
},
},
}
}
</syntaxhighlight>
* [[Service - Translations Graph]]
* [[Service - Orders Graph]]

=== Schema comes from [[NPM module - Izara Core - Property Node|BasicNodeSchemaLib]] ===

# paymentMethodPropertyLabel
#* [[Service - Translations Graph]]
# paymentMethodProperty
#* [[Service - Translations Graph]]
# paymentMethodSalePropertyLabel
#* [[Service - Translations Graph]]
# paymentMethodSaleProperty
#* [[Service - Translations Graph]]

= Complex Filter requests =

<syntaxhighlight lang="JavaScript">
{
filterType: "handlerPaymentMethod" //unique id is paymentMethodId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "currencyId",
comparison: "equals",
value: "xx"
},
{
type: "complexFilter",
complexFilter: {
filterType: "paymentMethodProperty",
// see [[NPM module - Izara Core - Property Node|Complex Filter requests]]
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "paymentMethodNameTranslation" //unique id is paymentMethodId
type: "group",
elements:
[
{
// see [[Service - Translations|Complex Filter requests]]
type: "logical",
logicalTag: "textTag_languageId_text",
resultType: "paymentMethod",
textTag: "paymentMethodName",
languageId: "en",
text: "Is a great term",
subjectIdentifierPropertyName: "paymentMethodId",
caseSensitive: true
},
]
}
},
...
]
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
filterType: "handlerUserPaymentMethod" //unique id is userPaymentMethodId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "paymentMethodId",
comparison: "equals",
value: "xx"
},
{
type: "complexFilter",
complexFilter: {
filterType: "paymentMethod",
// see above
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "userPaymentMethodProperty",
// see [[NPM module - Izara Core - Property Node|Complex Filter requests]]
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "userPaymentMethodSaleProperty",
// see [[NPM module - Izara Core - Property Node|Complex Filter requests]]
}
},
...
]
}
</syntaxhighlight>

= Data structure notes =

* Users can create new paymentMethods which are uniquely identified by their translation
* Users can create userPaymentMethod nodes for their account which connect to paymentMethods, one user can have multiple userPaymentMethod links to the same paymentMethod, eg different Bank Transfer nodes for different bank accounts, which can be applied to sell offers in any combination

= Working documents =

[[:Category:Working_documents - Payment Method Generic|Payment Method Generic]]

[[Category:Backend services| Payment Method Generic]]

Service - Payment Method Manager

2026-01-06T08:16:47Z

Jammy:

= Overview =

Each payment method is handled by a [[Service - Payment Method (handlers)]] service, with [[Service - Payment Method Generic]] taking all new/simple payment methods.

The Payment Method Manager service handles shared orchestration of the Payment Method Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-payment-method-manager/src/master/

= Schemas =
==ObjectSchemas==
===paymentMethod===
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethod",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "PaymentMethodRecords",
"serviceTag": "PaymentMethodManager"
}
},
"fieldNames": {
"paymentMethodId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"storageResourceTags": ["dynamoDB","graph"],
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"}
},
"paymentMethodHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": false,
"storageResourceTags": ["dynamoDB"],
"validation": { "pattern": "^[a-zA-Z0-9-_]+$"}}
},
"currencyId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"storageResourceTags": ["dynamoDB"],
"validation": { "pattern": "^[a-zA-Z0-9-_]+$"}}
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "paymentMethodId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript" inline>currencyId</syntaxhighlight>:is uuid and connect translations declere currency eg:"THB" ect.

=== userPaymentMethod ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethod",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "UserPaymentMethodsRecords",
"serviceTag": "PaymentMethodManager"
}
},
"fieldNames": {
"userPaymentMethodId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"storageResourceTags": [
"dynamoDB",
"graph"
],
"validation": {"pattern": "^[a-zA-Z0-9-_]+$"}
},
"paymentMethodHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": true,
"storageResourceTags": [
"dynamoDB"
],
"validation": {"pattern": "^[a-zA-Z0-9-_]+$"}
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isPaymentMethod ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "PaymentMethodManager",
"objectType": "userPaymentMethod"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"to": {
"objType": {
"serviceTag": "PaymentMethodManager",
"objectType": "paymentMethod"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Payment Method Manager|Payment Method Manager]]

[[Category:Backend services| Payment Method Manager]]

Service - Locations

2026-01-06T07:52:36Z

Jammy:

Service - Product Attributes

2026-01-06T07:39:56Z

Jammy:

= Overview =

Manages Product Attributes and ProductAttributeLinks. Product Attributes can be shared by many Products, ProductAttributeLinks are used to create an attribute tree for one Product.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-product-attributes/src/master/

= Schemas =
==ObjectSchemas==
=== productAttribute ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttribute",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"productAttributeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productAttributeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttributeLink",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"productAttributeLinkId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productAttributeLinkId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttributeLabel",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"labelId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "labelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isProductAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttribute"
},
"requiredOnCreate": false,
"linkType": "one",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isProductAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttribute"
},
"linkType": "many",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLabel"
},
"requiredOnCreate": false,
"linkType": "one",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasProductAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

},
"requiredOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
},
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "ProductAttribute",
"relationshipTag": "disabledProductAttributeLink"
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledProductAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": true,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": false,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "ProductAttribute",
"relationshipTag": "hasProductAttributeLink"
}
],
"canMove": false
}
</syntaxhighlight>

== Basic node schemas ==

Schema comes from [[NPM module - Izara Core - Attribute Tree|BasicNodeSchemaLib]]

# {ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Label
#* [[Service - Translations Graph]]
# {ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}
#* [[Service - Media Graph]]
#* [[Service - Translations Graph]]
# {ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}PropertyLabel
#* [[Service - Translations Graph]]
# {ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Property
#* [[Service - Translations Graph]]

= Working documents =

[[:Category:Working_documents - Product Attributes|Product Attributes]]

[[Category:Backend services| Product Attributes]]

Service - Product Manager

2026-01-06T07:32:40Z

Jammy:

= Overview =

Each product is handled by a [[Service - Product (handlers)]] service.

The Product Manager service handles shared orchestration of the Product Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-product-manager/src/master/

= Schemas =
==ObjectSchemas==
=== product ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "product",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"addOnDataStructure": [],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"productId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productRecord ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productRecord",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"storageResources": {
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "ProductStandard",
"serviceTag": "ProductManager"
},
"myGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "propertyValue"
}
],
"fieldNames": {
"productId": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB"
]
},
"productHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "partitionKey",
"fieldName": "productId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isProduct ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductManager",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "VariantStandard",
"objectType": "variantProductLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": true
},
"to": {
"objType": {
"serviceTag": "ProductStandard",
"objectType": "productStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Product Manager|Product Manager]]

[[Category:Backend services| Product Manager]]

Service - Product Standard

2026-01-06T07:15:44Z

Jammy:

Service - Product Attributes

2025-12-23T08:01:01Z

Jammy:

= Overview =

Manages Product Attributes and ProductAttributeLinks. Product Attributes can be shared by many Products, ProductAttributeLinks are used to create an attribute tree for one Product.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-product-attributes/src/master/

= Schemas =
==ObjectSchemas==
=== productAttribute ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttribute",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"productAttributeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productAttributeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttributeLink",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"productAttributeLinkId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productAttributeLinkId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productAttributeLabel",
"canDelete": true,
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"labelId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"mainGraph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "labelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isProductAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttribute"
},
"requiredOnCreate": false,
"linkType": "one",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isProductAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttribute"
},
"linkType": "many",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLabel"
},
"requiredOnCreate": false,
"linkType": "one",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasProductAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

},
"requiredOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
},
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "ProductAttribute",
"relationshipTag": "disabledProductAttributeLink"
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledProductAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductAttribute",
"fieldNames": {
"originTimestamp": {
"type": "number",
"requiredOnCreate": true,
"optionalOnCreate": true,
"canUpdate": true,
"validation": {

}
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"mainGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"mainGraph"
],
"from": {
"objType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"linkType": "one",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"serviceTag": "ProductAttribute",
"objectType": "productAttributeLink"
},
"requiredOnCreate": false,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "ProductAttribute",
"relationshipTag": "hasProductAttributeLink"
}
],
"canMove": false
}
</syntaxhighlight>

= DynamoDB tables =

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

=== Configuration tags ===

..

== LogicalResults ==

Stores results for any requests to perform logical searches on media links

<syntaxhighlight lang="JavaScript">
{
resultId: xxx // eg: filterMainId for a single logical element
dataId: xxx // one productAttributeLinkId
}
</syntaxhighlight>

* partition key: resultId
* sort key: dataId

= Graph database =

== [[Service - Products Graph]]==

=== Nodes ===

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Label",
}
{
nodeLabel: "{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}",
}
{
nodeLabel: "{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Link",
}
{
nodeLabel: "{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}PropertyLabel",
}
{
nodeLabel: "{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Property",
}
</syntaxhighlight>
* see [[NPM module - Izara Core - Attribute Tree|DataSchemaLib]]

=== Relationships ===

<syntaxhighlight lang="JavaScript">
{
relationshipType: "has_{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Link",
}
{
relationshipType: "disabled_{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Link",
}
{
relationshipType: "is_{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}",
}
{
relationshipType: "is_{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Label",
}
{
relationshipType: "has_{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Property",
}
{
relationshipType: "disabled_{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Property",
}
{
relationshipType: "is_{ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}PropertyLabel",
}
</syntaxhighlight>
* see [[NPM module - Izara Core - Attribute Tree|DataSchemaLib]]

== Basic node schemas ==

Schema comes from [[NPM module - Izara Core - Attribute Tree|BasicNodeSchemaLib]]

# {ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Label
#* [[Service - Translations Graph]]
# {ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}
#* [[Service - Media Graph]]
#* [[Service - Translations Graph]]
# {ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}PropertyLabel
#* [[Service - Translations Graph]]
# {ProductAttributesLib.PRODUCT_ATTRIBUTE_GRAPH_NODE_LABEL}Property
#* [[Service - Translations Graph]]

= Working documents =

[[:Category:Working_documents - Product Attributes|Product Attributes]]

[[Category:Backend services| Product Attributes]]

Service - Variant Standard

2025-12-23T07:36:09Z

Jammy:

= Overview =

Handler service for the standard variant type.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-variant-standard/src/master/

= Schemas =
==ObjectSchemas==
=== variantStandard ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantStandard",
"extendObjType": {
"serviceTag": "VariantManager",
"objectType": "variant"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "VariantRecord",
"serviceTag": "VariantManager"
}
},
"fieldNames": {
"variantId": {
"storageResourceTags": [
"graph",
"dynamoDB"
]
}
},
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== variantProductLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantProductLink",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"addOnDataStructure": [],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantProductLinkId": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
],
"hashOnCreate": [
"variantId",
"productId"
]
},
"variantId": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
},
"productId": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": true,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "variantProductLinkId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== variantAttributeValueStandard ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeValueStandard",
"addOnDataStructure": [],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {

},
"extendObjType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== hasVariantProductLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantStandard",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "VariantStandard",
"objectType": "variantProductLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": true
},
"to": {
"objType": {
"serviceTag": "VariantStandard",
"objectType": "variantStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledVariantProductLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantStandard",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "VariantStandard",
"objectType": "variantProductLink"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "VariantStandard",
"objectType": "variantStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= DynamoDB tables =

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

=== Configuration tags ===

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

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

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

== LogicalResults ==

Stores results for any requests to perform logical searches on variant data

<syntaxhighlight lang="JavaScript">
{
resultId: xxx // eg: filterMainId for a single logical element
dataId: xxx // one variantId
}
</syntaxhighlight>

* partition key: resultId
* sort key: dataId

= Graph database =

== [[Service - Products Graph]]==

=== Nodes ===

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{VariantStandardLib.VARIANT_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
variantId: {
identifier: true, //(random uuid)
},
variantHandlerServiceNameTag: {
immutable: true,
},
},
}
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{VariantStandardLib.VARIANT_PRODUCT_LINK_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
variantId: {
identifier: true,
},
variantHandlerServiceNameTag: {
immutable: true,
},
productId: {
identifier: true,
},
productHandlerServiceNameTag: {
immutable: true,
},
},
}
}
</syntaxhighlight>
* adds a node between each variant to product relationship, we do this so we can add variantProductLink specific relationships, eg to media that only relates to this link, not to other parent variants the product has

=== Relationships ===

<syntaxhighlight lang="JavaScript">
{
relationshipType: "{VariantStandardLib.createHasVariantProductLinkGraphRelationshipType()}", // "has_variantProductLink"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{VariantStandardLib.createDisabledVariantProductLinkGraphRelationshipType()}", //"disabled_variantProductLink"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
* links variant to a variantProductLink, or a variantProductLink to a product

= Working documents =

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

[[Category:Backend services| Variant Standard]]

Service - Variant Manager

2025-12-23T07:22:48Z

Jammy:

= Overview =

Each product is handled by a [[Service - Variant (handlers)]] service.

The Variant Manager service handles shared orchestration of Variant Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-variant-manager/src/master/

= Schemas =
==ObjectSchemas==
=== variant ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variant",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"addOnDataStructure": [],
"storageResources": {
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "VariantRecord",
"serviceTag": "VariantManager"
},
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
},
"variantHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB",
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "variantId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== variantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLabel",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLabelId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeLink",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeLinkId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeLinkId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== variantAttributeValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "variantAttributeValue",
"addOnDataStructure": [],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"variantAttributeValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "variantAttributeValueId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isVariantAttribute ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isVariantAttributeLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variantAttributeValue",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLabel",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== hasVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledVariantAttributeLink ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "VariantManager",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "variant",
"serviceTag": "VariantManager"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "variantAttributeLink",
"serviceTag": "VariantManager"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= DynamoDB tables =

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

=== Configuration tags ===

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

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

<syntaxhighlight lang="JavaScript">
{
configKey: "TranslateIdsType"
configTag: xxx // eg SellOffer > Product would be sellOffer_product
configValue: {
ttl: 64000 // number of seconds TranslateIdsCache records live for
}
}
</syntaxhighlight>

== VariantRecord ==

Records which Handler manages each variant

<syntaxhighlight lang="JavaScript">
{
variantId
variantHandlerServiceNameTag
}
</syntaxhighlight>

* partition key: variantId
* sort key: (none)

== TranslateIdsCache ==

Stores a record for any unique translateId process

<syntaxhighlight lang="JavaScript">
{
cacheId // fromType + "_" + fromDataId + "_" + toType
toDataId
expireTime
}
</syntaxhighlight>

* partition key: cacheId
* sort key: toDataId
* expireTime is set as an automatic DynamoDB TTL attibute

= Working documents =

[[:Category:Working_documents - Variant Manager|Variant Manager]]

[[Category:Backend services| Variant Manager]]

Service - Product Standard

2025-12-23T07:06:12Z

Jammy:

= Overview =

Handler service for the standard product type.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-product-standard/src/master/

= Schemas =
==ObjectSchemas==
=== productStandard ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productStandard",
"extendObjType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [],
"fieldNames": {
"productId": {
"storageResourceTags": [
"graph"
]
}
},
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isProduct ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductStandard",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "VariantStandard",
"objectType": "variantProductLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": true
},
"to": {
"objType": {
"serviceTag": "ProductStandard",
"objectType": "productStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= DynamoDB tables =

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

=== Configuration tags ===

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

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

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

== LogicalResults ==

Stores results for any requests to perform logical searches on product data

<syntaxhighlight lang="JavaScript">
{
resultId: xxx // eg: filterMainId for a single logical element
dataId: xxx // one productId
}
</syntaxhighlight>

* partition key: resultId
* sort key: dataId

= Graph database =

== [[Service - Products Graph]]==

=== Nodes ===

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{ProductStandardLib.PRODUCT_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
productId: {
identifier: true, //(random uuid)
},
productHandlerServiceNameTag: {
immutable: true,
},
},
}
}
</syntaxhighlight>

== Basic node schemas ==

=== product ===

[[Service - Media Graph]]

= Working documents =

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

[[Category:Backend services| Product Standard]]

Service - Product Standard

2025-12-23T07:03:37Z

Jammy:

= Overview =

Handler service for the standard product type.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-product-standard/src/master/

= Schemas =
==ObjectSchemas==
=== productStandard ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productStandard",
"extendObjType": {
"serviceTag": "ProductManager",
"objectType": "product"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [],
"fieldNames": {
"productId": {
"storageResourceTags": [
"graph"
]
}
},
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productRecord ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productRecord",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"storageResources": {
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "ProductStandard",
"serviceTag": "ProductManager"
},
"myGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "propertyValue"
}
],
"fieldNames": {
"productId": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB"
]
},
"productHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "partitionKey",
"fieldName": "productId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isProduct ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductManager",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "VariantStandard",
"objectType": "variantProductLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": true
},
"to": {
"objType": {
"serviceTag": "ProductStandard",
"objectType": "productStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= DynamoDB tables =

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

=== Configuration tags ===

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

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

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

== LogicalResults ==

Stores results for any requests to perform logical searches on product data

<syntaxhighlight lang="JavaScript">
{
resultId: xxx // eg: filterMainId for a single logical element
dataId: xxx // one productId
}
</syntaxhighlight>

* partition key: resultId
* sort key: dataId

= Graph database =

== [[Service - Products Graph]]==

=== Nodes ===

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{ProductStandardLib.PRODUCT_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
productId: {
identifier: true, //(random uuid)
},
productHandlerServiceNameTag: {
immutable: true,
},
},
}
}
</syntaxhighlight>

== Basic node schemas ==

=== product ===

[[Service - Media Graph]]

= Working documents =

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

[[Category:Backend services| Product Standard]]

Service - Product Manager

2025-12-23T06:46:32Z

Jammy:

= Overview =

Each product is handled by a [[Service - Product (handlers)]] service.

The Product Manager service handles shared orchestration of the Product Handler services.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-product-manager/src/master/

= Schemas =
==ObjectSchemas==
=== product ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "product",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"addOnDataStructure": [],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"productId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "productId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== productRecord ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "productRecord",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"storageResources": {
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "ProductStandard",
"serviceTag": "ProductManager"
},
"myGraph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "propertyValue"
}
],
"fieldNames": {
"productId": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB"
]
},
"productHandlerServiceNameTag": {
"type": "string",
"randomOnCreate": false,
"requiredOnCreate": false,
"optionalOnCreate": true,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"dynamoDB"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "partitionKey",
"fieldName": "productId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

== RelationshipSchemas ==

=== isProduct ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "ProductManager",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "VariantStandard",
"objectType": "variantProductLink"
},
"linkType": "one",
"requiredOnCreate": true,
"handler": true
},
"to": {
"objType": {
"serviceTag": "ProductStandard",
"objectType": "productStandard"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= DynamoDB tables =

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

=== Configuration tags ===

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

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

== ProductRecord ==

Records which Handler manages each product

<syntaxhighlight lang="JavaScript">
{
productId
productHandlerServiceNameTag
}
</syntaxhighlight>

* partition key: productId
* sort key: (none)

= Working documents =

[[:Category:Working_documents - Product Manager|Product Manager]]

[[Category:Backend services| Product Manager]]

Service - Delivery Method Rate Table

2025-12-19T10:27:56Z

Jammy:

= Overview =

Manages delivery rate tables for delivery methods (possible other objects). Rate tables combine set rates at a certain value with increment settings to easily maintain rate table calculations.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-delivery-method-rate-table

= Schemas =

==ObjectSchemas==
=== rates ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "rates",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"ratesId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"minLength": 1
}
},
"storageResourceTags": [
"graph"
]
},
"upToValue": {
"type": "number",
"randomOnCreate": false,
"optionalOnCreate": false,
"requiredOnCreate": true,
"canUpdate": false,
"validation": {

},
"storageResourceTags": [
"graph"
]
},
"rate": {
"type": "number",
"randomOnCreate": false,
"optionalOnCreate": true,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {

},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "ratesId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

=== rateTable ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "rateTable",
"canDelete": false,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"rateTableId": {
"type": "string",
"randomOnCreate": true,
"optionalOnCreate": false,
"requiredOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"minLength": 1
}
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "rateTableId"
}
],
"generatedBy": "userGenerated",
"compositeKeyDeliminator": "_"
}
</syntaxhighlight>

==RelationshipSchemas==

=== hasRates ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DeliveryMethodRAT",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rates"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disableRates ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DeliveryMethodRAT",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rates"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== deliversToLocationNode ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DeliveryMethodRAT",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationNode"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== disabledDeliversTolocationNode ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "DeliveryMethodRAT",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "DeliveryMethodRAT",
"objectType": "rateTable"
},
"linkType": "many",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationNode"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

= DynamoDB tables =

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

=== Configuration tags ===

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

== LogicalResultsMain ==
[[Standard LogicalResults Per Service|LogicalResultsMain]]

== LogicalResultsData ==
[[Standard LogicalResults Per Service|LogicalResultsData]]

== LogicalAwaitingStep ==
[[Standard LogicalResults Per Service|LogicalAwaitingStep]]

= Graph database =

== [[Service - Products Graph]]==

=== Nodes ===

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{DeliveryMethodRateTableLib.RATETABLE_GRAPH_NODE_LABEL}", // "rateTable"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
rateTableId: {
identifier: true, // create unique id from request params and uniqueMessageId
},
},
}
}
</syntaxhighlight>

=== Versioned data ===

==== rateTableRates ====

<syntaxhighlight lang="JavaScript">
{
properties: {
rates: [
{
type: "setRate",
upToValue: xx, // numeric value that this setRate goes up to
rate: xx, // numeric rate
},
{
type: "increment",
upToValue: xx, // numeric value that this setRate goes up to
ratePerIncrement: xx, // numeric amount that rate increases per increment
increment: xx, // numeric incremental amount
},
// ..
],
},
}
</syntaxhighlight>

=== Relationships ===

<syntaxhighlight lang="JavaScript">
{
relationshipType: "{DeliveryMethodStandardLib.createHasDeliveryMethodRateTableGraphRelationshipType()}", // "deliversTo_locationNode"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{DeliveryMethodStandardLib.createDisabledDeliveryMethodRateTableGraphRelationshipType()}", // "disabledDeliversTo_locationNode"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>

* enable/disable links to locationNodes
* after a locationNode relationship is added to a RateTable it always remains as either one of the above relationships, in order to maintain history of changes

<syntaxhighlight lang="JavaScript">
{
relationshipType: "adjustDeliversTo_performedBy"
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
locationNodeId:
action: // "added"|"enabled"|"disabled"
},
}
}
</syntaxhighlight>

* adds a relationship record between rateTable node and user whenever delivers to relationship added or removed

= Data structure notes =

* multiple deliveryMethods could point to a single rateTable

= Complex Filter requests =

<syntaxhighlight lang="JavaScript">
{
filterType: "deliveryMethodRateTable" //unique id is rateTableId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "deliverToLocationId",
comparison: "equals",
value: "xx"
},
{
// finds all rateTables that has at >=1 has_deliveryMethodRateTable incomming relationship from give sellOfferPlanDeliveryMethodLinkId
type: "logical",
logicalTag: "activeSellOfferPlanDeliveryMethodLinkId",
comparison: "equals",
value: "xx"
},
{
// finds all rateTables that has at >=1 has_deliveryMethodRateTable incomming relationship
type: "logical",
logicalTag: "isEnabled",
comparison: "true",
},
...
]
}
</syntaxhighlight>

= Working documents =

[[:Category:Working_documents - Delivery Method Rate Table|Delivery Method Rate Table]]

[[Category:Backend services| Delivery Method Rate Table]]

Service - Payment Method Generic

2025-12-19T09:27:43Z

Jammy:

= Overview =

Handler service for generic payment methods that give text instruction to buyer at completion of sale. userPaymentMethod is also handled by each Payment Method Handler because there will be unique settings depending on the Payment Method.

= Repository =

https://bitbucket.org/izara-market-products/izara-market-products-payment-method-generic/src/master/
= Schemas =
==ObjectSchemas==
===paymentMethodGeneric===
*ExtendObjType:paymentMethod
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethodGeneric",
"extendObjType": {
"serviceTag": "PaymentMethodManager",
"objectType": "paymentMethod"
},
"addOnDataStructure": [
{
"type": "propertyValue"
}
],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "PaymentMethodRecords",
"serviceTag": "PaymentMethodManager"
}
},
"fieldNames": {},
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== userPaymentMethodGeneric ===
*ExtendObjType:userPaymentMethod
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGeneric",
"extendObjType": {
"serviceTag": "PaymentMethodManager",
"objectType": "userPaymentMethod"
},
"addOnDataStructure": [
{
"type": "propertyValue"
}
],
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
},
"dynamoDB": {
"storageType": "dynamoDB",
"tableName": "UserPaymentMethodsRecords",
"serviceTag": "PaymentMethodManager"
}
},
"fieldNames": {},
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericSalePropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericSalePropertyValue",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericSalePropertyValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericSalePropertyValueId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericSalePropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericSalePropertyLabel",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericSalePropertyLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericSalePropertyLabelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
'''property'''
=== paymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethodGenericPropertyLabel",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"paymentMethodGenericPropertyLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "paymentMethodGenericPropertyLabelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== paymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "paymentMethodGenericPropertyValue",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"paymentMethodGenericPropertyValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "paymentMethodGenericPropertyValueId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericPropertyLabel",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericPropertyLabelId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericPropertyLabelId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
=== userPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "userPaymentMethodGenericPropertyValue",
"addOnDataStructure": [
{
"type": "translation"
}
],
"canDelete": true,
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"fieldNames": {
"userPaymentMethodGenericPropertyValueId": {
"type": "string",
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"randomOnCreate": true,
"validation": {
"pattern": "^[a-zA-Z0-9-_]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"identifiers": [
{
"type": "identifier",
"fieldName": "userPaymentMethodGenericPropertyValueId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

==RelationshipSchemas==

=== disabledPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "paymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "paymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": true
"canChangeToRelTypes": [
{
serviceTag:"PaymentMethodGeneric",
relationshipTag: "hasPaymentMethodGenericPropertyValue"
},
]
}
</syntaxhighlight>

=== disabledUserPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],

"canMove": true
}
</syntaxhighlight>

=== disabledUserPaymentMethodGenericSalePropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "hasUserPaymentMethodGenericSalePropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== hasPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "paymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "paymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "disabledPaymentMethodGenericPropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== hasUserPaymentMethodGenericPropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "disabledUserPaymentMethodGenericPropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== hasUserPaymentMethodGenericSalePropertyValue ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGeneric",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "from",
"requiredOnCreate": false,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "to",
"requiredOnCreate": true,
"handler": false
},
"canDelete": false
}
],
"canChangeToRelTypes": [
{
"serviceTag": "PaymentMethodGeneric",
"relationshipTag": "disabledUserPaymentMethodGenericSalePropertyValue"
}
],
"canMove": false
}
</syntaxhighlight>
=== isPaymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "paymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "paymentMethodGenericPropertyLabel",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>
=== isUserPaymentMethodGenericPropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericPropertyLabel",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>
=== isUserPaymentMethodGenericSalePropertyLabel ===
<syntaxhighlight lang="JavaScript">
{
"relationshipServiceTag": "PaymentMethodGeneric",
"fieldNames": {
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyValue",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "many",
"direction": "from",
"requiredOnCreate": true,
"handler": false
},
"to": {
"objType": {
"objectType": "userPaymentMethodGenericSalePropertyLabel",
"serviceTag": "PaymentMethodGeneric"
},
"linkType": "one",
"direction": "to",
"requiredOnCreate": false,
"handler": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>
= DynamoDB tables =

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

=== Configuration tags ===

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

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

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

= Graph database =

== [[Service - Products Graph]]==

=== Nodes ===

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "paymentMethodGeneric",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
paymentMethodId: {
identifier: true, // create unique id from translation
}
},
}
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{PaymentMethodManagerLib.USERPAYMENTMETHOD_GRAPH_NODE_LABEL}", // "userPaymentMethod"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
userPaymentMethodId: {
identifier: true, // create unique id from user and uniqueMessageId
},
paymentMethodId: { // stored here to reduce queries finding matching methods, eg sellOffers
immutable: true,
},
userPaymentMethodTag: { // users reference name for this userPaymentMethod
},
},
}
}
</syntaxhighlight>
* adds a node between a user and a payment method
* this is the node linked to by sellOfferPlans

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{PaymentMethodGenericLib.PAYMENTMETHOD_GRAPH_NODE_LABEL}PropertyLabel",
}
{
nodeLabel: "{PaymentMethodGenericLib.PAYMENTMETHOD_GRAPH_NODE_LABEL}Property",
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{PaymentMethodGenericLib.USERPAYMENTMETHOD_GRAPH_NODE_LABEL}PropertyLabel",
}
{
nodeLabel: "{PaymentMethodGenericLib.USERPAYMENTMETHOD_GRAPH_NODE_LABEL}Property",
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{PaymentMethodGenericLib.USERPAYMENTMETHOD_SALE_PROPERTIES_GRAPH_TAG}PropertyLabel", // userPaymentMethodSalePropertyLabel
}
{
nodeLabel: "{PaymentMethodGenericLib.USERPAYMENTMETHOD_SALE_PROPERTIES_GRAPH_TAG}Property",
}
</syntaxhighlight>
* see [[NPM module - Izara Core - Property Node|DataSchemaLib]]
* two sets of property nodes for userPaymentMethod, one for presentation properties (when browsing), paymentMethodSale for after sale, properties that get sent to the buyer, eg bank account number

=== Relationships ===

<syntaxhighlight lang="JavaScript">
{
relationshipType: "{PaymentMethodManagerLib.createIsPaymentMethodGraphRelationshipType()}", // "is_paymentMethod"
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{PaymentMethodManagerLib.createIsUserPaymentMethodGraphRelationshipType()}", // "is_userPaymentMethod"
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
</syntaxhighlight>
* not setup logic to disable userPaymentMethods at this time

<syntaxhighlight lang="JavaScript">
{
relationshipType: "has_{PaymentMethodGenericLib.PAYMENTMETHOD_GRAPH_NODE_LABEL}Property",
}
{
relationshipType: "disabled_{PaymentMethodGenericLib.PAYMENTMETHOD_GRAPH_NODE_LABEL}Property",
}
{
relationshipType: "is_{PaymentMethodGenericLib.PAYMENTMETHOD_GRAPH_NODE_LABEL}PropertyLabel",
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
relationshipType: "has_{PaymentMethodGenericLib.USERPAYMENTMETHOD_GRAPH_NODE_LABEL}Property",
}
{
relationshipType: "disabled_{PaymentMethodGenericLib.USERPAYMENTMETHOD_GRAPH_NODE_LABEL}Property",
}
{
relationshipType: "is_{PaymentMethodGenericLib.USERPAYMENTMETHOD_GRAPH_NODE_LABEL}PropertyLabel",
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "has_{PaymentMethodGenericLib.USERPAYMENTMETHOD_SALE_PROPERTIES_GRAPH_TAG}Property",
}
{
relationshipType: "disabled_{PaymentMethodGenericLib.USERPAYMENTMETHOD_SALE_PROPERTIES_GRAPH_TAG}Property",
}
{
relationshipType: "is_{PaymentMethodGenericLib.USERPAYMENTMETHOD_SALE_PROPERTIES_GRAPH_TAG}PropertyLabel",
}
</syntaxhighlight>
* see [[NPM module - Izara Core - Property Node|DataSchemaLib]]

== Basic node schemas ==

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{PaymentMethodGenericLib.PAYMENTMETHOD_GRAPH_NODE_LABEL}", // "paymentMethod"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
paymentMethodId: {
identifier: true,
},
paymentMethodHandlerServiceNameTag: {
immutable: true,
},
},
}
}
</syntaxhighlight>
* [[Service - Translations Graph]]
* [[Service - Orders Graph]]

=== Schema comes from [[NPM module - Izara Core - Property Node|BasicNodeSchemaLib]] ===

# paymentMethodPropertyLabel
#* [[Service - Translations Graph]]
# paymentMethodProperty
#* [[Service - Translations Graph]]
# paymentMethodSalePropertyLabel
#* [[Service - Translations Graph]]
# paymentMethodSaleProperty
#* [[Service - Translations Graph]]

= Complex Filter requests =

<syntaxhighlight lang="JavaScript">
{
filterType: "handlerPaymentMethod" //unique id is paymentMethodId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "currencyId",
comparison: "equals",
value: "xx"
},
{
type: "complexFilter",
complexFilter: {
filterType: "paymentMethodProperty",
// see [[NPM module - Izara Core - Property Node|Complex Filter requests]]
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "paymentMethodNameTranslation" //unique id is paymentMethodId
type: "group",
elements:
[
{
// see [[Service - Translations|Complex Filter requests]]
type: "logical",
logicalTag: "textTag_languageId_text",
resultType: "paymentMethod",
textTag: "paymentMethodName",
languageId: "en",
text: "Is a great term",
subjectIdentifierPropertyName: "paymentMethodId",
caseSensitive: true
},
]
}
},
...
]
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
filterType: "handlerUserPaymentMethod" //unique id is userPaymentMethodId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "paymentMethodId",
comparison: "equals",
value: "xx"
},
{
type: "complexFilter",
complexFilter: {
filterType: "paymentMethod",
// see above
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "userPaymentMethodProperty",
// see [[NPM module - Izara Core - Property Node|Complex Filter requests]]
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "userPaymentMethodSaleProperty",
// see [[NPM module - Izara Core - Property Node|Complex Filter requests]]
}
},
...
]
}
</syntaxhighlight>

= Data structure notes =

* Users can create new paymentMethods which are uniquely identified by their translation
* Users can create userPaymentMethod nodes for their account which connect to paymentMethods, one user can have multiple userPaymentMethod links to the same paymentMethod, eg different Bank Transfer nodes for different bank accounts, which can be applied to sell offers in any combination

= Working documents =

[[:Category:Working_documents - Payment Method Generic|Payment Method Generic]]

[[Category:Backend services| Payment Method Generic]]

Service - Locations

2025-12-19T09:02:49Z

Jammy:

= Overview =

Manages Location Graph

= Repository =

https://bitbucket.org/izara-core-locations/izara-core-locations-locations/src/master/

= ObjectSchemas =
=== LocationType ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "locationType",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"locationTypeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "locationTypeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== LocationNode ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "locationNode",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"locationNodeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "locationNodeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== LocationLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "locationNode",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"locationNodeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "locationNodeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

= RelationshipSchemas =
=== hasLocationLink ===
<syntaxhighlight lang="JavaScript">

{
"relationshipServiceTag": "Locations",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationNode"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"to": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isLocationNode ===

<syntaxhighlight lang="JavaScript">

{
"relationshipServiceTag": "Locations",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationLink"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"to": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationNode"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>

=== isLocationType ===

<syntaxhighlight lang="JavaScript">

{
"relationshipServiceTag": "Locations",
"fieldNames": {
"originTimeStamp": {
"type": "number",
"requiredOnCreate": false,
"canUpdate": true,
"validation": {

},
"optionalOnCreate": false
},
"relId": {
"type": "string",
"generatedField": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {

}
}
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"links": [
{
"storageResourceTags": [
"graph"
],
"from": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationNode"
},
"requiredOnCreate": true,
"linkType": "many",
"handler": true
},
"to": {
"objType": {
"serviceTag": "Locations",
"objectType": "locationType"
},
"linkType": "one",
"handler": true,
"requiredOnCreate": false
},
"canDelete": false
}
],
"canMove": false
}
</syntaxhighlight>
= DynamoDB tables =

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

=== Configuration tags ===

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

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

= Graph database =

== [[Service - Locations Graph]]==

=== Nodes ===

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{LocationsSharedLib.LOCATIONNODE_GRAPH_NODE_LABEL}", // "locationNode"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
locationNodeId: {
identifier: true, // create unique id from translation and uniqueMessageId (because multiple locationNode can have same translation)
},
topLevel: {}, // true|false // now may be nodeLabel (extent)
},
}
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{LocationsSharedLib.LOCATIONTYPE_GRAPH_NODE_LABEL}", // "locationType"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
locationTypeId: {
identifier: true, // create unique id from translation
},
},
}
}
</syntaxhighlight>
* Want to split eg postcodes for different countries into their own locationTypes, this will mean each has to have a different translation (two cannot be named "Post Code" or they will be considered the same label/use the same locationType node), for now use unique translations for each, but could add another translation as the presentation text, which is not used to identify the type, but when presenting the value

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{LocationsSharedLib.LOCATIONLINK_GRAPH_NODE_LABEL}", // "locationLink"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
locationLinkId: {
identifier: true, // create unique id from parent and child locationNode identifiers, because we only want one link to exist between two specific nodes
},
},
}
}
</syntaxhighlight>

=== Relationships ===

<syntaxhighlight lang="JavaScript">
{
relationshipType: "{LocationsSharedLib.HAS_LOCATIONLINK_GRAPH_REL_TYPE}", // "has_locationLink
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{LocationsSharedLib.IS_LOCATIONNODE_GRAPH_REL_TYPE}", // "is_locationNode
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{LocationsSharedLib.IS_LOCATIONTYPE_GRAPH_REL_TYPE}", // "is_locationType
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
},
}
}
</syntaxhighlight>

== Basic node schemas ==

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{LocationsSharedLib.LOCATIONNODE_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
locationNodeId: {
identifier: true,
},
},
}
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{LocationsSharedLib.LOCATIONTYPE_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
locationTypeId: {
identifier: true,
},
},
}
}
</syntaxhighlight>

= Complex Filter requests =

<syntaxhighlight lang="JavaScript">
{
filterType: "locationNode" //unique id is locationNodeId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "parentLocationNodeIds",
comparison: "equals",
fromLocationNodeId: "xx",
maxHops: "xx" // numeric, optional, if not set default = 20
},
...
]
}
</syntaxhighlight>

= Translations =

== locationNode ==

* given name of the location, eg: Bangkok

== locationType ==

* description of the type of label, eg: Country
* see note about about adding a second translation textTag for presentation text, because locationType translation is used to create locationTypeId, so if want to split Post Codes for different countries into their own locationTypes will need to have unique text (eg: "Post Code (USA)", but might want to present with same text (eg: "Post Code")

= Using locationNodeIds to search for sell offers =

* Sellers set where they ship to, setting more inclusive ship to locationNodeIds is best (if it matches their actual service) because will be included in all searches for lower level locationNodeIds
* Buyers set where they are so can see sell offers that ship there, best to be as low level/specific as possible because will search sell offers for all matching parents
* Buyers can use their address which will find all parent locationNodeIds for all locationNodeIds in their address, or buyers can choose specific locationNodeId/s, eg a country when not signed in, this would return less results as will only return sell offers that specify they can ship anywhere in that country

== Possible optimization when finding matching parents ==

* eg: when given a set of locationNodeIds from a buyer's address, we find all parent locationNodeIds and use this list to filter ship to locationNodeIds to find sell offers that ship to this buyer. This can result in a large number of queries
* this will be mitigated a lot by our cached complex filter and search results, but is still a lot of processing
* in all cases, all nodes set in an address would be searched for, these optimizations are for finding additional parents for checking
* we could reduce the filtering work by reducing the number of parent locationNodeIds
* one way is to only accept parent links that meet a certain weight, eg reach a limit of how many times they have been used as a parent in user addresses. Problem with this is lower level links will have less links, and just because a link is used little does not make it invalid
* another way is to curate the types of parent links to search for, eg only accept certain chains of links, such as city > post code > state, any parent nodes that do not match this chain are ignored. Would probably need to know the country beforehand to set the accepted chains. Additional processing to handle this might outweigh the gains
* another is to have curated parents, user entry (eg by a low level admin role) sets which are real links worth checking
* new plan: set only one locationNodeId as used by an address to calculate the chain of parent locationNodeIds, default is the lowest level node, but allow per address to choose which node

= Working documents =

[[:Category:Working_documents - Locations|Locations]]

[[Category:Backend services| Locations]]

Service - Locations

2025-12-19T08:16:46Z

Jammy:

= Overview =

Manages Location Graph

= Repository =

https://bitbucket.org/izara-core-locations/izara-core-locations-locations/src/master/

= ObjectSchemas =
=== LocationType ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "locationType",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"locationTypeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "locationTypeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== LocationNode ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "locationNode",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"locationNodeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "locationNodeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>

=== LocationLink ===
<syntaxhighlight lang="JavaScript">
{
"objectType": "locationNode",
"canDelete": true,
"belongTo": {
"serviceTag": "UserAccount",
"objectType": "user"
},
"storageResources": {
"graph": {
"storageType": "graph",
"graphServerTag": "GraphHandler"
}
},
"addOnDataStructure": [
{
"type": "translation"
}
],
"fieldNames": {
"locationNodeId": {
"type": "string",
"randomOnCreate": true,
"requiredOnCreate": false,
"optionalOnCreate": false,
"canUpdate": false,
"validation": {
"pattern": "^[a-zA-Z0-9_-]+$"
},
"storageResourceTags": [
"graph"
]
}
},
"compositeKeyDeliminator": "_",
"identifiers": [
{
"type": "identifier",
"fieldName": "locationNodeId"
}
],
"generatedBy": "userGenerated"
}
</syntaxhighlight>
= DynamoDB tables =

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

=== Configuration tags ===

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

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

= Graph database =

== [[Service - Locations Graph]]==

=== Nodes ===

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{LocationsSharedLib.LOCATIONNODE_GRAPH_NODE_LABEL}", // "locationNode"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
locationNodeId: {
identifier: true, // create unique id from translation and uniqueMessageId (because multiple locationNode can have same translation)
},
topLevel: {}, // true|false // now may be nodeLabel (extent)
},
}
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{LocationsSharedLib.LOCATIONTYPE_GRAPH_NODE_LABEL}", // "locationType"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
locationTypeId: {
identifier: true, // create unique id from translation
},
},
}
}
</syntaxhighlight>
* Want to split eg postcodes for different countries into their own locationTypes, this will mean each has to have a different translation (two cannot be named "Post Code" or they will be considered the same label/use the same locationType node), for now use unique translations for each, but could add another translation as the presentation text, which is not used to identify the type, but when presenting the value

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{LocationsSharedLib.LOCATIONLINK_GRAPH_NODE_LABEL}", // "locationLink"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
locationLinkId: {
identifier: true, // create unique id from parent and child locationNode identifiers, because we only want one link to exist between two specific nodes
},
},
}
}
</syntaxhighlight>

=== Relationships ===

<syntaxhighlight lang="JavaScript">
{
relationshipType: "{LocationsSharedLib.HAS_LOCATIONLINK_GRAPH_REL_TYPE}", // "has_locationLink
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{LocationsSharedLib.IS_LOCATIONNODE_GRAPH_REL_TYPE}", // "is_locationNode
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
},
}
}
</syntaxhighlight>
<syntaxhighlight lang="JavaScript">
{
relationshipType: "{LocationsSharedLib.IS_LOCATIONTYPE_GRAPH_REL_TYPE}", // "is_locationType
schema: {
elementCanBeRemoved: false,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
},
}
}
</syntaxhighlight>

== Basic node schemas ==

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{LocationsSharedLib.LOCATIONNODE_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
locationNodeId: {
identifier: true,
},
},
}
}
</syntaxhighlight>

<syntaxhighlight lang="JavaScript">
{
nodeLabel: "{LocationsSharedLib.LOCATIONTYPE_GRAPH_NODE_LABEL}",
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
locationTypeId: {
identifier: true,
},
},
}
}
</syntaxhighlight>

= Complex Filter requests =

<syntaxhighlight lang="JavaScript">
{
filterType: "locationNode" //unique id is locationNodeId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "parentLocationNodeIds",
comparison: "equals",
fromLocationNodeId: "xx",
maxHops: "xx" // numeric, optional, if not set default = 20
},
...
]
}
</syntaxhighlight>

= Translations =

== locationNode ==

* given name of the location, eg: Bangkok

== locationType ==

* description of the type of label, eg: Country
* see note about about adding a second translation textTag for presentation text, because locationType translation is used to create locationTypeId, so if want to split Post Codes for different countries into their own locationTypes will need to have unique text (eg: "Post Code (USA)", but might want to present with same text (eg: "Post Code")

= Using locationNodeIds to search for sell offers =

* Sellers set where they ship to, setting more inclusive ship to locationNodeIds is best (if it matches their actual service) because will be included in all searches for lower level locationNodeIds
* Buyers set where they are so can see sell offers that ship there, best to be as low level/specific as possible because will search sell offers for all matching parents
* Buyers can use their address which will find all parent locationNodeIds for all locationNodeIds in their address, or buyers can choose specific locationNodeId/s, eg a country when not signed in, this would return less results as will only return sell offers that specify they can ship anywhere in that country

== Possible optimization when finding matching parents ==

* eg: when given a set of locationNodeIds from a buyer's address, we find all parent locationNodeIds and use this list to filter ship to locationNodeIds to find sell offers that ship to this buyer. This can result in a large number of queries
* this will be mitigated a lot by our cached complex filter and search results, but is still a lot of processing
* in all cases, all nodes set in an address would be searched for, these optimizations are for finding additional parents for checking
* we could reduce the filtering work by reducing the number of parent locationNodeIds
* one way is to only accept parent links that meet a certain weight, eg reach a limit of how many times they have been used as a parent in user addresses. Problem with this is lower level links will have less links, and just because a link is used little does not make it invalid
* another way is to curate the types of parent links to search for, eg only accept certain chains of links, such as city > post code > state, any parent nodes that do not match this chain are ignored. Would probably need to know the country beforehand to set the accepted chains. Additional processing to handle this might outweigh the gains
* another is to have curated parents, user entry (eg by a low level admin role) sets which are real links worth checking
* new plan: set only one locationNodeId as used by an address to calculate the chain of parent locationNodeIds, default is the lowest level node, but allow per address to choose which node

= Working documents =

[[:Category:Working_documents - Locations|Locations]]

[[Category:Backend services| Locations]]

2025-11-24 ImportData Document

2025-11-25T06:43:33Z

Jammy:

= Process ImportData =
== ProcessCsvFile ==
#Receive bucketName and fieldName.
#Define the range e.g. range = "bytes=0-5000".
#Fetch data from S3 with:<syntaxhighlight lang="javascript">
{
Bucket: 'izara-importdata',
Key: 'csv/xxxx.csv',
Range: 'bytes=0-5000'
}
</syntaxhighlight>
#Take the importBatchId from the S3 metadata and use it to get ImportBatchMain to retrieve importConfigId.
#Use the retrieved importConfigId to get CsvImportConfig.
#Use the CsvImportConfig as the main configuration for processing.
#Loop through the S3 data to extract the titleRow, collecting all field names.
#After extracting all title rows, update fieldNames in ImportBatchMain.
#If S3 data is not fully read, continue with pagination to fetch the next portion.
#When the file ends, send importBatchId to ProcessRowData.

== ProcessRowData ==
#Receive importBatchId.
#Use the received importBatchId to get ImportBatchMain and extract importConfigId.
#Use the retrieved importConfigId to get CsvImportConfig.
#Fetch data from S3 with:<syntaxhighlight lang="javascript">
{
Bucket: 'izara-importdata',
Key: 'csv/xxxx.csv',
Range: 'bytes=0-5000'
}
</syntaxhighlight>
#Loop through the fetched data and store each row into dataRow, including pendingObjects and tempRelationship.
#Validate Schema, Validate Type, Check Required fields, and Check Action (create/update/reference/error).
#Check ImportUserReference to see if this object was already created; if yes, change Action from create → reference.
#Store PendingObjectMain, PendingObjectReference, PendingLink, and FloatingRelationships.
#If the file is not finished, re-invoke itself with the new startByte:
#*If not timed out → continue looping.
#*If timed out → perform pagination.
#If the file is finished, send importBatchId to ProcessFloatingRelationshipsHdrDsq.

== ProcessFloatingRelationshipsHdrDsq ==
#Query FloatingRelationships using importBatchId.
#Process based on action type (create or update):
#*create
#**Create PendingLink for relationships where action = create, and update FloatingStatus: "complete".
#*update
#**Update the existing relationship using data from object A/B.
#**Save AwaitingStep.
#**Call sendMessageToExternalForUpdateRelationship, sending: firstObject, secondObject, relType, relId, relationshipProperties, relationshipDirection.
#If not finished, continue with pagination.
#If fully processed, send importBatchId to ProcessPendingLinkHdrDsq.

== ProcessPendingLink ==
#Query PendingLink using importBatchId.
#Loop to process each PendingLink.
#Run validateLinkConfig to check RequiredOnCreate.
#If no RequiredOnCreate, create AwaitingMultipleSteps:<syntaxhighlight lang="javascript">
await asyncFlowSharedLib.createAwaitingMultipleSteps(
_izContext,
[
asyncFlowSharedLib.createAwaitingStepId(pendingObjectMainOfObjectA.pendingObjectId, consts.PREFIX_CREATE_PENDINGLINK), // object A
asyncFlowSharedLib.createAwaitingStepId(pendingObjectMainOfObjectB.pendingObjectId, consts.PREFIX_CREATE_PENDINGLINK) // object B
],
asyncFlowSharedLib.createPendingStepId(queryPendingLink.pendingLinkId, consts.PREFIX_CREATE_PENDINGLINK) // pendingLink
);
</syntaxhighlight>
#If RequiredOnCreate exists, create two AwaitingMultipleSteps:
#*<syntaxhighlight lang="javascript">
await asyncFlowSharedLib.createAwaitingMultipleSteps(
_izContext,
[asyncFlowSharedLib.createAwaitingStepId(objectRequiredOnCreate.pendingObjectId, consts.PREFIX_IMPORTBATCHMAIN)],
asyncFlowSharedLib.createPendingStepId(importBatchId, consts.PREFIX_IMPORTBATCHMAIN)
);
</syntaxhighlight>
#*<syntaxhighlight lang="javascript">
await asyncFlowSharedLib.createAwaitingMultipleSteps(
_izContext,
[asyncFlowSharedLib.createAwaitingStepId(otherPendingObject.pendingObjectId, consts.PREFIX_CREATE_PENDINGOBJECT)],
asyncFlowSharedLib.createPendingStepId(objectRequiredOnCreate.pendingObjectId, consts.PREFIX_CREATE_PENDINGOBJECT)
);
</syntaxhighlight>
#Update the PendingObjectMain of the RequiredOnCreate object:<syntaxhighlight lang="javascript">
{
"attributeName": "requireOnCreateLinkIds",
"value": [pendingLinkId],
"action": "SET",
"listAppend": true
}
</syntaxhighlight>
#If more data remains, continue pagination.
#If all processed, send importBatchId to ProcessPendingObjectHdrDsq.

== ProcessPendingObjectHdrDsq ==
#Query PendingObjectMain using importBatchId.
#Loop through each PendingObjectMain.
#If the object has RequiredOnCreate, do not send to ExternalService.
#If it has no RequiredOnCreate:
#*Create AwaitingMultipleSteps using PREFIX_IMPORTBATCHMAIN + pendingObjectId.
#*Send to ExternalService according to Action (create, get, update), including:
#**callingFlow = ExternalActionCompleteHdrSqs
#**callingFlowProperties = PREFIX_IMPORTBATCHMAIN + pendingObjectId

== ExternalActionComplete ==
#Receive objType, objInstanceFull, errorFound, passBackProperty from ExternalService.
#Extract pendingObjectId from passBackProperty, locate AwaitingMultipleSteps, and remove it.
#If errorFound, run recursiveErrorPendingObject.
#If no error, update status to "complete".
#Create pendingObjectAwaitingId to find objects that were waiting for this one.
#If there are objects waiting:
#*If they still wait for others → remove their AwaitingMultipleSteps.
#*If not → execute the RequiredOnCreate object and create its relationship.
#Check if all objects are completed. If yes → remove awaitingStep of ImportBatchMain and call clearAllAwaitingSteps.
#Return { returnValue: "externalActionComplete finish" }.

== CreateLinkExternalComplete ==
#Receive firstObject, secondObject, relType, errorFounds, passBackProperties from ExternalService.
#Extract pendingLinkId from passBackProperties, find AwaitingMultipleSteps, and remove it.
#If there are errorFounds → update PendingLink as error; otherwise → mark it complete.
#Remove AwaitingMultipleSteps and call clearAllAwaitingSteps.

2025-11-24 ImportData Document

2025-11-24T10:12:09Z

Jammy: Created page with "= Process ImportData = == ProcessCsvFile == #Receive bucketName and fieldName. #Define the range, e.g. range = "bytes=0-5000". #Fetch data from S3 with:<syntaxhighlight lang="javascript"> { Bucket: 'izara-importdata', Key: 'csv/xxxx.csv', Range: 'bytes=0-5000' } </syntaxhighlight> #Take the importBatchId from the S3 metadata and use it to get ImportBatchMain to retrieve importConfigId. #Use the retrieved importConfigId to get CsvImportConfig. #Use the Cs..."

= Process ImportData =
== ProcessCsvFile ==
#Receive bucketName and fieldName.
#Define the range, e.g. range = "bytes=0-5000".
#Fetch data from S3 with:<syntaxhighlight lang="javascript">
{
Bucket: 'izara-importdata',
Key: 'csv/xxxx.csv',
Range: 'bytes=0-5000'
}
</syntaxhighlight>
#Take the importBatchId from the S3 metadata and use it to get ImportBatchMain to retrieve importConfigId.
#Use the retrieved importConfigId to get CsvImportConfig.
#Use the CsvImportConfig as the main configuration for processing.
#Loop through the S3 data to extract the titleRow, collecting all field names.
#After extracting all title rows, update fieldNames in ImportBatchMain.
#If S3 data is not fully read, continue with pagination to fetch the next portion.
#When the file ends, send importBatchId to ProcessRowData.

== ProcessRowData ==
#Receive importBatchId.
#Use the received importBatchId to get ImportBatchMain and extract importConfigId.
#Use the retrieved importConfigId to get CsvImportConfig.
#Fetch data from S3 with:<syntaxhighlight lang="javascript">
{
Bucket: 'izara-importdata',
Key: 'csv/xxxx.csv',
Range: 'bytes=0-5000'
}
</syntaxhighlight>
#Loop through the fetched data and store each row into dataRow, including pendingObjects and tempRelationship.
#Validate Schema, Validate Type, Check Required fields, and Check Action (create/update/reference/error).
#Check ImportUserReference to see if this object was already created; if yes, change Action from create → reference.
#Store PendingObjectMain, PendingObjectReference, PendingLink, and FloatingRelationships.
#If the file is not finished, re-invoke itself with the new startByte:
#*If not timed out → continue looping.
#*If timed out → perform pagination.
#If the file is finished, send importBatchId to ProcessFloatingRelationshipsHdrDsq.

== ProcessFloatingRelationshipsHdrDsq ==
#Query FloatingRelationships using importBatchId.
#Process based on action type (create or update):
#*create
#**Create PendingLink for relationships where action = create, and update FloatingStatus: "complete".
#*update
#**Update the existing relationship using data from object A/B.
#**Save AwaitingStep.
#**Call sendMessageToExternalForUpdateRelationship, sending: firstObject, secondObject, relType, relId, relationshipProperties, relationshipDirection.
#If not finished, continue with pagination.
#If fully processed, send importBatchId to ProcessPendingLinkHdrDsq.

== ProcessPendingLink ==
#Query PendingLink using importBatchId.
#Loop to process each PendingLink.
#Run validateLinkConfig to check RequiredOnCreate.
#If no RequiredOnCreate, create AwaitingMultipleSteps:<syntaxhighlight lang="javascript">
await asyncFlowSharedLib.createAwaitingMultipleSteps(
_izContext,
[
asyncFlowSharedLib.createAwaitingStepId(pendingObjectMainOfObjectA.pendingObjectId, consts.PREFIX_CREATE_PENDINGLINK), // object A
asyncFlowSharedLib.createAwaitingStepId(pendingObjectMainOfObjectB.pendingObjectId, consts.PREFIX_CREATE_PENDINGLINK) // object B
],
asyncFlowSharedLib.createPendingStepId(queryPendingLink.pendingLinkId, consts.PREFIX_CREATE_PENDINGLINK) // pendingLink
);
</syntaxhighlight>
#If RequiredOnCreate exists, create two AwaitingMultipleSteps:
#*<syntaxhighlight lang="javascript">
await asyncFlowSharedLib.createAwaitingMultipleSteps(
_izContext,
[asyncFlowSharedLib.createAwaitingStepId(objectRequiredOnCreate.pendingObjectId, consts.PREFIX_IMPORTBATCHMAIN)],
asyncFlowSharedLib.createPendingStepId(importBatchId, consts.PREFIX_IMPORTBATCHMAIN)
);
</syntaxhighlight>
#*<syntaxhighlight lang="javascript">
await asyncFlowSharedLib.createAwaitingMultipleSteps(
_izContext,
[asyncFlowSharedLib.createAwaitingStepId(otherPendingObject.pendingObjectId, consts.PREFIX_CREATE_PENDINGOBJECT)],
asyncFlowSharedLib.createPendingStepId(objectRequiredOnCreate.pendingObjectId, consts.PREFIX_CREATE_PENDINGOBJECT)
);
</syntaxhighlight>
#Update the PendingObjectMain of the RequiredOnCreate object:<syntaxhighlight lang="javascript">
{
"attributeName": "requireOnCreateLinkIds",
"value": [pendingLinkId],
"action": "SET",
"listAppend": true
}
</syntaxhighlight>
#If more data remains, continue pagination.
#If all processed, send importBatchId to ProcessPendingObjectHdrDsq.

== ProcessPendingObjectHdrDsq ==
#Query PendingObjectMain using importBatchId.
#Loop through each PendingObjectMain.
#If the object has RequiredOnCreate, do not send to ExternalService.
#If it has no RequiredOnCreate:
#*Create AwaitingMultipleSteps using PREFIX_IMPORTBATCHMAIN + pendingObjectId.
#*Send to ExternalService according to Action (create, get, update), including:
#**callingFlow = ExternalActionCompleteHdrSqs
#**callingFlowProperties = PREFIX_IMPORTBATCHMAIN + pendingObjectId

== ExternalActionComplete ==
#Receive objType, objInstanceFull, errorFound, passBackProperty from ExternalService.
#Extract pendingObjectId from passBackProperty, locate AwaitingMultipleSteps, and remove it.
#If errorFound, run recursiveErrorPendingObject.
#If no error, update status to "complete".
#Create pendingObjectAwaitingId to find objects that were waiting for this one.
#If there are objects waiting:
#*If they still wait for others → remove their AwaitingMultipleSteps.
#*If not → execute the RequiredOnCreate object and create its relationship.
#Check if all objects are completed. If yes → remove awaitingStep of ImportBatchMain and call clearAllAwaitingSteps.
#Return { returnValue: "externalActionComplete finish" }.

== CreateLinkExternalComplete ==
#Receive firstObject, secondObject, relType, errorFounds, passBackProperties from ExternalService.
#Extract pendingLinkId from passBackProperties, find AwaitingMultipleSteps, and remove it.
#If there are errorFounds → update PendingLink as error; otherwise → mark it complete.
#Remove AwaitingMultipleSteps and call clearAllAwaitingSteps.