Interface table and functionality
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
4 weeks ago
Hi Friends,
I have a requirement from a client to build a common functionality to store the data of all integrations and must be processed via a common table.
It will show Incoming or outgoing data, request body, response body, http status, error messages etc. I suggesting we can have one table for outgoing data but for incoming data we should use Inbound Web services based on the requirement of the interface.
Can you guys share your expert opiniton or update set if somebody has already build something like this? Generic tables for any time of interface/integrations which can be used for troubleshooting.
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
4 weeks ago
You can retrieve this information from REST API logs, Transaction logs and Outbound HTTP logs.
First, analyse whether this requirement is a must have or can be managed by creating reports or dashboards which captures integration errors and you can check further details from Flow execution or transaction logs rather than storing data for all inbound and outbound transactions.
To achieve your requirement, you need to understand various methods you are using for integration i.e. Flow Designer, Scripted REST API, Email, Import Set API, Table API, Integration Hub ETL etc.,
Create a table for inbound and outbound and for each integration, you need to capture the transaction details as part of the integration method. For example, if you have an outbound integration to Splunk, after a transaction is made, add 'Create/Update' record action in custom table to capture the details of the transaction.
Thanks,
Bhuvan
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
4 weeks ago
You will require a custom table to store the outbound request body, endpoint, response you got, Status etc
This table will help you debugging in future and will also help in retry mechanism if required.
My Experience:
1) I did work on something similar and we had create a custom table and whenever a REST Message was consumed we used to enter data into that table and also update it with response came
Note: Remember custom table has cost involved in it due to licensing
If my response helped please mark it correct and close the thread so that it benefits future readers.
Ankur
✨ Certified Technical Architect || ✨ 9x ServiceNow MVP || ✨ ServiceNow Community Leader
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
4 weeks ago
Hi Ankur - Thank you for response. Do you have the design doc or update set for it to share? If not, can you give me a highlevel details what fields to add to a custom table, how to populate the data and how to process it etc?
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
4 weeks ago
At high level fields would be
1) status - in progress, success, failure, error
2) Request body
3) Response body
4) Endpoint
5) HTTP Status
6) Target Record
7) Flow Context - flow which triggered this
Thank you for marking my response as helpful.
If my response helped please mark it correct and close the thread so that it benefits future readers.
Ankur
✨ Certified Technical Architect || ✨ 9x ServiceNow MVP || ✨ ServiceNow Community Leader