All Frameworks Class Hierarchy This Framework Previous Indexes
VPMSTEPExchanges Class VPMExMergerRepManager
VPMExMergerRepManager
Usage: you must use this class as is. You should never derive it.
public class VPMExMergerRepManager
VPMExMergerRepManager allows to log information during import/export process.
Role :This class is used to generate error/warning/information messages.
Usage Notes :
- a VPMExMergerRepManager object is automatically instanciated
by the master Import/Export engine
- the report is generated in memory as an SDAI model, based on
VPMExMergerReport schema
- the STEP report model can be converted into a given format and saved
to file thanks to the methods of the interface ENOVIExReportLogFormat
- the CATNls messages are in the file VPMExReportManagerMsg.CATNls
- the report parameters are set in the import/export script file in the node
'exchange_skeleton.x_reportlog' :
- report_id is the name of the report file
- report_location is the path where the report should be saved
- report_format is the late type of the converter
- report_display : Y or N, specifies if the messages should be displayed
on current output during the process
- report_level : 1 (not currently used)
- report_persitency : PERSISTENT (not currently used)
- See also:
- ENOVIExReportLogFormat
Constructor and Destructor Index
- o
~VPMExMergerRepManager()
-
Method Index
- o
ActivateReportLog()
- Activate the Report Manager.
- o
AddRecord_CheckDataError(CATString&,CATUnicodeString&,CATString&,SdaiAppInstanceH&,CATUnicodeString&,ReportAttrKind,CATUnicodeString&,CATUnicodeString&)
- Logs the fact that a rule is not observed in a checker.
- o
AddRecord_CreateDataError(CATString&,CATUnicodeString&,CATString&,SdaiAppInstanceH&,CATUnicodeString&,ReportAttrKind,CATUnicodeString&,CATUnicodeString&)
- Logs the fact that an object could not be created or reconciliated in ENOVIA.
- o
AddRecord_CreateEDXDataError(CATString&,CATUnicodeString&,CATString&,CATBaseUnknown*,CATUnicodeString&,CATUnicodeString&,ReportAttrKind,CATUnicodeString&,CATUnicodeString&)
- Logs the fact that the ENOV_DATAX entity corresponding to an ENOVIA object cannot be
created in the volatile model.
- o
AddRecord_DataInfoError(CATString&,CATUnicodeString&,CATString&,SdaiAppInstanceH&,CATUnicodeString&,CATUnicodeString&,ReportAttrKind,CATUnicodeString&,CATUnicodeString&)
- Logs problems concerning concerning an object to import.
- o
AddRecord_DataRefError(CATString&,CATUnicodeString&,CATString&,SdaiAppInstanceH&,CATUnicodeString&,CATUnicodeString&,ReportAttrKind,CATUnicodeString&,CATUnicodeString&)
- Logs problems concerning an object's reference (pointed object).
- o
AddRecord_Environment(CATString&,CATUnicodeString&,CATString&)
- Logs an environment problem.
- o
AddRecord_Environment_Data(CATString&,CATUnicodeString&,CATString&,CATUnicodeString&)
- Logs a general problem with data.
- o
AddRecord_ExportError(CATString&,CATUnicodeString&,CATString&,CATBaseUnknown*,CATUnicodeString&,ReportAttrKind,CATUnicodeString&,CATUnicodeString&)
- Logs the fact that a given object could not be extracted from ENOVIA (export failed).
- o
AddRecord_ExportProcess(CATUnicodeString&,CATString&,int,int,ReportModifKind,CATBaseUnknown*,CATUnicodeString&,ReportAttrKind,CATUnicodeString&,CATUnicodeString&)
- Generates information messages during export process.
- o
AddRecord_GetData(CATString&,CATUnicodeString&,CATString&,CATUnicodeString&)
- Logs the fact that a given type of data cannot be retrieved from ENOVIA.
- o
AddRecord_GetDataInfo(CATString&,CATUnicodeString&,CATString&,CATBaseUnknown*)
- Logs the fact that some information (other than an attribute's value) cannot be retrieved on a given ENOVIA object.
- o
AddRecord_GetDataInfoAttr(CATString&,CATUnicodeString&,CATString&,CATUnicodeString&,CATBaseUnknown*)
- Logs the fact that an object's attribute's value cannot be retrieved from ENOVIA.
- o
AddRecord_GetDataRef(CATString&,CATUnicodeString&,CATString&,CATBaseUnknown*,CATUnicodeString&)
- Logs the fact that an object pointed by a given object cannot be retrieved from ENOVIA.
- o
AddRecord_GetEDXData(CATString&,CATUnicodeString&,CATString&,CATBaseUnknown*,CATUnicodeString&,ReportAttrKind,CATUnicodeString&,CATUnicodeString&)
- Logs the fact that the ENOV_DATAX entity corresponding to an ENOVIA object cannot be
retrieved from the volatile model.
- o
AddRecord_ImportProcess(CATUnicodeString&,CATString&,int,int,ReportModifKind,SdaiAppInstanceH&,CATUnicodeString&,ReportAttrKind,CATUnicodeString&,CATUnicodeString&)
- Generates information messages during import process.
- o
DesactivateReportLog()
- Desactivate Report Manager.
- o
DisplayFollowMessage(CATUnicodeString&,int,int)
- Displays messages on screen to follow the progression of a process for a given kind of objects.
- o
GetComponent(SdaiAppInstanceH,CATUnicodeString&)
- Gets the name of the component where a given record has been generated.
- o
GetErrorList(CATUnicodeString,CATLISTP(SdaiAppInstance)&)
- Gets the list of records corresponding to errors or warnings
- o
GetMessage(SdaiAppInstanceH,CATUnicodeString&)
- Gets the CATNls message corresponding to a given record instance.
- o
GetNbOfProcessedObjects(CATUnicodeString&,int&)
- Gets the number of objects corresponding to a given action.
- o
GetObjectList(CATUnicodeString,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&)
- Gets the objects processed during import/export.
- o
GetProcessList(CATUnicodeString,CATLISTP(SdaiAppInstance)&)
- Gets the list of records (SdaiAppInstance) corresponding
to a given action for further treatment
- o
GetReportManagerAccess()
- Gets an access to ReportManager, in the aim to report ERROR, WARNING,
SUCCESS, for each object Imported or Exported.
- o
IsReportActive()
- Checks whether the Report Manager is active or not.
- o
ReleaseReportManagerAccess()
- Release an access to ReportManager, .
- o
Save(CATBoolean)
- Saves the report under the format specified in the script file.
Constructor and Destructor
o ~VPMExMergerRepManager
public ~VPMExMergerRepManager( | ) |
-
Methods
o ActivateReportLog
-
Activate the Report Manager.
Note: Report Manager can be activated only if information about it are available in the script file.
That imposes that Script Manager is enable
- Returns:
- S_OK if Activation of Report manager is done. S_FALSE if activation of Report Manager is not possible.
E_ABORT if an error occurs.
o AddRecord_CheckDataError
-
Logs the fact that a rule is not observed in a checker.
Note: When one key attribute is unsufficient to identify the object, you
can use infoAttr and infoValue (in that case use _PLUS messages)
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_CHECKDATA_ ...
- inst
- the concerned ENOV_DATAX instance
- instKeyAttr
- the name of the instance's key attribute
- instKeyAttrType
- the type of the key attribute
- infoAttr
- further information to identify the object if needed
- infoValue
- values associated with infoAttr
o AddRecord_CreateDataError
-
Logs the fact that an object could not be created or reconciliated in ENOVIA.
Note: When one key attribute is unsufficient to identify the object, you
can use infoAttr and infoValue (in that case use _PLUS messages)
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_CREATEDATA, ERROR_CREATEDATA_PLUS, ERROR_RECONCILIATEDATA, ERROR_RECONCILIATEDATA_PLUS
- inst
- the concerned ENOV_DATAX instance
- instKeyAttr
- the name of the instance's key attribute
- instKeyAttrType
- the type of the key attribute
- infoAttr
- further information to identify the object if needed
- infoValue
- values associated with infoAttr
o AddRecord_CreateEDXDataError
-
Logs the fact that the ENOV_DATAX entity corresponding to an ENOVIA object cannot be
created in the volatile model.
Note: When one key attribute is unsufficient to identify the object, you
can use infoAttr and infoValue (in that case use .._PLUS messages)
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_CREATE_EDX, ERROR_CREATE_EDX_PLUS
- iObj
- the concerned ENOVIA object
- objKeyAttr
- the name of the object's key attribute
- objKeyAttrType
- the type of the key attribute
- infoAttr
- further information to identify the object if needed
- infoValue
- values associated with infoAttr
o AddRecord_DataInfoError
-
Logs problems concerning concerning an object to import.
- when an attribute could not be set in ENOVIA
- when an attribute's value could not be retrieved from ENOVIA
- when an attribute's value could not be retrieved from ENOV_DATAX
- when an attribute's value could not be set in ENOV_DATAX
Note: When one key attribute is unsufficient to identify the object, you
can use infoAttr and infoValue (in that case use _PLUS messages)
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_CREATEDATAINFO, ERROR_CREATEDATAINFO_PLUS, ERROR_GETDBINFO,
ERROR_GETDBINFO_PLUS, ERROR_GETEDXINFO, ERROR_GETEDXINFO_PLUS,
ERROR_SETEDXINFO, ERROR_SETEDXINFO_PLUS
- inst
- the concerned ENOV_DATAX instance
- instKeyAttr
- the name of the instance's key attribute
- instKeyAttrType
- the type of the key attribute
- infoAttr
- further information to identify the object if needed
- infoValue
- values associated with infoAttr
o AddRecord_DataRefError
-
Logs problems concerning an object's reference (pointed object).
- when it could not be created in ENOVIA
- when an attribute could not be set
- when the treatment of this object by the exchange component failed
- when the corresponding ENOVIA objects could not be linked
Note: When one key attribute is unsufficient to identify the object, you
can use infoAttr and infoValue (in that case use _PLUS messages)
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_CREATEDATAREF, ERROR_CREATEDATAREF_PLUS, ERROR_SETDBREF,
ERROR_SETDBREF_PLUS, ERROR_WORKWITHREF, ERROR_WORKWITHREF_PLUS
ERROR_LINKDBREF, ERROR_LINKDBREF_PLUS
- inst
- the concerned ENOV_DATAX instance
- instKeyAttr
- the name of the instance's key attribute
- instKeyAttrType
- the type of the key attribute
- infoAttr
- further information to identify the object if needed
- infoValue
- values associated with infoAttr
o AddRecord_Environment
-
Logs an environment problem.
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_ENV_...
o AddRecord_Environment_Data
-
Logs a general problem with data.
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_ENV_EDXSTRUCTURE
- iData
- the data concerned by the error message
o AddRecord_ExportError
-
Logs the fact that a given object could not be extracted from ENOVIA (export failed).
Note: When one key attribute is unsufficient to identify the object, you
can use infoAttr and infoValue (in that case use .._PLUS messages)
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_EXPORT, ERROR_EXPORT_PLUS
- iObj
- the concerned ENOVIA object
- objKeyAttr
- the name of the object's key attribute
- objKeyAttrType
- the type of the key attribute
- infoAttr
- further information to identify the object if needed
- infoValue
- values associated with infoAttr
o AddRecord_ExportProcess
-
Generates information messages during export process.
Note:
- When one key attribute is unsufficient to identify the object, you can
use infoAttr and infoValue (in that case use .._PLUS messages)
- The parameters iDisplayFrequency and iTotalNb are used to display process
messages on standard output
- Parameters:
-
- iDataXComp
- the name of the exchange component where the message is generated
- iMsgID
- the tag of the CATNls message
Legal values
PROCESS_EXPORT, PROCESS_EXPORT_PLUS
- iDisplayFrequency
- the display frequency of the message on standard output (0 if not used)
- iTotalNb
- the total number of objects that will be processed (0 if it is not known)
- iModif
- the kind of process (EXTRACT)
- iObj
- the concerned ENOVIA object
- objKeyAttr
- the name of the object's key attribute
- objKeyAttrType
- the type of the key attribute
- infoAttr
- further information to identify the object if needed
- infoValue
- values associated with infoAttr
o AddRecord_GetData
-
Logs the fact that a given type of data cannot be retrieved from ENOVIA.
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_GETDATA
- objType
- the kind of data concerned by the error message
o AddRecord_GetDataInfo
-
Logs the fact that some information (other than an attribute's value) cannot be retrieved on a given ENOVIA object.
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_GETDATAINFO_KOSYNC
- iObj
- the concerned ENOVIA object
o AddRecord_GetDataInfoAttr
-
Logs the fact that an object's attribute's value cannot be retrieved from ENOVIA.
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_GETDATAINFO_ATTR
- iAttrName
- the name of the attribute
- iObj
- the concerned ENOVIA object
o AddRecord_GetDataRef
-
Logs the fact that an object pointed by a given object cannot be retrieved from ENOVIA.
- Parameters:
-
- iType
- the kind of message (ERROR or WARNING)
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_GETDATAINFO_REF
- iObj
- the concerned ENOVIA object
- refObjType
- the kind of the referenced object
o AddRecord_GetEDXData
-
Logs the fact that the ENOV_DATAX entity corresponding to an ENOVIA object cannot be
retrieved from the volatile model.
Note: When one key attribute is unsufficient to identify the object, you
can use infoAttr and infoValue (in that case use .._PLUS messages)
- Parameters:
-
- iType
- the kind of message
Legal values
ERROR, WARNING
- iDataXComp
- the name of the exchange component where the error occured
- iMsgID
- the tag of the CATNls message
Legal values
ERROR_GET_EDX, ERROR_GET_EDX_PLUS
- iObj
- the concerned ENOVIA object
- objKeyAttr
- the name of the object's key attribute
- objKeyAttrType
- the type of the key attribute
- infoAttr
- further information to identify the object if needed
- infoValue
- values associated with infoAttr
o AddRecord_ImportProcess
-
Generates information messages during import process.
Note:
- When one key attribute is unsufficient to identify the object, you can
use infoAttr and infoValue (in that case use .._PLUS messages)
- The parameters iDisplayFrequency and iTotalNb are used to display process
messages on standard output
- Parameters:
-
- iDataXComp
- the name of the exchange component where the message is generated
- iMsgID
- the tag of the CATNls message
Legal values
PROCESS_IMPORT, PROCESS_IMPORT_PLUS, PROCESS_CHECKDATA, PROCESS_CHECKDATA_PLUS
- iDisplayFrequency
- the display frequency of the message on standard output (0 if not used)
- iTotalNb
- the total number of objects that will be processed (0 if it is not known)
- iModif
- the kind of process
Legal values
CREATE, UPDATE, REMOVE
- inst
- the concerned ENOV_DATAX instance
- instKeyAttr
- the name of the instance's key attribute
- instKeyAttrType
- the type of the key attribute
- infoAttr
- further information to identify the object if needed
- infoValue
- values associated with infoAttr
o DesactivateReportLog
public void DesactivateReportLog( | ) |
-
Desactivate Report Manager.
Note: All functionalities of the Report manager are desactivated..
o DisplayFollowMessage
-
Displays messages on screen to follow the progression of a process for a given kind of objects.
Note: For instance the result on screen could be : "10 objects of kind VPMPartMaster over 1000 have been currently treated"
- Parameters:
-
- objectType
- the kind of object
- nbObj
- the number of treated objects
- nbTotal
- the total number of objects to be processed
o GetComponent
-
Gets the name of the component where a given record has been generated.
- Returns:
- S_OK if operation runs well E_FAIL in case of errors
- Parameters:
-
- iRecordInstance
- the SdaiAppInstance corresponding to the record in the report model
- oXCompo
- the name of the exchange component
o GetErrorList
-
Gets the list of records corresponding to errors or warnings
- Returns:
- S_OK if operation runs well E_FAIL in case of errors
- Parameters:
-
- iType
- Legal values
ERROR, WARNING
- olistOfRecords
- List of the records(SdaiAppInstance) corresponding to iType in the report model
o GetMessage
-
Gets the CATNls message corresponding to a given record instance.
- Returns:
- S_OK if operation runs well E_FAIL in case of errors
- Parameters:
-
- iErrorInstance
- the SdaiAppInstance corresponding to the record in the report model
- oMessage
- the CATNls message
o GetNbOfProcessedObjects
-
Gets the number of objects corresponding to a given action.
- Returns:
- S_OK if operation runs well E_FAIL in case of errors>
- Parameters:
-
- iAction
- Legal values
CREATE,UPDATE,REMOVE,EXTRACT
- nbObjects
- Number of objects
o GetObjectList
-
Gets the objects processed during import/export.
Note: The resulting lists have the same size and their index match each other.
- Returns:
- S_OK if operation runs well E_FAIL in case of errors
- Parameters:
-
- iAction
- Legal values
CREATE,UPDATE,REMOVE,EXTRACT
- objTypeList
- List of the objects' types
- objAttrList
- List of the attributes identifying each object (separated by '+')
- objAttrValueList
- List of the values corresponding to the identifier attributes (separated by '+')
- objAttrValueList
- List of the OID in the case of an export, #ele in the case of an import
o GetProcessList
-
Gets the list of records (SdaiAppInstance) corresponding
to a given action for further treatment
- Returns:
- S_OK if operation runs well E_FAIL in case of errors
- Parameters:
-
- iAction
- Legal values
CREATE,UPDATE,REMOVE,EXTRACT
- olistOfRecords
- List of the records(SdaiAppInstance) corresponding to iAction in the report model
o GetReportManagerAccess
-
Gets an access to ReportManager, in the aim to report ERROR, WARNING,
SUCCESS, for each object Imported or Exported.
Warning: Each access must be released thanks to method ReleaseReportManagerAccess.
Note: Report log will be write only if ReportManager is activated thanks to ActivateReportLog.
- Returns:
- : A reference on ReportManager.
o IsReportActive
public boolean IsReportActive( | )const |
-
Checks whether the Report Manager is active or not.
Note: The Report Manager is said to be active if the specific XML tags are in the script file.
- Returns:
- TRUE if the Report Manager is active FALSE if the Report Manager is not active
o ReleaseReportManagerAccess
public static void ReleaseReportManagerAccess( | ) |
-
Release an access to ReportManager, .
Warning: Method GetReportManagerAccess must be call before.
o Save
-
Saves the report under the format specified in the script file.
- Parameters:
-
- iNewFile
-
Legal values
CATTrue, CATFalse
- Returns:
- S_OK if operation runs well E_FAIL in case of errors
This object is included in the file: VPMExMergerRepManager.h
If needed, your Imakefile.mk should include the module: VPMSTEPExDec