Define a procedure parameter - Intergraph Smart Materials - Version 2020 (10.0) - Help - Hexagon

Intergraph Smart Materials Web Help (2020)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web
Search by Category
Help
Smart Materials/Smart Reference Data Version
2020 (10.0)

What are the parameters that an API takes within the BOM procedures?

An API (M_PCK_BOM_PROC.LOG_DETAIL_INFO) is provided to record customized log messages from within the BOM procedure. After execution of the procedure, the log messages can be viewed on the Maintain BOM page. The API takes four parameters, which are as follows:

  • The <KIND_OF> argument is a message type of indicator for classifying the log message. You can use any three characters for the value of the <KIND_OF> argument. Do not use the argument values ‘MAR’, ‘WRN,’ or ‘ERR’ because these values are reserved for system internal logs (‘MAR’ - information log, ‘WRN’ - warning log, ‘ERR’ - error log).

  • For the <TEXT> argument, you can use any text value that you want to have as a log comment.

  • For the <RET_VAL> argument, you can use any text value that you want to have as a log comment returning from the BOM procedure.

  • The P_LP_ID argument must always be kept as the last argument in the list. This variable is passed as the first argument to the BOM procedure.

The first characters of the character string returned through the variable V_RET_VAL from the BOM Procedure must not be Error.

  1. On the Home page, click Bill of Materials > BOM Procedures/Macros.

  2. Click Add Row in the BOM Procedure Parameters block.

  3. Select the appropriate code from the select list in the Parameter cell.

    Only those parameters that are defined in Parameter page in the Administration module are available for BOM Procedure Parameters.

  4. Enter a unique number in the Seq cell.

    This field specifies the order of parameter in a BOM Procedure. The order a BOM Procedure Parameter must be greater than 1 as the order value '1' is reserved for LP_ID.

  5. Select the appropriate parameter value from the select list in the Default Value cell.