Attributes - Intergraph Smart Reference Data - 2020 10.0 - Customization & Programming - Hexagon

Intergraph Smart Reference Data Integration (2020)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Customization & Programming
Smart Materials/Smart Reference Data Version
2020 (10.0)

The Attributes tab is used to assign attributes with properties to the sheet and to define the retrieval method for each attribute.

The attributes will appear on the resulting Excel sheet in the sequence defined in the Sequence column. The attribute name as displayed in the Attribute Name column is used as the column title on the Excel sheet.

If a default value is defined for the Default Value column, it is used when no other value is found, independent of the defined retrieval method.

The entries in the Dependencies column are used to indicate on which level the needed information for the attribute is mapped to classes and material in Smart Reference Data. This field contains a comma-separated list of dependencies. Valid values are:

  • ID for ident (also idents resulting from ident ranges)

  • CC for commodity code (also commodities resulting from commodity ranges)

  • P for commodity part (or group)

  • SI for spec item

  • SH for spec header

  • TD for table detail related mapping independent from group/part (like commodity ranges)

The list above also represents the order in which the procedure evaluates the different levels during the search for a value.

Include all levels you consider reasonable. For example, if there is a value that normally depends on the commodity part, but sometimes deviates for distinct commodity codes, you should set the dependencies to "CC,P". This will enable the software to first look if the actual CC is mapped to the requested parameter. If the CC is not mapped, the mapping on the part level is queried.

The Physical Attribute column defines the column in the export and inventory tables for the selected attribute, and their names consist of the digits:

  • A - for Attribute

  • C - for Character (alphanumeric)

  • 0010 - for the maximum length of 10 digits (available lengths: 10, 20, 30, 60, 256, 2000, 4000)

  • 001 - the sequential number for all attributes with the same data type and size

Possible values in the Retrieval Method drop-down list for the attributes are:

NONE

The column will be left untouched. This is the method of choice if the column remains empty, because NONE saves the time spent calling a retrieval function (which will not find a value because there is simply nothing mapped).

BASE_COLUMN

Takes the value from the Smart Reference Data base tables, which are associated to the sheet.

Sheets of all categories can use all columns from each base table that is assigned to the sheet via Retrieval Source on the sheet level.

Note that the attributes that will form the catalog part number (commodity code, schedules, nominal sizes) must be BASE_COLUMN based. They may use functions that modify the result. The column names in the Retrieval Source field should always be typed in lowercase and contain the alias. A valid value would be for example, 'NVL(i.input_3,'X')'.

Example

The R-Hierarchy sheet has R-ClassNodeDescribes assigned in the Source field. The Retrieval Source column uses the tables with aliases:

m_sp3d_struct_elems cse

m_sp3d_exp_dst_cat_structs edcs

m_sp3d_cat_struct_e_shts cses

m_sp3d_shts sht

The attributes assigned to R-Hierarchy have both retrieval method BASE_COLUMN assigned, with the sources (alias.column or table_name.column or just column when it’s unique):

cse.cse_code (or m_sp3d_struct_elems.cse_code)

sht.sht_code (or m_sp3d_shts.sht_code)

Sheets of category PART_FILTER or PART_DEFINITION can use all columns from base tables:

m_commodity_groups (alias cg),

m_parts (alias p),

m_commodity_codes (alias cc)

m_idents (alias i)

Sheets of category SPEC_RULE can use all columns from base tables:

m_spec_headers (alias sh),

m_spec_revisions (alias spr)

Sheets of category SPEC_ITEM_FILTER can use all columns from base tables:

m_spec_headers (alias sh),

m_spec_revisions (alias spr)

m_spec_items (alias si),

m_commodity_groups (alias cg),

m_parts (alias p),

m_commodity_codes (alias cc)

m_idents (alias i)

ATTR_STND_METHOD

Looks in the Retrieval Source field and calls the specified function to fetch the correct value.

ATTR_CUST_METHOD

The retrieval method (Retrieval Method drop-down) calls the CIP m_pck_sp3d_custom. ATTR_CUST_METHOD. By default, this procedure is empty, which means you must program the logic to export the sheet yourself.

CC_IDENT_INFO

