Digabit Inc.
Welcome, Guest Login

Digabit Support Center

Creating New Interactive Parts Pages - The Definitive Guide

Last Updated: Jan 11, 2017 10:55AM MST

Creating a New Interactive Parts Page

Using Docustudio publishers are able to create interactive parts pages with static images and bill of materials or parts lists. If users have .SVG diagrams or files available, Docustudio is able to automatically hotpoint the images and match them to the bill of materials list. Below are instructions for creating a new page, adding a BOM and diagram, using the auto-hotpoint feature and instructions for manually hotpointing interactive parts pages.

Creating a Blank or New Parts Page

1.Login to Docustudio.
2.Verify preferences or ‘Settings’ that automatically populate.
3.Click on the ellipsis icon  to check that the interactive pages you create (.plz files) will save in the correct location.
4.Check that ‘Default Tenant’ and ‘Default Supplier’ are correct for the parts pages you will be creating.
5.Uncheck all ‘Process Instructions.' (This ensures no Part or Page Tag data will be lost on upload. You can check these when you understand the advantages/disadvantages to these settings.)
6.Uncheck ‘Callout Properties.’ (Check indicates that hotpoint callouts should be transparent.)
7.Check ‘Lookup Properties.’ (Check indicates that a part lookup will be conducted any time a new BOM or parts list is imported.)
8.Click on the ‘Java’ tab at the top of the ‘Settings’ window.
9.Check that the ‘Java Executable’ file field is connected to the Java Jre8 program file. (Note: If there is no information in this field, follow instructions: How to Link Docustudio to Java.)

 
 
 
10.Click ‘Save.’

 
11.On the top left of the Docustudio file ribbon click the ‘New’ icon.
12.In the ‘New’ parts page filename window enter a valid ‘Filename.’
 
Note: You should have a predetermined file naming process. We recommend using the following file name protocol method: Catalog/Book Name_Page/Diagram#
Example. T500XD_2-3_3.

13.Determine if you are creating this page with one locale name and description (translation), or if you are adding multiple translations. If you are creating this page with your default locale (language) only, add an ‘[Default Locale] Name’ and ‘[Default Locale] Description.’ 


Note: You should have a predetermined display naming process. We recommend using the following name protocol method: Page/Assembly Name
Example: Jib Boom Hydraulic Exploration
14.If you are adding more than one page name and translation, select the ‘Multiple Translations?’ checkbox and click ‘Add’ in the ‘Translations’ table that appears in the 'New' window. Enter a Translation (i.e. page display name) for your page. Click ‘Add’ again to add any additional page name translations and page description translations.

15.If needed, click the ‘Add’ button in the ‘Tags’ area to add any tags you would like to associate to the new parts page.
16.Click the ‘Create’ button.
 

 

Add the BOM or Parts List to the DocuStudio Page Publisher

Ideally, your Bill of Materials (BOM) should be available in column-delimited format (i.e., Microsoft Excel) The first 1 through 7 steps in the process describe how to copy a parts list from an existing PDF catalog into Excel. If you already have the BOM in Excel format, start at step 8.
1.Open the BOM page in the PDF parts catalog.
2.Open a blank Excel document.
3.Hold ‘Alt’ on your keyboard and drag your mouse over the first column in your BOM.
4.Copy the entire column by letting go of ‘Alt’ and pressing ‘Ctrl’ and ‘C’, or right click on your mouse and click ‘Copy.’

5.Go to your open Excel file and click on cell ‘A1.’
6.Paste the copied information in that cell.
7.Continue copying each column from the PDF into the Excel document following steps 1 through 6.

8.Copy all fields that contain information from Excel (ex. In this spreadsheet you would highlight cells A1 through E23 and copy).

9.Open DocuStudio and click the ‘Import BOM’ button  in the ‘Page’ ribbon. 
   Note: You can also left click on the BOM Panel and Paste the BOM using the hot key Ctrl + V
 
10.Drag and drop column headers into the appropriate columns from the list on the left to the headers on the right above the BOM columns.
11.Once everything matches up, click the ‘Import’ button.

