Home / Siemens NX / Customize the Shop Documentation template data file siemens NX

Customize the Shop Documentation template data file siemens NX

You can customize how the list of the shop documentation templates appear in the Shop Documentation dialog box. You can remove, reorder, or add to this list of templates.

The shop_doc.dat is a resource file that controls the list of available shop documentation templates located in the Report Format list on the Shop Documentation dialog box. This file organizes the formats into the order in which they appear in the Report Format list and controls the look of the report output.

Below is an example of what the contents in the shop_doc.dat file looks like:

Operation List Select (HTML/Excel), ${UGII_CAM_SHOP_DOC_DIR}excel_templates\shopdoc_template_English_operation_list_select.tcl, ${UGII_CAM_SHOP_DOC_DIR}excel_templates\shopdoc_excel.tpl Operation List Select (TEXT), ${UGII_CAM_SHOP_DOC_DIR}shopdoc_oper_list_text.tcl, ${UGII_CAM_SHOP_DOC_DIR}excel_templates\shopdoc_excel.tpl

Tool List Select (HTML/Excel), ${UGII_CAM_SHOP_DOC_DIR}excel_templates\shopdoc_template_English_tool_list_select.tcl, ${UGII_CAM_SHOP_DOC_DIR}excel_templates\shopdoc_excel.tpl Tool List Select (TEXT), ${UGII_CAM_SHOP_DOC_DIR}shopdoc_tool_list_text.tcl, ${UGII_CAM_SHOP_DOC_DIR}excel_templates\shopdoc_excel.tpl

In the template list, the “#” in front of the old templates indicate that they have been commented out and do not appear in the UI.

# – Other excel templates –

# English Excel-html Letter, ${UGII_CAM_SHOP_DOC_DIR}excel_templates\shopdoc_template_English_Letter.tcl, ${UGII_CAM_SHOP_DOC_DIR}excel_templates\shopdoc_excel.tpl

# Chinese Excel-html A4, ${UGII_CAM_SHOP_DOC_DIR}excel_templates\shopdoc_template_Chinese_A4.tcl, ${UGII_CAM_SHOP_DOC_DIR}excel_templates\shopdoc_excel.tpl

# – Legacy Templates

# Operations in Part List (TEXT), ${UGII_CAM_SHOP_DOC_DIR}shopdoc_programview_text.tcl, ${UGII_CAM_SHOP_DOC_DIR}shopdoc_programview_text.tpl

# Tools in Part List (TEXT), ${UGII_CAM_SHOP_DOC_DIR}tool_list.tcl, ${UGII_CAM_SHOP_DOC_DIR}tool_list.tpl

# Operation List (HTML), ${UGII_CAM_SHOP_DOC_DIR}shopdoc_programview_html.tcl, ${UGII_CAM_SHOP_DOC_DIR}shopdoc_programview_text.tpl

# Tool List (HTML), ${UGII_CAM_SHOP_DOC_DIR}tool_list_html.tcl, ${UGII_CAM_SHOP_DOC_DIR}tool_list.tpl

# Operation List by Method (TEXT), ${UGII_CAM_SHOP_DOC_DIR}shopdoc_methodview_text.tcl, ${UGII_CAM_SHOP_DOC_DIR}shopdoc_methodview_text.tpl

# Operation List by Method (HTML), ${UGII_CAM_SHOP_DOC_DIR}shopdoc_methodview_html.tcl, ${UGII_CAM_SHOP_DOC_DIR}shopdoc_methodview_text.tpl

# Unique Tool List by Program (TEXT), ${UGII_CAM_SHOP_DOC_DIR}unique_tool_progview.tcl, ${UGII_CAM_SHOP_DOC_DIR}tool_programview.tpl

# Unique Tool List by Program (HTML), ${UGII_CAM_SHOP_DOC_DIR}unique_tool_progview_html.tcl, ${UGII_CAM_SHOP_DOC_DIR}tool_programview.tpl

# Advanced Operation List (HTML),${UGII_CAM_SHOP_DOC_DIR}general_template.tcl, ${UGII_CAM_SHOP_DOC_DIR}html_oper_list.tpl

# Tools and Operations (HTML), ${UGII_CAM_SHOP_DOC_DIR}tools_operations_html.tcl, ${UGII_CAM_SHOP_DOC_DIR}simple1_machview.tpl

# Advanced Web Page Mill (HTML), ${UGII_CAM_SHOP_DOC_DIR}mill_shopdoc_html.tcl, ${UGII_CAM_SHOP_DOC_DIR}mill_shopdoc_html.tpl

# Advanced Web Page Mill Turn(HTML), ${UGII_CAM_SHOP_DOC_DIR}millturn_shopdoc_html.tcl, ${UGII_CAM_SHOP_DOC_DIR}millturn_shopdoc_html.tpl

# Export Tool Library to ASCII datafile, ${UGII_UG_LIBRARY_DIR}export_tools_to_ascii.tcl, ${UGII_UG_LIBRARY_DIR}export_tools_to_ascii.tpl

Making Changes To The File

If you rearrange, add, delete, or comment out items from this file, it will change the display order in the Report Format list on the Shop Documentation dialog box. For example, if the Tool List (HTML) preformatted template is never used by your company, just delete it or comment it out from this list in the shop_doc.dat file and it no will longer appear in the Report Format list on the Shop Documentation dialog box dialog.

For each pre-formatted template in the shop_doc.dat, two files are specified: the Template File, and the Event Handler. The Template file can be identified by the extension .tpl and the Event Handler can be identified by the extension .tcl. All of these Template files and Event Handler files as well as the shop_doc.dat files must be located in the shop_doc_folder or contain complete file paths. The following are some suggestions for customization:

  • To make small changes to an existing format, you can edit the existing Template file.

  • For larger changes you can make a copy of the Event Handler and Template file and add a new entry to the .dat file. Then make a change to the copies.

Note

WARNING: Prior to the first time you customize any files make a copy of the entire shop_doc folder and give it a different name. All customizing changes should be made in this new folder. Otherwise, when a new version of NX is loaded, it overrides all your customized changes. Update the environment variable in the ugii environment file to point to your new folder.

Configuration File

To customize the available formats in the Shop Documentation scroll bar, make all your changes in shop_doc.dat file.

Warning

WARNING: Remember, if you are making any changes in the dialog it is easiest to keep all the Template and Event Handler files in the shop_doc folder. If you do not do this, you will receive an error and your customizations will not work.

Leave a Reply

Your email address will not be published. Required fields are marked *