RpReports Globals

RpReports Globals

The globals section of the RpReports Project_settings.csv file define various globals which are used by the project.

Globals are set whenever the project is loaded, overriding any user settings.

GlobalDefaults are only set the first time a user start RpReports. The user settings are remembered in the Windows Registry, and used when the user starts SketchUp and RpReports again.

Contents

Values

[Globals]

  • srpreports_project_title - name of the product for dialogs, etc.
  • srpreports_author - this phrase appears in the PDF report as the author
  • srpreports_project_url - URL for about box
  • srpreports_support_email_name - title for support email
  • srpreports_support_email_address - address for support email

Special attribute field names

  • srpreports_component_field_name - name of field containing component name - the component name is placed in this field
  • srpreports_description_field_name - name of field containing description - ModelInfo description is placed in this field if no attributes are set
  • srpreports_package_count_field_name - name of field containing package_count - leave blank if not using package count feature. See: RpReports Package Counts
  • srpreports_total_label - word to use for total row
  • srpreports_quantity_field_label - name of field for quantity

fields for indented bill of materials

  • srpreports_sub_extend_field_name - default is "Sub Cost" # cost of an indented component
  • srpreports_sub_extended_field_label - default is "Sub Extended Cost"
  • srpreports_sub_quantity_field_label - default is "Sub Qty" # qty of an indented component
  • srpreports_indentation_prefix" # used to indent descriptions for sub-levels
  • srpreports_sub_level_field_label - default is "Lev" displays if there is more than one sub field - column is not displayed if left blank
  • irpreports_indented_bom_level - do the bill of indented materials to this level
  • brpreports_show_components_without_attributes - skip components with no attributes
  • brpreports_selected_components_only - report on selected items only


  • brpreports_show_quantity - # show quantities in report
  • brpreports_show_totals - # show total quantity and total cost/price
  • brpreports_ask_user_for_report_options - user will be asked to verify report settings -
  • brpreports_ask_user_for_report_options=true

GlobalDefaults

  • srpreports_report_title - # title for report
  • srpreports_report_intro - this appears above the picture in reports
  • srpreports_caption - caption under picture in reports
  • srpreports_body - additional text under picture in reports
  • srpreports_trailer - trailer at the end of each page inder reports

page setup defaults

  • irpreports_page_size - 0=letter, 1=legal, 2=A3, 3=A4
  • irpreports_page_orientation - 0 = portrait, 1=landscape
  • rrpreports_left_margin - in inches
  • rrpreports_right_margin - in inches
  • rrpreports_top_margin - in inches
  • rrpreports_bottom_margin - in inches
  • brpreports_launch_report - launch report when done
  • brpreports_launch_report=true

other defaults

  • irptools_copy_wizard_mode - 0 = normal copy wizard, 1 = Z copies in separate column



Sample

[Globals],,globals are always set when a project is loaded
srpreports_project_title,RpReports Demonstration,name of the product for dialogs, etc.
srpreports_author,Render Plus Systems, Inc.,this phrase appears in the PDF report as the author
srpreports_project_copyright,Copyright 2007 - Render Plus Systems, Inc., copyright phrase
srpreports_project_url,http://www.renderplus.com, URL for about box
srpreports_support_email_name,%APPP% Support Request,title for support email
srpreports_support_email_address,support@renderplus.com, address for support email
#SPECIAL ATTRIBUTE FIELD NAME,,
srpreports_component_field_name,Component,name of field containing component name - the component name is placed in this field
srpreports_description_field_name,Description,name of field containing description - ModelInfo description is placed in this field if no attributes are set
srpreports_package_count_field_name;;name of field containing package_count - leave blank if not using package count feature
srpreports_total_label,Totals,word to use for total row
srpreports_quantity_field_label,Count,name of field for quantity
#FIELDS FOR INDENTED REPORT,,
srpreports_sub_extend_field_name,Sub Cost,"default is ""Sub Price"" cost of an indented component"
srpreports_sub_extended_field_label,Sub Extended Cost,"default is ""Sub Extended Price"""
srpreports_sub_quantity_field_label,Sub Qty,"default is ""Sub Qty"" qty of an indented component"
srpreports_indentation_prefix,+,used to indent descriptions for sub-levels
srpreports_sub_level_field_label,Level,displays if there is more than one sub field - column is not displayed if left blank
#--- DEFAULTS FOR REPORTS---,,"Defaults are set the first time, but remember user values when restarted"
irpreports_indented_bom_level,0,do the bill of indented materials to this level
brpreports_show_components_without_attributes,y,skip components with false attributes
brpreports_selected_components_only,n,report on selected items only
brpreports_show_quantity,y,show quantities in report
brpreports_show_totals,y,show total quantity and total cost/price
#---CLIENT REPORT DIALOG SETUP ---,,These setting determine which features are available on the Client Report Dialog
brpreports_show_report_dialog,y,Do not display dialog at all if false
brpreports_include_report_title,y,Client can change Report Title
brpreports_include_report_introduction,y,Client can change Report Introduction Comments
brpreports_include_report_selected_entities_only,y,Client can specify - Selected Entities only
brpreports_include_report_entities_without_attributes,y,Client can specify - Show Entities without Attrbiutes
brpreports_include_report_groups_as_assemblies,y,Client can specify - Treat top-level groups as assemblies
brpreports_include_report_show_quantity,y,Client can specify - Show quantity
brpreports_include_report_show_totals,y,Client can specify - Show Totals
brpreports_include_report_set_bom_level,y,Client can specify - Indented Bill of Materials level
brpreports_include_report_launch_report,y,Client can specify - Show report when complete
brpreports_include_report_page_setup,y,Client can perform Page Setup
#Selection Dialog,,
srpreports_selection_folder,,additional folder for RpReports components
brpreports_use_sketchup_components,y,include SketchUp components on selection dialog
brpreports_place_multiple,y,"n-place and select, y-place multiple copies"
[GlobalDefaults],,Global defaults are only set if there is not a value defined yet (previous values may have been stored in the registry)
#REPORT DEFAULTS,,
srpreports_report_title,(put title here...),title for report
srpreports_report_heading,Sample RpReports report,heading for report above picture and intro text
srpreports_report_intro,,this appears above the picture in reports
srpreports_caption,Image from SketchUp,caption under picture in reports
srpreports_body,,additional text under picture in reports
srpreports_trailer,RpReports from Render Plus,trailer at the end of each page inder reports
#PAGE SETUP,,
irpreports_page_size,0,"0 letter, 1=legal, 2=A3, 3=A4"
irpreports_page_orientation,1,"0 = portrait, 1 = landscape"
rrpreports_left_margin,0.5,in inches
rrpreports_right_margin,0.5,in inches
rrpreports_top_margin,0.5,in inches
rrpreports_bottom_margin,0.5,in inches
brpreports_launch_report,y,launch report when done

Project_settings.csv file sections

See each section for data definitions and a sample.

  • [Project] - Project Name
  • [Levels] - Description of attribute and report levels
  • [Client] - Items to include on Client toolbar
  • [Globals] - Settings which are always set.
  • [GlobalDefaults] - Settings which are only set the first time the Client project is loaded, but which can be overridden by the client.
  • Sample _settings.csv file

See Also