After the login environment is set successfully, this procedure must be executed once for each document to be imported. Any number of documents can be imported. Each document is stored temporarily in table m_documents_imports and pooled with an internal ID.
When these records are processed later, this internal ID is used to identify all records belonging to that particular import.
Procedure Parameters
|
Parameter |
Description |
|---|---|
|
p_doc_source |
Character (20). Valid values are SPF and OTHER (default). |
|
p_mode_ind |
Character (1). A is the only allowed value at the moment. |
|
p_doc_name |
Character (256). Mandatory. Will be converted to uppercase. |
|
p_revision |
Character (6). The default value is 0. |
|
p_path_type |
Character (1). P - Physical (default), L – Link. |
|
p_client_ref |
Character (300) |
|
p_partner_ref |
Character (300) |
|
p_list_of_units |
Character (300) |
|
p_material_code |
Character (300) |
|
p_list_of_tags |
Character (300) |
|
p_doc_type |
Character (256) |
|
p_number_of_pages |
Character (5) |
|
p_status |
Character (15) |
|
p_author |
Character (10) |
|
p_creation_date |
Character (12) |
|
p_authorized_by |
Character (10) |
|
p_authorization_date |
Character (12) |
|
p_changed_by |
Character (10) |
|
p_changed_date |
Character (12) |
|
p_docu_format |
Character (40) |
|
p_comments |
Character (240) |
|
p_reference_module |
Character (80) |
|
p_file_name |
Character (255) |
|
p_source_path |
Character (2000) |
|
p_std_code |
Character (3) |
|
p_src_code |
Character (20) |
|
p_origin_code |
Character (10) |
|
p_directa_class |
Character (30) |
|
p_directa_docu_type |
Character (30) |
|
p_obid |
Character (24) |
|
p_spf_uid |
Character (128) |
|
p_spf_revision |
Character (6) |
|
p_spf_version |
Character (6) |
|
p_spf_version_date |
Character (12) |
|
p_spf_version_UID |
Character (128) |
|
p_spf_category |
Character (256) |
|
p_spf_subtype |
Character (256) |
|
p_spf_title |
Character (256) |
|
p_spf_plant |
Character (256) |
|
p_spf_project |
Character (256) |
|
p_short_desc |
Character (20) |
|
p_description |
Character (2000) |
Most of the parameters correspond with fields on the D.10.11 Documents screen and are therefore not described here. For more information, see Documentation Tasks.
Date and number values are converted accordingly where possible.
SmartPlant Foundation Documents
In the case of using this API with data from SmartPlant Foundation (p_doc_source=SPF), the Smart Materials revision can be defaulted to 0. The SPF revision and version should be filled with the corresponding values from SmartPlant Foundation. During processing, the Smart Materials revision is derived accordingly.
Documents from SmartPlant Foundation can come with the same name, but it could be
a different document with a different UID. Taking the document UID and the name into
account, duplicates are avoided by adding the primary key of table m_documents (Docu_ID)
to the document name in Smart Materials. The original document name is displayed in
the Org. Document Code field.