Packet Report Setup

Navigate: Closed Reports and Interfaces > Packet Report Setup

Description

Packet Report Setup provides the ability to create templates to generate Packets of detail to send inclusive of reports, correspondence, attachments, and commonly referenced materials that are included in all Packets of a specific type without existing as an attachment to a specific object in Aumentum. Packet definitions are Module specific. The packet reports available for each module are dependent on a match to keywords that support the module.

Example: Valuation is typically identified by keywords associated to the revenue object.

Generating the Packets based on the templates configured occurs from the Module menu where templates may be run as is, modified for a single run to exclude detail, or include additional details.

The Steps included identify how to create the templates. Additional details to generate or "run" the packet are provided per Module area when in use for that module.

Example: for additional information related to running Case Management, Evidence Packets: See the help topic for Case Management > Reports > Build Evidence Packets.

Steps

Access: Reports and Interfaces > Packet Report Setup

Packet Report List will provide a list of all existing defined Packets. If no Packets are yet defined, the Grid will be empty. The options available are:

  • New - New button will navigate to begin building a new template.
  • Close - Close button will return the user to the previously focused Aumentum page.
  • Action Column contents:
    • Edit - Pencil icon opens the existing packet report in edit mode. See below for additional details.
    • Copy - Copy icon (stacked pages) creates a copy of the existing template in edit mode. See below for additional details.
    • Delete - Trashcan icon will delete a template that is no longer needed. See below for additional details.

Creating a New Template

Click the Newbutton to begin a new Packet Report Template definition. The available actions are:

  • Validate button can be used at any point in the template creation process to confirm that required elements are configured. If a validation is not successful, the data element in error will be outlined in red and in focus. If multiple are not successful, all will be outlined in red with focus on the first data element that requires additional configuration.
  • Save button is only active when recognized changes exist. Save will write the changes and refresh the template details as written and ready for additional edits.
  • Previous button will return the user to the Packet Report List. If changes exist that are not yet saved, the user will receive a message confirming that changes will be lost:
    • OK (to continue to the previous page without saving)
    • Cancel (to resume editing the current tempalte).
  • Close button will return the user to Aumentum home page. If changes exist that are not yet seaved, the user will receive a message confirming that changes will be lost, requiring a selection of OK or Cancel.

Initial Packet Report detail must be provided before elements can be added to the template.

  • Description - is required. Provide a description that is unique and recognizable for the purpose of this packet.
  • Packet Report Type - is required. Select the appropriate type from the available options provided in the drop-down list.
  • Module - will automatically populate based on the Packet Report Type selected. This is the only area within Aumentum where the packet template will be available to users for report generation.
  • Attachment Category - is required. Select the appropriate Category. It is important to assign a Category that aligns with the Attachment Category relevant to where the generated report should be found from the Attachments icon.
  • Attachment Label - is required. The Attachment Label dropdown list will populate with relevant available Labels configured for use with the Attachment Category selected.

