Parser Getting Started

Feb. 8, 2022

Parser as a Service Background

Empirasign first introduced our Parser as a Service in 2017 to provide clients with direct access to our market-leading, proprietary parsing technology via the simplicity of an API call. In the Extract, Transform, and Load process for message handling, the heavy lift is the Transform step. Our Parser as a Service enables clients to off-load this step to an outside vendor whose long-standing core competency is transforming unstructured data into structured form. Our Freemium Service Tier made it easier than ever to get started. However, technical hurdles remain.

Inbox Parsing Demo Scripts

Having removed the cost hurdle, we aim to dispense with any remaining technical hurdles with the introduction of two demo parsing scripts--one for IMAP and one for Outlook.

Pseudo Code for Demo Scripts

connect to email INBOX (IMAP or Outlook)
for message in INBOX:
 parse message via API call
 save parsed results to disk as JSON blob
 if remaining quota OK
   rinse/repeat
 else
   exit loop

IMAP Script (Cross-Platform)

https://gist.github.com/empirasign/8eac751354e8cc0c9d0318e7a82005f6

Outlook Script (Windows only)

https://gist.github.com/empirasign/8237e8e68243e9f2532e88cf17cb84ca

Common Dependencies

If you use the Outlook version, pywin32 is also required (Windows only).

The example scripts send runs to our corporate runs parser endpoint. Other endpoints include:
/v1/parse-run/ (Structured Products runs)
/v1/parse-bwic/ (Structured Products BWICs)
/v1/parse-corp/ (Corporate Bonds and Muni runs)
/v1/parse-loan/ (Levered Loans runs)

Link to full docs: www.empirasign.com/api-docs/

Parser GUI

A GUI is available to replay and view any previously parsed message. As we don't permanently store messages, this replay feature is only available for two weeks after an API call is made. You can disable this temporary data storage by sending along store=False as a parameter.

Example GUI replay and debugging URLs:

https://www.empirasign.com/parse-run/{tx_id}/
https://www.empirasign.com/parse-bwic/{tx_id}/
https://www.empirasign.com/parse-corp/{tx_id}/

Each API call returns a tx_id in the response object.

For more information on the GUI replay feature, please consult this blog post:
www.empirasign.com/blog/Parser-Replay-Viewer/

A few sample screenshots are below:

Parser Validated Records

Freemium

Contact us to get started today with Empirasign's Parser as a Service. The Freemium Service Tier allows for 100 messages parsed per day (BWICs or Runs).

Getting an API Key

If you're already an Empirasign customer, it's best to get in touch with your account representative. If not, send an email to info@empirasign.com with Parser in the subject line.

More to come

In 2022, we'll be doing these technical user and developer-focused tutorials on a regular basis.


1