xfilev5 3.2.x users manual -...

Tex

t ve

rsio

n 2

015

-02-

17

XXFFIILLEEVV55 33..22..xx

for CATIA® V5

UUsseerrss MMaannuuaall

Orientation Symbols Used in the Manual

Warning triangle

The warning triangle refers to critical circumstances, which should be considered i m p e r a t i v e l y in order to avoid s e r i o u s problems in your work.

Hint symbol

The light bulb relates to hints, which provide you with practical examples to simplify your work.

Note symbol

The hand symbol relates to notes, which you should pay attention to in order to assure that you can work without problems.

Info symbol

The info symbol relates to background information.

Step symbol

The work steps symbol refers to a step-by-step instruction sheet.

TRANSCAT PLM on the Internet: http://www.transcat-plm.com/

TRANSCAT PLM Hotline: Phone: +49 721 9704335 E-mail: [email protected]

© TRANSCAT PLM GMBH 2015

http://www.transcat-plm.com/

mailto:[email protected]

T A B L E O F C O N T E N T S

Transcat PLM 3 XfileV5 3.2.x

Table of Contents

1. What is XF ILEV5 ? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2. XF ILEV5 in Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 X F I L E V 5 Language Support .................................................................................................... 8

2.1 XFILEV5 Operation Modes .................................................................................... 9

2.1.1 Interactive Mode ...................................................................................................................... 10

2.1.1.1 Export ....................................................................................................................................... 10 Export file tree dialog box ........................................................................................................ 16

2.1.1.2 Import ...................................................................................................................................... 20 Import File Tree dialog box ...................................................................................................... 25

2.1.2 Utility Mode ............................................................................................................................. 29

2.1.2.1 Export & … ............................................................................................................................... 29 2.1.2.2 Import ...................................................................................................................................... 29

2.1.3 Batch Mode.............................................................................................................................. 30

2.1.3.1 Export ....................................................................................................................................... 30 User modifications in the course of batch export ................................................................... 33

2.1.3.2 Import ...................................................................................................................................... 36

2.2 File Description—XFileV5.par ...................................................................... 39

2.3 License Management ......................................................................................... 43

2.4 XFILEV5 Output Information ............................................................................... 43

2.4.1 XML File ................................................................................................................................... 43

2.4.2 Log File for XFILEV5 ................................................................................................................. 48

2.4.3 Return Codes for XFILEV5 ........................................................................................................ 48

3. CV5 CONSISTENT F ILE SET in Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

3.1 How to Work ....................................................................................................... 52 Input on the Command Line—Syntax ..................................................................................... 52

3.2 The Check Results ...............................................................................................54

3.2.1 Report Files for CV5 CONSISTENT FILE SET ................................................................................ 55

3.2.2 Log File for CV5 CONSISTENT FILE SET ...................................................................................... 58

3.2.3 Return Codes for CV5 CONSISTENT FILE SET ............................................................................ 58

3.3 TCAXFILEV5Customize.nls File ................................................................. 58

4. DELETE in Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

4.1 Functionality in General ..................................................................................... 59

4.2 Work Steps ......................................................................................................... 60 Checks executed while deleting ............................................................................................... 61

4.3 Graphical User Interface of DELETE ..................................................................... 62

T A B L E O F C O N T E N T S


4.4 Log File for DELETE ............................................................................................. 64

5. MOVE in Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.1 Introduction ....................................................................................................... 65

5.2 Send files with Move .......................................................................................... 66

5.3 Resolve conflicts ................................................................................................ 67

5.4 Save and restore the transfer list ........................................................................ 68

5.5 Define names and properties for moved files ..................................................... 69

5.5.1 General ..................................................................................................................................... 69

5.5.2 Define new names and properties manually .......................................................................... 69

5.5.3 Define new names and properties using an external process ............................................... 70

5.5.4 Add or change properties ........................................................................................................ 70

5.6 Reference to the Move dialog ............................................................................. 72

5.7 Report Files ......................................................................................................... 75

* * *

W H A T I S X F I L E V 5 ?


1. What is XFILEV5 ?

XFILEV5 is a package of programs conceived to facilitate the work with CATIA V5

documents. It consists of four modules independent of each other:

XFILEV5 itself and CV5 CONSISTENT FILE SET, DELETE and MOVE. The different modules will

be described below.

XFILEV5 is a tool facilitating the exchange of CATIA V5 document sets on both sending

and receiving sides:

On the send ing side the tool finds out on the base of a specified root document,

which are the linked documents of this root and packs them in a container file.

On the rece i v ing side the tool unpacks the container file and checks the complete-

ness of the CATIA V5 document sets.

The main features and benefits of XFILEV5 will be described in the following section 32H32H2

33H33HXFILEV5 in Detail starting on page 34H34H7.

CV5 CONSISTENT FILE SET is a tool for the verification of directories:

—it checks all files contained in a specified directory to find out whether the document

set in it is consistent

—and eventually generates one or two report files in xml format, a text log file and

gives out return code.

For detailed description see section 35H35H3 36H36HCV5 CONSISTENT FILE SET in Detail, starting on

page 37H37H49.

DELETE is a tool destined to help the user giving him a clear overview when deleting

structured CATIA V5 and CATIA V4 documents:

—DELETE checks which linked documents relate to the currently opened CATIA

document or to the selected components;

—the DELETE tool deletes completely:

The opened CATIA document and the documents linked to it;

In case of CATProducts: The selected document within the opened document

and the documents linked to it.

CV5 CONSISTENT

FILE SET

DELETE

MOVE

XFILEV5

W H A T I S X F I L E V 5 ?


—Components that are referenced by other documents will be excluded from

deleting.

—DELETE finally generates a log file in txt format.

For detailed description see section 4 Delete in Detail on page 59.

MOVE is a tool that facilitates moving of CATIA V5 and CATIA V4 documents to a

different directory:

—MOVE determines the documents linked to a selected CATIA document.

—MOVE transfers the the root document and all linked documents to a directory

selected by the user.

—For moving the CATIA SendTo method is used.

—The files in the original location can be kept or deleted.

—MOVE generates a report about the operation.

For detailed description see section 5 Move in Detail on page 65.

X F I L E V 5 I N D E T A I L


2. XFILEV5 in Detail

Export

Import

Exp o r t

The sender specifies a root document of a CATIA file set to be prepared for sending. For

this root document all linked documents—existing and missing ones—will be identified.

The sender may verify in a File tree dialog box the extent and the structure of the file set:

—Which files are in the file set?

—What is the hierarchy?

—Are there missing files?

Also the sender may determine which files are not to send so that is no need to send

unnecessary documents.

When the settings are done, pressing the Start button launches the process of packing the

selected document set, a container file is created storing beside of the documents them-

selves also an XML file containing information on the document set.

Imp o r t

During import the container file is unpacked, the completeness of the CATIA V5 document

sets is checked (if it matches the XML file information), and the link information is

adapted to the target directory.

Interactive import allows to import as well XFILEV5 containers as non-XFILEV5 container. In

case of non-XFILEV5 containers, first an analysis must be started.

Do cument se t in fo rmat io n :

The XML information file contains data-exchange relevant information: names of all docu-

ments—sent as well as not sent or missing—, and their type, directory names etc.

Unpacking and checking documents

XML Report File

TXT Log File

Return Code

unpacked document set

Selecting TAR file

START

Packing document set

TAR file with selected CATIA documents and XML Report File

TXT Log File

Return Code

Selecting root document

START

Option: Selecting documents

X F I L E V 5 I N D E T A I L


Pack ing a nd unp ack ing :

In order to avoid loss of naming information, the documents for sending are packed in a

container file. To avoid incompatibilities of packing tools, GNU PACKER is delivered with

XFILEV5 so that all XFILEV5 users will work with the same tool.

Avo id ing l ink p ro b lems :

The Send To save method of CATIA is used to adapt the link information according to the

current directory. For packing the Send To method is used optionally, for unpacking the

use is compulsory.

XF I LEV5 Language Support

XFILEV5 is delivered with both German and English GUI. In which language the manual is

opened depends from the language selected for CATIA. If in CATIA an other language

beside English and German has been selected, XFILEV5 is opened with English GUI.

2 . X F I L E V 5 I N D E T A I L


2.1 XFILEV5 Operation Modes

To work with XFILEV5, th ree d i f f e ren t o pe ra t io n mo des are available. The table

below gives an overview of these modes.

The details of the operation modes will be described in the following chapters.

Operation mode

How to be started Purpose and general description Detailed description

Interactive Mode

CATIA icon to start CATIA with XFILEV5 environment

Exporting or importing CATIA document sets and other linked documents from w i t h i n CATIA V5

See section 38H38H2.1.1 2H2HInteract ive Mode on page 39H39H10.

Utility Mode

XFILEV5 desktop icon

Exporting or importing CATIA document sets and other linked documents from GUI w i t h o u t s t a r t i n g CATIA.

See section 40H40H2.1.2 3H3HUtility Mode on page 41H41H13

Batch Mode

From command line Exporting or importing CATIA document sets and other linked documents from c o m m a n d l i n e . Batch Mode allows integration of data-exchange operations into automated processing applications, possibility to process several jobs one after another.

See chapter 42H42H2.1.3 4H4HBatch Mode on page 43H43H30.

2 . X F I L E V 5 I N D E T A I L — 2 . 1 X F I L E V 5 O P E R A T I O N M O D E S — I N T E R A C T I V E M O D E


2.1.1 Interactive Mode

The interactive mode of XFILEV5 is started inside an interactive CATIA V5 session; the

operation is controlled via GUI.

2.1.1.1 Export

The Export function provides the following functionalities (cf. fig. below):

To select the inp ut do cument to be sent.

To specify the o u tp u t co n ta ine r f i l e na me .

To select the co p y metho d (normal copying or copying using Send To method).

To specify the l o g - f i l e name .

The 44H44H70H70HExport file tree dialog box (see page 45H45H16) allows:

To verify whether documents of the document set are missing.

To select which documents are to be packed in the container file.



Export dialog box

Input box

Root file name text box with File selection button and Root document selection button

