Service - Delivery Method Rate Table

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

{
  "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": "_"
}

rateTable

{
  "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": "_"
}

RelationshipSchemas

hasRates

{
  "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
}

disableRates

{
  "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
}

deliversToLocationNode

{
  "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
}

disabledDeliversTolocationNode

{
  "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
}

DynamoDB tables

Standard Config Table Per Service

Configuration tags

{
	configTag: "ProductGraphServiceName"
	configKey: "ProductGraphServiceName"
	configValue: xxx // eg: "ProductGraph"
}

LogicalResultsMain

LogicalResultsMain

LogicalResultsData

LogicalResultsData

LogicalAwaitingStep

LogicalAwaitingStep

Graph database

Service - Products Graph

Nodes

{
	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
			},
		},
	}
}

Versioned data

rateTableRates

{
	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
			},
			// ..
		],
	},
}

Relationships

{
	relationshipType: "{DeliveryMethodStandardLib.createHasDeliveryMethodRateTableGraphRelationshipType()}", // "deliversTo_locationNode"
	schema: {
		elementCanBeRemoved: true,
		allPropertiesImmutable: true,
		restrictProperties: true,
		properties: {
			originTimestamp: //timestamp the request to create/change this relationship was sent
		},
	}
}

{
	relationshipType: "{DeliveryMethodStandardLib.createDisabledDeliveryMethodRateTableGraphRelationshipType()}", // "disabledDeliversTo_locationNode"
	schema: {
		elementCanBeRemoved: true,
		allPropertiesImmutable: true,
		restrictProperties: true,
		properties: {
			originTimestamp: //timestamp the request to create/change this relationship was sent
		},
	}
}

• 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

{
	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"
		},
	}
}

• 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

{
	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",
		},		
		...
	]
}

Working documents

Delivery Method Rate Table