Adding a Diagram to a Parts Page

Images can be added to the Diagram field in one of two ways. The first is a simple copy and paste using keyboard controls (i.e. ‘Ctrl V’ to paste) to paste copied diagrams into the blank ‘Diagram’ area of the Docustudio page window. The second way to add images is described below.

1.To add an image from a saved file on your computer, click on the ‘Add Diagram’  button on the top right of the ‘Page’ ribbon.
2.Find the image in the correct file location.

3.Click ‘Open.’
4.Additional diagrams may be added to your page by following the same processes (either using ‘Ctrl V’ to paste a copied image into the Diagram window, or following steps 1 through 3).

Auto-Hotpointing a Diagram

Utilizing several OCR (Optical Character Recognition) algorithms, Publishers are able to customize Auto Hotpoint settings to auto hotpoint their raster and vector based images. Publishers are able to skip the manual hotpointing process and use Docustudio’s Auto-hotpoint feature. Below are instructions for auto-hotpointing diagrams:
1.Open the parts page file (.plz format) that needs to be auto-hotpointed by logging into Docustudio and clicking "Open" in the file toolbar to find and open your PLZ file.
2.Select the ‘Hotpoint’ button  in the top right corner of the Diagram pane to enter into Hotpoint mode.


3.In the Diagram toolbar, click on the Auto Hotpoint icon .
4.An ‘Algorithm’ drop-down will appear.

5.Select the algorithm that best fits your diagram type and callout type.

Auto Hotpoint Algorithms
 
Algorithm Options Description Call-Out Example 
SVG None Ideal algorithm to use for SVG images. Reads the item numbers in the SVG XML information.
 
Any SVG image, unless the SVG XML is formatted incorrectly.
Blob Finder Min/Max Area Reads pixels and floods or fills the lines in the diagram to find standalone pixels that represent callout item numbers. Settings allow you to erode bold and dilate faint item numbers.
 
Contour Shape Circle, Triangle, Square, Hexagon, Min/Max Area Searches for the callout shape and then the callout item number within the callout shape based on the min and max area set.
Template Matching None Matches item numbers based on an XML file that contains the number formats and matching thresholds. Meant only for organizations that have callouts that are consistent across all of their diagrams (both font and text size), and must be created by Digabit Service Engineers. Only used by customers who have customized XML files containing their call-out font and size formats.
 
 
6.If you have selected ‘Blob Finder’ or ‘Contour Shape,’ configure the following settings:
  • Min Area: This setting limits the minimum pixel area that the algorithm will attempt to find item numbers within. It sets a threshold for the minimum size that an item number could be in pixels. For example, if you set the minimum area to ‘1’ then the algorithm will search for item numbers as small as 1x1 pixels, and will likely hotpoint extra lines that are not actually item numbers.
  • Max Area: This setting limits the maximum pixel area that the algorithm will attempt to find item numbers within. It sets a threshold for the maximum area that an item number could be in pixels. For example, in the ‘Blob Finder’ algorithm, if you set the maximum area to ‘100000’ then the algorithm will attempt to flood the image with thousands of additional pixels to retrieve item numbers, and will likely hotpoint extra areas of the diagram that are not actually item numbers. 
  • Shape (Contour Shape Only): Selects the shape type surrounding the item numbers in the diagram.
7.Click ‘Process’ when all of your settings are configured.
8.To retry auto hotpointing the diagram with different settings, simply change the settings and click the ‘Process’ button again. Continue to adjust your settings as needed to optimize the auto hotpointing algorithms.  
NOTE: Always check and review your diagrams for accuracy when manually OR auto-hotpointing diagrams.
9.In the Diagram toolbar, click on the Increase Hotpoint Size icon to enlarge the hotpoints.
10.In the Diagram toolbar, click on the Outline Mode  icon to toggle on/off the hotpoints and verify that they are numbered and aligned correctly.
11.Use the cursor to drag any hotpoints around the image in order to realign.
Note: You may also use the Shift + Arrow keys to move hotpoints more precisely.
12.Save your new interactive parts page Docustudio by going to: File > Save.
Note: See ‘Docustudio User Guide’ for detailed descriptions and definitions on the purpose of each icon in the Diagram toolbar. See ‘General Hotpointing Tips and Tricks’ for tips, tricks and best practices when hotpointing diagrams.

