This information and tools are provided to help resellers or affiliates develop and deploy 3D Inspection packages that include or are bundled with custom content. The same "content" requirements apply to target products bundled with a focus edition or for use with any other edition.  However any user who wishes to produce content bundled with another edition must be using a full-featured Premier edition.  To verify that you are using a Premier edition, use Help > About 3D.  If your About window does not indicate a current version "Premier" edition, you must upgrade first.  The Sales department may assist in that regard.

The information below covers basic redistributable content development. It may be helpful to print this information for reference. Topics covered:

Developing Focus Data in a Separate folder
Focus Edition Requirements (applies to all editions)
Using the Focus Deployment Wizard
Submitting Your Data for approval and bundling

DEVELOPING FOCUS DATA IN A SEPARATE FOLDER

Although not required, for development purposes, we recommend developing or copying your custom Focus content to a folder separate from the main program data folder you use normally for your personal use. Here's how:

  • Use Explorer to create a new folder for your focus content.  We suggest creating a new folder under your Documents folder, perhaps named something like "3D Focus Data"
  • Copy any existing content developed for your custom product into the folder.
  • Use report writer Preferences > Preferences, File locations tab to note your existing "Location of data files" (you will need to switch back to this later to return to your normal content in use).  Next use the browse button to the right of the Data folder location to select your new content folder that you created.  Save your changes in Preferences and close the 3D program.
  • Re-launch your 3D program.  It will now use your new Data folder to load in forms, actions, documents.  Your existing version 12 Office Management database will remain loaded.
  • Now you can work on adjusting the various actions, documents, or forms so as to be suitable for re-distribution.  For instance, be sure to remove any company specific information you may have hard-coded into your items and replace it with appropriate Company merge fields (you may want to do this to your own content as well).   Adjust the Actions pane to remove any proprietary items that launch items that you cannot re-distribute.
  • Whenever you wish to switch back to your original content, simply use report writer Preferences > Preferences again to change the data folder as appropriate, and close and reopen 3D.

Note: If you are developing other Focus products, repeat the above steps for each product, simply using a different folder for each.

Once you have your custom Focus content together in a folder, you can easily customize it as desired by switching to that folder and use the Focus Deployment Wizard to collect and submit it (covered later in this document).

FOCUS EDITION REQUIREMENTS
 Focus Editions should contain (at least) the following items:

1. PAGE SETUP ITEMS- General layout for printing narrative reports, and the Header/Footer and Index documents, accessed from report writer File > Page setup. These items must be included:

Header/Footer Document (letterhead) for reports and attached documents.

  • Tip: To use a different or suppressed header and/or footer on the first/cover page use Insert > First page header/footer.  Leave area empty to suppress header or footer. Use Insert > Header/Footer to edit the header or footer areas that apply to all following pages of report.
  • Insert a table in header or footer areas for easier formatting, especially to place information side by side. Table borders will not print unless you set them to.  Insert > Office Management Fields, Company Information items to include merge fields in a table cell to automatically import the end users information. Use Insert > Logo to include a field to automatically import the users logo. To work properly, a logo field MUST be within a table cell. See help for Logo feature information. You may choose to include company and logo information in the index or a separate cover document instead if you prefer. 
  • While editing header/footer document, use File > Page Setup to adjust margin settings.  We recommend distance "from edge" settings for header and footer areas use a minimum of 0.50". Otherwise, header or footer items may fall too high or low for some printers, although visible in previews or PDF.  Also note the regular top and bottom margin settings used in this document, as you should to use the same top and bottom margins in other documents typically attached to reports so they format on-screen the same as they will with the report.

Index Document (attaches to new reports when created and merges at print time):

  • Index document should minimally include index merge fields for Sections and Page, each within their respective table cell.  You may opt to combine TOC information in the document with a cover page, contract, or general information.  Use Ctrl+Enter to add hard page breaks between items.
  • While editing index document, use File > Page Setup to adjust document margin settings. Set the top and bottom margins to match the header/footer document top and bottom margins.  Index document MUST have its properties set to print with the report. 
  • Use the Insert menu to include Office Management fields for importing job specifics where desired. Use Insert > Cover Image to specify a location and size for cover image of the property if desired.

Page Setup layout (font and margin settings):

  • Save a main Page Setup layout to select in the Deployment wizard, by using Report Writer File > Page Setup.  Click Page Setups > Save Layout Template to save your layout as an LTP file. You will later select that file as your default Page Setup in the Deployment wizard. The Focus Deployment wizard will automatically adds the word Install to the filename, and automatically include attached Header/Footer and Index Documents. Later when your users launch 3D the first time, the Install*.ltp file is automatically installed as the new PageSettings.dat file, and any user's prior PageSettings.dat file is renamed to OldLayout.ltp.
  • In Page Setup, if you used any custom Templates for any Page Setup items instead of Style settings, you will need to also select those particular PLT files using the Other Files area of the Deployment wizard.  OR you may save a specific LTP layout and attach that to the specific forms you are distributing, and recompile them, so that all applicable items are automatically included with the distributed forms.  If you only used "styles" for all Page Setup items, then this does not apply to you. Any override PLT templates used in your forms themselves are automatically included in your form backup, so those do not need to be selected manually in the Deployment wizard.
  • IF you include additional Page Layouts as Actions for an end user to quickly load, you may not select one of those LTP files as your default layout in the Deployment wizard. The file selected there must be a separate filename (e.g. Default.ltp ) from the layout filenames attached to the Actions. If you want one of those same layouts to also load as the default, save the same layout to two names or make a copy of the saved layout file and choose that copy as your page setup file in the Deployment wizard.  We do not recommend distributing additional page layouts as actions if it is not necessary.

2. REQUIRED DOCUMENTS- The following type document items are required:

  • Summary Document containing at least one summary merge field.
  • Cover Page containing merge field for the cover image. (Note: the cover image may and usually would be combined with the index or summary if desired)
  • (Optional) Any additional .W3D documents that add value to your product (contracts, agreements, re-inspection documents, etc) may be included. You may want to include at least one extra empty or generic spare document for end users to use for any purpose, since they may be unable to create new documents directly.

All included documents should usually have their Inspection document properties set to automatically print with the report.  Use the document editor File > Inspection Document Properties to do so.

Use File > Page Setup to adjust margin settings for each document. Set your margins to match the margins used in your header/footer document. That way users will see pages break on-screen while editing the documents as they will format when combined with reports.

All included document attachments (.W3D files) must have TWO Report Writer Actions. One set up to edit their template (Report Writer: Open an existing document for editing) and another to attach them to inspections (Report Writer: Attach a new document to the inspection OR Attach a file to the inspection) because Focus editions do not include a separate Word Processor for managing documents.

All documents attached to Actions will be automatically located and included by the Focus Deployment wizard without you having to manually include them.

Note: Documents used with inspections may be set up on the Actions pane as Attached Documents (Report writer- Attach a new document to the inspection) when it should be part of the main client report, or as Attached Files (Report writer- Attach a file to the inspection), rather than Attached Documents when it should be treated as a separate entity with its own headers or footers independent from the main report.  Keep in mind that "attached files" (vs "attached documents") cannot be included in the "report" preview, or exported there along with a report to another standard format, like Word.  Thus, "Attached Files" are most useful for related items that are not necessarily an integral part of the actual report itself, but could be related to the job. For example, items such as thank-you letters or manufacturer handouts. Attached files may be any type of item, although W3D files can append to the actual report printout itself. See report writer documentation for details.

Images: If including any documents originally created in a prior version, we recommend re-inserting any images within them fresh.  Images inserted in prior document formats may have been inserted using an older mode that may be prone to formatting or quality issues.

Office Management Merge Fields: Be aware that Focus and Standard edition users do not have the ability to adjust their Job Details (custom) fields.  A limited number of Job Details fields come pre-installed with such editions.  If you are merging information from the Job Details tab in Office Management, please check with 3D as to the default field configuration to verify whether such fields will work or whether you may want to omit or change merge fields used in your content.  Optionally, resellers developing custom focus content may opt to include a fields definition file for new users for new database setup- check with 3D for details.  This would not affect existing users who already have a database and wish to add your content.

3. ACTIONS PANE- Your user will do nearly everything from the Actions pane. You may include a variety of actions to handle these functions:

Attach and Edit documents: For each Document you include, you MUST:

  • Include a Report Writer- Open an Existing Document for editing Action
  • Include a Report Writer- Attach a New Document to the inspection type Action (or in some cases Report Writer- Attach a file to the inspection)
  • Use Word Processor File > Inspection document properties to set it to print with inspection

(Optional) Website Link Actions: Use Open a File type actions to link to website URLs:

  • 3D Website: http://www.3dinspection.com/applink/home
  • Support: http://www.3dinspection.com/applink/tech
  • Forums: http://www.3dinspection.com/applink/bb
  • Your own website for user updates, information, etc
  • Useful industry links. Note: Using the action type Miscellaneous- Open a File uses file associations to launch the website using user's default preferred browser. However, windows file associations may not properly launch certain special web domains (such as .gov websites), in which case you may need to use the action type Miscellaneous- Launch an Application instead along with a command line argument. In such cases, the command format would be explorer http://www.website.gov

Welcome / Instructional document: Include a Miscellaneous- Open a file type Action that links to a PDF document providing an overview of your product and how to use your included content. See item 5 below for suggestions.

Optional Actions:

  • Actions to quickly change report screen for certain tasks. Use Report Writer: Memorize Screen Configuration actions to create as desired.
  • Add a form type actions for use on the fly. Focus users do not have the ability to add forms to an existing report, other than what you may provide this way. They do have the ability to add or adjust forms or form groups in the Custom Form Studio.
  • Useful handouts or reference material pertaining to your product or industry
  • Special graphics for use in reports. Be sure you own or have distribution rights for any graphics you include.