These three elements allow to select the document to be sent. The document name can be entered in the text box or can be selected with the File selection dialog box or with the Root directory selection dialog box, which are opened after pressing the respective button.

46H46H

In case of Interactive Mode by default the text box is filled with the name of the

currently opened CATIA document.

Open file button

This button opens the File selection dialog box in which a document to send can be selected.



Root directory selection button

This button opens the Root directory selection dialog box that facilitates root-documents recognition.

After clicking this button, first a directory selection dialog box is opened. Select in this window a directory and click the OK button. The selected directory is scanned for root documents, which then will be displayed for selection in the root-document selection dialog box. Select in the root-document selection dialog box the required root document.

In the Root selection box the required root document is to be selected.

In the Existing files box, it can be verified which files relate to the selected root document.

In the Missing files box the names of documents are displayed that are linked to the selected root document, but are missing.

The Filter list box allows to restrict the display in the Root selection box to the documents of one only document type.

Output box

Container file name text box and Open file button

These two elements allow to define the name of the container file to be created. 47H47HThe document name can be entered in the text box or can be selected with the File selection dialog box, which is opened after pressing the respective button.

By de fau l t , this text box is filled with a name identical to the root-document name, the extension tar being added (if this is predefined in the XFileV5.par admini-stration file—keyword EXP_CONTAINER_DEF_TAR_EXTENSION). The user can define a default directory of the container file using the environment variable TCAXFILEV5_EXP_TARGET_DIR .

To p rede f ine a name for the container file, the TCAXFILEV5_ADMIN environment variable is to be used, which points to the XFileV5.par file in the admin directory. In the XFileV5.par file the format of the container name can be predefined.



Copy files using Send to check box

If this option is activated, the selected files will be sent to the specified directory using the CATIA Send To method. If unchecked, normal copying will take place. (This check box can be deactivated by the administrator.)

Keep directory structure check box

This option is active only if the Copy files using Send To check box is activated.

If this check box is activated, the Send-to method will be applied with keeping the directory structure. (This check box can be deactivated by the administrator.)

Copying files using SendTo method with activated Keep directory structure

option is possible only if all files to copy are on the same d r i ve .

Copying files using SendTo method with activated Keep directory structure option is no t possible if DLNam es are used.

Call external process check box

The name of this check box might have been mo d i f i ed according to user needs!

(The name of the checkbox can be defined in the TCAXFILEV5Customize.nls file with the parameter of the keyword Export_CallExternalProcessCheckButton_Label).

If this option is activated, after pressing the 76H76HStart button 77H77H—as soon as the file container is created—a user-programmed process will be started. This process may consist of different operations that automatize export/send processes (as copying files, sending the prepared container file into a predefined directory or to a specified address, writing the results of the XFILEV5 operation into a database for statistical overview etc.).

In the XFileV5.par file the arguments of the external process can be predefined, using the xfileV5.EXP_EXTERNAL_PROCESS_ARG variable.

When an external process is started, XFILEV5 can show two behaviors, depending from the setting for xfileV5.EXP_EXTERNAL_PROCESS_WAIT – XFILEV5 can wait for the end of the external process or not wait for it (cf. page 40).

Check options box

CATDUA for Ghost links analysis check box

If this option is activated, a check for ghost links will be executed. In case that ghost links have been found, the user can solve the link problem by using the CATIA CATDUA routine. To see whether by the check ghost links have been found, press the 48H48HShow Tree button 49H49H to open the 50H50H70H70HExport file tree dialog box—if found, in the 53H53HDocument tree box 54H54H (page 55H55H19) in the file tree b lue icons before the file name will be displayed, signaling that the respective file needs to be processed with the CATDUA routine. In the 56H56HGeneral info box 57H57H (see page 58H58H16) the number of the files with the NeedCATDUA state will be indicated with their total size. Cf. 59H59HShow/hide files with ghost-link toggle switch 60H60H on page 61H61H17). If ghost links have been found and the 62H62HStart button 63H63H is pressed, a warning message will be displayed.



Tree box

Show preview check box

If this option is activated, in the 64H64H70H70HExport file tree dialog box the 67H67HPreview box 68H68H (see page 69H69H20) will be activated.

No te : If a directory is write-protected, a preview of the files in it cannot be given.

Show properties check box

If this option is activated, in the Export file tree dialog box the properties of the highlighted component will be displayed.

Show product structure check box

This check box controls whether in the Export file tree dialog box (see page 72H72H16) the documents will be shown in a (simplified) hierarchical product structure or only in a flat structure.

Show Tree button

By pressing this button the selected root directory is checked and the Export file tree dialog box is opened—see section 70H70H70H70HExport file tree dialog box on page 16. The icon on the button prompts in which structure the file tree will be shown (hierarchical or flat).

Report box

Log-file name text box and Open file button

These two elements allow to specify the log file document. The document name can be entered in the text box or can be selected with the File selection dialog box, which is opened after pressing the respective button.

By de fau l t this text box is filled with a name identical to the root-document name, the extension log being added. The default directory of the log file is predefined:

by the environment variable TCAXFILEV5_TMP_DIR

or (in case of TCAXFILEV5_TMP_DIR variable not defined) by the CATIA environment variable CATTemp .

Start button

By pressing this button, the send operation is started.

The documents activated for sending and the XML file are copied into a temporary directory (depending on the selected option, either by normal copying or using the CATIA Send To functionality). This temporary directory by default is the CATIA tem-porary directory. With the CATIA TCAXFILEV5_TMP_DIR environment variable a predefined directory can be specified. The files saved in the t emp o ra r y directory then are packed in the specified container file, which is saved in the t a rge t directory. When this operation is finished, the temporary directory is deleted.

XFileV5 Help button

When this button is clicked, the XFILEV5 manual is opened (this manual).



78H78H

For UNIX, the TCAXFILEV5_DOC environment variable must also

contain the command to launch ACROBAT READER and the path of the

PDF manual file.

Info button

When this button is clicked, information about XFILEV5 (version number etc.) is displayed.

Exit button

By pressing this button, the dialog box is closed, the settings made in the dialog box being saved in the CATSetting file.



Export file tree dialog box

The Export-file tree dialog box displays the root product and all its child documents, giving

an overview of the documents and their properties—especially if documents are missing

or not, and allows to control which files are to be packed in the container file. Depending

on whether the 79H79HShow product structure check box (see page 80H80H14 item 81H81H) was activated or

not, the file tree may be displayed with hierarchical product structure (checked) or in flat

structure (unchecked).

File tree with hierarchical product structure

… without hierarchical structure

General info box

Here the number of existing, missing, not-to-send files and files with ghost links is displayed with their total size (for missing files a size can not be given).

If with the Show product structure check box (page 14) the export was pre-defined w i th product structure, also the number of deactivated components is displayed (this is possible only in case a CATIA version is run R16 SP3 or higher).



Tree options box

Buttons for tree manipulation

Anchor button

Pressing this button moves the root of the document tree to the left upper corner of the tree box.

Expand all button

Pressing this button expands the document tree completely.

Collapse all button

Pressing this button collapses the document tree completely.

T I P P :

For the se l ec ted elements the expand/collapse func-tionalities also are accessible over the co n tex t - sen -s i t i ve menu.

Visibil ity fi l ter toggle switches

Show/hide parameters toggle switch

When this button is pressed, the parameters of the documents are hidden; when it is not pressed, the parameters are shown (provided that the knots are expanded).

Show/hide existing files toggle switch

When this button is pressed, the existing files are hidden. The root document never will be hidden.

Show/hide missing files toggle switch

When this button is pressed, missing documents are hidden (if such exist).

Show/hide not-to-send files toggle switch

When this button is pressed, documents with NOT_SEND state (files that are not to be packed in the container file) are hidden (if such exist).

Show/hide files with ghost-link toggle switch

When this button is pressed, files are hidden that have a ghost link (files having a blue icon, if such exist).

In case that the icon is grayed out, the CATDUA for Ghost links analysis check box (see page 13) was not activated and no check for ghost links was executed.



Show/hide deactivated components toggle switch

When this button is pressed, deactivated components are hidden (if such exist).

The icon is grayed out when the file tree is displayed without product structure.

Parent elements having unhidden children in every case will remain unhidden—

as long as these children are not hidden.

The root document never will be hidden.

File name / Part number l ist box

This list box is active if in the Export dialog box the Show properties check box is activated. In this check box, it can be selected which entity names are to display in the file tree—file names or part numbers.

Selected entities box and Deactivated entities box

Send/not send buttons

These buttons allow to control whether a document will be sent or not—the docu-ments are switched between their initial state (no NOT_SEND state, i. e. they will be sent) and the NOT_SEND state (the documents will not be sent).

Not send selection and children button

By pressing this button the highlighted document and its children will be set to the NOT_SEND state. (If the highlighted document has no children, only this highlighted document will be set to the NOT_SEND state.)

Send only selection button

The highlighted document and its parents will be set back to Send state (i. e. their NOT_SEND attribute is deleted).

Send selection and children button

The highlighted document and all its parents and children will be set back to the SEND state.

Not send deactivated entities button

Clicking on this button will switch deactivated components to the NOT_SEND state.

Send deactivated entities button

Clicking on this button will switch deactivated components back to the Send state (i. e. they will be sent).



Filter combo boxes

With the Name and Type combo boxes the documents displayed in the Document tree box can be filtered, i. e. the number of documents displayed will be restricted to the ones, having the selected or specified names and types.

Name combo box: * — all documents with any name are displayed. E xamp les : Printer* — only documents with names beginning with “Printer” are displayed. ???_Start — only documents with names beginning with any three characters and ending with “_Start” are displayed.

Type combo box: — From the list one of different types of CATIA documents can be selected. — In the box can be entered any document types. If entering several types, they must be semicolon separated. Example: CATProduct;CATPart;CATDrawing;doc;jpg — In the Document tree box documents of the CATIA types CATProduct, CATPart, CATDrawing, and also doc and jpg documents are displayed; other types are not displayed (being filtered out).

Document tree box

Which elements of the document tree are displayed in the Document tree box depends on the selection made with the buttons or by means of the context-sensitive menu.

