About User Exits

User Exits help you to abort a particular action when the condition fails. For example, you can abort the Checkin operation when the name of the file does not follow the company's naming convention before the Checkin operation starts.

User Exits are available with Checkin, Checkout, Attribute Synchronization from X-CAD Design Management, File Open, Lock/Unlock (only RFA objects) and Notification.

The Integration Administrator sets the necessary User Exits in the IEF-UserExitEventRegistration attribute of the GCO. Only registered user exit functions are called during their operations.

You can set values as shown in the table for actions by leaving a white space in between the two possible values for UGS NX and Pro/ENGINEER integrations and separated by comma in CATIA, Inventor, Solid Edge, Microstation, and AutoCAD integrations. For example, the system administrator can set values like CheckinPartPre CheckoutPartPre in UG and CheckinPartPre,CheckoutPartPre in Inventor to have User Exits before Checkin and Checkout operations.

The following table lists the User Exit function values you can set for various actions in X-CAD Design Management:

ActionUser Exit Function Values Description
Checkin

CheckinDialogPre

Called as soon as the user clicks Checkin and before first request is sent to Integration Framework. Depending on this result, checkin starts.

The user exit is called only once it is executed.

If the user exit passes, the checkin dialog box is displayed.

If the user exit fails, the operation is cancelled.

CheckinStart

Called after second response and before third request, typically used to create image files. The part file is not checked in yet, no attributes are created or updated, and no relationships are established.

The user exit is called as many as the number of CAD object nodes in the checkin request.

If the user exit passes, the file is uploaded successfully.

If the user exit fails the operation is cancelled.

CheckinPartPre

Called before the object creation for each selected item.

The user exit is called as many times as the number of CAD objects.

If the user exit passes, the meta-data is created successfully.

If the user exit fails the operation is cancelled.

CheckinPartPost

Called after successful file transfer and before exiting checkin operation.

The user exit is called as many as the number of CAD object nodes in the checkin request.

If the user exit fails, the operation in context (corresponding operation) is not cancelled.

Checkout

CheckoutPartPre

Called for each selected item prior to all selected items being checked out.

The user exit is called as many times the number of objects are selected to open from ENOVIA.

If the user exit passes, the checkout operation is completed successfully.

If the user exit fails, the operation is cancelled.

CheckoutPartPost

Called after all the selected items are checked out.

The user exit is called as many times the number of objects are selected to open from ENOVIA.

If the user exit passes, the checkout operation is completed successfully.

If the user exit fails, the operation in context (corresponding operation) is not cancelled.

File Open during Checkout

OpenPartPre

Called before opening each selected CAD file during checkout.

In case of open with file overwrite operation, even if a file is not selected for overwrite, it is opened from the local disk and loaded in the CAD tool. This user exit is also called for such files.

The user exit is called as many times as the number of files and object references that are loaded in CAD tool session, during the checkout operation"

This user exit is also called for such instances / configuartions of a family, which do not contain files.

If the user exit passes, the CAD file is loaded successfully in the CAD tool.

If the user exit fails, the operation is cancelled.

OpenPartPost

Called after opening each selected file and after updating file attributes during Checkout.

In case of open with file overwrite operation, even if a file is not selected for overwrite, it is opened from the local disk and loaded in the CAD tool. This user exit is also called for such files.

The user exit is called as many times as the number of files and object references that are loaded in CAD tool session, during the checkout operation"

This user exit is also called for such instances / configuartions of a family, which do not contain files.

If the user exit passes, the CAD file is loaded successfully in the CAD tool.

If the user exit fails, the operation in context (corresponding operation) is not cancelled.

Attribute Synchronization from Matrix

UpdateAttributesInCadPre

Called prior to updating attributes of the CAD file from ENOVIA

The user exit is called as many time as the number of objects are selected to open from ENOVIA.

If the user exit fails, the operation is cancelled.

UpdateAttributesInCadPost

Called after updating the attributes of the CAD file from ENOVIA

The user exit is called as many time as the number of objects are selected to open from ENOVIA.

If the user exit fails, the operation in context (corresponding operation) is not cancelled.

Check For Update Current / Global Refresh

CheckoutPartPre

Called for each selected item prior to all selected items being checked out.

The user exit is called as many time as the number of objects are selected to open from ENOVIA.

If the user exit passes, the checkout operation is completed successfully.

If the user exit fails, the operation is cancelled.

CheckoutPartPost

Called after all the selected items are checked out.

The user exit is called as many time as the number of objects are selected to open from ENOVIA.

If the user exit passes, the checkout operation is completed successfully.

If the user exit fails, the operation in context (corresponding operation) is not cancelled.

OpenPartPre

Called before opening each selected CAD file during checkout

The user exit is called as many times as the number of files are loaded in CAD tool session, during the checkout operation.

If the user exit passes, the CAD file is loaded successfully in the CAD tool.

If the user exit fails, the operation is cancelled.

OpenPartPost

Called after opening each selected file and after updating file attributes during Checkout

The user exit is called as many times as the number of files are loaded in CAD tool session, during the checkout operation.

If the user exit passes, the CAD file is loaded successfully in the CAD tool.

If the user exit fails, the operation in context (corresponding operation) is not cancelled.

Check For Update All

CheckoutPartPre

Called for each selected item prior to all selected items being checked out.

The user exit is called for the number of objects that are selected to open from ENOVIA.

If the user exit passes, the checkout operation is completed successfully.

If the user exit fails, the operation is cancelled.

CheckoutPartPost

Called after all the selected items are checked out.

If the user exit passes, the checkout operation is completed successfully.

If the user exit fails, the operation in context (corresponding operation) is not cancelled.

Lock/Unlock (Applicable only for RFA Object)

LockPartPre

Called for each selected item once submitted for lock and prior to download from RFA folder.

The user exit is called as many times as the number of objects are locked and downloaded to local disk from RFA location.

If the user exit passes, the RFA objects are locked and downloaded successfully to local disk.

If the user exit fails, the operation is cancelled.

LockPartPost

Not used.

If the user exit fails, the operation in context (corresponding operation) is not cancelled.

The user exit values LockPartPre and LockPartPost are applicable only when designs are locked using the ENOVIA > Lock\Unlock option from collaborative apps.