When you set up a filter or adjust a file's import settings, the Extraction preview shows the segments, words and tags wxrks would extract from a file with those settings. You see the result right away, before you save the filter or create the project, so you can fix a RegEx (regular expression) or a parsing option without creating test projects.
💡 Who is this for? Account Admins and Project Managers who create filters or set up files for new projects.
Permissions:
To preview a sample file in an Organizational Unit's filter, you need Organizational Unit Update.
To preview a project file's import settings, you need Project Resource Create, the same permission used to save those settings.
See How to manage Permission Groups to grant them.
What the preview applies
The preview runs the same import that a new project would run, using the values currently in the form, even unsaved ones. Nothing is saved and no project is created. It applies:
The filter's settings, such as the import options and Apply segmentation to text.
The RegEx for tags. Text that matches it becomes a tag. The Organizational Unit's own RegEx applies together with the filter's. If the filter's RegEx for tags field is empty, the platform default RegEx applies instead.
The segmentation rules of the Organizational Unit for the source language. See All about Segmentation Rules.
Preview a sample file in a filter
Use this when you create or edit a filter.
Go to Settings > Translation > Filter settings. Choose Account for account filters, or click Org unit and search for the unit to work on its filters.
Click Add filter, or Edit on an existing filter. Extraction preview is at the top of the window.
For an account filter, pick an Organizational Unit in Preview as Org Unit (step 1 in the image). An account filter doesn't belong to any unit, so the preview borrows this unit's RegEx and segmentation rules. A unit's own filter uses that unit and doesn't show this field.
Choose the Source language of the sample (step 2).
Under Sample file, drop or browse a file of the filter's type, up to 5 MB (step 3).
Click Preview (step 4). After the first run, the button reads Refresh preview.
Read the result
The summary line shows how many segments, words and tags were extracted, and when the preview ran (step 5 in the image above). The table lists each segment with:
Context: the key or context of the segment in the file, for example
welcome.titlein a JSON file.Segment: the source text. Tags appear as numbered chips; hover over a chip to see the text it captured. Click the document icon next to a segment to switch between Show the original text (as it is in the file) and Show the tags.
Words: the word count of the segment.
In the example, the RegEx \{[^}]+\} turns placeholders such as {userName} into tags, so translators can't change them by mistake, and the summary counts 3 tags.
Check which RegEx was applied
Above the RegEx for tags field, RegEx applied in the last preview lists every RegEx the last run used and where each one came from:
Origin | Meaning |
Org unit RegEx (inherited) | The Organizational Unit's own RegEx, applied to all its files. |
RegEx of this field | The filter's RegEx for tags field. |
Platform default (the field is empty) | The default RegEx wxrks applies when the field is empty. |
Click Use as base to copy the part this filter controls into the RegEx for tags field, so you can start from it instead of typing it again. While you edit the field, press Enter to run the preview again.
When the preview is out of date
The preview never runs again on its own. When you change any extraction setting after a run, The preview is out of date. appears next to Refresh preview at the bottom of the window, and the RegEx panel turns yellow. Click Refresh preview (or press Enter in the RegEx field) to see the new result.
Preview a file while creating a project
When you create a project, you can preview the files you upload with their real settings.
Go to Projects > New Project, choose the Org unit and the languages, and upload your files.
Click Import settings on a file (step 1 in the image).
Click Preview in Extraction preview (step 2). The preview uses the uploaded file, so it runs once the file shows Uploaded.
Adjust the import settings and click Refresh preview until the segments look right, then click Next.
The same Extraction preview appears wherever you set a file's import settings: in Add files on an existing project, and in Configure for each Organizational Unit in Project routing. In Project routing, each target unit applies its own RegEx and segmentation rules.
ℹ️ Note: A project file preview shows the first 500 segments, and its totals count only those segments. Files larger than 50 MB can't be previewed: save a small sample and preview it in the filter instead. The settings still apply when the project is created.
Troubleshooting
Message | What to do |
The tag regex is not valid | The message gives the reason, for example |
The tag regex matches empty text and cannot be used | An expression such as |
Nothing to translate was found | Check the Import as type and the filter of the file. For XLSX files, check that Sheet name matches a worksheet of the file. |
The file is too large to preview | Use a smaller sample file (up to 5 MB in a filter). |
The preview took too long or The preview is busy | Try again in a moment. A preview stops after 30 seconds. |
Pick an Org Unit first | For an account filter, choose an Organizational Unit in Preview as Org Unit. |
Limits
The preview doesn't show content the filter ignores, and doesn't apply an XSLT stylesheet.
Related articles