Supply Chain Framework Release Notes (1.5.0)

Multi-Instance Support

The main feature in this release is support for multiple, independent namespaces. This feature works as follows:

• All API end points now include the namespace name. See API Changes.

• For each supply chain namespace, there is a set of default supply chain roles, with names that include the namespace name.

• Users must be carefully managed so that they have access only to the resources in the applicable namespaces:

  • A single InterSystems IRIS server defines a common set of usernames, which are not automatically tied to any particular namespace.

  • A user who has one of the supply chain roles will have that role updated automatically as described above, such as from SC_Business_User will be migrated to SC_NAMESPACE_Business_User. No additional changes to the user profile is needed.

  • For any user assigned to a custom role, make sure to follow instructions above to examine the role definition carefully and make any adjustment as needed. If the role definition is properly configured, no additional user profile change is required.

API Changes

There are several API related changes in this release:

1. API endpoints now include the InterSystems IRIS namespace name. For example:

   • Endpoint in previous releases: HTTPS://{SERVER}/api/scdata/v1/customers

   • Same endpoint in release 1.5.0: HTTPS://{SERVER}/api/{NAMESPACE}/scdata/v1/customers

2. All data APIs now have full support for PUT and PATCH:

   • PUT APIs are used to update all data fields in an object based on the request data. Any field not provided in the input will be deleted. This is a change from previous releases (where PUT was implemented using PATCH logic).

   • PATCH APIs are used to update specific fields in an object based on the request data, and not changing anything in the object not specified in the input.

3. API calls now have a maximum number (1000) of records returned. This change prevents potential abuse of data APIs. If a request uses a page size greater than 1000, the request will still be accepted, except that no more than 1000 records will be returned.

Supply Chain Data Model Changes

There is no change in the canonical supply chain data model in this release.

There is a new table, for tracking the task execution metrics: sc_core_metrics.timingdata. Data in this table can be used for monitoring, and is available through the /api/monitor/metricsOpens in a new tab endpoint provided by InterSystems IRIS.

Known Issues

Currently there is an internal limitation on using InterSystems IRIS with metrics. Specifically the total length (in characters) of all the namespaces with metrics enabled, plus the number of commas needed to separate these names, must be less than 50. If this limit is exceeded, the metrics data will still be stored in the corresponding tables, but the access to the metrics using the InterSystems IRIS standard endpoint will error out.