Re: Stratml Project Architechture document - JSON specific communication

[Owen Ambur]

Thanks, Naval.  This response from Bing's new chat service highlights why I have reservations about providing an API(s) for my StratML query service:

APIs can place a significant burden on a server depending on how they are designed and implemented. The amount of burden depends on factors such as the number of requests made, the size of the data being transferred, and the complexity of the API1. However, there are ways to reduce the burden on a server such as caching frequently requested data, optimizing database queries, and using load balancers1.

1 How to Use REST APIs – A Complete Beginner's Guide (freecodecamp.org)

Thus, it has been my preference to encourage others to reuse the code on their own servers while improving and extending it and supporting interaction among such applications, e.g., by sharing newly indexed files.  (Chris has expressed interest in sharing files with his StratNavApp.)

However, I would not want my concern to be a needless impediment to progress, particularly if: a) it may not yet be a real issue and b) Carroll and/or others may wish to enhance the query and/or presentation of results capabilities.

Eventually, for example, more advanced services should empower users to pick and choose which elements of the schema to query as well as which to display in the search results listings.

It might also be good to enable users to query the same elements for multiple terms as well as for synonyms, abbreviations, and alternate spellings.

For the date elements, a key feature would be to enable reminders for EndDates coming due as well as to query for ranges when exact dates are unknown.

In short, the query capabilty options are endless but not unique to StratML.  No doubt, many, if not all of them have been addressed by others for different datasets.

It would also be great if someone could generate statistics and browse listings like Andre used to provide and plans to restore again in the near future.  https://stratml.us/#Cusson  I'd love to see such capabilities relieve me of the need to maintain my hypertext listing and improve upon Joe Carmel's StratML catalog, for which his Perl script no longer seems to work on my old PC anyway.

In any event, I have posted the architecture document at https://stratml.us/references/StratMLSearchSoftwareArchitecture.pdf with a link at https://stratml.us/#WorkResults

I look forward to learning what Carroll and/or others may wish to do along these lines.

Owen Ambur

https://www.linkedin.com/in/owenambur/

On Friday, June 9, 2023 at 09:13:12 AM EDT, Naval Sarda <nsa...@epicomm.net> wrote:

Hi Carroll, Owen, Chris

We have updated/corrected the details provided by Owen in the doc as attached

Also added the URL to test the search API in the document. It is for searching the database created based on StratML files created and maintained by Owen. It will return limited fields in JSON format with a link to the actual Stratml file maintained by Owen.

We can customise request and response like adding more fields in the results, etc

JSON maps to programming objects and database fields without major programming effort. Whereas XML provides a way to render UI without lot of efforts.

Also Chris has provided another API to explore.

Naval

-------- Forwarded Message --------

Subject:	Re: Stratml Project Architechture document - JSON specific communication
Date:	Thu, 8 Jun 2023 19:04:45 +0000 (UTC)
From:	Owen Ambur <owen....@verizon.net>
Reply-To:	Owen Ambur <owen....@verizon.net>
To:	Carroll Ganier <gani...@gmail.com>, Naval Sarda <nsa...@epicomm.net>

Naval, I defer to Carroll as to whether the PDF you attached is the kind of information he seeks.  However, from my perspective, it does not seem to enable him to provide new and additional capability, as I understand he'd like to do.  

In any event, here are couple editorial comments.

1.  In the brief introduction, "Startml" should be "StratML".
2.  Apparently, there are now more than 5K files in the collection.

Based upon a "." full-text query at https://search.aboutthem.info/, the number seems to be 5,706.  When Joe Camel's StratML cataloguer was last run on January 14, it was 5,609.

Owen Ambur

https://www.linkedin.com/in/owenambur/

On Thursday, June 8, 2023 at 12:21:56 PM EDT, Naval Sarda <nsa...@epicomm.net> wrote:

Please see below

-------- Forwarded Message --------

Subject:	Stratml Project Document
Date:	Thu, 8 Jun 2023 20:58:11 +0530
From:	Sudarshana Chavan <sudar...@epicomm.net>
To:	Naval Sarda <nsa...@epicomm.net>

Carrol,

Herewith we are providing you document for basic software architecture.

In this system we have collection of more than 3000 XML files. If you want to use same system for importing more XMLs then the system is ready. If you want to import in different format then we can provide that.

-Sudarshana