The file state icons may have add i t io na l marks :

(1) P ink squ are :

This mark prompts that the file exists in seve r a l ins tan ces . In the proper-ties box there is displayed the number of instances that exist beside the highlighted element itself (e. g. in the screenshot above there is given the information IDENTICAL_NODES_NB. 1, what means that in total there are two instances in the file tree—the one highlighted and another one).

82H82H

If a l l instances of an element have the not-send state, the pink square

mark is not shown.

(2) The deactivated-element mark:

This mark (with dark-red brackets) prompts that the element is deactivated.

(3) Multi-model links

This mark (with question mark) prompts that the element has a multi-model link.



(4) Node is shown compulsorily:

Due to filter settings, this node normally would not be shown; as it is in top position, it is shown nevertheless.

(5) Node is shown compulsorily and has not-send state:

Same as (4), but with not-send state.

Context-sensitive menu of the tree entities

The tree entity is expanded.

The tree entity is collapsed.

The entity is set to the not-send state.

The entity is set to the send state.

The entity and its children are set to the send state.

Properties box

This box displays the properties of the highlighted document.

Preview box

When in the Export dialog box (see on page 83H83H1111) the 84H84HShow preview check box 85H85H (see on page 86H86H14) is activated, in this box for CATIA V5 model files a preview will be displayed. If for a file no preview is possible, a message will be displayed instead.

OK button

When this button is pressed, the tree dialog box is closed with saving the NOT_SEND state settings.

Exit button

When this button is pressed, the tree dialog box is closed, the last NOT_SEND state settings being discarded.

2.1.1.2 Import

The Import function provides the following functionalities (cf. fig. below):



Selecting the input document to be imported

Specifying the target directory

Specifying the log-file name

Defining whether the container file is only to be extracted or also is to be copied to the

target directory.

Specifying for interactive mode, whether the imported root document is to be opened

for a CATIA session.

For import in every case the Send To method is used, ensuring adaptation of the link

information to the new directory.



Input box

Container-file name text box and Open file button

These two elements allow to select the container file to be unpacked. 87H87HThe document name can be entered in the text box or can be selected with the File selection dialog box, which is opened after pressing the respective button. When reopening the dialog box for a new session, the text box is filled with the name of the container file from the preceding session.

Root-file name text box and Analyze container button

Two cases are possible:

(6) In the Container-file name text box an XFileV5 container has been specified or

(7) an other container, i. e. a non-XFILEV5 container, has been specified.

Ad (6): In the Root-file name text box, no name is specified (as in XFILEV5 containers only o ne root file is available). Clicking the Analyze container button will result in a message displayed that the selected container is an XFILEV5 container.

Ad (7): In case that an other container has been specified, it needs to be analyzed. In comparison to the import of XFILEV5 containers importing other containers might last longer because of the analysis.

Clicking on the Start button or Show Tree Dialog button without having analyzed the container will trigger warning messages.

To analyze the container click the Analyze container button. This opens the Container analysis window.

In the Root selection box the required root document is to be selected.

In the Existing files box, it can be verified which files relate to the selected root document.

In the Missing files box the names of documents are displayed that are linked to the selected root document, but are missing.



The Filter list box allows to restrict the display in the Root selection box to the documents of one only document type.

With the SAM Light button, the SAM LIGHT application is started. This button is active only in case that the container contains a file of the *.stp type.

Clicking the OK button will close this dialog box, taking over the selected root docu-ment name in the Root-file name text box (see page 22).

Output box

Taking over button

If this button is clicked, from the Container-file name text box the long path name is taken over as target directory name. If a container has no .tar extension, a suffix is appended, which is predefined in the XFILEV5 administration file (keyword imp_target_dir_suffix).

Target directory text box and Directory selection button

These elements allow to select the target directory where the unpacked files are to be saved. The directory name can be entered in the text box or can be selected with the dialog box, which is opened after pressing the Directory selection button. With the TCAXFILEV5_IMP_TARGET_DIR environment variable a directory can be predefined.

Keep directory structure check box

If this check box is activated, the Send-to method will be applied with keeping the directory structure. If the container to import contains no directory structure, the Send-to method will be applied without directory structure.

The state for this check box depends on the setting made for the keyword xfileV5.IMP_KEEP_DIR_DLG (cf. page 41).

Load root document check box

This option is available only for Interactive Mode. If it is activated, the import operation will be completed with opening the imported root document in CATIA.

Tree box

Show preview check box

If this option is activated, in the 88H88HImport File Tree dialog box the 91H91HPreview box 92H92H (page 93H93H28) will be activated.

94H94HNo te : If a directory is write-protected, a preview of the files in it cannot be given.

Show properties check box

If this option is activated, in the 88H88HImport File Tree dialog box the properties of the highlighted component will be displayed. 94H94

Show product structure check box

This check box controls whether in the 88H88HImport File Tree dialog box 7 the documents will be shown in a (simplified) hierarchical product structure or only in a flat structure.



Show Tree Dialog button

By pressing this button the import container is unpacked and the Import file tree dialog box is opened—see section 96H96HImport File Tree dialog box (page 25). The icon on the button prompts in which structure the file tree will be shown (hierarchical or flat).

Report box

Log-file name text box and Open file button

These two elements allow to specify the log file document. The document name can be entered in the text box or can be selected with the File selection dialog box, which is opened after pressing the respective button.

By de fau l t this text box is filled with a name identical to the root-document name, the extension log being added. The default directory of the log file is predefined:

by the environment variable TCAXFILEV5_TMP_DIR

or (in case of TCAXFILEV5_TMP_DIR variable not defined) by the CATIA environment variable CATTemp .

Start button

By pressing this button, the import operation is started.

The import operation comprises the following steps: The container file selected for import will be unpacked in a temporary directory (if before the 98H98HShow Tree Dialog button 99H99H [page 100H100H24] not had already been pressed so that the unpacking operation already had been executed). The completeness of the file set will be checked by com-paring the file set with the XML file information (in case of missing files a warning message will be displayed). The files will be transferred into the target directory and the link information is adapted to the new directory, using CATIA Send To method. For Interactive Mode, in case of activated Load root document option, the import operation will be completed with opening the root document in CATIA. This will c l o se the XFILEV5 program.

102H102H

103H103HXFileV5 Help button

When this button is clicked, the XFILEV5 manual is opened (this manual).

104H104H

105H105HFor UNIX, the TCAXFILEV5_DOC environment variable must also

contain the command to launch ACROBAT READER and the path of the

PDF manual file.

Info button

When this button is clicked, information about XFILEV5 (version number etc.) is displayed.

101H101HExit button

By pressing this button, the dialog box is closed, the settings made in the dialog box being saved in the CATSetting file.



Import File Tree dialog box

The Import-file-tree dialog box displays the files of the directory of the unpacked import

container—root product and all its child documents, giving an overview of the documents

and their properties—especially if documents are missing or not, and allows to see which

files are imported. This dialog box gives only an overview of the files to import, but it does

not provide tools controlling the import.

File-tree with elements checked previously for ghost l inks

… no t checked previously

General info box

General info box

Here the number of existing, missing, not-to-send files and files with ghost links is displayed with their total size (for missing files a size can not be given).



If with the Show product structure check box (page 14) the export was pre-defined w i th product structure, also the number of deactivated components is displayed (this is possible only in case a CATIA version is run R16 SP3 or higher). The number of deactivated components is not displayed.

Tree options box

Buttons for tree manipulation

Anchor button

Pressing this button moves the root of the document tree to the left upper corner of the tree box.

Expand all button

Pressing this button expands the document tree completely.

Collapse all button

Pressing this button collapses the document tree completely.

T I P P :

For the se l ec ted elements the expand/collapse func-tionalities also are accessible over the co n tex t - sen -s i t i ve menu.

Visibil ity fi l ter toggle switches

Show/hide parameters toggle switch

When this button is pressed, the parameters of the documents are hidden; when it is not pressed, the parameters are shown (provided that the knots are expanded).

Show/hide existing files toggle switch

When this button is pressed, the existing files are hidden. The root document never will be hidden.

Show/hide missing files toggle switch

When this button is pressed, missing documents are hidden (if such exist).

Show/hide not-to-send files toggle switch

When this button is pressed, documents with NOT_SEND state (files that are not to be packed in the container file) are hidden (if such exist).

Show/hide files with ghost-link toggle switch

When this button is pressed, files are hidden that have a ghost link (files having a blue icon, if such exist).



110H110H

111H111HIn case that the icon is grayed out, the sender, while exporting the files, did

not execute the CATDUA for Ghost links analysis (for details see Export dia-

log box—CATDUA for Ghost links analysis check box on page 13).

Show/hide deactivated components toggle switch

When this button is pressed, deactivated components are hidden (if such exist).

The icon is grayed out when the file tree is displayed without product structure.

Parent elements having unhidden children in every case will remain unhidden—

as long as these children are not hidden.

The root document never will be hidden.

File name / Part number l ist box

This list box is active if in the Export dialog box the Show properties check box is activated. In this check box, it can be selected which entity names are to display in the file tree—file names or part numbers.

Selected entities box and Deactivated entities box

Send/not send buttons

These buttons for import are not active.

Filter combo boxesWith the Name and Type combo boxes the documents displayed in the Document tree box can be filtered, i. e. the number of documents displayed will be restricted to the ones, having the selected or specified names and types.

Name combo box: * — all documents with any name are displayed. E xamp les : Printer* — only documents with names beginning with “Printer” are displayed. ???_Start — only documents with names beginning with any three characters and ending with “_Start” are displayed.

Type combo box: — From the list one of different types of CATIA documents can be selected. — In the box can be entered any document types. If entering several types, they must be semicolon separated. Example: CATProduct;CATPart;CATDrawing;doc;jpg — In the Document tree box documents OF the CATIA types CATProduct, CATPart, CATDrawing, and also doc and jpg documents are displayed; other types are not displayed (being filtered out).



Document tree box

Which elements of the document tree are displayed in the Document tree box depends on the selection made with the buttons or by means of the context-sensitive menu.

The file state icons may have add i t io na l marks :

( 8 ) P ink squ are :

