3D PLM PPR Hub Open Gateway

File XPDM (PX1)

Sending a Consistent Set of Files

How to use CATIxPDMSendToServices

Use Case

Abstract

This article shows how to send a consistent set of files [1] using the CATIxPDMSendToServices interface

What You Will Learn With This Use Case
The CAAxPDMSendTo Use Case
Step-by-Step
In Short
References

What You Will Learn With This Use Case

This use case details the usage the CATIxPDMSendToServices interface.

[Top]

The CAAxPDMSendTo Use Case

CAAxPDMSendTo is a use case of the CAAxPDMInterfaces.edu framework that illustrates CATxPDMInterfaces framework capabilities. Be careful, such as all use cases illustrating the CATxPDMInterfaces framework, the current one requires a PX1 licence.

[Top]

What Does CAAxPDMSendTo Do

This use case sends (copies) a set of files to a target directory. The sent files are :

input files with their name
+ those pointed by input files. ( recursive computation)

The files are renamed (Send_to_CATIA_Document_Num) and, only Part and Product files are sent, other one are excluded.

A report file ( CAAxPDMSendToReport.txt ) in the target directory is created. It lists the sent file, and their new names.

Here is an example. ( see How to Launch CAAxPDMSendTo section)

mkrun -c "CAAxPDMSendTo TestDir E:\...\CAAxPDMInterfaces.edu\InputData\SendTo\Product1.CATProduct"

...
_The CAAxPDMSendTo main program begins ....

A session is created
Read all information on file : E:\...\CAAxPDMInterfaces.edu\InputData\SendTo\Product1.CATProduct
Compute Consistent set of E:\...\CAAxPDMInterfaces.edu\InputData\SendTo\Product1.CATProduct
Number of items in consistent set:3
-Found items:3
1 E:\...\CAAxPDMInterfaces.edu\InputData\SendTo\Product1.CATProduct
2 E:\...\CAAxPDMInterfaces.edu\InputData\SendTo\Part1.CATPart
3 E:\...\CAAxPDMInterfaces.edu\InputData\SendTo\Part2.CATPart
Item E:\...\CAAxPDMInterfaces.edu\InputData\SendTo\Product1.CATProduct will be send to :
TestEGD\Send_To_CATIA_Document_1.CATProduct
Item E:\...\CAAxPDMInterfaces.edu\InputData\SendTo\Part1.CATPart will be send to :
TestEGD\Send_To_CATIA_Document_2.CATPart
Item E:\...\CAAxPDMInterfaces.edu\InputData\SendTo\Part2.CATPart will be send to :
TestEGD\Send_To_CATIA_Document_3.CATPart
The session is deleted

The CAAxPDMSendTo main program is ended.
...

The CAAxPDMSendToReport.txt file is the following

...
_________________________________________________________

===========   Send To operation Report File   ===========
_________________________________________________________

====> The copy is carried out 
Location=: E:\.....\CAAxPDMInterfaces.edu\InputData\SendTo\
Name=: Product1.CATProduct
TargetLocation: TestDir
TargetCompleteName: Send_To_CATIA_Document_1.CATProduct

Success while copying the file :Product1.CATProduct 

Location=: E:\users\egd\adele\DevR17\egdpreint17\CAAxPDMInterfaces.edu\InputData\SendTo\
Name=: Part1.CATPart
TargetLocation: TestDir
TargetCompleteName: Send_To_CATIA_Document_2.CATPart

Success while copying the file :Part1.CATPart 

Location=: E:\users\egd\adele\DevR17\egdpreint17\CAAxPDMInterfaces.edu\InputData\SendTo\
Name=: Part2.CATPart
TargetLocation: TestDir
TargetCompleteName: Send_To_CATIA_Document_3.CATPart

Success while copying the file :Part2.CATPart 

Copied documents links update in progress 
_________________________________________________________
_________________________________________________________

 SEND TO OPERATION PROCESSED
_________________________________________________________
...

[Top]

How to Launch CAAxPDMSendTo

To launch CAAxPDMSendTo, you will need to set up the build time environment, then compile CAAxPDMSendTo along with its prerequisites, set up the run time environment, and then execute the use case [2]. To launch it, execute the following command:

mkrun -c "CAAxPDMSendTo TargetDirectory FileName1 [FileName2 FileName3 ...]"

where Filenamei is the complete path of a file. You can use those located in the InputData/SendTo directory of the CAAxPDMInterfaces.edu framework .

[Top]

Where to Find the CAAxPDMSendTo Code

The CAAxPDMSendTo use case is made of one single file, the CAAxPDMSendToMain.cpp file, located in the CAAxPDMSendTo.m module of the CAAxPDMInterfaces.edu framework:

Windows	`InstallRootDirectory\CAAxPDMInterfaces.edu\CAAxPDMSendTo.m\`
Unix	`InstallRootDirectory/CAAxPDMInterfaces.edu/CAAxPDMSendTo.m/`

where InstallRootDirectory is the directory where the CAA CD-ROM is installed.

[Top]

Step-by-Step

1. Read and Check the argument.
2. Open the session.
3. Retrieve the input file items.
4. Compute the cumulated consistent Set of the input file items.
5. Create a SendTo Instance.
6. Add all input file items.
7. Rename all pointed items of the consitent set
8. Remove all items which are not CATProduct or CATPart
9. Simulate Send To operation.
10. Run Send To operation.
11. Delete the session

[Top]

In Short

[Top]

References

[1]	CATIA V5 and External PDM System Integration Principles
[2]	Building and Launching a CAA V5 Use Case
[Top]

History

Version: 1 [Feb 2006]	Document created
[Top]