Note: Some actions not available in Focus editions should NOT be included:

Any Word Processor type Actions Not Included
Report Writer- Insert a Standard Paragraph Not Included
Custom Form Studio- Edit Graphical Form Layout Not Included

The Focus Deployment wizard automatically renames the Actions.dat file you select to "Install Actions.dat" for proper distribution. When 3D is launched, new actions from the Install Actions.dat file are added to any existing actions.

4. FORM SETS
At least one form group should be included. Additional value may be provided by including others. Create form distribution files using the Custom Form Studio:

  • Right-click form group in Custom Form Studio and Compile. 
  • Review compile log to make sure there are no errors or warnings that need correcting.
  • When finished, right-click group again and use Backup/Distribute Group. For normal distribution, choose to include uncompiled forms in backup. Otherwise use custom options as desired.

Note: If you included any Add a form type actions, make sure those forms are included within a form group you distribute. If any Add a form items are not already included in your main groups, then you will need to create a new group in the Custom Form Studio to include them, perhaps called Xtra Add a Form group, and drag the additional files into it. You do not need to compile that group- simply right-click and Backup/Distribute Group to create a 3DF for inclusion.

The Deployment Wizard automatically adds Install to the 3DF filenames you include as Form Sets so they will install automatically at initial launch if they do not already exist.

5. WELCOME / INFORMATIONAL DOCUMENT
We recommend including a brief PDF attached to Actions explaining your custom product items in your product to your user/buyer.  Consider including information such as:

  • the intended usage of various documents included in Actions
  • information about other Actions included, or any special items
  • how to label the summary menu for the categories used in your included summary document or forms
  • other useful information to understand how to use your content or method. For example, special abbreviations you might use, etc.
  • your contact information should there be questions/suggestions about your product
  • additional services or items you offer to inspectors, such as training, etc.

Make your welcome document friendly and brief. You may include a few pointers on getting started, but there's no need to include detailed explanations about 3D features already covered by the program HelpDesk tutorials and guides.

An easy way to produce your document is to create it using the 3D Word Processor, then preview and Save > PDF. Add an Action Miscellaneous- Open a file and choose your PDF.

Note: During certification review, the reviewer only verifies that the basic items needed for a focus version to work are "present".  If any potential issues or obvious mistakes are noticed, these may be mentioned, but detailed proofreading of documents or forms and testing how they work is your responsibility.

USING THE FOCUS DEPLOYMENT WIZARD
Content for custom products must be managed and submitted using the Focus Deployment wizard, downloadable here: 
https://downloads.3dinspection.com/index.php?category=39
This streamlines development and certification process for bundled product content, and allows you to manage and easily rebuild projects when content is updated.

Note that the Focus Deployment Wizard may be used to collect data for direct distribution to another user without submitting it to 3D.  The recipient may simply use the File > Install reseller content option in Office Management to select the forms.zip file you provide them to add your content to their existing program.  For data that will be bundled as a focus edition product, it must be submitted to 3D and meet all necessary requirements.

SUBMITTING YOUR DATA
Note that a minimum annual sales commitment applies to focus bundled editions.  Please contact sales regarding current requirements, and if applicable provide us with the following items to complete your product (otherwise you may simply distribute content directly without a bundled focus product):

  • The forms.zip content file created by the Focus Deployment wizard
  • A brief readme.txt file for Message from the author information to appear on the product download page. Example wording might be something like this:

Welcome to the [NAME OF YOUR PRODUCT] package, designed to help you produce a professional [TYPE OF REPORT] inspection. After installing, please review the [NAME OF YOUR WELCOME DOCUMENT ACTION] found on the Actions side pane in the software for useful tips and details about the included items.

If you have questions or suggestions about the included forms and documents, please contact us at [YOUR CONTACT INFO].

If you need technical assistance with installation, please contact 3D Inspection Systems technical support at: http://www.3dinspection.com/applink/tech

Thank you and enjoy your new software!

To create your readme.txt file, use Start > Programs > Accessories > Notepad. Enter the text you want to appear on your installation screen, then close and save the file as readme.txt
If desired, you may choose to include your readme.txt along with your product content in Other Files in the Focus Deployment wizard.  Be sure to let the reviewer know if you have included this information here or have updated it since your last submission.

  • Provide your logo for the product download page and shopping cart.  Please format logo as a 221 x 92 pixel graphic file.
  • Let us know the name of your product
  • Up to 225 character product "Brief description" for the shopping cart index.
  • A longer full Product Description sales pitch for shopping cart details.
  • The retail price you wish to charge (your net profit will be the price minus the program wholesale cost)

Please submit the forms.zip and other items to the attention of Donna using a support ticket.

Once updated product content is certified, your Focus product can be built or updated for sale. To list the finished product for sale on our website and a shopping cart, we'll need your Product Description wording.