Modify a Connection

After a vcfile, vcfolder, or vcmodule connection is defined, you can change the definition with the Modify Businessobject command. This command lets you add or remove defining clauses and change the value of clause arguments. If you have checkin access, you can modify existing vcconnections.

This MQL command modifies a connection:

modify businessobject BO_NAME vcconnection [index NUMBER] [VC_MOD_ITEM];

Or

modify businessobject BO_NAME vcmodule path PATH [VC_MOD_ITEM];
  • BO_NAME is the name of the business object associated with the connection .
  • index NUMBER is an identifier number unique among all connections. Each connection is assigned one when created and this value never changes. Unless the index number of a connection is specified, the modify command modifies ALL connections.
  • PATH is the string that identifies the path of folders leading to the vcmodule relative to the path defined in the store indentifying the server.
  • VC_MOD_ITEM indicates the modifications you can make. The modifications you can make correspond to the different clauses you can define when you create the connection. The modifications that can be made for all three connection types are specified in the following table. Some of the modifications described in the table are not possible for all three connection types.
Modify Businessobject Clause Specifies that...

store NAME

The name of the DesignSync store (representing a DesignSync server) is changed to the NAME given.

format NAME

The name associated with the connection is changed to the NAME given.

path STRING

The string that identifies the path of folders leading to vcfile, vcfolder, or vcmodule relative to the path defined in the store identifying the server is changed to the STRING given.

description STRING

The description is changed to the STRING given.

sparse true

Attributes for business objects of this type that are not populated when the object is create/modified are not instantiated (not part of the business object's Oracle tables).

sparse false

All attributes defined for the type are instantiated for all business objects of the type, even if the attributes are not populated.

versionid STRING

The string identifying a particular version of a vcfile or vcmodule is changed to the STRING given.

versiontag STRING

The string identifying the tag applied to a particular version of a vcfile or vcmodule is changed to the STRING given.

add|remove versiontag STRING

The version tag applied to a particular version of a vcfile or vcmodule is either added to or removed from the vcfile or vcmodule. If the add operation is not successful, an error is returned. Errors are not returned for the remove operation regardless of outcome.

branchid STRING

The string identifying the branch of the vcfile or vcmodule is changed to the STRING given.

branchtag STRING

The string identifying the tag applied to the branch of the vcfile or vcmodule is changed to the STRING given.

add|remove branchtag STRING

The branch tag applied to a particular version of a vcfile or vcmodule is either added to or removed from the vcfile or vcmodule. When you remove a branch tag from a version, you remove the tag from the branch of that version. If the add operation is not successful, an error is returned. Errors are not returned for the remove operation regardless of outcome.

selector STRING

The string identifying the branch and version of the vcfile or vcmodule is changed to the STRING given.

qualifier STRING

The string identifying the version of the branch picked out by the connection is changed to the STRING given.

config STRING

The name of the folder configuration being associated with the file connection is changed to the STRING given. This value can be used with the select vcfolder command allowing you to navigate to the folder containing the file.

[in]complete

The "completeness" flag is changed to complete or incomplete.

checkintag STRING

The string holding the autotag (the version tag value) is changed to the STRING Given.

[un]lock

The vcfile is either locked or unlocked.

copyfromstore STORE_NAME path STRING |VERSION|

Or, use this command when copying vcfolders:

copyfromstore STORE_NAME path STRING |config NAME|;

The vcfiles or vcfolders from one DesignSync store are copied to another store.

The BO_NAME and the index NUMBER specified in the command are the business object connected to one or more vcfiles or vcfolders of the store you are copying to and the number of the connection to a vcfile or vcfolder in the store you are copying to. If the index number is not specified, the command applies to all vcconnections associated with the business object.

The STORE_NAME is the DesignSync store from which you are copying over the vcfile. The path STRING is the string that identifies the path of folders leading to vcfile from which you are copying the vcfile. If this path does not exist in the destination store, it is created during the copy process. The VERSION is the version of the vcfile you are copying. The different ways to specify the version of a vcfile are described in Specify Version. The config NAME is the name of the configuration of the vcfolder you are copying.

In the destination store, an auto-generated checkin tag is applied to the latest version of the file that is copied over. If the file already exists at the destination position determined by the specifier on the vcconnection, and its content is identical to that of the file being copied, then the new file is not copied. The existing file at the destination gets the checkin tag placed on the matching version.

All the strings issued with this command except path and description should contain 255 characters or less.