diff --git a/docs/8.0/ayanova/docs/adm-report-templates.md b/docs/8.0/ayanova/docs/adm-report-templates.md index e82b4c7a..dd40f5ab 100644 --- a/docs/8.0/ayanova/docs/adm-report-templates.md +++ b/docs/8.0/ayanova/docs/adm-report-templates.md @@ -2,7 +2,7 @@ Report templates used to generate .pdf report documents from business object data. -AyaNova features a built in [report editor](ay-report.md) where existing report templates can be customized or new ones created. +AyaNova features a built in [report editor](ay-report-edit.md) where existing report templates can be customized or new ones created. ## Authorization Roles required diff --git a/docs/8.0/ayanova/docs/ay-report.md b/docs/8.0/ayanova/docs/ay-report.md index 76b2b85f..0a7fc376 100644 --- a/docs/8.0/ayanova/docs/ay-report.md +++ b/docs/8.0/ayanova/docs/ay-report.md @@ -1,9 +1,31 @@ -# Report viewer form placeholder +# Report picker -#b4beta +The report picker control displays a list of [report templates](adm-report-templates.md) available for the business object type being displayed. -( it's how to use the report rendering then yes and include screnshots before beta) -Report viewer, overview, how to use, link to report designer topics etc +The picker is also the gateway to editing and creating reports in AyaNova. +## Authorization Roles required -Reports listed may vary depending upon the authorization roles required to view that particular report. \ No newline at end of file +This form is available to User's on any reportable object form to which they have access. + +Report templates [can be restricted](ay-report-edit.md#properties) to certain [roles](ay-biz-admin-roles.md) meaning some reports will not be listed for all users even if they have full rights to the underlying AyaNova business object type. For example a Customer report could be restricted to the Business Administration role only even though the User may have full rights to edit Customers as the report may contain management level only information. + +## How to access reports + +Reports are accessed from the `Report` menu option in [data table](ay-start-form-data-tables.md) and single object edit forms. In addition the most recently used report will also be listed below the general `Report` option by it's name to give quick access to a commonly used report. + +## How reports work + +### Selecting + +![report picker](img/report-selector.png) + +The image above shows a report picker for Work order reports. Because the logged in user has the Business administration role and is allowed to [edit reports](ay-report-edit.md) the image shows that each report listed also has an edit button to the right and there is a "New" option at the bottom to create a new report. + +For Users without the right to edit reports the list will show all available reports for selection without the edit controls. + +### Rendering + +In AyaNova reports are "Rendered" (not "Printed") to a .PDF [Portable document format](https://en.wikipedia.org/wiki/PDF) format document and displayed in the browser for printing, viewing, saving or sending. + +Reports are designed to work with a single object or multiple objects so if you select a report from a [data table](ay-start-form-data-tables.md), the report will display one or more [selected records](ay-start-form-data-tables.md#selecting-records). If you render a diff --git a/docs/8.0/ayanova/docs/ay-start-edit-forms.md b/docs/8.0/ayanova/docs/ay-start-edit-forms.md index 55704b91..0df9387e 100644 --- a/docs/8.0/ayanova/docs/ay-start-edit-forms.md +++ b/docs/8.0/ayanova/docs/ay-start-edit-forms.md @@ -9,7 +9,7 @@ #### Report -This menu option opens a list of [reports](ay-report.md) available to be rendered for this object type. +This menu option opens a [list of reports](ay-report.md) available to be rendered for this object type. #### Last report diff --git a/docs/8.0/ayanova/docs/ay-start-form-data-tables.md b/docs/8.0/ayanova/docs/ay-start-form-data-tables.md index fa56fd5e..de038aec 100644 --- a/docs/8.0/ayanova/docs/ay-start-form-data-tables.md +++ b/docs/8.0/ayanova/docs/ay-start-form-data-tables.md @@ -12,7 +12,7 @@ Most data tables in AyaNova share the same common menu options. One ore more of #### Report -This menu option opens a list of [reports](ay-report.md) available to be rendered from this data list. +This menu option opens a [list of reports](ay-report.md) available to be rendered from this data list. [Filtering](#filtering-columns) affects which records will be rendered in reports; what is available in the data table is what is sent to the report rendering engine. So, for example, if you filter for only work orders from the current week that is what will be reflected in the report. diff --git a/docs/8.0/ayanova/docs/img/report-selector.png b/docs/8.0/ayanova/docs/img/report-selector.png new file mode 100644 index 00000000..c54b94fc Binary files /dev/null and b/docs/8.0/ayanova/docs/img/report-selector.png differ diff --git a/docs/8.0/ayanova/mkdocs.yml b/docs/8.0/ayanova/mkdocs.yml index f45edfc8..29d6d943 100644 --- a/docs/8.0/ayanova/mkdocs.yml +++ b/docs/8.0/ayanova/mkdocs.yml @@ -100,7 +100,7 @@ nav: - 'Vendors': 'vendors.md' - Misc: - 'About': 'ay-about.md' - - 'Report': 'ay-report.md' + - 'Report picker': 'ay-report.md' - 'Review': 'ay-review.md' - 'Customize': 'ay-customize.md' - 'Web app diagnostic log': 'ay-log.md'