Create Import Job - Intergraph Smart Materials - Version 2020 (10.0) - Customization & Programming - Hexagon

Intergraph Smart Materials Classic API Configuration (2020)

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

Create a new import job by calling the NEW_OMI_FLC_JOB procedure with the parameters described in the table below.

A log file (prefixed with OMI_API) will be written into the UTL file directory on the database server. The amount of information depends on the message level set on A.60.61 User Preferences.

Parameter

Mandatory

Description

p_us_id

Yes

The US_ID from table m_user_securities is set when you log in to Smart Materials. It uniquely identifies the log in context including the discipline, language, and the assigned role. You can find this US_ID either in the Session Information section after you successfully logged in to Smart Materials, or you can look up the table directly.

FLC based BOM imports are not possible in the product group context. This should be considered when you decide on an appropriate US_ID.

p_proj_id

Yes

The PROJ_ID is the commonly known project that you select when you log in to Smart Materials. Although the US_ID is already uniquely identifying the log in context, the project must be provided by populating parameter p_proj_id. This prevents users from accidentally importing into the wrong project by using the US_ID only. If the PROJ_ID does not match the US_ID, it will not be possible to log in.

p_job_code

Yes

This is the standard job code from B.40.01. It has a name part and is suffixed by a dash (-) and a number, for example, MyOMIjob-1. If a job with this name is already available in the project, a successor is created automatically - just like it would be on the screen. The new job code is passed back in this parameter. This way you do not necessarily have to be concerned with the naming of the job each time you are using this API for a similar import.

p_issue_status

Yes

A valid value within the project from B.10.08 Issue Status.

p_list_status

Yes

A valid value within the project from B.10.02 List Status.

p_flc_config

Yes

A valid value within the project from B.10.41 Flat Configurations. As it is for all other FLC based BOM imports, the FLC configuration defines the record structure that can be processed.

p_node_path

No

Optional field to identify the BOM start node. When used, p_node_path must be provided with the full BOM path.

p_sep

No

The parameter p_sep must be filled with the character that separates the node names. This is usually /.

p_pit_stop

No

Optional field corresponding to the Pit Stop check box on B.40.01. The value can be Y or N (default).

p_comment

No

Optional free text field, corresponding to the User Comment field on B.40.01.

p_find_ident

No

Optional field corresponding to the Find Ident check box on B.40.01. The value can be Y or N (default).

p_transfer

No

Optional field corresponding to the Transfer check box on B.40.01. The value can be Y (default) or N.

p_company_code

No

Optional field corresponding to the Company Code field on B.40.01, which must be a valid entry from the Company Code list on A.10.23 Companies.

p_tsq

No

Optional field corresponding to the Transfer Site Qty check box on B.40.01. The value can be Y (default) or N.

p_check_cons

No

Optional field corresponding to the Check Consistency check box on B.40.01. The value can be Y or N (default).

p_pos

No

Optional field corresponding to the Pos. Numbers field on B.40.01. Possible values are DATA, BOTH, AUTO (default).

p_next_status

No

Optional field corresponding to the Next Issue Status check box on B.40.01. The value can be Y or N (default).

p_lock

No

Optional field corresponding to the Lock BOM check box on B.40.01. The value can be Y or N (default).

p_transact_size

No

Optional field corresponding to the Transaction Size field on B.40.01. Values between 100 (default) and 9999 are allowed.

p_omij_id

No

Output value that contains the OMIJ_ID of the newly created job.

  • This procedure tries to evaluate all input parameters and raises an error with a descriptive message showing the problems if the pre-checks failed.

  • If all requirements are met, the procedure returns the ID and the code of the created job.