This mark prompts that the file exists in seve r a l ins tan ces . In the proper-ties box there is displayed the number of instances that exist beside the highlighted element itself (e. g. in the screenshot above there is given the information IDENTICAL_NODES_NB. 1, what means that in total there are two instances in the file tree—the one highlighted and another one).

82H82H

If a l l instances of an element have the not-send state, the pink square

mark is not shown.

(9) The deactivated-element mark:

This mark (with dark-red brackets) prompts that the element is deactivated.

(10) Multi-model links

This mark (with question mark) prompts that the element has a multi-model link.

(11) Node is shown compulsorily:

Due to filter settings, this node normally would not be shown; as it is in top position, it is shown nevertheless.

(12) Node is shown compulsorily and has not-send state:

Same as (4), but with not-send state.

Properties box

This box displays the properties of the highlighted document.

Preview box

When in the Import dialog box the 113H113HShow preview check box 114H114H (see on page 115H115H23) is activated, in this box for CATIA V5 model files a preview will be displayed. If for a file no preview is possible, a message will be displayed instead.

Close button

When this button is pressed, the tree dialog box is closed.

2 . 1 X F I L E V 5 O P E R A T I O N M O D E S


2.1.2 Utility Mode

2.1.2.1 Export & …

2.1.2.2 Import

The Utility Mode provides the advantage that export/import operation can be executed

outside of CATIA (i. e. without starting CATIA). Beside of that and despite the slightly

different optical aspect of the GUIs, the export and import functionalities of the Utility

Mode and the structure of the respective windows are identical with those of the

Interactive Mode—thus the detailed description in sections 116H116H2.1.1.1 117H117HExport (starting from

page 118H118H10) and 119H119H2.1.1.2 120H120HImport (starting on page 121H121H20) applies also for the Utility Mode.

Export

Import



2.1.3 Batch Mode

General Options

TCAXFILEV5BatchMd -?|-h|-help Displaying help information.

TCAXFILEV5BatchMd -v|-version Displaying the version number of the program.

2.1.3.1 Export

Batch export can be performed—depending on the options set—

either in tw o steps—(1) Export operation 1 (XML file export) and then (2) Export operation 2 (export of container file from XML file)

or as o ne co n t inuous operation—Export operation 3 (creation of container file directly FROM CATIA file).

Structuring the export into two operations provides the following possibilities:

When having creating the XML file, it can be looked up before creating the container file (e. g. to verify if it contains all required documents).

Element names can be changed.

(For details see section “User modifications in the course of batch export” on p. 33.)

Input on the Command Line—Syntax

<CATIA_install-path>\code\bin\catstart -env environmentName -direnv environmentDirectory –run

"TCAXFILEV5BatchMd -exp -r rootfilePathName -x xmlReportPathName

-c containerPathName -l logFile [-s] [-p previewFormat] [-catdua]

[-keepdir] [-extended]"

TCAXFILEV5BatchMd Program name

Environment: In case that the CATIA V5 environment not has been set yet:

–env environmentName Environment name: Write the name of the of XFILEV5 environment.



–direnv

e

n

v

i

r

o

n

m

e

n

t

P

a

t

h

Environment path: Write the full path of the environment.

-exp Start export.

–r rootfilePathName Path and name of the root

file: Write –r followed by blank and full path name of the

root file.

–x xmlReportPathName Path and name of the XML report file

Write –x followed by blank and full path name of the XML report file to be created—if you want to create o n l y an XML report file

–c containerPathName Path and name of the container file to create:

Write –c followed by blank and full path name of the container file to be created (backslash/ slash included!)—if you want to create a container file with XML report file included in it.

122H122H Alternatives using –x and –c

Export operations: (1) When using –r and –x, only an XML report file will be

created. (2) When using –r and –c, a container file will be created,

containing the exported files and the XML report file in it.

(3) When using –x and –c, a container file will be created on the base of the information in the XML report file. (In this case, the option -r is not used.)

[-s] Copying files using CATIA Send To method

Optional. If this option is set, for copying the CATIA Send To method will be used. This setting will be ignored in case of exporting only an XML file (Export operation 1).

–l logFile Path and name of the log file

Write: –l followed by blank and full path where the log file is to be created. If the -l option is not specified by the user; nevertheless a log file will be created in a default path, the name of the path being displayed on the console.



[-p previewFormat] Creating previews of the exported CATIA files

Optional. If this option is set, for every exported CATIA file a preview will be created. Instead of previewFormat, write the required format code (jpg, bmp, tif, or png). This setting will be ignored in case of the exporting only an XML file (Export operation 1). 123H123HN o t e : If a directory is write-protected, a preview of the files in it cannot be given.

[-catdua] Check whether exist files with ghost links

Optional. In case that files with ghost links exist, a warning will be written in the log file (return code 5).

[-keepdir] Send-to method with keeping directory structure

Optional. The Send-to method will be applied with keeping the directory structure. This option is operationally only if also the [-s] option is activated.

[-extended] Extended batch-export mode

Optional. This option allows to create in the XML file additional attributes with their respective sub-elements:

INTERNAL_ID: Internal element identification number in the XML file.

