wiki:Commands/AA_Report

AA_Report Command

http://www.rhinopiping.com/images/icon/command/32x32/AA_Report.png Generate the Bill of Materials of the selected items. (They may be -or not- piping component)

Usage

  1. Select the items you want to see in your Bill of Material. (You can select a whole pipeline in Rhino Piping with the command RP_SelectWholePipeline)
  2. Run the command, http://www.rhinopiping.com/images/icon/command/32x32/AA_Report.png
  3. Open the template file (.tpl). This file depends on your catalog; please read the section Creating a template file.
  4. Select where you want to save the Bill of Materials.
  5. The Bill of Materials is saved as a .csv file you can open it with excel for exemple.

Pre-selection

The pre-selection is mandatory. If there is no selection, the output file will be created but empty.

Creating a template file

The template file is formated like a kind of .csv with a .tpl extension. It can be opened with a text editor like notepad.

When you create your template file, you must follow those rules:

  • The separator must be ;
  • If you are using a spreadsheet program like Excel for edition, check it won't add double quotes.
  • Make sure all the attributes you are refering to have a default value. If they don't, the command AA_Report will stop when meeting an attribute with no value.1;
  • A "cell" can contain text, attribute values, or both

Exemple:

Let's build a typical exemple of template file to generate a Bill of Materials. Create a text file and rename it for exemple "BillOfMaterials.tpl".

The template file will be read from top to bottom when `AA_Report` is running. So you may wish to begin with a simple line of texts for columns titles:

Label_ISO ;DN;Part number;Mass;Lineic mass;Material

The attributes values will be called like that: (exemple with label_ISO)

$(attribute:label_ISO)

We can look for different attributes for each kind of population. This is nearly always necessary, since all piping elements don't have the same attributes (for exemple only the elbows have a `curvature`attribute). To separate the population, we use the filters.

The most common way would be to separate pipes, elbows and others:

$(filter:population:Pipe)$(attribute:label_ISO);;;;;
$(end-filter)
$(filter:population:Elbow)$(attribute:label_ISO);;;;;
$(end-filter)
$(filter:population:ComponentNode:)$(attribute:label_ISO);;;;;
$(end-filter)

As you can see, the line begin with the filter, and there is no separator before the first column definition. (We take the following line to end the filter.) The population:Elbow stands for the automatic elbows (not the components).

If you leave nothing beetween two separators, it will leave a blank cell in the Bill Of Material. In the example above, `AA_Report` will create a CSV file with only the labels in the first column.

Now we can complete it and add the line for column titles:

Label_ISO ;DN;Mass;Lineic mass;Material
$(filter:population:Pipe)$(attribute:label_ISO);$(attribute:sorted_DN);$(attribute:CATALOG:Weight);$(attribute:lineic_mass);$(attribute:CATALOG:Material);
$(end-filter)
$(filter:population:Elbow)$(attribute:label_ISO);$(attribute:sorted_DN);;;$(attribute:CATALOG:Material);
$(end-filter)
$(filter:population:ComponentNode:)$(attribute:label_ISO);$(attribute:sorted_DN);$(attribute:CATALOG:Weight);;$(attribute:CATALOG:Material);
$(end-filter)


  1. 1. Warning: Please remember that despite the attribute Label_ISO being created in the selected items when you run the command RP_Iso3D it is not included in the default attribute spec. Find the file `default-attribute-spec.xml` and add an entry point for the attribute Label_ISO with a default value to guarantee it will always have a value for the Bill of Materials. For exemple: <attribute name = "label_ISO" default = "none"/>


Last update: 0.9.27-2014-01-24

Last modified 3 years ago Last modified on Apr 2, 2015 6:46:32 PM