Check-In
The AutoCheckIn allows you to Check-In components using the command line and, if necessary, to create a new version. Through the use of settings in the configuration file, the master data and component type can be configured.
The following command must be entered:
C:Program Files (x86)vdogClientVDogAutoCheckIn.exe /at:c "/rd :`<vdClientArchive>`" [/account :`<user>` [/domain :`<domain>`] [/password:] /CFile:d :`<configuration file>`
Keys and values for command lines:
| Paramete | Descriptio |
|---|---|
| /rd:{ClientArchive | Fully qualified path to the client archiv |
| /account :`<User> | Name of the user who carries out the Check-In!!! note Only required if the username is not provided in the configuration file. |
| /domain:<Domain> | Domain of the user!!! note Only necessary if the username is also provided in the command line |
| /password:` |
Password of the user!!! note Only necessary if the username is also provided in the command line |
/CFile:<Configuration file> |
Fully qualified path to the configuration fil |
| /JobConfi | Shows that a job should be created!!! note Only required if only the job configuration is to be changed and no new component is to be created, no versioning and no Check-In is to be performed. |
Configuration file
To check in a component via the command line, to version it or to create a job, an INI file is required for configuration. The necessary sections, keys, and values for the configuration file are listed in the table below.
Note
If a value starts or ends with a blank space, this value must then appear in quotation marks in the configuration file. If you want to use a default value for a key, this does not need to be entered into the configuration file.
Section Key Description
[User] Account
Name of the user who carries out the Check-In
Note
Only required if the username is not given in the command line.
The default value is an empty string.
Domain
Domain of the user
Note
Only required if the username is also provided in the configuration file.
The default value is an empty string.
Password
Password of the user
Note
Only required if the username is also provided in the configuration file. The default value is an empty string.
PasswordMode
Specifies how the password should be treated. Possible values:
0: The password is treated as unencrypted and is provided directly.
2: The key is ignored and the password must be entered via the command line during runtime.
Note
Only required if the username is also provided in the configuration file.
[Component] Dir
Relative path to the component
Note
There is a backslash at the beginning, but not at the end.
ComponentTypeId Valid component type ID that replaces the existing component type ID.
[CreateComponent] ComponentTypeId
If the component does not already exist, it can be created. The prerequisite for this is that a valid component type ID has been stored, which is then used as a template.
Note
If values are specified for both the ComponentTypeId and ComponentId keys, then octoplant always
uses only the ComponentId (in other words, if you specify a value for the ComponentId key then you do not need to specify one for the ComponentTypeId key).
ComponentId
If the component does not already exist, it can be created. The prerequisite for this is that a valid component ID has been stored, which is then used as a template.
Note
If values are specified for both the ComponentTypeId and ComponentId keys, then octoplant always
uses only the ComponentId (in other words, if you specify a value for the ComponentId key then you do not need to specify one for the ComponentTypeId key).
WorkingDir
Specifies an external working directory
Source
Specifies an external working directory. Source is either a directory or a ZIP file.
Note
If there is already data available in the working directory (for example, in case of restoring a component or importing
a directory structure), the component will not be created and the entire AutoCheckIn process will end in an error.
[Version] Enabled
Specifies whether a new version should be created before the component is checked in. Possible values:
Y: A new version is created
N: No new version will be created.
The default value is N.
HversionUserDefined
Version number of the created version (if a version was created)
The default value is an empty string.
Comment
Comment for this version
Note
A line break is displayed using .
The default value is an empty string.
ChangeReason
Change reason for the version
Note
A line break is displayed using .
The default value is an empty string.
WithoutComparison
Specifies whether a comparison should be carried out. Possible values:
Y: No comparison will be carried out.
N: A comparison will be carried out.
The default value is N.
Note
If a comparison is not carried out (Y), then a new version will also be created if there are no differences between the
current version and the previous version.
SilentMode
Specifies whether VDogAutoCheckIn.exe can open message windows during the comparison. Possible values:
Y: Message windows will be displayed.
N: No message windows will be displayed.
The default value is N.
UserId
User ID under which the version is to be generated.
Format:<ID with 32 characters>
The default value is the logged-in user.
ComputerName
Name of the computer on which the version was created.
The default value is the name of the computer on which the VDogCheckIn runs.
TimeStamp
Time stamp on which the version was created.
Format:<YYYYMMDD HHMMSS>
The default value is the current time stamp.
TagName Tag which should be assigned to the created version. This key is optional.
CreateTagIfNotAlreadyExists
Specifies whether a tag is to be created if no tag exists for the version.
Y: The tag is created if it does not already exist
N: Only existing tags are to be linked to the created version. If a tag does not exist, the application will fail. The version created will remain without a tag.
TagComment If a new tag is created, a comment related to the new tag can be entered here.
[CheckIn] ReleaseAfterCheckIn
Specifies whether the version of the component should be made available after Check-In. Possible values:
Y: The version is available.
N: The version is not available.
The default value is Y.
SilentMode
Specifies whether VDogAutoCheckIn.exe can display message windows during Check-In. Possible values:
Y: Message windows will be displayed.
N: No message windows will be displayed.
The default value is N.
IgnoreProjectDataIsNot
Version
Specifies if VDogAutoCheckIn.exe should ignore unversioned project changes during Check-In.
Y: If there are unversioned project changes in the working directory, a warning will appear. Already saved versions will be checked-in.
N: If unversioned project changes are present in the working directory, a warning will appear. The Check-In will be terminated. Already saved versions will be checked-in.
The default value is N.
[MasterData] Dat a<1..10>
Specification of the master data to be changed. The following applies:
If you enter a value, this value will be entered in the master data field.
To clear the master data field, do not enter a value.
By default, nothing is changed.
[Result] ErrorTex t<0..n>Error message(s) if an error occurs.
ErrorCod e<0..n>
Error message(s) if an error occurs.
Format:
<Display type><Error code in hexadecimal notation>
Display type 0: Error code is shown as an unsigned decimal number.
Display type 1: Error code is shown as a signed decimal number.
Display type 2: Error code is shown as a hexadecimal number.
HVersion Version identifier of the created version (if a version was created).
JobId
ID of the created job
Note
Only necessary if keys are used in section [Jobconfig].
Examples
Transfer of the user and password in the call
Command line call:
C:ProgrammevdogClientVDogAutoCheckIn.exe /at:c "/rd:D:vdClientArchive" /account:User /domain:Testdomain /password :`<********>`/CFile:d:AutoCheckIn.ini
Configuration file AutoCheckIn.ini:
User and password supplied in the configuration file
Command line call:
Configuration file AutoCheckIn.ini:
[User]
Account=User
Domain=Testdomain
Password =`<********>`
[Component]
Dir=Plant 1Hall 1Area 1110 S7
Passing the password in the call and the user in the configuration file
Command line call:
C:ProgrammevdogClientVDogAutoCheckIn.exe /at:c "/rd:D:vdClientArchive" /password:{Passwort} /CFile:d:AutoCheckIn.ini
Configuration file AutoCheckIn.ini:
Application example: Creating a new component
Batch file:
@echo off
set VDTOOL=C:Program Files (x86)vdogClientVDogAutoCheckIn.exe
set CLIENTARCHIVE=D:vdClientArchive
set PASSWD=********
set USERNAME=User
set CFGFILE=CheckInTest.ini
SET mypath=%~dp0
set CFGFILE=%mypath%%CFGFILE%
echo [ * ] start Check-In
"%VDTOOL%" "/AT:C" "/RD:%CLIENTARCHIVE%" "/CFile:%CFGFILE%" "/Password:%PASSWD%" "/Account:%USERNAME%"
echo [ * ] Check-In finished (%ERRORLEVEL%)
pause
Configuration file CheckInTest.ini:
[Component]
Dir=TestNewComponent
[CreateComponent]
// Binary
ComponentTypeId=D565D656350A428E8B286F834C4F74BA
Application example: Adjusting master data for multiple components at the same time
File CheckIn.bat
@echo off set VDTOOL=C:Program Files (x86)vdogClientVDogAutoCheckIn.exe
set CLIENTARCHIVE=D:vdClientArchive
set PASSWD=********
set USERNAME=User
set CFGFILE=CheckInTest.ini
SET mypath=%~dp0
set CFGFILE=%mypath%%CFGFILE%
echo [ * ] start Check-In
type %CFGFILE% > %CFGFILE%.cfg
echo [Component] >> %CFGFILE%.cfg
echo dir=%*>> %CFGFILE%.cfg
"%VDTOOL%" "/AT:C" "/RD:%CLIENTARCHIVE%" "/CFile:%CFGFILE%.cfg" "/Password:%PASSWD%" "/Account:%USERNAME%"
echo [ * ] Check-In finished (%ERRORLEVEL%)
File CheckIn.bat
File Loop.bat
File myfile.txt
Plant 1Hall 1Area 1110 S7
Plant 1Hall 1Area 2DocumentationBook list
Plant 1Hall 1Area 2DocumentationCADD