3D PLM PPR Hub Open Gateway
|
File XPDM (PX1)
|
Check-Out Scenario
Process example for a Check-Out scenario |
Technical Article |
Abstract
This article explains the principles, and gives a step by step
scenario of Check-Out operation for a CATIA V5 and an external PDM System
integration [1].
|
Check-Out Scenario
The Check-Out is a scenario whereby CATIA V5 documents are extracted from
the PDM system repository to be opened in the interactive CATIA session.
Check-Out enables extract a consistent set of documents that has been
checked-in [2] previously . It reuses the document
link information, stored at Check-In step, to compute the consistent set of
documents in order to ensure the CATIA session consistency.
This operation is implemented by:
- Computing the consistent set of documents the document to Check-Out
belongs to
- Invoking in sequence the PDM Check-Out operation for each document
,
and for each of them
- Extracting it from the PDM repository
- Copying it in the user Work area [1].
- Opening the checked out document in the CATIA session
This scenario, developed in the
Check-Out Scenario Detailed
Steps section, can be also presented by this Diagram:
Fig.1: The Check-Out Scenario Diagram
 |
The Check-Out scenario must enforce the following rules:
- Check-Out operation processes a consistent set of documents
- user Work area must be cleared if some documents are out of
synchronization with the consistent set of document that will be extracted
from the PDM
- Documents must be copied and restored "as is" in the user Work area
[Top]
Check-Out Scenario
Detailed Steps
This section details step by step the Check-Out 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-Out scenario as an interactive
CATIA command running within the CATIA session context. It proposes a
Document Selection dialog box displaying the list of CATIA V5 documents
stored in the external PDM. The end users chooses a document to process.
A CATIA session is open.
- The user starts the Check-Out command
- Integration displays the dialog box enabling the seach for a document
in PDM system, and the user
- Locates the document in the displayed list
- Clicks OK button to confirm the selection
- Integration starts the Check-Out operation by performing
preliminary checks
- The selected document is not already checked-out in the PDM system
- The document is not locked in the PDM system
- Integration computes the consistent set of documents the
selected document belongs to, and checks for each of them
- If one already exists in the user Work area
- If it already exists in session, Check-Out operation must be
cancelled
- If it is not in session, a specific "Check-Out with force" option
can be implemented to support this specific case to pursue Check-Out
operation and replace the existing file.
- If one is locked or checked-out by
another user, Check-Out operation
must be cancelled
- For every document belonging to the consistent set of document,
Integration performs following operations
- Lock the document in the PDM
- Associate Check-Out status with the document in the PDM system
- Extract the document from the PDM vault and transfer it in the user
Work area
- Integration opens the
Check-Out document in V5 session within a new editor window
- Integration stops the Check-Out command
[Top]
In Short
[Top]
References
History
Version: 1 [Feb 2005] |
Document created |
[Top] |
Copyright © 1994-2005, Dassault Systèmes. All rights reserved.