Note: This tutorial assumes that you already created a mailbox and sent your first email. If not, check out this article to get started.
Prefer to watch a video?
Step 1: Open the template editor
You can create your first template in two ways, using the wizard and using the standard flow.
Option 1: open the template editor from the wizard
If you have just created your template, the Wizard will offer you to create your first template.
Option 2: open the template editor the standard way
Every template needs to be created from a base document.
Head over to the Documents section on the left menu. Then locate the email you want to create a template from and click on the + button.
Step 2: get acquainted with the template editor
When you create your first template, the Template Editor tutorial opens. You can revisit that tutorial at any time by clicking on the "How to use this editor" link at the top right corner of the screen.
The Template Editor is where you will show which information you want to retrieve from documents.
Let's go through each section of this screen:
- Template Name: give your template a name (name must be unique in a mailbox)
- View As: leave this on Rich for now. Other modes can be useful but are for an advanced usage.
- Available tab: lists the fields used in other templates. As this is your first template, the list is empty.
- Used tab: lists the fields currently captured from the document for this template. As you haven't created any field yet, this list is also empty.
- Extra tab (this tab may be hidden behind the drop-down menu on smaller screens): lists additional metadata fields you may want to add to your parsed results. See below for more information.
- Action: leave this on Processed. Skip and Delete can be use when you want to discard emails from being processed.
- Status: leave this on Enabled. If you set this to Disabled, the template won't be used (useful when making tests).
- Reprocess all unprocessed documents: leave this checked. Uncheck this if you don't want unprocessed documents to be reprocessed using this template (useful when making tests of if you have a large number of older unprocessed documents you don't want to process anymore).
Step 3: Create your first field
In Parseur, a field represents a piece of information you want to extract.
The animation below shows you how to add your first field.
To add a field:
- Select the piece of text you want to capture
- The "New Field" button becomes available
- Click this button, this will add a new entry into the Used fields section
- Name your field
- Click the "Tick mark" icon (or press Enter)
Step 4: Create all remaining fields and save
Repeat steps described above for every field you want to capture.
Step 5: Add extra metadata fields (optional)
You may want to extract additional metadata information that is not present in the document body, like for instance the Sender email address, the date the email was sent to etc.
Head over to the Extra fields tab next to the Used fields tab
Note: If you are on a small screen, the Extra tab may be hidden in the drop-down menu.
For more information about each field hover the light blue information icon next to it or check our Using Extra Fields article.
Step 6: Save the template
Once finished, click "Create".
You will now see that your document has been processed.
For each document, you can perform 8 actions:
- View: display the email and the parsed data
- Re-run parsing: useful if you updated the template and want to refresh the captured data
- Create a new template based on the document
- Skip document: Parseur will now ignore it
- Copy document to another mailbox
- View the logs to see an audit trail of what happened to the document (new! not shown on the screen capture)
- Launch the template debugger to see which parts of the document matches or not a template
- Delete the document
The recommended action is shown is darker blue.
In this case it is "View". Click on it.
Step 5: Check results
Make sure that all the data was captured correctly.
In this screen you see:
- At the top, metadata info about the document, including the number of credits that were used
- At the top right, the action buttons (hover them for more information)
- On the left, the email
- On the right, the parsed data extracted (based on the template indicated at the top)
If everything looks correct, congratulations! You have parsed your first email.
Now send more emails and verify that your data is correctly extracted. Create new templates as necessary.