Overview

  • Energy Efficiency programs often require an evidence pack consisting of digital assets created during a job.
  • Without the file pack generator an ASAP operator must manually select the assets required using the Jobs Files Tab and by hand sort and build the pack.
  • This manual process is both time consuming and error prone.
  • A file pack will collect the assets of a job into a file that is downloaded from the same Jobs Files Tab.

  • A File Pack like your Desktop PC consists of Files and Directories, A File Pack configuration could look like:

              EvidencePack.zip
              - [D]Pre Installation Photos
                -- [F]Pre Installation File Category
                  --- Area1_Pre_Install_Photo.jpg
                  --- Area2_Pre_Install_Photo.jpg
                  --- Area3_Pre_Install_Photo.jpg
                  --- Area4_Pre_Install_Photo.jpg
                
              - [D]Post Installation Photos
                  -- [F]Pre Installation File Category
                      --- Area1_Post_Install_Photo.jpg
                      --- Area2_Post_Install_Photo.jpg
                      --- Area3_Post_Install_Photo.jpg
                      --- Area4_Post_Install_Photo.jpg
    
              - [D]Forms
                  -- [F]AssignmentForm
                      --  A30123_Assignment_Form_v1.pdf
                      --  A30123_Assignment_Form_v2.pdf
                      --  A30123_Assignment_Form_v3.pdf
    
  • In this example
    • The name of the file pack is:
      • EvidencePack.zip
    • The directories that contain forms or photos are:
      • [D]Pre Installation Photos, [D]Post Installation Photos, [D]Forms

Creating a File Pack

1. Add a File Pack

  1. Open the File Pack Management screen by clicking Admin → File Packs → File Packs
  2. Enter the File Pack Properties into the fields at the bottom of the screen
  3. Select the Add File Pack button.

File Pack Property Descriptions

  • Use these descriptions to fill file pack properties

    Property Description
    File Pack ID An ID allocated by ASAP
    Pack Name The name of the file pack, a way of identifying it within ASAP
    Download File Name The name of the file pack once downloaded, can include:
    • {job_id} - Will insert the current job number
    • {ext} - Will insert the file extension, defaults to zip
    Description A brief description of the file pack
    Sort A method of sorting where 0 will appear first
    Form Work Types A method of sorting File Packs, 0 being the highest
    Tip: Leave a gap between sort orders, e.g. 10 then 20 rather than 10 then 11. This allows room for future changes
    Valid From & To A method of determining whether the file pack is valid, compared with job creation date

2. Add File Pack Items

  1. Open the File Pack Items Management screen by clicking Admin → File Packs → File Pack Items
  2. Select a File Pack from the File Pack drop down menu
  3. Enter the File Pack Item Properties into the fields at the bottom of the screen
  4. Select the Add Pack File button

File Pack Item Property Descriptions

Property Description
Pack Item ID The Database Identifier
File Name name to generate for each file included, use the variables below to avoid duplicates
Description What this item is to include
File Type Is this item a directory or to include forms or data categories
Link to a Parent Directory Make this item a sub-directory only do so after created the item, so knows which FilePack Directories to list
File Pack The File Pack to include this item on
From Work Types Restrict the item to forms and files related to that work type.
Required Data Categories Images categories to include for this item.
Required Forms Forms to include for this item.

Variables in Form Names

Data Variable Description
{app_id} The Appointment ID
{job_id} The Job ID
{file_number} A File Number
{form_id} The Database Id of the form
{form_name} The name of the form
{category} The form category
{ext} The File Extension
{company_name} The Company Name of the Customer
{qid=} A Global question Answer
{fw_attr_id=} A Fieldworker Attribute
{client} Customers Client Name
{agent} The Fieldworkers Agent
{fieldworker} The Fieldworker
{customer_name} Customers Name
{customer_email} Customers Email
{customer_phone} Customers Phone
{customer_mobile} Customers Mobile

Examples Forms :

  • {app_id}_{form_name}.{ext}
  • {job_id}_{form_name}.{ext}
  • {form_name}.{ext}

Variables in Data Categoriess (Images)

Data Variable Description
{app_id} The Appointment ID
{job_id} The Job ID
{file_number} A File Number
{area_number} Area Number where taken
{file_category} The name of data category
{ext} The File Extension
{block_name} Name of the Question Block Where question that required photo linked on
{combined_name} Combines {area_number} and {block_name}
{company_name} The Company Name of the Customer
{qid=} A Global question Answer
{fw_attr_id=} A Fieldworker Attribute
{client} Customers Client Name
{agent} The Fieldworkers Agent
{fieldworker} The Fieldworker
{customer_name} Customers Name
{customer_email} Customers Email
{customer_phone} Customers Phone
{customer_mobile} Customers Mobile

Examples For Images not in area :

  • {app_id}{file_category}{file_number}.{ext}

Example for Images in Area:

  • {app_id}{file_category}{combined_name}.{ext}

FAQ

Q: Will a directory always be included? A: Yes a directory will be included when there are no assets.

Q: Will the forms always be included? A: The generator only include files that relevant e.g forms that were active when the job was completed. If the form is available under the Job Files Tab it will be included in the pack.

Q: I have a file category that used in both a assessment and an installation and I want the install images only is this possible? A: Yes you can restrict assets used by an ASAP Worktype.