3D PLM PPR Hub Open Gateway

Check-In Scenario

The Check-In is a scenario whereby CATIA session information and persistent documents are used to create new or modify existing PDM system data. Check-In enables save a consistent set of documents from CATIA V5 in the external PDM system with the appropriate document links exposure. These document links information must be sufficient to compute the right consistent set of documents to perform the other elementary functions: Check-Out [2], Rename [3], and Derivative Design Copy [4].

This operation is implemented by:

• Computing the consistent set of documents the document to Check-In belongs to
• Computing the list of document links to expose in PDM
• Extracting and Updating document internal properties if necessary
• Invoking in sequence the PDM Check-In operation for each document
  
• Performing the  transfer  of the persistent documents in the PDM system
• Updating documents attributes in the PDM system
  

This scenario, developped in the Check-In Scenario Detailed Steps section, can be also presented by this Diagram:

Fig.1: The Check-In Scenario Diagram

The Check-In scenario must enforce the following rules:

• The consistent set of documents is computed from the persistent documents on disk in the user Work area meaning that the CATIA documents loaded in session will have to be saved prior the Check-In operation, to make the modified documents persistent on disk. The Check-In function must have the ability to force the save of modified document if required.

[Top]

Check-In Scenario Detailed Steps

This section details step by step the Check-In scenario. But, no API will be given, you should refer to the elementary PX1 use cases, or the CATxPDMInterfaces framework API documentation, to have implementation details.

The Integration can implement the Check-In scenario as an interactive CATIA command running within the CATIA session context. This command will display a Dialog box with the name of the selected document in the current editor. If no document has been selected first, the name of the editor root document ( see CATIxPDMSession interface ) will be displayed. The user starts the Check-In operation by clicking the OK button.

A CATIA session is open. It contains CATIA documents.

1. The user performs Save management prior to Check-In
2. The user starts the Check-In command after choosing the editor window he wants to Check-In documents; The Check-In command displays the name of the selected document in the dialog box
3. User clicks OK button to confirm the selection
4. Integration starts the Check-In operation by performing preliminary checks:
   1. The selected document doesn’t need to be saved meaning it is persistent on disk
   2. If the document is modified, it must be saved again
   3. The physical storage location path of the document is the user Work area
   4. It computes the consistent set of documents this document belongs to and checks that there is no missing documents
5. For every document belonging to the consistent set of document, Integration checks:
1. If the document is loaded in session. If so, it must be already saved
2. The physical storage location path of the document is the user Work area
3. If the document already exists in PDM system:
   • It has been checked-out by the user
   • It has been modified since the last Check-Out [2]
   • It is not locked in the PDM
   • The new document is compatible with the document stored in the PDM
4. If the document doesn’t exists in PDM system: Integration must
   • Perform the reservation of the new document name in the PDM
   • Lock the new document name in the PDM
6. Integration updates the properties of the documents of the consistent set:
1. The document must be loaded in session
2. The property value of the document is updated in session
3. The document becomes modified in session
4. Integration must save the document in the user Work area again
7. Integration extracts information on this consistent set of documents
1. The Structure links hierarchy
2. The positioning matrices of the instances
3. The Consistent Set links
4. The current documents properties
5. gGenerates preview files
8. Integration updates PDM system data and information
1. The document links for the consistent set of document
2. The positioning matrices of the instances in the Product structure
3. Transfers the documents into the PDM repository (only modified documents)
4. Updates the PDM attributes of every document
• Incrementing the revision level of the document
• Associating with its preview file
5. Removes PDM lock on documents
9. Integration stops the Check-In command

[Top]

In Short

[Top]

References

History

Copyright © 1994-2005, Dassault Systèmes. All rights reserved.