The Packet Element controls will become available when a Packet Report Type is selected. The available elements for Packet Report definitions are:

  • Add Table Of Contents Element: Table of Contents provides a list of all elements included in the packet report including the page number in the packet where the element begins. The control is only available when it has not been selected in the template, preventing multiple occurrences of a Table of Contents.
  • Add Attachment Element: Add Attachment allows the user to identify by Category and Label an attachment to include, if it exists associated by keyword to the object of the packet generation run. If the attachment does not exist for the object, there will be nothing to include for that particular run. The parameters for Attachment: 
    • Attachment description: is required. It is recommended that the description be changed to identify the type or name of the attachment intended for ease in recognition at later packet generation. Click the Pencil icon to change the description. The pencil icon changes to a Check Mark. Click the check mark to save changes.
    • Category: is required. Select the appropriate category from the available list. Category and Label are assigned when attachments are added to objects. It is imperative that the Category and Label identified here align with the Category and Label added during attachment.
    • Label: is required. Select the appropriate label to identify the attachment to include.
    • Number Of Latest Attachments: Defaults to 1 (minimum allowable number). Increase to the number of iterations to include for a specific attachment type. Example: if you wish to include the latest 3 site photos, set this number to 3. When a packet report generates it will include all photos up to 3 in count by most recent first.
    • Max Age (in days): defaults to 0. 0 is an indication that there is no limit. Identify the maximum number of days in age for consideration of inclusion. Any attachment of the type identified older than the number of days identified from the generation date will not be included. Example. If a count of 3 is identified for site photos where the Max Age is 365 days and only 2 site photos exist with a date less than 365, only those 2 site photos will be included.
  • Add Existing Attachment Element: This option allows the user to identify attachments that are relevant and/or required for inclusion of every generation of the report packet without existing as an attachment on the object. Example: a document that identifies the federal, state, or local regulations relevant to the business process aligned with the purpose of the packet report. Clicking this option navigates the user to Select Attachments where the following options are available:
    • Cancel button will return the user to the template being configured.
    • Continue button is only available once an attachment is identified. This will return the user to the template with the attachment selected as a packet element. If this packet will be used by multiple users, the original must exist in a shared location that all users can access.
    • Select file... button will open the browser navigation window allowing the user to navigate to and select the desired file for inclusion. Double click, or click and select Open to return to Select Attachment with the identified attachment to include.
    • Drag and Drop: Users may drag and drop the desired attachment from an explorer window into the "Select file..." bar where "Drop file here" is indicated.
    • Description: is required. The description will default to the file name of the attachment selected. Users may change this name, if desired.

    Click Continue to return to the packet report template with a card for the element selected. The description may also be edited from the packet report template by clicking the Pencil icon next to the existing description. Remember to click the Check Mark icon to save the edit.

  • Add Report Element: Select this option to include an Aumentum Report in the packet report generation. Selection of this option navigates the user to Select Report. Any report that has a match to the keyword required by the module area will be listed as a potential report for inclusion. The column headers are sortable by clicking the column title to change from Ascending to Descending for that column. Each column can be filtered to restrict the reports displayed to narrow the displayed results. Available options:
    • Select: will become available when a row is selected. Multiple rows may be selected. Select will create a separate report card on the packet report template page for each row checked..
    • X: will close the page without inclusions.

    The following options are available for Report Elements when returning to the packet report template after selections are made:

    • Description: The description defaults to the report name selected. The description may be edited by clicking the Pencil icon. Remember to click the Check Mark icon to save.
    • Parameters: Any parameters identified for the report will be provided. Any required parameters will be identified by a red asterisk. This is only visible and relevant if parameters exist.
    • Parameters provided by Keywords: The Parameters provided by Keywords will appear as minimized on the card. The parameters may be viewed by expanding the section (clicking the arrow at the beginning of the row).
    • Use Attachment (when available) checkbox: Selection of this option will provide additional details to identify the attachment. When the identified attachment exists, matching the criteria identified, the attachment will be used. If no attachment exists, then the identified report will be generated when the packet is generated. The additional Attachment Detail required for this option are:
      • Category: is required. Select the appropriate category from the available list.
      • Label: is required. Select the appropriate label to identify the attachment to include
      • Max Age (in days): defaults to 0. 0 is an indication that there is no limit. Identify the maximum number of days in age for consideration of inclusion. If an attachment meeting the number of days at the time of the packet report generation is not found, the identified Report would generate with the packet report.
       
  • Expand arrow: The Expand arrow will expand all minimized content on all cards.
  • Collapse Arrow: The Collapse arrow will collapse all content on cards. This is beneficial when trying to rearrange cards.

All card elements may be rearranged by dragging and dropping them in the ordered needed.

Editing a Template Definition

Templates are intended for continued use. There are many reasons that a template may require modifications. The Pencil icon allows access to an existing template to add, remove, or modify existing card elements. Accessing a template to edit will provide the same functions as are available when creating a new template, as well as provide all previously configured packet report cards. Individual cards may be edited or removed.

Copying a Template Definition

Depending on the business process surround the need for packet reports, there may be a need for multiple, similar packets that vary by one or two elements based on the object characteristics. If a packet exists containing similar content, it can be copied to start a new packet definition. Locate the existing packet report definition and click the Copy icon in the action column for that row. All template definition will be copied to a new template. The existing description will be appended with " - Copy" to prevent overwriting the original template. It is recommended that a new name be established to identify the specific purpose of the report packet.

Deleting a Template Definition

If an existing template is no longer needed it can be deleted by the following methods:

  • Recommended: Click the Pencil icon of the template that is a candidate for removal. This will provide the user the opportunity to review the defined content to confirm it is no longer needed. Click the Delete button.
  • The Trashcan icon is available to remove the template directly from the Packet Report List.

Both "Delete" options will present the user with the following message: "Are you sure you want to delete Packet Report 'NameOfTemplate'? NOTE: this cannot be un-done."

  • Click OK to complete the delete process and return to the Packet Report List
  • Click Cancel return without deleting the template.