Best Practices for Structuring Supplier To Manufacturer JSON Exchanges

General Discussion
1

I'm working on setting up some JSON exchanges between supplier and manufacturer.

Where do you usually transition from a flatter JSON format to a more nested typically?

Are there aspects of ISA-95 or another standard that was built for XML that is common to consider?

Do you normally spend around 10 minutes picking the JSON format or is it something worth taking extra time to give attention to?

I used to both provide J1939 message sequencing and also follow some J1939 message sequencing. The protocol lent itself to a flat design. So I think my tendency is to desire a flat JSON design. So I think it will help me if I can learn the decision process for when designers like to nest data in JSON.

Beyond the payload itself, what is the best way to receive the JSON exchange?
Is an email to copy the payload from and a perspective page to paste into a silly technique since it is still manual?
I want to save time for supplier and manufacturer if I can.

2

That is the primary purpose of the WebDev module, for transfers initiated outside Ignition. When initiating on the Ignition side, no module is required. Just use system.net.httpClient().

1 Like
3

I went to find some WebDev Inductive University videos and some pages in the manual. I didn't find them.

Is the WebDev module not from IA?

4

I swore I watched a IU video on it, but not seeing one now. Here's the manual pages:

1 Like
5

It is, but using it presumes general knowledge of web technologies.

Beyond the user manual Michael linked, this forum's discussions are the best resource.

1 Like
6

In my experience the flatter the better.

Too deep/nested gets annoying to select from.

ofc it highly depends on structure

1 Like
7

I bet I was thinking of the Sepasoft Web Services module which is an added cost, but would definitely make life easier for anyone not well versed in web technologies since it uses a more GUI approach to setting something like this up.

1 Like
8

What is the common way to isolate the gateway WebDev produced API calls?

When setting up the WebDev REST API Endpoints, that is usually done on a gateway that faces externally?
Moves data to a database, then data is moved from that database to another for the production gateways to use?

9

You'd commonly use a proxy with SSL that is exposed to the public internet, configured to forward the /system/webdev URLs to the real gateway with WebDev. Basically the same kind of configuration where perspective is exposed, but the rest of the gateway admin pages are not.

1 Like