PROPERTIES: Properties of the element (these attributes are created in case that the elements really have properties.

STRUCTURE: Structure component of the CATIA docu-ment.

If this option is activated, for the Export operation 2 (ex-port of container file from XML file) (see p. 33) auto-matically the SendTo method is used (cf. above option [-s]).

NOTE:

For running XFileV5 in batch mode, the following variable should be set either as a CATIA environment variable or system variable:

I4LIB_VERB=YES

Set this variable to avoid certain problems that cause the abnormal termination of the CATIA batch process.

124H124H

Hint:

For batch export DLNames can be used.



Syntax Examples

Export operation 1 (XML file export):

<CATIA_install-path>\code\bin\catstart -env environmentName -direnv environmentDirectory

–run "TCAXFILEV5BatchMd

-exp –r /V5Models/RootFile.CATProduct

-x /tmp/report.xml -l /tmp/log.txt"

Export operation 2 (export of container file from XML file):


–run "TCAXFILEV5BatchMd -exp -x /tmp/report.xml

-c /ContainerPath/ContainerName.tar

-l /tmp/log.txt"

Export operation 3 (creation of container file directly from CATIA file):


–run "TCAXFILEV5BatchMd -exp

-r /V5Models/RootFile.CATProduct

-c /ContainerPath/ContainerName.tar

-l /tmp/log.txt"

User modifications in the course of batch export

Performing batch export in two steps gives the user the opportunity to modify the names/

values of certain elements of the CATIA document, e. g. in order to adapt the names to the

receiver’s naming conventions. To be able to perform these modifications, it is required to

set for both export steps the extended mode (using the –extended option, which in the

syntax example above is not indicated). The modifications then are to be executed by the

user in the XML file. It is possible to modify the names/values in the NAME, VALUE and

INSTANCE_NAME attributes, and to add new properties. When the receiver afterwards



will perform the import, the newly defined names/attributes will be adopted as the new

CATIA element names. The procedure will be explained in detail below.

Steps for modification

(1) In i t i a l s t a t e : The XML file created as the result of the

Export operation 1 (XML file export) contains only the

NAME, VALUE and INSTANCE_NAME attributes (the last-

mentioned two types may exist, but are not mandatory).

(1)

(2)

(3)

(2) M o di f y ing the names : In this XML file, the user

can add to each existing NAME, VALUE and

INSTANCE_NAME attributes one NEW_NAME,

NEW_INSTANCE_NAME and NEW_VALUE attribute

respectively. In these new attributes the new

names/values are to be specified that are to replace the

existing names/values. (To do that, for instantce, text

editors, XML editors or special software with integrated

renaming tools can be used.)

No te : If NEW_NAME is used to define a new file name,

then consider:

(a) Specify the filename without extension.

(b) Don’t use special characters

(as German “ä”, “ü”, “ö” or “ß”).

(c) If several new file names are defined, never use a

filename twice.

Add ing new p ro per t i es : The user can add new

properties to the XML file. In an existing PROPERTIES

node, a new PROPERTY element can be inserted. For the

new PROPERTY element, the following attributes have to

be specified: NAME, TYPE, VALUE, NEW_VALUE and

VALUE_TYPE.

(3) Crea t ing the co n ta ine r f i l e : While creating the

container file with the Export operation 2 (export of con-

tainer file from XML file), a new XML file (report file) will

be created. In this new XML file the user-defined names/

values will be adopted as the new names of the docu-

ments, values and instances respectively. The initial

names/values are held in the OLD_NAME, OLD_VALUE

or OLD_INSTANCE_NAME attributes.



When the receiver will perform the import, the new names/values that now have been

transferred into the NAME, VALUE and INSTANCE_NAME attributes will be adopted as

the new CATIA element names. The initial names/values in the attributes having the OLD_

prefix will no more be used; they are kept in the XML file only for the purpose of control.

NOTE:

If in the XML file new names/values are defined, but the -extended option not have been set for both export operations, the new names/values will be conserved in the XML file, but they will no be used.



2.1.3.2 Import



–run "TCAXFILEV5BatchMd –imp -c containerFileName [-t targetPath]

-l logFile [-p previewFormat] [-notow] [-keepdir]"

TCAXFILEV5BatchMd Program name


–env environmentName Environment name: Write the name of the of CATIA V5 environment (XFILEV5 environment is a part of it).

–direnv

e

n

v

i

r

o

n

m

e

n

t

P

a

t

h

Environment path: Write the full path of the environment.

-imp Start import.

–c containerPathName Path and name of the container file to import:

Write –c followed by blank and full path name (included file name) of the container file to import

[–t targetPath] Target path: Optional. Write –t followed by blank and the path name of the target path. Import options: (1) If no target path is specified, the container file

will be opened in its original directory. (2) If a target path is specified, the container file will

be opened in this directory.



–l logFile Path and name of the log file.

Write: –l followed by blank and full path (included file name) for the log file to create. If the -l option is not specified by the user; never-theless a log file will be created in a default path, the name of the path, being displayed on the console.

[-p previewFormat] Creating previews of the imported CATIA files.

Optional. If this option is set, for every imported CATIA file a preview will be created. Write instead of previewFormat the required format code (jpg, bmp, tif, or png). 125H125HN o t e : If a directory is write-protected, a preview of the files in it cannot be given.

[-notow] Do n o t overwrite existing files.

If this option is used, in case of import option 2 (import in a specified directory) the existing files in this directory will n o t be overwritten.

[-keepdir] Send-to method with keeping directory structure

Optional. The Send-to method will be applied with keeping the directory structure. This option is ignored if container has no directory structure.

NOTE:

For running XFileV5 in batch mode, the following variable should be set either as a CATIA environment variable or system variable:

I4LIB_VERB=YES

Set this variable to avoid certain problems that cause the abnormal termination of the CATIA batch process.

126H126H No te : For batch import in every case the Send To method is used, ensuring adaptation of

the link information to the new directory.

H in t :

For batch import DLNames can be used.



Syntax Examples

Import operation 1 (Opening container file in its original directory):


–run "TCAXFILEV5BatchMd -imp

-c /V5Models/containerName.tar -l /tmp/log.txt"

Import operation 2 (Opening container file in specified directory):


–run "TCAXFILEV5BatchMd -imp

-c /V5Models/containerName.tar

–t /V5Models/targetPath -l /tmp/log.txt"

2 . 2 F I L E D E S C R I P T I O N — X F I L E V 5 . P A R


2.2 File Description—XFileV5.par

The XFileV5.par file contains the XFILEV5 administrator settings.

Sample, explaining the file structure

In the XFileV5.par file every keyword with set value is preceded by explaining

information, given in the following order:

# Define the maximal length of the container name

(1) Description

# Allowed values: integer > 0

(2) Allowed values

# Default: 100

(3) Default value

xfileV5.EXP_MAX_CONTAINER_NAME 100

(4) Keyword with default value

Used keywords and their description

Keyword Allowed Values

Description

xfileV5.EXP_MAX_CONTAINER_NAME Integer > 0

(default: 100) Number of allowed characters of the container name

xfileV5.EXP_CONTAINER_NAME_FOR

MAT

Definition of the format of the container name. The values also may be given in form of a string (example: CCD_%ROOT%_%DAY%_text).

%ROOT% (default)

Placeholder for the name of the root file

%YEAR% Placeholder for the year %MONTH% Placeholder for the month %DAY% Placeholder for the day %HOUR% Placeholder for the hour %MIN% Placeholder for the minutes %SEC% Placeholder for the seconds %USER% Placeholder for the user name

xfileV5.EXP_CONTAINER_DEF_TAR_

EXTENSION

Definition of the container extension YES (default) tar extension NO No extension

xfileV5.IMP_XML_COPY_TO_TARGET Copying the XML file to target directory (together with the CATIA documents)




Description

YES The XML file is also copied to the target directory.

NO (default) The XML file is not copied to the target directory.

xfileV5.EXP_SEND_TO_DLG State of the SendTo check box (interactive mode, see page 13 point ):

BOTH State is fully user-controlled. ON (default) … always ON; user cannot switch to OFF. OFF … always OFF; user cannot switch to ON. DEFAULT_ON … ON by default; user can switch to OFF. DEFAULT_OFF … OFF by default; user can switch to ON.

xfileV5.EXP_KEEP_DIR_DLG State of the Keep directory structure check box on the Export dialog box for the interactive mode (see page 127H128H13—128H129H).

BOTH State is fully user-controlled. ON … always ON; user cannot switch to

OFF. OFF (default) … always OFF; user cannot switch to

ON. DEFAULT_ON … ON by default; user can switch to OFF. DEFAULT_OFF … OFF by default; user can switch to ON.

xfileV5.EXP_XML_NAME_FORMAT Format definition of the output XML file name. The values also may be given in form of a string (example: CCD_%ROOT%_%DAY%_text).

%ROOT% (default) Placeholder for the name of the root file %YEAR% Placeholder for the year %MONTH% Placeholder for the month %DAY% Placeholder for the day %HOUR% Placeholder for the hour %MIN% Placeholder for the minutes %SEC% Placeholder for the seconds %USER% Placeholder for the user name

xfileV5.IMP_OVERWRITE_EXTRACT_

DLG

Overwrite with unpacked files dialog box: YES Display window. NO (default) Do not display window. Overwrite

directory if exist. xfileV5.EXP_EXTERNAL_PROCESS_A

RG

External process arguments: %RETURN% Return code %CONTAINER% Container file path name %USER% User name %LOG% Log-file path name

xfileV5.EXP_EXTERNAL_PROCESS_W

AIT YES (default) XFileV5 waits for the end of the external

process. NO XFileV5 does not wait for the end of the

external process. xfileV5.IMP_LOAD_MAX_SIZE Integer > 0

(default: 512) Maximum size (in MB) of the loaded file(s).




Description

xfileV5.IMP_TARGET_DIR_SUFFIX Format definition of the target directory suffix in case of "extract only" option used (only if container name has no extension) (example: %DAY%_%MONTH%_text). The Extract only option is applied automatically by XFILEV5 if in batch mode no target directory is specified. In this case XFILEV5 creates inside the container directory a directory having the container name.

%YEAR% Placeholder for the year %MONTH% Placeholder for the month %DAY% Placeholder for the day %HOUR% Placeholder for the hour %MIN% Placeholder for the minutes %SEC% Placeholder for the seconds %USER% Placeholder for the user name

xfileV5.EXP_READ_REC_ROOTS_

FROM_DIR

Reading roots within the selected directory recursively (i. e. all roots of all levels) or not:

YES (default) Roots are read recursively. NO Only roots from first level are read.

xfileV5.EXP_SEARCH_INSIDE_

ROOT_DIR

Search components inside root directory and child directories

NO (default) Use Tools > Options settings. YES Search components only inside root

directory. YES_REC Search recursively components inside

root directory. xfileV5.IMP_KEEP_DIR_DLG State of the Keep directory structure check

box on the Import File Tree dialog box for the interactive mode, see page 127H128H2323—).


OFF. OFF … always OFF; user cannot switch to

ON. DEFAULT_ON … ON by default; user can switch to OFF. DEFAULT_OFF

(default) … OFF by default; user can switch to ON.

delete.SECURE_MODE_DLG State of the Secure Mode check box in XFILEV5 DELETE








Description

move.MOVE_KEEP_DIR_DLG State of the Keep directory structure check box in XFILEV5 MOVE





move.MOVE_GHOST_LINKS_DLG State of the Call CATDUA for Ghost links analysis check box in XFILEV5 MOVE





move.MOVE_XML_REPORT_EXT_FORMA

T_

DLG

State of the Write extended report check box in XFILEV5 MOVE





move.MOVE_COPY_CUT_CMB_DLG Available options in the Copy/Move to new location list box in XFILEV5 MOVE

BOTH (default) User can select between Copy to new location and Move to new location.

COPY Only Copy to new location is available. Users cannot change this option.

CUT Only Move to new location is available. Users cannot change this option.

DEFAULT_COP

Y The default option is Copy to new

location. Users can select Move to new location.

DEFAULT_CUT The default option is Move to new location. Users can select Copy to new location.

move.MOVE_DELETE_ATM_EXP_IMP_F

ILE

When running the Automatically Export and Import Properties function, the intermediate CFS report file can be kept or deleted.

YES (default) Delete the CFS report file NO Keep the CFS report file.



2.3 License Management

For working with XFILEV5 (as well as for working with the other tools of the XFILEV5 pack)

CATIA PX1 license is required.

The Ba tch M o de uses this license only for the operation time and releases the license

when operation is completed.

In order to restrict the time of use of the PX1 license in In te rac t i ve and Ut i l i t y

M o des , a CATIA session can be started using no PX1 license. XFILEV5 in this case auto-

matically starts, for the operations requiring PX1 license, in background an XFILEV5 batch

session. For that purpose the TCAXFILEV5_ENV and TCAXFILEV5_DIRENV

environment variables must point to an environment with PX1 license. (Cf. XFILEV5

installation manual.)

2.4 XFILEV5 Output Information

2.4.1 XML File

The XML file contains information about the root document and its referenced docu-

ments. It is structured on two levels. The first level is for the root document, the second

for the referenced documents. Following attributes are defined for the nodes:

Attribute Description

NAME Current document name

DIRECTORY Name of the directory of the current document

TYPE For CATIA V5 documents: CATIA V5 document type—independent of the file extension.

For non CATIA V5 documents: the file extension (without checking the real file type, except for non CATIA V5 documents with a CATIA V5 file extension, which will get the value „NotAV5File“).

LAST_SAVE_NAME File name at last save with CATIA V5

LAST_SAVE_DIRECTORY Directory name at last save with CATIA V5



Attribute Description

LAST_SAVE_VERSION CATIA V5 version at last save with CATIA V5

For V5R9 or lower: The value is NOT_AVAILABLE.

For V5R10 or higher: Version, release and service pack.

For V5R14 or higher: Additionally Hot Fix.

N o t e : NOT_AVAILABLE: Following attributes can not be determined for CATIA V5R9 and lower or non CATIA documents: LAST_SAVE_NAME, LAST_SAVE_DIRECTORY, LAST_SAVE_VERSION. These attributes have the value NOT_AVAILABLE.

STATUS EXISTING: Referenced document is available.

MISSING: Referenced document is not available.

NOT_SEND: Referenced document deactivated for sending.

GHOST_LINK_STATUS NO_GHOST_LINK Check for ghost links performed by the sender resulted in n o ghost links existing.

EXISTING_GHOST_LI

NK

Check for ghost links performed by the sender resulted in ghost links existing.

NOT_CHECKED No ghost link check performed by the sender.

INTERNAL_ID Element identification number internal to the XML file.

NEW_NAME Name before/after modification made by the user inside XML file. For details see section „User modifications in the course of batch export“ p. 33. OLD_NAME

NEW_VALUE Value before/after modification made by the user inside XML file. For details see section „User modifications in the course of batch export“ p. 33. OLD_VALUE

NEW_INSTANCE_NAME Name of an instance before/after modification made by the user inside XML file. For details see section „User modifications in the course of batch export“ p. 33.

OLD_INSTANCE_NAME

XML files that have been created using the extended batch-export mode (with

-extended batch-export option set) can contain following additional nodes:

Node Sub-node Description

PROPERTIE

S Can appear in the ROOT_FILE, FILE and COMPONENT nodes (if in the model properties are defined).

PROPERTY NAME Name of the property

TYPE Type of the property (e. g. Force)

VALUE Value of the property

VALUE_TYPE Type of the value of the property (e. g. REAL)



Node Sub-node Description

STRUCTURE Structure components of CATIA products and links

COMPONENT NAME Structure component name (part number)

EMBEDDED_IN INTERNAL_ID of the parent element

INTERNAL_ID Element identification number internal to the XML file.

LINK FROM Link source—INTERNAL_ID of the parent element

TO Link target—INTERNAL_ID of the element

TYPE Link type:

ASSEMBLY Assembly link

DRAWING_PRODUCT Link between drawing and product or part document

MULTI_MODEL_ LINK

Multi-model link

ASSEMBLY_LINK_

DETAILS INSTANCE_NAME Instance name



Example XML file—created without -extended option

Example for file with EXISTING state

Example for file with GHOST_LINK state

Example for file with NOT_SEND state

Example for file with MISSING state



Example XML file—created with -extended option

The nodes/attributes that are created with this option in addition to the standard

nodes/attributes are marked with a color frame.



2.4.2 Log File for XFILEV5

The log file is a text file containing the following information:

Program version number

Issued command

Root document

A list of all processed documents

A list of missing files

A list of documents deactivated for sending

A list of files with ghost links

A list of not overwritten files (for import only)

Information on general errors (e. g. no write access on target directory)

Return code

2.4.3 Return Codes for XFILEV5

Code Explication

0 Process OK

1 Wrong arguments

2 Internal error

3 No PX1 license available.

4 Documents missing.

5 CATDUA link analysis is recommended.

7 No TC-XFileV5 license available.

For CV5 CONSISTENT FILE SET return codes see section 129H130H3.2.3 130H131HReturn Codes for CV5 CONSISTENT FILE SET on page 131H132H58.

3 . C V 5 C O N S I S T E N T F I L E S E T I N D E T A I L


3. CV5 CONSISTENT FILE SET in Detail

CV5 CONSISTENT FILE SET is a command line based checking tool that controls the

consistency of CATIA V5 document sets in a specified directory. The tool is primarily

intended to be used to check incoming and outgoing CATIA V5 document sets on their

consistence.

A co ns i s t en t se t of CATIA V5 documents contains:

One or more ro o t documents (i. e. documents that are themselves not a link target,

but may be a link source):

CATProduct, CATPart, CATDrawing etc.,

Non-CATIA V5 documents,

No n - ro o t do cuments (CATIA V5 / non-CATIA V5 documents that are link targets of

the root documents of the document set).

The file set is co ns i s t en t if it contains all documents that are linked with each other.

132H133H No te : CV5 CONSISTENT FILE SET also checks links to other directories o u t s i d e of the

checked directory. In the check result, however, it is not expressly stated that the

link target is situated outside of the checked directory.

Check Operation

CV5 CONSISTENT FILE SET checks all files contained in a specified directory to find out

whether the document set in it is consistent, and eventually generates one or two report

files in XML format, a text log file and returns an error code.

CV5 CONSISTENT FILE SET identifies missing documents and writes additional information

to the report file (e. g. CATIA version at last save and document type for CATIA V5 docu-

ments). Optionally the CV5 CONSISTENT FILE SET also identifies naming conflicts for

renamed CATIA V5 documents.

Checking documents

XML Report File

TXT Log File

Return Code

Command line entry

START



Detailed Description of Check Operation

CV5 CONSISTENT FILE SET executes the following steps:

Retrieving recursively the CATIA V5 documents, starting from the directory specified in

the command issued, and then checking all its sub-directories.

Retrieving information of the documents:

Document type

Document directory

and for CATIA V5 additionally:

CATIA version at last save

Last-save name

Last-save directory.

Identifying all the root files.

Identifying for each root file the associated set of documents and checking it regarding

consistency.

Finding out whether documents are missing in the file set:

NOT EXISTING (RENAMED OR REMOVED)

RENAMED.

Writing a structured (XML) report of the document set and

—optionally—writing a structured (XML) “Resolved” report of the document set for

renamed documents.

Writing an error log file.

Details:

Document type check

CV5 CONSISTENT FILE SET checks CATIA V5 documents of the following types whether they

have correct names and name extensions:

CATProduct

CATPart

CATDrawing

CATProcess

CATAnalysis

CATMaterial

catalog



In case of not corresponding names and name extension, information will be written in

the XML report file.

For all other files of non-CATIA types this check has no effect (for instance, a jpeg

graphic file with a txt extension would not be found out as having a faulty name

extension).

Link check

As a result of the check the links between the documents and missing linked documents

are reported. The following links are considered:

Links from CATIA V5 documents to other CATIA V5 documents,

Links from CATIA V5 documents to other non-CATIA V5 documents.

Links from no n -CATIA V5 documents to no n -CATIA V5 documents are no t checked.

Report file vs. Resolved Report f ile

Both are XML files. The difference between these files is as follows.

Report type Representation of renamed fi les Displayed state information

Report file: A renamed file that has lost its link is represented as r o o t file.

EXISTING

Resolved Report file: A renamed file that has lost its link is represented as l i n k e d d o c u m e n t file (on its o r i g i n a l position, i.e. under the correct root file)

RENAMED



3.1 How to Work


<CATIA_install-path>\code\bin\catstart -env environmentName

-direnv environmentDirectory –run

"TCAXFILEV5CfsMd –d inputDirectory -o reportFile

[–r resolvedReportFile] –l logFile"

TCAXFILEV5CfsMd Program name: Write: TCAXFILEV5CfsMd

(Cfs stands for CONSISTENT FILE SET)


–env environmentName Environment name: (5) Write the name of the of CV5 CONSISTENT FILE SET environment.

–direnv

e

n

v

i

r

o

n

m

e

n

t

P

a

t

h

Environment path: (6) Write the full path of the environment.

–d inputDirectory Input directory: Write: –d followed by blank and full path name of the directory to check.

–o reportFile Report file: Write: –o followed by blank and full path name of the XML report file to be created.



[–r

r

e

s

o

l

v

e

d

R

e

p

o

r

t

F

i

l

e

]

Resolved report file: Optional Write: –r followed by blank and full path name of the XML resolved report file is to be created.

–l logFile Log file: Write: –l followed by blank and full path where the log file is to be created.

[-scs] Optional

Files are searched according to the CATIA settings under Tools > Options > Linked Document Localization.

[–scr] Optional If this parameter is n o t set, child documents, which have the same document name and the same localization as the parent root document, are n o t taken into account.

(In case of certain contextual links a root product itself may also be child To exclude this case from checking, the parameter [-scr] is to be omitted.)

133H134H

No te : Full path means f i l e b a s e d—DLNames cannot be used.

Input directory: Sub-directories included in the input directory also will be

checked.



3.2 The Check Results

The check results are delivered in form of

a log file,

a report and—optionally—a “Resolved” report file and

a return code.

In the following sections these results will be described in detail.

134H135H

NOTE:

If a log file or a report file already exists, it will be o ve rw r i t t en by the next check.



3.2.1 Report Files for CV5 CONSISTENT FILE SET

The report files are structured files in XML format containing the information of the

checked document sets. Basically the report file consists of a list of root file elements.

Each root file element consists of a list of associated file elements (on two levels—the first

level for the root element, the second level for all linked documents). Both root file and file

elements have following attributes:

Attribute Explication

NAME Current file name

DIRECTORY Current directory of the file

TYPE For CATIA V5 documents the r e a l f i l e t y p e is indicated—independent of the current file name and extension (which might have been changed by renaming).

For non-CATIA V5 documents the f i l e n a m e e x t e n s i o n is indicated (without verification, except the case that a non-CATIA V5 document has been renamed with a CATIA V5 reserved name extension—see below).

N o t A V 5 F i l e —this type is attributed to files that have a CATIA V5 file-name extension, but are not CATIA V5 documents.

LAST_SAVE_NAME File name at last CATIA V5 save

LAST_SAVE_DIRECTO

RY

Directory of the file at last CATIA V5 save

LAST_SAVE_VERSION CATIA V5 version at last CATIA V5 save

For V5R9 or lower: The value will be NOT_AVAILABLE .

For V5R10 or higher: Version, release, service pack will be indicated.

For V5R14 or higher: Additionally hot fix will be indicated.

135H136H NOT_AVAILABLE: In case that the value for LAST_SAVE_NAME, LAST_SAVE_DIRECTORY, LAST_SAVE_VERSION cannot be determined (CATIA V5 R9 or lower, non-CATIA files), to these attributes the value NOT_AVAILABLE is assigned.

STATUS EXISTING: Referenced file is available in the checked directory.

MISSING: Referenced file is missing in the checked directory.

RENAMED: Referenced file is available in the checked directory, but has been renamed.

136H137H N o t e :

The RENAMED state is available only in the “ R e s o l v e d ” report file with resolved naming conflicts.

In the Resolved report is only r e p o r t e d that there is a name issue, but CV5 CONSISTENT FILE SET does not resolve it— n o r e -r e n a m i n g to the original file name is executed.



Example for

report file

Sample



Example for

“Resolved”

report file



3.2.2 Log File for CV5 CONSISTENT FILE SET


Command issued to start the check

Information on general errors (e.g. input directory not found)

A list of all processed files

A list of all root files

A list of all missing files

If necessary, a list of all renamed files.

3.2.3 Return Codes for CV5 CONSISTENT FILE SET

Code Explication

0 Process OK

1 Impossible to find input directories

2 Impossible to open input directories

3 Impossible to find/open/write report file

4 No PX1 license available

5 Internal error

6 Documents missing.

7 No TC-XFileV5 license available.

For XFILEV5 return codes see section 137H138H2.4.3 138H139HReturn Codes for XFILEV5 on page 139H140H48.

3.3 TCAXFILEV5Customize.nls File

