Cable and Harness Report Generator In This Exercise

Cable and Harness Report Generator In This Exercise
Cable and Harness Report Generator
In This Exercise
The Report Generator is unique to Autodesk
Inventor Professional Cable and Harness. It
is a powerful tool for providing information
such as a bill of materials, wire run list, or
connector tables for your harnesses.
This skill builder provides the answers to
your most frequently asked questions about
the Report Generator. Specifically, it:
■
■
■
■
Provides tips on using the Cable and Harness ReportGenerator.
Describes the workflow for creating
reports
Explains key options and how they are
related.
Lists the properties you can use when
setting up reports.
Tips To Get You Started
■
■
■
■
■
■
■
■
The Report Generator can only view report configuration (.cfg) files that are created and edited using
the Report Generator. You cannot use Microsoft Excel, Notepad, or similar applications.
To reduce input time and errors, start with an existing .cfg file from the Report Generator samples directory. Use it as is, or edit it to meet your needs. The default location is C: Program Files\Autodesk\Inventor
Professional <version>\Cable & Harness\Sample\Report Generator
Only use the sample .cfg files from the Report Generator sample folder. Do not use .cfg files from the
Wire List Import or Wire Library directories to generate reports.
Store the .cfg files used with the Report Generator in a shared location, such as on a server, to provide
access for all required users. These .cfg files are not specific to a particular harness or drawing.
It is recommended to disable the Print filter information, Print head, or Print information options when
you create reports for tables on the nailboard drawing. They affect the parsing of the data when the table
is created.
Properties are not case sensitive, but case sensitivity is maintained once a property is entered in the
Report Generator.
The harness assembly must be fully up to date before running a report.
Only segments with wires or cable wires routed through them are included in reports.
Workflow for Creating Reports
1. Start Autodesk Inventor Professional and activate a harness assembly.
2. Click the Report tool on the Cable and Harness toolbar.
3. Optionally, click the Edit Configuration File tool on the Report Generator toolbar to create your own
configuration file or rename and customize a sample configuration file.
4. Click the Create Reports tool on the Report Generator toolbar, click Add File to List, and navigate to and
select one or more configuration (.cfg) files to process the data. You can use the sample files or your own.
5. Click OK to create the report.
Frequently Asked Questions
Which configuration file do I use?
Always use the configuration files in the Report Generator samples directory (default
location C: Program Files\Autodesk\Inventor Professional <version>\Cable &
Harness\Sample\Report Generator).
As mentioned previously, Autodesk Inventor Professional also uses configuration files
to import wire lists into the application and the Cable and Harness Library. Do not use
these files in the Report Generator, because they have a different format and will not work for reports.
To determine which sample file to use, navigate to the Report Generator samples directory, select a
configuration file name that looks appropriate for the report you need, and then open the file and read the
summary in the Information tab. For example, suppose that you want to run a bill of materials report for an
active harness. To find the file you need:
1. Start Autodesk Inventor Professional and open a harness assembly of your choice. You can use one from
the Samples directory or one of your own.
2. Activate a harness assembly, and then click the Report tool on the Cable and Harness toolbar.
3. In the Report Generator dialog box, click the Edit Configuration File tool on the Report Generator toolbar.
Cable and Harness Report Generator
2
4. Select the .cfg file to edit. For this example, navigate to and select part_splice_wire_cable_BOM.cfg
5. In the Report Generator dialog box, click the Info tab to verify that the report will provide the information
you need.
6. Close the dialog box.
You may find the sample configuration files provide all the report information you need. You can use these
configuration files as they are, or you can use them as a base for your edits. You can also start from a blank
file to create an original configuration file. In this case, the Information tab is where you would include the
description of your custom file.
How do I determine the objects to include in the report?
The options you click under “Select objects to report” specify which harness objects you want to include in
the report. You may select one, some, or all objects.
The objects you select here determine what is included in the report, as well as the values that are available
in the Table tab, Link Type row. If you choose to include cables in your report, you can also choose to include
spare (unterminated) cable wires. By default, spare cable wires are not included.
How do the object filters work?
Under “Object filters”, the Property Names, Property Values, and Exclusion Property work together to
indicate items to include or exclude from the report. All are dependent on the properties you set on the
harness object when it is created or edited.
Cable and Harness Report Generator
3
To include all property names or values, check All.
■
■
To restrict reports to objects with a specific property name, clear the All selection and specify the property name or value.
To omit an object with a specific property name and value, enter the property name to exclude from the
report. You can also enter a value, but you must enter a property name first. This setting is most often
used when All is checked.
How do I use an exclusion property?
Valid exclusion properties include any property defined for a harness object in the active harness. The
exclusion Value is optional. If you choose to enter a Value, you must first enter the Name.
You can find an example of exclusion in the part_splice_wire_cable_BOM.cfg file. In this file, the exclusion
property is BOM and the value is False. To make this exclusion setting work for the report, you must add a
custom BOM property to the harness objects you want to exclude from the BOM.
To see an example of the exclusion property at work:
1. Open the Rack Enclosure.iam in the Rackmount Enclosure sample directory.
2. In the browser, activate the D Sub Cable harness assembly.
3. Click the Report tool, click the Edit tool, and then open the part_splice_wire_cable_BOM.cfg for editing.
4. Verify that the exclusion property is set as shown.
5. Click the Create New Report tool, select part_splice_wire_cable_BOM.cfg, and click OK to run the report.
Cable and Harness Report Generator
4
6. Notice there are 3 items in the report including the cable with the part number 1179C.
7. Now add a custom BOM property with a value of False to the harness objects you want to exclude from
the BOM. In this case, the custom property shown below was added to the cable, with the Cable ID DS1.
Property name
Property value
8. Run the report again. This time, notice how the cable is excluded from the report.
Cable property name 1179C included
Cable property name 1179C excluded
How do I get a quantity for a harness object?
Quantity by property name sets a property value used to group like objects for quantity calculations. The
calculation provides a total length or part count total. Valid properties include any property name used in the
Table tab. This setting is also dependent on certain settings in the Table tab.
For example, to get a total length for a wire, you must set the Quantity by property name to Part Number on
the Filter tab. On the Table tab, include a Length or Adjusted Length column and add a Quantity column. To
see an example:
1. Activate the D Sub Cable harness assembly in the Rack Enclosure.iam, click the Edit tool, and then open
part_splice_wire_cable_BOM.cfg for editing.
2. On the Filter tab, make sure Quantity by property name is set to Part Number.
Cable and Harness Report Generator
5
3. On the Table tab, include a Length or Adjusted Length column, add a Quantity column, and enter the
Length or Adjusted Length property and Quantity keyword.
Property
Keyword
4. Examine the results. Notice how the report includes the total length for the cable and a part count for
each electrical part.
Total length
Part count
Can I reorganize the table?
You can add and remove columns and specify new column headings, but you cannot make changes to the
text in the default column and row headers. Although you cannot drag a column to change the order of
existing columns, you can change the order.
1. Add a column in a new, designated position.
2. Transfer the data (re-enter or cut and paste contents of each cell) from the previous column location into
the new column location.
3. Delete the column in the previous location.
What is a Link Type?
Once harness objects such as parts, wires, cable wires and/or harness segments are placed into an
assembly, they have a relationship to one another. For example, a harness segment contains a wire, the wire
is connected to a pin, the pin is on a part, and so on. To traverse through the hierarchy of these relationships,
you use link types. These relationships can be traversed through the hierarchy of the harness objects to view
the connectivity as well as the object definition and occurrence level properties placed on the objects.
A good example of the need for link types is for a wire run list where the main items in your report are wires
and cables, but you also need the information on the related parts and pins. Link types such as GETPIN1,
GETPIN2, GETPART1, GETPART2 enable you to get information on harness objects on both ends of the
wire.
Part 1
Pin 1
Wire 1
Wire 2
Segment
Cable 1
Cable and Harness Report Generator
Wire 1
Cable 1
Part 2
Wire 2
Pin 2
6
The values available in the link type cells are dependent on the objects you select on the Filter tab. If a single
harness object is selected on the Filter tab, then all link types available for that object are displayed in that
dropdown list. Link types are not supported when more than one object is being filtered, so the value is
NONE. The exception to this is Wires, Cable Wires, and Parts, Splices object pairs. These harness object
pairs have the same set of link types, so all the link types are displayed in the table.
For a complete list of link types for each object type, search for “link types” in the online Help.
To experiment with link types:
1. Open a sample configuration file for editing, such as part_splice_wire_cable_BOM.cfg.
2. Select different combinations of objects to include on the Filter tab and examine the affect of your selections on the link type values. Try selecting:
■
an individual harness object
Single item selected
■
multiple objects
Multiple objects selected
■
one of the harness object pairs (Wires/Cable Wire or Part/Splice).
Part and Splice pair selected
Cable and Harness Report Generator
7
If the main items in your report are parts and splices as shown above, the report generator automatically
parses the harness assembly for information on the individual parts and splices, so there is no need for a
GETPART1 link type. You can use link types to get information about the harness objects related to a part.
For example, the information on Part 1 is automatically parsed so no link type is needed. To parse the active
harness for information on the pin (Pin 1) attached to the part, use GETPINS. Use the
GETPINSGETWIRESGETPIN2 link type to traverse through the hierarchy from Part 1 to Pin 1 (GETPINS),
through wire 1 (GETWIRES), to the pin (PIN 2) at the end farthest from Part 1. The
GETPINSGETWIRESGETPART2 link type gets similar results. The link type traverses through the
hierarchy from Part 1 to Pin 1 (GETPINS), through wire 1 (GETWIRES), to the part (PART 2) at the other
end of the harness.
Part 1
Part 2
Wire 1
Pin 1
Wire 1
Pin 2
What values can I use in the Name row?
The Name row provides the most flexibility for the values you can enter. In this row, you can enter:
■
■
■
predefined keywords
constants
properties listed for included objects
Predefined Keywords
The special keywords that are recognized by the Report Generator include:
■
■
■
■
Quantity - displays quantity data such as a part count or total length. For example, to get quantity information, enter Quantity. (Refer to “How do I get a quantity for a harness Object?” for details.)
ColumnNumber*ColumnNumber - multiplies columns. For example, enter 4*5 to multiply column 4 by
column 5.
ColumnNumber+ColumnNumber - adds columns. For example, enter 1+3 to add columns 1 and 3.
Count Rows - counts the number of rows and places a row number in each row of the Count Rows column.
Cable and Harness Report Generator
8
<constant>
Specify any string or constant in the Name cell for any column. When you enter a string or constant, you
must also set the Property data row to NO. The following example shows the string set to const_test.
How do I get column totals?
Sum, Count, and None appear as values in the Subtotal function row on the Table tab. These options set
the value to place in the last row. The value can be a sum of numeric values, a count of the rows with data,
or none (placeholder). Click in the cell to access the dropdown list.
Cable and Harness Report Generator
9
Setting a table column to Sum adds the items in the column.
How do I know what properties I can use?
There are several different types of properties that you can use with Autodesk Inventor Professional:
■
■
■
■
■
Required – Properties that are explicitly listed in the object dialog, each with its own title and data entry
field. These property values are required for the object definition to be complete. The data type is fixed
for required properties. Example: Outer Diameter for library wires.
Reserved – Properties that are explicitly listed in the object dialog, each with its own title and data entry
field, although you do not have to enter a value. The data type is fixed for reserved properties. Example:
RefDes, Part Number.
Recommended – A list of predefined property names available in the “Name” drop-down list in the
Custom tab. These properties must be added explicitly, one by one. The property name and data type
cannot be changed, but you can control their presence and their value can. The data type is fixed for
recommended properties. Example: Embedded Length, Class, Max Length.
Custom or User-Defined – Properties entered by the user in which the name, data type and value must
be entered. These properties can be deleted or renamed as needed and the data type can be changed.
Example: Vendor Part Number for a part definition.
Internal – Properties derived from the placement or settings of the object. The names and values can
not be modified but they are listed in the object dialog. The data type is fixed for internal properties.
Example: Length for an occurrence wire.
The following are the properties you can use in the Report Generator along with any custom properties you
may have defined.
Object Type
Property
Description
Pin
Pin Name
Unique name for the pin within the part.
Embedded Length
Compensation for wire within pinned object.
Part Name
Name of part.
Embedded Length
Compensation for Wire within pinned object.
RefDes
Unique identifier or Reference Designator of the part in the
assembly. On a library part it is typically a place holder such
as J?.
Part
Cable and Harness Report Generator
10
Object Type
Property
Description
Wire
Wire Name
Unique name for the wire within the library.
Color Style
The display color of the wire when used in the graphics window.
Outer Diameter
The physical diameter for the outside of the wire. It is used
to calculate the harness segment diameter in which a wire
is routed.
Part Number
Number of the part.
Category
A user-defined type that is used to group wires into logical
groups in the Cable and Harness Library.
Gauge
American Wire Gauge. Can be used to specify the conductor size of the library wire.
Core Size
The physical inner (core) diameter of the wire. Can be sued
to specify the conductor size of the library wire.
Bend Radius
Factor that is multiplied by the wire diameter to determine
the minimum bend radius.
Cable Name
Unique name for the cable within the Cable and Harness
Library.
Outer Diameter
The physical diameter for the outside of the wire. It is used
to calculate the harness segment diameter in which a wire
is routed.
Part Number
Number of the part.
Bend radius
Factor that is multiplied by the wire diameter to determine
the minimum bend radius.
RefDes
Unique identifier or Reference Designator of the part in the
assembly. On a library part it is typically a place holder such
as J?.
Wire ID
Unique name for the wire occurrence within the assembly.
Separation Code
Used to categorize wires into types or categories for comparison.
Class
Used to categorize wires and segments into class groupings for comparison.
Max Length
Maximum allowable length for wire.
Cable ID
Used to group wires into cables.
Adjusted Length
Derived length of a wire based on properties and settings
that affect wire length.
Length
Original length of a wire.
Cable
Part Occurrence
Wire Occurrence
Cable and Harness Report Generator
11
Object Type
Property
Description
Cable Occurrence
Class
Used to categorize cables and segments into class groupings for comparison.
Max Length
Maximum allowable length for cable.
Cable ID
Used to group wires into cables.
Service Loop
Used to add extra length to all wires, including cable wires,
contained in the harness segment. The length also affects
the segment length. Extra wire length is only listed in
reports.
Bend Radius
Factor that is multiplied by the segment diameter to determine the minimum bend radius.
Class
Used to categorize wires or cables and segments into class
groupings for comparison.
Color Style
The display color of the segment when used in the graphics
window.
Diameter
Can be calculated (cannot be edited) or fixed. Fixed can be
edited.
Max Diameter
Largest diameter to which a dynamic segment may grow
without causing an error.
Adjusted Length
Derived length of the segment.
Length
Original length of the segment.
RefDes
Unique identifier or Reference Designator of the part in the
assembly. On a library part, it is typically a place holder
such as J?.
Part Number
Number of the part.
Embedded Length
Compensation for Wire within pinned object.
Segment
Splice
How do I control the formatting and printing behavior?
The formatting and printing behavior is controlled primarily by the Format tab. There are also three settings
on the Table tab that control some formatting and printing behavior, including:
■
■
■
Print unit suffix - specifies whether to print the unit suffix in the report output. For example, if units are
inches, then “in” is printed in the report.
Print column - specifies whether to print the selected column. When set to No, the column is not printed
in the report.
Column width - controls the width of the column in the report output.
TIP To control the size of a column in the Table tab, simply drag the column. Resizing is sometimes
necessary when the value does not fit in the existing cell.
Cable and Harness Report Generator
12
Multiple Files
The connector.cfg sample file contains a good example of where multiple files are printed. It is set to create
one file for each electrical component or splice with a RefDes value and wires attached to them in the
selected harness assembly. The format is set to create a file for each electrical component or splice with a
RefDes value and wires attached to them. <RefDes>.txt is used as the default output name.
The following example shows the results of creating a report using connector.cfg with the D Sub Harness
active in the Rack Enclosure.iam.
2 electrical parts with defined RefDes
Other options on the Format tab include:
Print Header
Cable and Harness Report Generator
13
How are placeholders used?
The use of placeholders helps to keep columns in the report aligned and uncluttered. The placeholder is
always used for blank values. You also have the option to use a placeholder when the same value is used
consecutively in a single column of a multiple line report. The text or character string you specify to use as
a placeholder is used for both blank and repeated values in the report.
The example below shows placeholders being used for items with blank values.
Placeholders
Cable and Harness Report Generator
14
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement