XML
How the Integration Hash is Built
Promob Observation Field Values in the Integration XML
PromobERP Integration – DefaultERP Integration - Additional Information TAG
Processed By Builder
The attribute Processed by Builder is an entity attribute developed to determine certain configurations of the item during the Promob x ERP integration. Below it will be shown how this attribute should be created in the Promob library and how this attribute works in each type of ERP integration.
How to create the attribute in the Promob libraries
The attribute must be created within entity attributes. To do this, inside Promob Catalog click on registration, then click on systems and select the attributes option.
Afterward, in the attributes window access the option attributes > entity.attributes. It must be created inside the entity folder with the following configuration:
ID = PROCESSED_BY_BUILDER
Name = Builder Process
Type = True/False
Default value = False
And in the Check Boxes, the following options must be checked:
Editable
Advanced property
Save with the Project
Operation within the integration with Promob ERP
For integration with Promob ERP, the attribute PROCESSED_BY_BUILDER defines the value of the Builder tag in the Item node of the XML.
When the attribute value applied to the piece is PROCESSED_BY_BUILDER=True, the tag receives Builder=S, and if the value is PROCESSED_BY_BUILDER= False, the value Builder=N is sent, as shown in the image below:
With the value Builder =S, the ERP imports the item considering that the entire engineering of the item is included in the XML.
If the node Builder=N and the item has the node Tipo_Produto= F (manufactured), the ERP searches in the ERP product configurator for the engineering of the indicated item.
Operation within the integration with Focco ERP
When the attribute value Processed_by_Builder = True is applied to a piece, this item will be generated in the integration XML with Focco, as in the example below:
If the attribute value Processed_by_Builder=”False” is applied to a piece, this item will not be generated in the integration XML with Focco, as shown in the example below:
Situations to be observed
Situation 1: When the attribute Processed_by_Builder=True is applied to a parent item, and then the attribute is applied again to a child item with the value Processed_by_Builder=False, and this item has children with the attribute value Processed_by_Builder=True, the children will not be sent to the XML.
If these items (children) need to be sent to the XML, the attribute with value Processed_by_Builder=”False” must be changed to Processed_by_Builder=True, and an integration characteristic for Focco called “Ghost” must be created and applied to the parent item.
Example
Showing in practice the correct situation described above:
Item path in the library in Promob Catalog
Available from versions:
Plugin Builder 1.11.26 or higher.
Plugin Builder Budget 1.11.24 or higher.
Plugin ERP Promob 1.11.10 or higher.
Plugin ERP Promob Start 1.11.9 or higher.
Plugin ERP Focco 1.11.11 or higher.
Objective
Seeks to identify in the integration XML the library path of an item.
Functionality
When generating the integration file, the tag “CAMINHOITEMCATALOG” will be generated, indicating the path of the item in the library.
Examples
ERP Integration XML
Focco Integration XML
NOTE: In the Focco integrator, this function will only work if the feature “Show custom Promob information” is enabled.
Change in the mapping of Integration XLS
Available from versions:
Plugin Builder 1.11.26.0
Promob 5.38.9
Improvements
1. The XLS files that were previously loaded from the Library are now loaded from the local folder.
That is, the generation of XLS files that previously was done inside the Library, in the System folder
“C\...\Promob Studio Start Labs \System\Budget\Layouts\Listing”
Now is done in the local folder
“C:\...\ ProgramData\Procad\Promob Studio Start Labs\Budget\Layouts\Listing”;
Example:
What previously happened in the following directory:
“C:\...\ Promob Studio Start Labs\Library\System\Budget\Layouts\Listing\Fabrica.xsl”
Now is loaded from:
“C:\ProgramData\Procad\Promob Studio Start Labs\Budget\Layouts\Listing\Fabrica.xsl”
2. BuilderSteps
The file BuilderSteps.steps, which was previously in the directory:
“Client Library\System\budget\Steps”
Is now loaded dynamically, without depending on the file; that is, if the file exists in this directory, it is ignored by Builder.
2.1. Budget files of the Integrators
The following files:
MCMBudget.budget;
FoccoBudget.budget;
WPSBudget.budget;
PromobERPStartBudget.budget.
Which were previously located in “C:\...\Client Library\System\budget” are now loaded directly from the DLLs of the respective integration plugins; thus, it is no longer necessary for them to be in this directory to be loaded.
Information for generating integration hash
The integration Hash is a value calculated from various information of a piece. To calculate this value, the following information is taken into account:
Height;
Width;
Depth;
Reference (Complete);
Quantity;
Entity attributes (DATABASE);
Material Id;
Material direction;
3D point of the Shape
Piece operations;
Piece structures;
IMPORTANT: If the item has aggregates, a new hash will be generated taking the aggregates into account.
Creation of the ID_MODULE attribute
Available from versions:
Plugin Builder Budget 1.11.23 or higher.
Plugin ERP Promob 1.11.9 or higher.
Plugin ERP Promob Start 1.11.8 or higher.
Objective
Seeks to identify in the integration XML which is the parent module of an entity.
Functionality
In the ERP and ERP Start integration XML, the attribute ID_MODULO was added, which has the function of informing the ID_PROMOB of the piece it composes.
NOTE: If the module has no parent, it will not have the ID_MODULO attribute.
Example:
In the image above, there are two modules in the environment, with ID_PROMOB “131” and “63”.
In the XML of the children of these modules, for example ID=”com_cos_tra_tra”, the attribute ID_MODULO will have the value of the parent, which in this case is ID_MODULO=”63”.
Builder TAG
The Builder Tag within the integration XML with Promob ERP works in two ways:
When inserting any operation in the builder tab of an item with geometry, automatically at the time of generating the XML files, the Builder TAG will have the value "S".
Operation within the integration with Promob ERP
When inserting the attribute PROCESSED_BY_BUILDER, the value of the Builder tag in the Item node of the XML is also defined. When the attribute value applied to the piece is PROCESSED_BY_BUILDER=True, the tag receives Builder=“S”, and if the value is PROCESSED_BY_BUILDER=”False”, the value Builder=“N” is sent, as shown in the image below:
With the value Builder=“S”, the ERP imports the item considering that the entire engineering of the item is included in the XML. If the node Builder=“N” and the item has the node Tipo_Produto=“F” (manufactured), the ERP searches in the ERP product configurator for the engineering of the indicated item.
Standard values in customer data to appear in the Integration XML
Available from version:
Plugin ERP Promob – 1.12.5.0 or higher
Plugin ERP Promob Start – 1.12.4.0 or higher
Seeks to define the standard values entered in customer data that will appear in the integration XML.
For customer data information to appear in the integration XML (ERP and ERP_Start), the standards are (value of the name tag in the html):
1. Store information
All these filled fields will be presented in the node Dados_Cliente in the field LOJA of the integration XML file.
2. Customer information
All these filled fields will be presented in the node Dados_Cliente in the field CLIENTE_LOJA of the integration XML file.
On the screen, it is displayed as below:
Promob Observation Field Values in the Integration XML
Available from version:
Plugin Builder: 1.60.0.21
Plugin ERP Standard: 1.60.0.8
Plugin ERP Promob: 1.60.0.10
Plugin ERP Promob Start: 1.60.0.11
From version 1.60.0.21 of Builder, when filling the Observation field inside Promob, the entered value is displayed in the integration XML. As shown in the examples below:
Integration XML Attributes
IDCATEGORY
The IDCATEGORY attribute is used to identify the identifier of the category to which the item belongs.
Below is an example of XML with the IDCATEGORY attribute applied to the item:
UNIT
The UNIT attribute is used to identify the type of unit of measure the item's quantity is in. Below is an example of XML with the UNIT attribute applied to the item:
REDEFINITION
The REDEFINITION attribute is used to identify the margin redefined in the library in items with margin redefinition.
Below is an example of XML with the REDEFINITION attribute applied to the item:
REPETITION
The REPETITION attribute is used to identify the repetition of a particular item in the environment. For libraries with Builder, this value is always 1.
Below is an example of XML with the REPETITION attribute applied to the item:
IDPRICEPROVIDER
The IDPRICEPROVIDER attribute is used to identify the identifier of the price provider. It normally has no value when there is only one provider, in this case Price.
Below is an example of XML with the IDPRICEPROVIDER attribute applied to the item:
PRICE
The PRICE attribute is used to search for prices online using the reference contained in the attribute (it is usually presented by the COMPLETE reference).
Below is an example of XML with the PRICE attribute applied to the item:
Tags available from Builder version 1.60.20.4:
FILECREATION
Informs the date and time that the file was generated.
ASSISTANCEORDER
Inform whether it is a Technical Assistance project.