How to Manually Hotpoint a Diagram

Publishers that are adding diagrams that are do not contain call-outs that can be optimized for Auto Hotpointing have the option to manually hotpoint their diagrams. This process is simple, but does require attention to detail to ensure accuracy. Below are instructions for how to manually hotpoint a diagram:
1.Start by creating a new page. Once the BOM and Parts Diagram has been added, manual hotpointing can begin. Alternatively you may also download an existing page from the server to make changes.
2.Select the ‘Hotpoint’ button  in the top right corner of the Diagram pane to enter into Hotpoint mode.

3.In the Diagram toolbar, click on the Hotpoint   icon.
4.Within the BOM, click on the item number that you want to add a hotpoint for in the diagram; Docustudio will highlight that item line in the BOM.
5.Now click on the diagram callout where you would like to place the hotpoint; Docustudio will add a hotpoint and that point will be associated to the BOM item selected.

6.Repeat steps c and d above for all items in the BOM.
7.In the Diagram toolbar, click on the Increase Hotpoint Size icon to enlarge the hotpoints.
8.In the Diagram toolbar, click on the Outline Mode  icon to toggle on/off the hotpoints and verify that they are numbered and aligned correctly.
9.Use the cursor to drag any hotpoints around the image in order to realign. 
10.Save your new interactive parts page Docustudio by going to: File > Save.
Note: See ‘Docustudio User Guide’ for detailed descriptions and definitions on the purpose of each icon in the Diagram toolbar. See ‘General Hotpointing Tips and Tricks’ for tips, tricks and best practices when hotpointing diagrams.

General Hotpointing Tips and Tricks

  • Select individual hotpoints by clicking on them when there are no active icons on the Diagram tool bar.
  • Select multiple hotpoints by dragging your mouse across the hotpoints you would like to select when there are no active icons on the Diagram tool bar (works similar to standard rectangular selector features in most software programs).
  • Delete hotpoints by selecting them (either individually or in groups) and clicking ‘Delete’ on your keyboard.
  • You can also use the keypad or keyboard to select items in the BOM for quicker hotpointing.
  •  Use the magnifying glass icons on the Diagram tool bar to view diagram at 100% zoom, zoom in or zoom out.
  •  Select the ‘H’ icon to place a hotpoint in the diagram associated with the part you have highlighted in the BOM list.
  • Select the ‘L’ icon to add a hotpoint link to the diagram. 
  •  Select the Outline Mode icon to view only the outline of all existing hotpoints.
    • Use this to check that your hotpoints correctly match up with the right callouts in the image (i.e. compare the number on the hotpoint to the callout number it is covering in the diagram).
  •   Select the Auto-hotpoint icon to auto hotpoint your diagram using the auto hotpoint options and configurations described in the ‘Auto Hotpointing a Diagram’ section of this guide.
  •  Use the Increase/Decrease Hotpoint icons to increase or decrease the size of ALL existing hotpoints in the diagram.
  •  Use the Auto-Align icons to horizontally or vertically align a selection of hotpoints automatically.

Housekeeping Hotpoint Tips

  • Always try to center your hotpoints to match up with the original image file’s callouts.
    • Example: Strive for this  instead of this 
  • Make your hotpoint size close to the size of the callout.
    • Example: Strive for this   instead of this 
  • Above All – ALWAYS double-check your manually hotpointed and Auto-Hotpointed diagrams. While Docustudio is generally very accurate when Auto-hotpointing, some lines or double-digit callouts can cause the Auto-hotpoint feature to incorrectly identify or match something on the diagram with the wrong lines on the BOM. 

Contact Us

Current System Status

support@digabit.com
http://assets1.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete