Home > SI5 Documentation > User Guide > Reports > Designer > Customization Examples > Formatted Scope of Work

Formatted Scope of Work

Adding a Formatted Scope of Work to Reports

This article will demonstrate how you can add a formatted Scope of Work (SOW) to a customized SI5 report. By default, the SOW field within SI5 is a database field and thus all formatting you copy/paste into the field is removed. This method will use a Rich Textbox control vs. the actual SOW field so that formatting such as font, bullets, numbering, etc. will be respected.
 
This method assumes that you are willing to pick a specific location and file name for the Rich Text Format document that will be used to house your SOW and that you will update this file for each project as this path and filename are going to be hardcoded into the report, i.e. – you will be using this same file for every project.

 

Tip: once done running your reports for a project, to keep a copy of the SOW document for each project by using the Add a File to This Project function.

  1. Create a folder somewhere on your machine. In this example the folder is on the C: drive and is named “_D-Tools SOW”.

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/localfolder.jpg

  1. Open a new document in Word and immediately do a Save As to save the file as a Rich Text Format document and save to the folder created in step 1. Name this file something appropriate, in this example it is named SOW.rtf.

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/rtfdoccreation.jpg

  1. Edit the RTF document to reflect the SOW for the project for which you wish to run this report then save and close the file. Simple example below showing different font sizes, colors, etc.:

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/sowtext.jpg

  1. Open the Report Designer (Tools->Report Designer->Standard Reports) and choose to create a “New Report Based on Existing Report:

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/nrw1.jpg

  1. Select the report where you want to add the SOW and click Next. In this example I am using the Proposal With Images report.
  2. Name your report on the next step then click Next through all the rest of the steps of this wizard until you get to the last step, then click Finish.
  3. I only want the SOW to print once so I will be using the ReportHeader1 section (where our the cover page is on our stock proposal reports). First thing to do is stretch the ReportHeader1 section to make some room at the bottom:

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/makeroom.jpg

  1. Drag over a PageBreak control from the Toolbox and place beneath the Company Address field:
  2. pagebreak.jpg

  3. Drag over a RichTextBox control and place beneath the page break control. Resize the control as needed. It is also good practice to name the control something appropriate in the Properties window. I chose the name “rtbScopeOfWork” to indicate that the control is a RichTextBox vs. a Label or a Text Box as well as let other user know what the control is used for.

richtextboxcontrol.jpg

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/renamertbcontrol.jpg

  1. If you want, add a Label control that displays “Scope of Work” above the RichTextBox control, but beneath the PageBreak control. In this example, I copied and pasted the two gray gradient shape and text box (that displays “Proposal”) and changed the wording to “Scope of Work”:

addlabels.jpg

  1. Double-click the RichTextBox control and remove the text “RichTextBox1”.
  2. While the control is still selected, right-click and choose “Load file…”:

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/loadingthefile.jpg

  1. Browse to the file you created back in step 2. You will now see your text displayed in the RichTextBox control:

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/loadedfile.jpg

  1. Click the [Save for Later] button. You must do this.

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/saveforlaterbutton.jpg

Now we must add some script to the report to make it pull in any changes we make to the SOW.rtf document.
 
  1. Click the Script tab along the bottom of the report “canvas”:

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/scripttab.jpg

  1. In the “ReportHeader1_Format” section, add the following line of code, substituting the name of your RichTextBox control and path to your file.
 
ReportUtilities.SetRTFControl(rpt,”ReportHeader1”,”rtbScopeOfWork”,”C:\_D-Tools SOW\SOW.rtf”)

 

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/scripting.jpg

  1. Click the [Publish Report] button:

File:Si5Wiki/SI5/10Reports/05Designer/xCustomization_Examples/Formatted_Scope_of_Work/publishreportbutton.jpg

  1. Run your report and verify that your SOW displays on the second page (first page is the cover sheet):

finisthedreport.jpg

  1. To test that this is dynamic, go make a change to your RTF file, save and close it, then re-run the report to verify that your changes display:

rerunofreport.jpg

You must to post a comment.
Last modified
15:52, 26 Nov 2013

Tags

This page has no custom tags.

Classifications

This page has no classifications.