PutInBriefcaseTree

<< Click to Display Table of Contents >>

Navigation:  Programming Mechworks PDM > DBWCommandShell > Commands Reference > RemoteAccess >

PutInBriefcaseTree

Description

Put a document in the BriefCase.

Syntax

call DBWShell("PutInBriefcaseTree ZipFile DestCompanyID DrawingsMode AddStandard AddGeneric

  AddNonManaged Silent AutoCheckOut TraverseMode AvoidToModifyCheckedOutDocs
AddForeignDocs TransferOwnership OnlyProjects")

Parameters

ZipFile

the full file name of the briefcase to put doc into

DestCompanyID

destination Company ID (according to what specified in DBCustomizer)

DrawingsMode

possibile values are:
0: Do not add drawings
1: Add all related drawings
2: Add only drawings of documents to be modified

AddStandard

possibile values are:
0: Do not add standard parts
1: Add standard parts

AddGeneric

possibile values are:
0: Do not add generic documents
1: Add generic documents

AddNonManaged

possibile values are:
0: Do not add unmanaged components
1: Add unmanaged components

Silent

to avoid asking confirmation
0: Ask confirmation (default)
1: Do not ask confirmation

AutoCheckOut

0: Do not set autocheckout
1: Set autocheckout mode

TraverseMode

0: Insert only the passed node
1: Insert also passed node children

AvoidToModifyCheckedOutDocs

0: Let modify checkedout documents
1: Do not allow the destination company to modify checkedout documents

AddForeignDocs

0: Do not add foreign documents
1: Add foreign documents

TransferOwnership

0: Do not allow to take ownership
1: Allows the destination company to take the full ownership of the documents received for modification

OnlyProjects

0: Insert every document
1: Insert only projects (and their PARENT_CHILD relations)

Remarks

warning

The option must be used with the Autocheckout Mode set to FALSE.

When the option is checked, the following changes applies to the briefcase being written:

the state BEING_MODIFIED ( Checked-out ) is transformed into state CHECKED_IN

the OWNER_COMPANY_ID is always set to NULL

the CHECKED_OUT_BY is always set to NULL

See also

GetFromBriefcaseTree command

Example

readableFileName="e:\myBriefcases\test.zip"

DestCompanyID = "MechWorks"
BcDrawingsMode="1" 'All related drawings
BcAddStandard="0"
BcAddGeneric="0"
BcAddNonManaged="0"
silent="1"
BcAutoCheckOut = "0"
BcTraverseMode = "1"
BcAvoidToModifyCheckedOutDocuments = "1"
BcAddForeignDocuments = "0"
transferOwnership = "1"
OnlyProjects = "0"
strCommand= Replace(readableFileName," ","|") & " " & _
 Replace(DestCompanyID," ","|") & " " & _
 BcDrawingsMode & " " & _
 BcAddStandard & " " & _
 BcAddGeneric & " " & _
 BcAddNonManaged & " " & _
 silent & " " & _
 BcAutoCheckOut & " " & _
 BcTraverseMode & " " & _
 BCAvoidToModifyCheckedOutDocuments & " " & _
 BCAddForeignDocuments & " " & _
 transferOwnership & " " & _
 OnlyProjects
call DBWShell("PutInBriefCaseTree " & strCommand)