Keyword Function

Export_CallExternalProcessCheckButton_L

abel

The parameter of this keyword (<Name>) is provided to modify the name of the Call external process check box on the Export dialog box of the Interactive Mode (check box on page 13).

4 . D E L E T E I N D E T A I L


4. DELETE in Detail

4.1 Functionality in General

The DELETE tool facilitates deleting of CATIA documents:

The selection of the CATIA document to be deleted (i. e. the opened root document or

its selected sub-documents) is made in an active CATIA session. This enables the user

to sea clearly which documents will be deleted and helps to exclude mistakes in file

selection while deleting documents.

The Secure Mode option allows to verify before deleting if subdocuments of the

selected document are referenced by other documents situated inside the directory of

the current document. Referenced sub-documents will not be deleted.

DELETE allows to delete the following types of CATIA documents:

CATPro duc ts

CATPar t s

CATD raw ings

mo de l (CATIA V4 models imported into CATIA V5)

cg r (approximated model)

DELETE works both in DLName mode and in Folder mode (depending on the settings

made in the CATIA menu Tools > Options > General > Document ).

Contextual links in general are not taken in consideration.

After a document has been deleted, it remains displayed in CATIA as long as it is available

in RAM; on the hard disk at this time it is however no more existing.

The DELETE operation is recorded in a log file (cf. 4.4 Log File for Delete on p. 64).



4.2 Work Steps

For the DELETE operation the following steps are to be done:

(1) Open in CATIA the document to be deleted.

(2) Start DELETE in CATIA.

DELETE is started from within CATIA clicking the XFileV5Delete button (on XFileV5Toolbar). After starting the DELETE GUI will be opened (cf. p. 62).

(3) In case of deleting C A T P r o d u c t s it is to be selected whether to delete the complete CATProduct

or only some of its sub-products/parts. To select the documents, click on the elements in the CATIA

specification tree.

In case of other CATIA document types, this selection step is dropped as the DELETE tool automatically selects the root document.

(4) Check in the Selected components list if the correct document or (in

case of CATProducts) the correct components have been selected.

In case that a wrong document has been selected, close the DELETE tool,

open in CATIA the correct document and then reopen DELETE.

In case that the wrong components of CATProducts have been selected,

unselect their names from the list, using the contextual menu, and select

in CATIA the correct components. (Unselecting from the list does not

signify erasing the documents themselves.)

See Selected components list .

(5) If appropriate, activate secure mode. See Secure mode option button p. 62.

(6) Press List button to prepare delete operation. See Secure mode p. 61. See List button on p. 63.

(7) In the Linked files list then will be listed which documents will be deleted. See Linked files list on p. 63.

(8) Define here name and path for the log file. See p. 63 text box .

(9) To initiate the delete operation, press Start button. See Start button on p. 63.

(10) When the delete operation is accomplished, look up the log file if

desired.

See 4.4 Log File for Delete on p. 64.

(11) The DELETE window will be closed automatically.



Checks executed while deleting

During delete operation, the DELETE tool executes the following checks:

(1) Are sub-documents of selected docu-ments situated in an other directory than the current document is?

Documents that are situated in other directories will be no t deleted.

(13) In case of CATProducts: Do sub-documents of the selected documents exist in several instances and have they all been selected for deleting?

If a l l instances of this sub-document have been selected, they will be de l e t ed .

If no t a l l instances have been selected, the selected sub-document will no t be deleted as it is still required.

(14) Secure mode: If the Secure mode option is ac t i -va ted , it will be checked whether the selected documents are referenced by other documents situated inside the current directory.

Referenced documents will be no t deleted as they are required for the refe-rencing documents.

If the Secure mode option is no t activated, it will be not checked whether the selected documents are referenced by other documents situated inside the current directory.

After pressing the Start button, a l l documents will be deleted irrespective of whether they are referenced by other docu-ments situated inside the current directory or not.



4.3 Graphical User Interface of DELETE

Explanation:

Selected components l ist

This list displays the CATIA document(s) preselected to be deleted. Together with the selected document also its complete substructure is preselected for deleting. The list is filled as follows:

For all CATIA documents excluded CATProduct, the list is filled automatically with the name of the currently opened CATIA document.

In case of CATProducts, the documents to be deleted must be selected by clicking on their name in CATIA specification tree. This can be either the complete CATPro-duct or some of its components.

Unselect command of the context -sensitive menu

This command is available if the list contains the name of a CATProduct or the names of components of a CATProduct; it is called by right-mouse clicking on a list item. Pressing this button removes the name from the list, but the component itself will be not deleted.

Secure mode option button

If this option is activated, DELETE will check the selected documents on their references—see p. 61 (3) Secure mode.



List files button

Click this button to release for deleting the components listed in the Selected com-ponents list list. This starts the check verifying whether there are files referencing the documents listed in list . The names of the retrieved linked documents together with the names of the CATIA documents selected in list will be listed in the Linked files list .

If the button has the whirl symbol, the Linked files list must be updated by clicking the button.

Linked files l ist This list (according to the results of the checks described on page 61) states in the Action column which components will be deleted and which not: – Delete operation deletes only the components with the delete state. – Components with the Ignore state will be excluded from deleting. (Ignore state is attributed (1) to components that are referenced by other docu-ments, (2) to documents that are situated in directories outside of the directory of the current document, and (3) to documents that have several instances in case that not all components have be selected.)

Log file name text box

Define here name and path for the log file.

Start button

Pressing this button launches the delete operation.

This button is deactivated if:

the Linked files list is empty or if

the Linked files list contains file names, but the Secure mode option button was activated or deactivated after filling the list (after what List files button button is marked with the whirl symbol) or

In the CATIA specification tree a new component has been highlighted. To activate the Start button, fill the Selected components list or update Linked files list

by pressing the List files button .

Help button

Pressing this button opens the help for DELETE.

Info button

Pressing this button opens a window with information about DELETE.

Close button

Pressing this button closes the DELETE window, all selections made before being discarded.



4.4 Log File for DELETE



Number and names of the selected components.

Total number of documents related to the selected component, how many of them were intended to be deleted. How many of them have been deleted and how many not have been deleted.

Information on general errors

Information: – Directory of the current document; – Secure mode activated or not; – PX1 license was not available in the current interactive session.

Return Codes:

0 – OK

1 – One or several documents could not be deleted.

5 . M O V E I N D E T A I L


5. MOVE in Detail

5.1 Introduction

MOVE sends selected CATIA root documents and all linked documents to a new location,

and updates the links between these files.

When you select a directory, MOVE identifies the root documents in this directory and

optionally in all subdirectories.

The following types of CATIA documents are supported:

CATProduct

CATPart

CATDrawing

model (CATIA V4 models imported into CATIA V5)

cgr

Move also sends files of any other type (for example xml, doc, CATMaterial) but without

analyzing these files.

The MOVE operation is recorded in report files in plain text and XML format.

Limitations

Contextual links in CATIA documents are not taken into account.

MOVE does not detect whether CATIA documents are linked to root documents which

are not on the transfer list. When you move documents and leave no copy in the

original location, it is always possible that links from other root documents get broken.

To prevent this, copy documents to a new location instead of moving them.

Alternatively, use the XFileV5 CFS tool to verify that every directory containing CATIA

documents forms a consistent file set.



5.2 Send files with Move

(1) In CATIA, click the Move button on the XFILEV5 toolbar .

(2) Select the root files to be moved.

Select individual files: Click the Add root files button . Next, choose the files to be

added.

Select a consistent file set from a folder:

To add the root files from one directory, click the Add root files from directory button .

To add the root files from one directory and its subdirectories, click the Add root files from

directory with subdirectories button .

You can choose between the two functions by clicking the black triangle in the lower right

corner of the button.

XFILEV5 identifies all CATIA root files in the chosen directory, and adds them. XFileV5 also

adds all other types of files from this directory.

Select root files from a CFS report: Click the Add root files from CFS report button .

Next, choose the CFS report to be loaded. Note that modified properties in an extended

CFS report are not processed during this operation.

(3) Add the root files to the transfer list.

To add a root file to the transfer list, double-click the check box for an entry. A check mark

will appear in the check box.

Alternatively, mark the root files to be added, then right-click the Root files list, and choose

Add selection to transfer list from the context menu.

The transfer list now contains the root files to be transferred, and all CATIA files linked to

these root files.

(4) If necessary, adjust the settings in the XFileV5 Move dialog.

You have the following options:

Keep the directory structure, or move all files to the same directory. See Keep directory

structure.

Move or copy the files to the new location. See Copy/Move files to new location.

Check the files on the transfer list for ghost links. See Call CATDUA for Ghost links analysis.

Write an extended report, which includes properties and structure information for the sent

parts. See Write extended report.

(5) In the New location text box, specify the new location for the files to be transferred.

(6) Note any notifications in the transfer list, and resolve the problems, where necessary.

See chapter 5.3 Resolve conflicts.



(7) To send the files with the current settings, click Start.

(8) When the files have been sent, you are prompted to view the log file.

5.3 Resolve conflicts

Icons and messages in the transfer list notify you of file conflicts in the new location or

other issues with the files to be transferred.

Below are descriptions for the various messages and how to resolve the problems.

Error: Two (or more) different documents to copy have the same final

identification.

The transfer list contains two or more files with identical names. Files with identical

names cannot be copied to the same location. In this case, XFileV5 does not send any

files.

Solutions:

Before sending the files, define new names for the target files using the Export/Import

functions.

If possible, select the Keep directory structure option to move the files including their

subdirectories.

Error: File not located on the same drive as its root

The linked file is not located on the same drive or network share as its root file. In this

case, XFileV5 does not send any files as long as the Keep directory structure option is

selected.

Solution:



If possible, deselect the Keep directory structure option to move all files to the same

location.

Warning: f i le exist already as root or as child from other root

The file is linked to more than one root file. No problems are expected. In this case,

XFileV5 sends all files to the new location.

Warning: f i le is missing

The linked file is missing. In this case, XFileV5 sends the root file anyway.

Warning: f i le has ghost l inks

The file contains one or more ghost links. XFileV5 sends files with ghost links anyway.

