Create, export, import and delete document parsers
A document parser holds the rules that read a work order. Parse under Work Order Import lists them as Document Parsers, with each parser's Name, Imports to, Source (PDF or email), Created and Updated. Click a name or Manage to open one, and use the menu on the row for Export and Delete.
The tabs All parsers, Simpro and Fergus filter the list, each with its count. A parser saved before Fergus was supported counts as a Simpro parser.
Before you start
A Work Order Import subscription. Without one the page says "A subscription is required before you manage document parsers.", Create Document Parser is greyed out ("Subscription required") and Import Parser is hidden.
Create a parser
- Click Create Document Parser.
- Enter a Parser Name. The label asks for at least 5 characters.
- Choose the Document type: PDF or Email.
- Choose Imports to: Simpro or Fergus.
- Choose what it creates, under Simpro object or Fergus object. Simpro offers Jobs and Quotes. Fergus offers Jobs (a Fergus job, of the job type set in the inbox), Quotes (a Quote job in Fergus with a draft quote on it) and Enquiries (a Fergus enquiry, made without a customer or site).
- Click Save.
The document type, the platform and what it creates can't be changed once the parser is saved. Each is greyed out afterwards. Upload a sample work order and build the rules next. See Parser properties.
A Fergus parser can't read the values Fergus has no field for. These are the date issued, due date and time, response time, site contact department and notes, cost centre totals and custom fields. See Destination fields.
How it maps
| Imports to | Object | Record created |
|---|---|---|
| Simpro | Jobs | A Simpro job |
| Simpro | Quotes | A Simpro quote |
| Fergus | Jobs | A Fergus job, of the job type set on the inbox |
| Fergus | Quotes | A Fergus Quote job with a draft quote |
| Fergus | Enquiries | A Fergus enquiry |
An inbox only offers parsers for its own platform. See Inboxes.
The warning on a parser
Site details not mapped appears on a parser whose rules read neither a site name nor a site address, so a job can't be placed on a site. An email parser is fine if one of its rules hands the work to a PDF parser that reads a site address.
Export a parser
Click the menu on the row, then Export. Your browser downloads a .json file named
parser- followed by the parser's name in lower case with dashes, for example
parser-acme-work-orders.json. The file holds the parser's rules and settings. It doesn't hold the
sample PDF or email the rules were built from, because those stay in your account.
An email parser can hand a PDF to a PDF parser. Exporting the email parser puts that PDF parser in the same file, so the file works on its own.
Import a parser
- Click Import Parser.
- Drop a parser file on the box, or click it to browse. The file must be a
.jsonexported from a document parser. - Check the preview. It lists each Parser with its Source, what it Creates, how many Rules and fields it has, and a Status: New, "already exists", Overwrites existing or No changes.
- If a name matches a parser already in the account, choose Import as a new parser or Overwrite the existing parser.
- Click the button at the bottom, which reads Import 2 Parsers (or the number in the file), or Overwrite when every parser in the file overwrites one. Then click Done.
A new parser is named as in the file. When the name is taken, it becomes Name (2), then
Name (3) and so on.
Overwrite replaces the rules and settings of the parser with that name, and it can't be undone.
The sample documents already uploaded against its rules are kept. A parser whose document type,
platform or object doesn't match the one it would overwrite is always imported as a new one.
A parser imported as new has no sample document. Upload a PDF or email before you edit its rules.
An email parser that handed work to a PDF parser is linked again to the PDF parser of the same name in this account. If that parser isn't in the file or the account, the dialog says "The PDF parser for ... could not be found, so that link has been cleared." and the rule needs a parser chosen again.
Delete a parser
Click the menu on the row, then Delete. If no inbox uses the parser, Formpiece asks "Delete this parser?", then deletes it, along with the sample PDFs held on its rules. This can't be undone.
If an inbox uses it, including an archived inbox, or an email parser reads a PDF with it, the dialog says "This parser cannot be deleted" and lists them. Move those inboxes to another parser, or remove the link, then try again.
When it goes wrong
"That file is not a Formpiece parser export."
The file isn't JSON, or it wasn't exported from Work Order Import.
"That export was made by a newer version of Formpiece."
The file's version is newer than the dashboard understands. A file with a Fergus parser has a newer version than one with only Simpro parsers, so an older dashboard won't read it.
"That export does not contain any document parsers."
The file is a parser export with nothing in it. Export again from the source account.
"... has an unknown document type"
The message names the parser. A parser can also be refused with "... has an unknown Simpro object." or "... imports to an unknown platform." Its document type, object or platform isn't one this dashboard knows. Export it again from an up to date dashboard.
I can't change the platform of a parser
It is locked once saved. Create a new parser for the other platform. Export and import won't change the platform either.