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 Designer Central, 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, SolidWorks, SolidEdge, Microstation, and AutoCAD integrations. For example, the system administrator can set values like CheckinPartPre CheckoutPartPre in UG and CheckinPartPre,CheckoutPartPre in SolidWorks 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 Designer Central:

Action User Exit Function Values Description

Checkin

CheckinDialogPre

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

CheckinStart

Called before the object creation for each selected item

CheckinPartPre

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.

CheckinPartPost

Called after successful file transfer and before exiting checkin operation.

Checkout

CheckoutPartPre

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

CheckoutPartPost

Called after all the selected items are checked out.

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 called for such files also.

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 called for such files also.

Attribute Synchronization from Matrix

UpdateAttributesInCadPre

Called prior to updating attributes of the CAD Part from ENOVIA

UpdateAttributesInCadPost

Called after updating the attributes of the CAD Part from ENOVIA

Check For Update Current

CheckoutPartPre

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

CheckoutPartPost

Called after all the selected items are checked out.

OpenPartPre

Called before opening each selected CAD file during checkout

OpenPartPost

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

Check For Update All

CheckoutPartPre

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

CheckoutPartPost

Called after all the selected items are checked out.

Lock/Unlock (Applicable only for RFA Object)

LockPartPre

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

LockPartPost

Not used.

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

Note: Even if the following user exits fail, the operation in context (corresponding operation) will not be aborted:

  • CheckinPartPost
  • CheckoutPartPost
  • OpenPartPost
  • UpdateAttributesInCadPost
  • LockPartPost