Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.royaltyport.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Edit Statement Dialog

Open Edit from the statement detail page to update metadata and add instructions for the AI. The dialog has two tabs: General and Contracts, plus an Instructions section.

​
General Tab

The General tab contains three sections: Period, Currency, and Tags.

​
Period

Set or correct the period covered by the statement:
FieldDescription
YearAccounting year (e.g. 2024)
TypeMonthly (M), Quarterly (Q), Half-yearly (H), or Annual (Y)
NumberFor M: 1–12 (January–December). For Q: 1–4. For H: 1–2. Not used for Annual.
The period is used for reporting and for currency conversion (sales period date).
All three applicable fields (Year, Type, and Number) must be set for the accounting period to be saved. If any field is left on “No change”, the period is not updated.

​
Currency

FieldDescription
Transaction CurrencyCurrency of the underlying sales transactions
Royalty CurrencyCurrency you are paid in
If the system did not detect currencies during processing, set them here and then use Retry so amounts are interpreted and converted correctly.

​
Tags

Add or remove tags on the statement directly from the Edit dialog.
  • The Tags selector shows all tags that exist for statements in this project.
  • Click a tag to add it; click again (or use the remove control) to remove it.
  • Type in the search box to filter existing tags or create a new one — if no match is found, a Create option appears.
  • To delete a tag entirely from the project, use the delete control next to the tag in the dropdown.
Deleting a tag removes it from all statements in the project, not just this one. Removing a tag from a statement only unlinks it.

​
Instructions

The Custom instructions field is a free-text area that is passed to the extraction/automap process when you run Retry. Use it to guide the LLM when the statement has an unusual layout or naming. Examples:
  • “The first column in the PDF is always the track title, not the ISRC.”
  • “Ignore the first two header rows on every page.”
  • “Map the column labeled ‘Net Amount’ to Licensor Revenue.”
  • “This statement has two revenue tables; the second one starts on page 4.”
Instructions are stored with the statement and used on every subsequent retry. The field opens blank regardless of any existing instructions — type new content to replace or add instructions. If you leave the field empty and save, the existing instructions remain unchanged.

​
Best Practices for Instructions

PDFs and spreadsheets with non-standard structure (e.g. merged cells, multiple tables, inconsistent headers) benefit from short, concrete instructions.
Refer to exact column names, row positions, or page numbers when possible (e.g. “Column D is royalty amount” rather than “one of the columns has the amount”).
Split complex guidance into separate sentences so the model can apply each rule clearly.
After saving Edit (period, currency, or instructions), use Retry so the statement is reprocessed with the new settings. Instructions are only used during processing.

​
Retry Processing

Retry (in the statement header actions) reruns the automap/extraction process for this statement. Use it when:
  • You have updated accounting period, currency, or instructions in Edit and want to re-extract with the new metadata
  • A previous run failed or produced low confidence and you want to try again
  • You fixed the source file and re-uploaded (or you want to re-run without re-uploading)
The retry uses the statement’s current settings, including any text in Instructions. Processing status will move to Queued then Processing; when it finishes, the Contents and other tabs will reflect the new extraction.

​
View Mappings

View Mappings opens a view of how columns in the uploaded file were mapped to statement fields (e.g. which column became “Licensor Revenue”, “Track Title”, etc.). Use it to:
  • Understand why a value ended up in a given field
  • Debug extraction when totals or line items look wrong
  • Decide what to put in Instructions for the next Retry
View Mappings is read-only; to change mappings, add Instructions and run Retry.

Statement Details

Tabs and all header actions.

Upload

Processing pipeline and statuses.