签入
AutoCheckIn允许你使用命令行签入组件,并在必要时创建一个新版本。通过使用配置文件中的设置,可以对主数据和组件类型进行配置。
必须输入以下命令:
C:\Program Files (x86)\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:<vdClientArchive>" [/account:<user> [/domain:<domain>] [/password:<password>] /CFile:d:<configuration file> |
命令行的键和值。
参数 | 描述 |
---|---|
/rd:{ClientArchive} | 客户端存档的完全限定路径 |
/account:<用户名> |
执行签入的用户名称 只有在配置文件中没有提供用户名的情况下才需要。 |
/domain:<域名> |
用户的域 只有在命令行中也提供用户名的情况下才需要。 |
/password: <密码> |
用户的密码 只有在命令行中也提供用户名的情况下才需要。 |
/CFile: <配置文件> |
配置文件的完全限定路径 |
/JobConfig |
显示应该创建一个作业 只有在只更改作业配置,而不创建新组件,不进行版本控制和不执行签入的情况下才需要。 |
配置文件
要通过命令行签入组件,对其进行版本控制或创建一个作业,需要一个 INI 文件进行配置。配置文件必要的区段、键和值如下表所列。
如果一个值以空格开始或结束,则该值必须在配置文件中以引号出现。如果您想为一个键使用默认值,则不需要输入到配置文件中。
区段 | 键 | 描述 |
---|---|---|
[User] | Account |
执行签入的用户名称 只有在命令行中没有给出用户名时才需要。 默认值是一个空字符串。 |
Domain |
用户的域 只有在配置文件中也提供用户名的情况下才需要。 默认值是一个空字符串。 |
|
Password |
用户的密码 只有在配置文件中也提供用户名的情况下才需要。 默认值是一个空字符串。 |
|
PasswordMode |
指定应如何处理密码。可能的值: 0: 密码被视作未加密,直接提供。 2: 键被忽略,密码必须在运行时通过命令行输入。 只有在配置文件中也提供用户名的情况下才需要。 |
|
[Component] | Dir |
组件的相对路径 开头有一个反斜杠,但结尾没有。 |
ComponentTypeId | 有效的组件类型 ID,取代现有的组件类型 ID。 | |
[CreateComponent] | ComponentTypeId |
如果组件尚不存在,可将之创建。这样做的前提是已经存储了一个有效的组件类型 ID,然后将其作为一个模板使用。 |
ComponentId |
如果组件尚不存在,可将之创建。这样做的前提是已经存储了一个有效的组件 ID,然后将其作为一个模板使用。 |
|
WorkingDir |
指定一个外部工作目录 |
|
Source |
指定一个外部工作目录Source(源)是一个目录或一个 ZIP 文件。 |
|
[Version] | Enabled |
指定在组件签入前是否应该创建新版本。可能的值: Y: 创建新版本 N: 不创建新版本。 默认值是 N。 |
HversionUserDefined |
所建版本的版本号(如果创建了一个版本) 默认值是一个空字符串。 |
|
Comment |
对该版本的注释 使用 <br> 显示换行。 默认值是一个空字符串。 |
|
ChangeReason |
版本的更改原因 使用 <br> 显示换行。 默认值是一个空字符串。 |
|
WithoutComparison |
指定是否应进行比较。可能的值: Y: 将不进行比较。 N: 将进行比较。 默认值是 N。 如果不进行比较 (Y),那么如果当前版本和上一版本之间没有差异,也将创建一个新版本。 |
|
SilentMode |
指定 VDogAutoCheckIn.exe 是否可以在比较期间打开消息窗口。可能的值: Y: 将显示消息窗口。 N: 将不显示任何消息窗口。 默认值是 N。 |
|
UserId |
生成该版本的用户 ID 格式。<有32个字符的ID> 默认值是登录的用户。 |
|
ComputerName |
创建该版本的计算机的名称 默认值是运行 VDogCheckIn 的计算机名称。 |
|
TimeStamp |
创建该版本的时间戳 格式。<年月日 hhmmss> 默认值是当前的时间戳。 |
|
TagName | 应该分配给所建版本的标签。这个键是可选的。 | |
CreateTagIfNotAlreadyExists |
指定如果版本中没有标签存在,是否要创建一个标签。 Y: 如果标签不存在,则创建标签。 N: 只将现有标签链接到所建版本。如果标签不存在,应用程序将失败。所建版本将保持无标签 |
|
TagComment | 如果创建了一个新标签,可以在这里输入与新标签有关的注释。 | |
[CheckIn] | ReleaseAfterCheckIn |
指定是否应该在签入后提供组件的版本。可能的值: Y: 该版本是可用的。 N: 该版本不可用。 默认值是 Y。 |
SilentMode |
指定 VDogAutoCheckIn.exe 是否可以在签入期间显示消息窗口。可能的值: Y: 将显示消息窗口。 N: 将不显示任何消息窗口。 默认值是 N。 |
|
IgnoreProjectDataIsNot Version |
指定VDogAutoCheckIn.exe在签入过程中是否应该忽略未版本化的项目变化。 Y: 如果工作目录中有未版本化的项目更改,将出现一个警告。已经保存的版本将被签入。 N: 如果工作目录中存在未版本化的项目更改,将出现一个警告。将终止签入。已经保存的版本将被签入。 默认值是 N。 |
|
[MasterData] | Data<1...10> |
要更改的主数据规范。适用于以下情况: 如果您输入了一个值,该值将被输入到主数据字段。 要清除主数据字段,不要输入一个值。 默认情况下,没有任何更改。 |
[Result] | ErrorText<0...n> | 发生错误时的错误消息。 |
ErrorCode<0...n> |
发生错误时的错误消息。 格式: <显示类型><空白处><错误代码为十六进制记数法> 显示类型 0:错误代码显示为无符号的十进制数。 显示类型 1:错误代码显示为一个有符号的十进制数字。 显示类型 2:错误代码显示为十六进制数字 |
|
HVersion | 所建版本的标识符(如果创建了一个版本) | |
JobId |
所建作业的 ID 只有在[Jobconfig]节中使用键时才需要。 |
示例
调用中的用户和密码传输
命令行调用:
C:\Programme\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:D:\vdClientArchive" /account:User /domain:Testdomain /password:<********>/CFile:d:\AutoCheckIn.ini |
配置文件 AutoCheckIn.ini:
[Component] Dir=\Plant 1\Hall 1\Area 1\110 S7 |
配置文件中提供的用户和密码
命令行调用:
C:\Programme\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:D:\vdClientArchive" /CFile:d:\AutoCheckIn.ini |
配置文件 AutoCheckIn.ini:
[User] 账户=用户 Domain=Testdomain Password=<********> [Component] Dir=\Plant 1\Hall 1\Area 1\110 S7 |
在调用中传递密码,在配置文件中传递用户
命令行调用:
C:\Programme\vdogClient\VDogAutoCheckIn.exe /at:c"/rd:D:\vdClientArchive" /password:{Passwort}/CFile:d:\AutoCheckIn.ini |
配置文件 AutoCheckIn.ini:
[User] 账户=用户 Domain=Testdomain PasswordMode=2 [Component] Dir=\Plant 1\Hall 1\Area 1\110 S7 |
应用示例:创建新组件
批处理文件:
@echo off set VDTOOL=C:\Program Files (x86)\vdogClient\VDogAutoCheckIn.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 |
配置文件 CheckInTest.ini:
[Component] Dir=\Test\NewComponent [CreateComponent] // Binary ComponentTypeId=D565D656350A428E8B286F834C4F74BA |
应用示例:同时调整多个组件的主数据
CheckIn.bat 文件
@echo off set VDTOOL=C:\Program Files (x86)\vdogClient\VDogAutoCheckIn.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%) |
CheckIn.bat 文件
[Version] Enabled=Y WithoutComparison=Y [MasterData] Data1="Offline" |
Loop.bat 文件
for /F "tokens=*" %%A in (myfile.txt) do checkin.bat %%A |
myfile.txt 文件
\Plant 1\Hall 1\Area 1\110 S7 \Plant 1\Hall 1\Area 2\Documentation\Book list \Plant 1\Hall 1\Area 2\Documentation\CADD |
相关主题 |
---|
UserClient -> 签入 |