If this retrieval method is selected from the drop-down list in the Retrieval Method field on the Attributes tab, the following options are available for the retrieval source to be selected from the LOV in the Source field:

  • TableDetail

  • CC Attribute

  • CC UDF (User Defined Field)

  • Ident Value

If Table Detail is selected, you must select a commodity attribute table (defined on SRD > Component Manager > Table Management) from the LOV in the Source Detail 1 field. Then, select any of the following from the LOV in the Source Detail 2 field:

  • Group Code/ Group

  • Short Desc/ Group Description

  • Group User Defined Field (UDF) values

  • Detail Code

  • Detail Short Desc/ Detail Description

  • Detail UDF values

If Short Desc or Description is selected, the NLS_ID will be selected in the Source Detail 3 field. You can leave it empty, and then the NLS of the login language will be used during export.

If CC Attribute is selected, you must select an attribute (defined on SRD > Component Management > Attribute Management) from the LOV in the Source Detail 1 field. The software will retrieve the value for this attribute from an attribute based commodity code.

If CC UDF is selected, you must select a physical attribute (defined on Table/ Attributes grid for M_COMMODITY_CODES table) from the LOV in the Source Detail 1 field. The software will retrieve the value for this attribute from a user defined field (Attribute name mapped to same physical attribute) of the commodity code from commodity codes grid.

If Ident Value is selected, you must select an attribute (defined on SRD > Component Management > Attribute Management) from the LOV in the Source Detail 1 field. The software will retrieve the ident value for this attribute.

PART_INFO

If this retrieval method is selected from the drop-down list in the Retrieval Method field on the Attributes tab, the following options are available for the retrieval source to be selected from the LOV in the Source field:

  • Discipline

  • (Commodity) Group Code

  • (Commodity) Group Short Desc(ription)

  • (Commodity) Group Description

  • (Commodity) Group UDF (User Defined Field)

  • Part Code

  • Part Short Desc(ription)

  • Part Description

  • Part UDF (User Defined Field)

  • If the sheet retrieval method is TEMPLATE_COPY, the attribute retrieval methods are ignored.

  • If ‘Default’ is selected as the Retrieval Source on the attribute level, the value will be searched on Item Mappings.

When you select the CMS retrieval method, the CMS Type field, CMS Source field, and the Use CMS Nls check box are displayed on the Attributes tab.

After selecting the Smart 3D attribute from the LOV in the Attribute field on the Attributes tab, select TABLE, ATTRIBUTE, or BASE_COLUMN from the drop-down list in the CMS Type field. Depending on the selected CMS type, the LOV in the CMS Source field shows the available CMS tables, attributes, or database columns. Select the Use CMS Nls check box if the Nls descriptions shall be used.

The Retrieval Method and Source fields are not displayed when CMS is selected as the sheet retrieval method.

The definition of retrieval sources for the sheets and attributes with its details can be found on the Retrieval Sources screen. Furthermore, this screen can be used to define your own retrieval sources. Defining the SQL statements of the retrieval sources requires a consolidated knowledge in Smart Reference Data database table structure. The retrieval sources that are provided with the software are marked as standard.

A retrieval source represents SQL code that will be used to populate a sheet or a sheet attribute. Retrieval Sources can be used to populate multiple sheets or attributes.

If the In XLS indicator is set, the column will appear on the Excel sheet. If the indicator is not set, the column will be written to the interface table, but not to the Excel sheet later on.

If the values of a row are the same in the following row in the sheet, in most cases they can be left out. This saves space, and can make the sheet more readable. If the Suppress Repetition check box is selected, duplicate values are not repeated. For example, the second size range in the PipingCommodityFilter sheet should not use this feature. Otherwise, 2size items could be interpreted as 1size items.

If the Mandatory check box is selected, the value of this item may not be null.

The Unique Key (UK) item can contain a number between 1 and 9. All attributes that belong to the same unique key get the same number. There is a special handling with hierarchical codelists. In those codelists, the codelist number should be declared as the first UK and any of the "XYZ ShortDescription" fields should also get its own UK. Do not use the UK for other fields in a hierarchical codelist sheet, and do not use UKs combined from more than one column.

The Unique Key Sequence item can contain a number between 1 and 99 to indicate the sequence of the attribute within the unique key.