Open Bee™ Scan Capture provides a number of variables in its scripts depending on the context in which they are used. These variables can be structured.
In Open Bee™ Scan Capture there is a special type: JSE_Result that allows you to return an object that is more complex than a simple string. Indeed, this object allows you, for example, to fill in the values of a drop-down list if your script is intended not only to return a value, but also to populate the drop-down list.
Pre-integrated variables
Reminder of contexts: LABEL, INDEX, VALIDATION, ENTRIES
Variables are made available for use within the script:
- Local variables (accessible in the main body of the script):
- pParameters —An array containing all Info and ArticleLineInfo objects found for the current document LABEL, INDEX, VALIDATION, ENTRIES
Global variables to the script:
| Name | Description | Type | Context | Version |
|---|---|---|---|---|
| ID_INVOICE | Displays the document ID in Open Bee™ Scan Capture | Text | LIBEL INDEX VALIDATION SCRIPTURES | 3.3.1 |
| INTERNAL_DOCUMENT_ID | Displays the internal ID of the document in Open Bee™ Scan Capture | Text | LIBEL INDEX VALIDATION SCRIPTURES | 3.8.0 |
| ID_DMS | L’identifiant du document dans Open Bee™ Portal quand celui a déjà été archivé par Capture. | Text | LIBEL INDEX VALIDATION SCRIPTURES | 3.5.0 |
| ID_DMS_LIST | Identifiants des documents dans le ou les Open Bee Portal™ quand le document a été archivé par Capture. | Liste de Texte | LIBEL INDEX VALIDATION SCRIPTURES | 4.3.0 |
| THIRDPART | Third Party of the Document | ThirdPart | LIBEL INDEX VALIDATION SCRIPTURES | |
| FOLDER | Document Folder | Folder | LIBEL INDEX VALIDATION SCRIPTURES | 3.3.0 |
| DOCUMENT_STATE | Current status of the document. Possible values: – WORKFLOW_DONE – ENTRY_DONE – DOCUMENT_FINAL – VIDEOCODAGE_DONE – ANALYTICAL_BREAKDOWN_DONE | Text | LIBEL INDEX VALIDATION SCRIPTURES | 3.4.0 |
| DOCUMENT_TEMPLATE | The template used for the document (corresponding to its third party, its folder or generic to the application) | Template | LIBEL INDEX VALIDATION SCRIPTURES | 3.8.0 |
| DOCUMENT_TYPE | The type of document in Open Bee™ Portal | Document Template | LIBEL INDEX VALIDATION SCRIPTURES | 3.8.0 |
| Wear out | Current user: LIBELLE the user who generates the accounting entries INDEX the user who videocodes the document (or if the script is executed on the server side, the user “USER_SYSTEM”) VALIDATION the user who validates and exports the document WRITINGS the user who exports the entries | Wear out | LIBEL INDEX VALIDATION SCRIPTURES | 3.4.0 |
| COMMENTS | Open Bee™ Portal | List of Comments | INDEX VALIDATION SCRIPTURES | 3.7.0 |
| ACCOUNT_ENTRIES | List of ledger entries associated with the document | List of Ledger Entries | VALIDATION SCRIPTURES | 3.7.0 |
| ACCOUNT_ENTRY | Writing in the process of being exported | Accounting Entry | SCRIPTURES | 4.2.0 |
| ACCOUNT_ENTRY_NUMBER | The number of the ledger entry in the export order. Starts at 1 | Whole | SCRIPTURES | 3.8.0 |
| DOCUMENT_WORKFLOW_STATUS | Status of the document vs. its status in the workflow (see accounting configuration) Status: Validated Refused NotProcessed Waiting | Text | SCRIPTURES | 3.8.0 |
| ID_UNIT | Instance number of the Current Info object | Text | LIBEL INDEX | |
| GROUPED_INDEX_ID | Unique identifier of the parent index: Populated only if the index belongs to an article group or row | Text | INDEX | |
| IS_ARTICLE | Specifies whether the line comes from an item line (In case an item line needs to generate a ledger entry) | Boolean | LIBEL | |
| IS_DISCOUNT_RATE_GENERATION | Indicates whether the line is the result of a discount generation | Boolean | LIBEL | 3.3.0 |
| ID_CURRENT_INDEX | The identifier of the index that was used to generate the row. Filled only in case of index -> entry line link (Ex: If I find the value foo on the index NOM_INDEX I debit the account 445600 with the amount excluding VAT) -> The value would be NOM_INDEX | Text | LIBEL | |
| CAPTURE_WS_TOKEN | Session capture token to call certain web services | Text | LIBEL INDEX VALIDATION SCRIPTURES | 4.1.0 |
| FILENAME | File Name | Text | LIBEL INDEX VALIDATION SCRIPTURES | 4.3.0 |
| INTERPRETATION_MODE | Where the script is executed | CLIENT, SERVER, or UNKNOWN | LIBEL INDEX VALIDATION SCRIPTURES | 4.5.0 |
| GENERATION_TEMPLATE_NAME | Ledger Entry Model Name | Text | LIBEL | 4.7.1 |