QBench Jinja Services

QBOrderService

Methods

get(id) → {dict}

Retrieve an Order by its ID.

Params:

• id (int) - Order ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Orders by filter_params.

Params:

• filter_params (dict) - filter options

QBSampleService

Methods

get(id) → {dict}

Retrieve a Sample by its ID.

Params:

• id (int) - Sample ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Samples by filter_params.

Params:

• filter_params (dict) - filter options

 

QBTestService

Methods

get(id) → {dict}

Retrieve a Test by its ID.

Params:

• id (int) - Test ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Tests by filter_params.

Params:

• filter_params (dict) - filter options

render_worksheet(test_entity) → {HTMLString}

Returns an HTML String that can easily be rendered in any template (Reports, Printdocs, etc.). This function will work with both QWML Worksheet Types and Spreadsheet Worksheet Types

NOTE:

If you are rendering a Spreadsheet Worksheet Type, you will need to include the following code in your <style> tag at the top of your template for the styles to be properly applied from your worksheet config:

{{ QBGlobals.SPREADSHEET_WORKSHEET_STYLES }}

render_chart(<chart_name>, test_entity, [config_override={}]) → {String}

Returns a string that is the patch to your rendered chart.

QBInvoiceService

Methods

get(id) → {dict}

Retrieve an Invoice by its ID.

Params:

• id (int) - Invoice ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Invoices by filter_params.

Params:

• filter_params (dict) - filter options

 

QBBatchService

Methods

get(id) → {dict}

Retrieve a Batch by its ID.

Params:

• id (int) - Batch ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Batches by filter_params.

Params:

• filter_params (dict) - filter options

render_worksheet(batch_entity) → {HTMLString}

Returns an HTML String that can easily be rendered in any template (Reports, Printdocs, etc.). This function will work with both QWML Worksheet Types and Spreadsheet Worksheet Types

NOTE:

If you are rendering a Spreadsheet Worksheet Type, you will need to include the following code in your <style> tag at the top of your template for the styles to be properly applied from your worksheet config:

{{ QBGlobals.SPREADSHEET_WORKSHEET_STYLES }}

 

QBInventoryItemService

Methods

get(id) → {dict}

Retrieve an Inventory Item by its ID.

Params:

• id (int) - Inventory Item ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Inventory Items by filter_params.

Params:

• filter_params (dict) - filter options

 

QBInventoryStockService

Methods

get(id) → {dict}

Retrieve an Inventory Stock by its ID.

Params:

• id (int) - Inventory Stock ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Inventory Stocks by filter_params.

Params:

• filter_params (dict) - filter options

render_worksheet(inventory_stock_entity) → {HTMLString}

Returns an HTML String that can easily be rendered in any template (Reports, Printdocs, etc.). This function will work with both QWML Worksheet Types and Spreadsheet Worksheet Types

NOTE:

If you are rendering a Spreadsheet Worksheet Type, you will need to include the following code in your <style> tag at the top of your template for the styles to be properly applied from your worksheet config:

{{ QBGlobals.SPREADSHEET_WORKSHEET_STYLES }}

 

QBEquipmentService

Methods

get(id) → {dict}

Retrieve an Equipment by its ID.

Params:

• id (int) - Equipment ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Equipment by filter_params.

Params:

• filter_params (dict) - filter options

QBRecordService

Methods

get(id) → {dict}

Retrieve a Record by its ID.

Params:

• id (int) - Log Entry ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Records by filter_params.

Params:

• filter_params (dict) - filter options

render_worksheet(record_entity) → {HTMLString}

Returns an HTML String that can easily be rendered in any template (Reports, Printdocs, etc.). This function will work with both QWML Worksheet Types and Spreadsheet Worksheet Types

NOTE:

If you are rendering a Spreadsheet Worksheet Type, you will need to include the following code in your <style> tag at the top of your template for the styles to be properly applied from your worksheet config:

{{ QBGlobals.SPREADSHEET_WORKSHEET_STYLES }}

QBLogTypeService

Methods

get(id) → {dict}

Retrieve a Log Type by its ID.

Params:

• id (int) - Log Type ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Log Types by filter_params.

Params:

• filter_params (dict) - filter options

 

QBLogEntryService

Methods

get(id) → {dict}

Retrieve a Log Entry by its ID.

Params:

• id (int) - Log Entry ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Log Entries by filter_params.

Params:

• filter_params (dict) - filter options

render_worksheet(log_entry_entity) → {HTMLString}

Returns an HTML String that can easily be rendered in any template (Reports, Printdocs, etc.). This function will work with both QWML Worksheet Types and Spreadsheet Worksheet Types

NOTE:

If you are rendering a Spreadsheet Worksheet Type, you will need to include the following code in your <style> tag at the top of your template for the styles to be properly applied from your worksheet config:

{{ QBGlobals.SPREADSHEET_WORKSHEET_STYLES }}

QBBatchObjectProtocolStepService

Methods

get(id) → {dict}

Retrieve a Batch Object Protocol Step by its ID.

Params:

• id (int) - Log Entry ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Batch Object Protocol Steps by filter_params.

Params:

• filter_params (dict) - filter options

render_worksheet(batch_object_protocol_step_entity) → {HTMLString}

Returns an HTML String that can easily be rendered in any template (Reports, Printdocs, etc.). This function will work with both QWML Worksheet Types and Spreadsheet Worksheet Types

NOTE:

If you are rendering a Spreadsheet Worksheet Type, you will need to include the following code in your <style> tag at the top of your template for the styles to be properly applied from your worksheet config:

{{ QBGlobals.SPREADSHEET_WORKSHEET_STYLES }}

QBTestObjectProtocolStepService

Methods

get(id) → {dict}

Retrieve a Test Object Protocol Step by its ID.

Params:

• id (int) - Log Entry ID

get_list(filter_params) → {generator}

Retrieve a generator to iterate through Test Object Protocol Steps by filter_params.

Params:

• filter_params (dict) - filter options

render_worksheet(test_object_protocol_step_entity) → {HTMLString}

Returns an HTML String that can easily be rendered in any template (Reports, Printdocs, etc.). This function will work with both QWML Worksheet Types and Spreadsheet Worksheet Types

NOTE:

If you are rendering a Spreadsheet Worksheet Type, you will need to include the following code in your <style> tag at the top of your template for the styles to be properly applied from your worksheet config:

{{ QBGlobals.SPREADSHEET_WORKSHEET_STYLES }}

Example Usage

{% set batch_id = 123 %}
{% set batch = QBBatchService().get(batch_id) %}
{{ batch.id }}

Prints:

123