Selectable Fields for Vcfile, Vcfolder and Vcmodule

Selectables for vcfiles, vcfolders and vcmodules can return ENOVIA metadata or data held in the DesignSync system. The following table lists selectables that return ENOVIA metadata.

ENOVIA metadata Selectable Fields
Field Description Output

abstract.*

(vcfile or vcmodule only)

Works only with a ".".

Applies the next select keyword to the abstract vcfile or vcmodule of the current vcfile or vcmodule version picked out by this connection

author

(vcfile or vcmodule only)

Name of the person who checked in the vcfile or vcmodule version.

Returns the name of the owner (author) of the file or module.

branchid

(vcfile or vcmodule only)

Branch id of a vcfile or vcmodule version.

Returns the id of the branch of the current file or module picked out by the connection.

branchtag[]

(vcfile or vcmodule only)

Branch tag of a vcfile or vcmodule version.

Without "[]", returns a list of branch tags associated with the current vcfile or vcmodule version picked out by the connection.

With "[]", returns True/False depending on whether the string provided is a valid branch tag for the current version of the vcfile or vcmodule.

branchparent.*

(vcfile or vcmodule only)

Parent vcfile or vcmodule of the branch of the current vcfile or vcmodule.

Returns the parent file or module of the branch of the current vcfile or vcmodule.

Works only with a ".". Applies the next keyword to the parent vcfile or vcmodule version of the branch of the current vcfile or vcmodule version picked out by the connection.

Without a ".", returns an error.

branchversion[].*

(vcfile or vcmodule only)

The different versions of the branch of the vcfile or vcmodule.

Returns the different versions of the current vcfile or vcmodule in the branch.

With no "[]" and no ".", returns in order the ids of the versions of the branch of the current vcfile or vcmodule version. With "[]" but no ".", returns True/False.

With a "." and no "[]", applies the keyword that follows to each version of the branch of the current vcfile or vcmodule version.

With a "[]" and a ".", applies the next keyword to the version identified by the string in the brackets treating it as a version id.

subbranch[].*

(vcfile or vcmodule only)

All branches emerging from a vcfile or vcmodule version.

With no "[]" or ".", returns the ids of all branches emerging from the vcfile or vcmodule version.

With "[]" and no ".", returns True/Flase depending on whether the string provided is a valid branch id or branch tag emerging from the current version of vcfile or vcmodule.

With a "." and no "[]", applies the next keyword to all the branches emerging from the current vcfile or vcmodule version picked out by the connection.

With "[]" and ".", applies the next keyword to the last version of the branch whose branch id or branch tag is inside the brackets. The branch should be emerging from the current vcfile or vcmodule version picked out by the connection.

config.*

Identify the configuration of the vcfolder or the folder containing the vcfile or vcmodule.

Returns the configuration name as provided in the configuration clause.

created

(vcfile or vcmodule only)

Date and time the vcfile or vcmodule version was created.

Returns the date and time of the creation of the file or module.

created.generic

(vcfile or vcmodule only)

Date and time in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator)

Returns the date and time in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) of the creation of the file or module.

complete

(vcfile or vcmodule only)

Is vcfile or vcmodule checkin complete?

True/False.

For information on the [in]complete flag see Connect to a File in DesignSync.

checkintag

(vcfile or vcmodule only)

A string containing the autotag (the version tag) that was assigned during checkin.

String Value

checkintag

(vcfolder only

A string containing the autotag (the version tag) that was assigned during checkin.

String Value

comment

(vcfile or vcmodule only)

Comment entered by a user when checking in a vcfile or vcmodule.

Returns the checkin log entry for the current vcfile or vcmodule.

description

Description of the connection.

Returns the description as provided in the description clause.

format[].*

Format of the connection.

Used as "format", returns the name of the format of this vcfile or vcmodule.

Used as "format[]", returns True/False.

Used as "format.*", applies the next select keyword to the format of the connection.

index

(vcfile or vcfolder only)

ENOVIA generated index number of the connection.

Returns the unique index number of the connection.

locked

(vcfile or vcmodule only)

Is the current vcfile or vcmodule version locked?

True/False.

locker

(vcfile or vcmodule only)

Name of the user who has locked the current vcfile or vcmodule version.

Returns the name of the user who locked the file or module.

otherconfigs[].*

(vcfolder only

Other configurations that are applicable to the vcfolder.

Returns information about other configurations applicable to the vcfolder.

Used as otherconfigs, returns a list of all names of configurations of this vcfolder in DesignSync.

Used as otherconfigs[], returns True if the string inside the brackets is the name of a configuration of the vcfolder.

Used as otherconfigs[].*, applies the next keyword to this folder as if its configuration was given by the string in the bracket.

parent.*

(vcfile or vcmodule only)

Parent vcfile or vcmodule of the current vcfile or vcmodule version.

Returns the parent file for the current vcfile or vcmodule.

Works only with a ".". Applies the next keyword to the parent vcfile or vcmodule version of the current vcfile or vcmodule version picked out by the connection.

Without a ".", returns an error.

path

Path of the connection.

Returns the path provided in the connect business object command.

qualifier

(vcfile or vcmodule only)

Identify the version of the branch picked out by the vcfile or vcmodule connection (at any given point in time).

Returns the value as provided in the qualifier clause. If no value was entered. returns an empty string " ".

The qualifier clause is applicable for spectypes branchid and branchtype only.

retired

(vcfile or vcmodule only)

Is the branch of the current vcfile or vcmodule version retired?

True/False.

Returns True if the branch of the file or module is retired. Otherwise returns False.

subfolder[].*

(vcfolder only)

Vcfolders that are subfolders of the vcfolder.

Returns information on subfolders that are part of the vcfolder.

Used as subfolder, returns the names of the vcfolders that are sub-folders of the vcfolder.

Used as subfolder[], returns True/False.

Used as subfolder[]., applies the next keyword to the sub-folder whose name is within the brackets.

Used as subfolder.*, applies the next keyword to each vcfolder that is a sub-folder of the vcfolder picked out by the connection.

spectype

(vcfile or vcmodule only)

Type of the specifier of the connection.

Returns one of the following types:

versionid/versiontag/branchid/branchtag/selector.

specifier

(vcfile or vcmodule only)

Specifier of the connection.

Returns the specifier of the connection as provided by the user.

store[].*

Store of the connection.

Used as "store", returns the name of the store of this vcfile or vcmodule.

Used as "store[]", returns True/False.

Used as "store.*", applies the next select keyword to the store of the connection.

Selectables that return data held in the DesignSync system.

DesignSync data Selectable Fields
Field Description Output

vcname

Name of a vcfile, vcfolder, or vcmodule version.

Returns the name of the current vcfile, vcfolder, or vcmodule version picked out by the connection.

vcpath

Path of a vcfile, vcfolder, or vcmodule version.

Returns the path relative to the path in 3DSpace store definition of the version of the vcfile, vcfolder, or vcmodule picked out by the connection.

When used with vcfile, the path includes the file name of the vcfile.

versionid

(vcfile or vcmodule only)

Id of a vcfile or vcmodule version.

Returns the unique id of the current file or module picked out by the connection.

versiontag[]

(vcfile or vcmodule only)

Version tag of a vcfile or vcmodule version.

Without "[]", returns a list of version tags associated with the current vcfile or vcmodule version picked out by the connection.

With "[]", returns True/False depending on whether the string provided is a valid version tag for the current version of the vcfile or vcmodule.

vcfile[].*

(vcfolder only

Vcfiles that are part of the vcfolder.

Returns information about vcfiles that are part of the vcfolder.

Used as vcfile, returns the name of each vcfile.

Used as vcfiles[] True/False depending on whether the string inside the brackets is the name of a file in the folder.

Used as vcfile[].*, applies the next keyword to the vcfile version indicated by the string within the brackets if it is the vcname of one of the files in the folder. The vcfile version is treated as if it were a vcfile connection identified by its version id.

Used as vcfile.*, applies the next keyword to all the vcfile versions in the same as is done with brackets.

vcfolder.*

(vcfile or vcmodule only)

The vcfolder (DesignSync folder) of which the vcfile or vcmodule is a part of.

Works only with a ".".

Applies the next keyword to the vcfolder of this vcfile or vcmodule treated as a vcfolder connection with the config of this connection. If there is no config, the operation of certain keywords will vary depending on the store.