Solution:

Clean the file using CATDUAV5.

Error: Can not load document in session. The fi le associated with th e

item is not on the disk.

The file contains contextual links to unavailable models. To ignore this error and continue,

set environment variable TCAXFILEV5_IGNORE_CTX_LINK_ERR=YES. Restart the

CATIA session for this setting to take effect.

5.4 Save and restore the transfer list

You can save the transfer list to a CFS report file in order to restore the same selection in a

later MOVE session.

Save the transfer l ist

(1) In the Export/Import section, choose Export transfer list (CFS format).

(2) Click the Perform selected action button .

(3) You are prompted to save the resulting CFS report file.

The resulting CFS report file contains all files that are currently in the transfer list.



Restore the transfer l ist from a CFS report

(1) To start with an empty transfer list, remove all entries from the Root files list if there are any.

(2) Click the Add root files from CFS report button , and select the previously saved CFS report

file.

(3) Mark all entries in the Root files list. Then right-click the list and choose Add selection to transfer

list from the context menu.

(4) If necessary, import the modified properties from an extended CFS report separately.

5.5 Define names and properties for moved files

5.5.1 General

You can change file names and properties of CATIA files when sent to the new location.

This comprises three steps:

(1) Export the transfer list to a CFS report file in extended format.

(2) Define the new the names and properties in the CFS report file.

(3) Import the properties into the transfer list.

You can perform these steps manually or use an external process.

5.5.2 Define new names and properties manually

(1) In the Export/Import section, choose Export transfer list (CFS extended format). Next, click the

Perform selected action button .

(2) You are prompted to save the resulting CFS report file.

(3) Open the CFS report file in a text or XML editor, and define new names and properties where

needed.

For a description of permitted modifications, see chapter 5.5.4 Add or change properties.

(4) Save the modified CFS report.

(5) In the Export/Import section, choose Import properties into transfer list. Next, click the Perform

selected action button .

The modified properties are applied to the corresponding models on the transfer list.

Properties for models not on the transfer list are ignored.



5.5.3 Define new names and properties using an external process

You can define an external process which modifies the exported CFS report file. XFileV5

imports the modified file names and properties back into the transfer list.

The command for the external process is defined by environment variable

TCAXFILEV5_MOVE_EXTERNAL_PROCESS. The command must contain the full path

to a file with extension .xml. The CFS report will be written to this file. If the command

contains more than one argument ending on .xml, the first of these arguments is used

as the path and file name for the CFS report.

If the command is invalid, MOVE reports an error when you click the Perform selected

action button.

Examples:

This will execute a Python script, which automatically modifies the given XML file:

TCAXFILEV5_MOVE_EXTERNAL_PROCESS=python

"c:\Program Files\TranscatPLM\XFileV5_3xx\

XFileV5_AddNewPropertyToExtendedXmlFile.py"

"%TEMP%\mod.xml"

This will open the CFS report file in Notepad on Windows and import the modified

properties as soon as you close Notepad:

TCAXFILEV5_MOVE_EXTERNAL_PROCESS=notepad.exe "%TEMP%\mod.xml"

5.5.4 Add or change properties

Modifying fi le names

In the CFS report file, locate the ROOT_FILE node corresponding to the file to be

renamed.

Add a NEW_NAME attribute to the ROOT_FILE element. Set the attribute value to the new

file name without extension.



<ROOT_FILE NAME="Part.CATPart" NEW_NAME="bolt" TYPE="CATPart" … >

Modifying parameter names and values

In the CFS report file, locate the ROOT_FILE element corresponding to the file, and

inside this node the PROPERTY node you want to change.

To define a new name for a user-defined parameter, add the NEW_NAME attribute.

<PROPERTY NAME="Kg" NEW_NAME="Weight" … />

The names of default properties such as PartNumber or Revision cannot be changed.

To define a new parameter value for a user-defined parameter, add the NEW_VALUE

attribute.

<PROPERTY NAME="Weight" … VALUE="MASS" NEW_VALUE="5kg" … />

Adding new properties

To add new properties to a sent file, define a new PROPERTY element inside an existing

PROPERTIES node. Define the following attributes in the new PROPERTY element:

NAME, TYPE, VALUE, NEW_VALUE and VALUE_TYPE.

<PROPERTY NAME="NewParam" TYPE="String" VALUE="" NEW_VALUE="abc"

VALUE_TYPE="STRING" />

Modifying instance names of product components

In the CFS report file, locate the ROOT_FILE node for the CATProduct, and inside this

node the STRUCTURE/LINK/ASSEMBLY_LINK_DETAILS child node for the respective

product component. To define a new instance name, add the NEW_INSTANCE_NAME

attribute to the ASSEMBLY_LINK_DETAILS element.

<ASSEMBLY_LINK_DETAILS INSTANCE_NAME="Part1.1"

NEW_INSTANCE_NAME="bolt.1" />



5.6 Reference to the Move dialog

Explanation:

A d d r o o t f i l e s button

Click to choose files to be added to the Root files list.

A d d r o o t f i l e s f r o m d i r e c t o r y button

Click to choose a directory. All CATIA root files and all non- CATIA files from the selected directory will be added to the root files list.

A d d r o o t f i l e s f r o m d i r e c t o r y a n d s u b d i r e c t o r i e s button

Click to choose a directory. All CATIA root files and all non- CATIA files from the selected directory and its subdirectories will be added to the root files list.

To choose between the functions with or without subdirectories, click the black triangle in the lower right corner of the button, then choose from the button menu.



A d d r o o t f i l e s f r o m C F S r e p o r t button

Click to choose a CFS report. All files listed in the report will be added to the root files list.

D i s c a r d s e l e c t e d r o o t f i l e s button

Click to remove the selected entries from the root files list.

D i s c a r d a l l r o o t f i l e s button

Click to remove all entries from the root files list.

R o o t f i l e s

This list contains the root files.

Click a column header to sort the list.

Check box column: If the check box is selected, the root file in this list and the depending CATIA files will be transferred. Double-click a check box to add or remove the root file from the transfer list.

Number column (#): Ordinal number for the root file. The same number is displayed for the root file and all linked files in the Root # column of the transfer list.

Name: Original file name without extension

Type: Original file name extension

Path: Original directory of the respective file

T r a n s f e r l i s t

The transfer list contains all root files and their linked files to be transferred.

Icons/first column: Icons in this column indicate notices or warnings related to this entry. See the Message column for more information.

Number column (#): Click the column header once or twice to restore the original sort order.

Name: Original file name without extension

Type: File name extension

Path: Original directory of the respective file

Status: One of the following: “Root” for root files; “Existing” for available linked CATIA files; “Missing” for unavailable linked CATIA files

Root #: Ordinal number of the associated root file in the root files list.

Ghost links: One of the following: “No ghost links” if no ghost links have been found; “Has ghost links” if the model contains ghost links; “Not checked” if no CATDUA check for ghost links has been executed.

New name: New name for this file in the new location. You can change the file using the Export/Import functions. See chapter 5.5 Define names and properties for moved files.

Message: Description of warnings or other alerts, as indicated by the icon in the first column.



C o p y / M o v e f i l e s t o n e w l o c a t i o n l ist box

Choose whether to copy or move the files:

Copy files to new location: The files in the transfer list will be sent to the specified location. The files in the original location will be kept.

Move files to new location: The files in the transfer list will be sent to the specified location. The files in the original location will be deleted.

K e e p d i r e c t o r y s t r u c t u r e

If this option is selected, the document directories will be replicated in the new location.

It is not possible to send files with this option selected if linked files are located on different drives, or when using DLNames.

C a l l C A T D U A f o r G h o s t l i n k s a n a l y s i s

If this option is selected, all files in the transfer list are checked for ghost links. The result is displayed in the Ghost links column of the transfer list.

To clean ghost links, use the CATDUAV5 utility in CATIA.

W r i t e e x t e n d e d r e p o r t

If this option is selected, properties and structure information for all transferred files is included in the XML report. If this option is not selected, this information is not included.

I g n o r e s e l e c t i o n o f N o n - C A T I A r o o t f i l e s

If this option is selected, only CATIA documents are selected files from a directory. Files in other formats are not selected.

Export/Import l ist box

Choose an action.

Export transfer list (CFS format): Write all entries of the transfer list to a file in CFS format.

Export transfer list (CFS extended format): Write all entries of the transfer list to a file in CFS extended format, which includies properties and structure information for CATIA files.

Import properties into transfer list: Import a modified file in CFS extended format. The modified properties and file names will be applied to the transferred files in the new location.

Automatically export and import: Automated sequence to modify file names and properties using an external process.

To perform the selected action, click the Perform selected action button.

Perform selected action button

Click to perform the selected action from the list box.



New location

Enter a new location in the text box, or click the Choose directory button to pick a location in the file system.

Reports

Enter a directory and base name for the MOVE log file and XML report, or click the

Choose file button to pick a location in the file system.

Any given file name extension will be removed and replaced by .log for the log file, and .xml for the XML report.

Start

Transfer the files in the transfer to their new location, according to the specified settings.

Exit

Close the XFileV5 Move dialog. The settings are kept, but the selected documents are discarded.

5.7 Report Files

When sending files to the new location, MOVE generates two report files, a log file in plain text (.log) and a CFS report (.xml).

In the Move dialog, you can specify the common path and base name for both report files. The .log and .xml extensions are added automatically to the report name.

Contents of log fi les

MOVE log files contain the following information:


Number and names of the linked documents (root documents and child documents)

Number of documents that were intended to be moved; how many of them have been moved and how many not have been moved.

Information on general errors (e. g. no write access on target directory)

New location

Return Codes:

0 – OK

1 – One or several documents could not be deleted.

2 – Internal error

3 – No PX1 license available.

4 – One or several documents could not be copied.



5 – One or several documents could not be copied and/or not deleted.

Contents of CFS report f i les

For the contents of CFS report files, see chapter 2.4 XFILEV5 Output Information.

To include properties and structure information of CATIA files in the CFS report, select the

Write extended report option in the Settings section of the MOVE dialog. See Write

extended report, page 74.

* * *