检入
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:{password} | 用户密码 只有通过命令行传输用户名时才需要。 |
| /CFile:{ 配置文件} | 配置文件的完整路径 |
| /JobConfig | 表示要创建作业 > 仅在只变更作业配置而不创建组件、不进行版本控制和检入时才需要。 |
配置文件
通过命令行检入组件、版本控制或创建作业，都需要 INI 文件进行配置。配置文件的必要部分、键和值见下表。
Info
如果值有前导空格或尾部空格，则必须在配置文件中用引号括起来。如果为某个键指定了默认值，则不必在配置文件中转移此键。
[User] 部分
| 键 | 描述 | 值 | 默认 |
|---|---|---|---|
| 账户 | 执行检入的用户姓名。 仅在不通过命令行传输用户名时才需要。 | 空字符串 | |
| 域 | 用户的域名。 仅当用户名也在配置文件中传输时才需要。 | 空字符串 | |
| 密码 | 用户密码。 仅当用户名也在配置文件中传输时才需要 | 空字符串 | |
| PasswordMode | 指定处理密码的方式。 仅当用户名也在配置文件中传输时才需要。 | 0：密码被视为未加密并直接传输。 2：密钥被忽略，密码必须通过命令行输入。 |
[Component] 部分
| 键 | 描述 |
|---|---|
| Dir | 组件的相对路径。开头有反斜线，结尾没有。 |
| ComponentTypeID | 有效组件类型 ID，现有组件类型 ID 将被替换。 |
[CreateComponent] 部分
| 键 | 描述 |
|---|---|
| ComponentTypeID | 如果组件还不存在，则可以创建。这样做的前提是已经存储了一个有效的组件类型 ID，然后将其用作模板。如果 ComponentTypeId 和 ComponentId 键都存在，则始终使用 ComponentId 键（也就是说，如果为 ComponentId 键输入了值，则无需为 ComponentTypeId 键输入值）。 |
| ComponentId | 如果组件还不存在，则可以创建。这样做的前提是已经存储了一个有效的组件 ID，然后将其用作模板。如果 ComponentTypeId 和 ComponentId 键都存在，则始终使用 ComponentId 键（也就是说，如果为 ComponentId 键输入了值，则无需为 ComponentTypeId 键输入值）。 |
| WorkingDir | 指定外部工作目录 |
| 来源 | 工作目录可以直接填入文件。源文件可以是目录或 ZIP 文件。如果工作目录中已经有数据（例如在重复使用组件或导入目录结构的情况下），则不会创建组件，整个 AutoCheckIn 过程也会失败。 |
[Version] 部分
| 键 | 描述 | 值 | 默认 |
|---|---|---|---|
| 已启用 | 指定是否应在检入前创建版本控制。 | Y： 新版本控制已创建。 N： 不创建新版本。 | N |
| HversionUserDefined | 可能创建的版本的版本号。 | 空字符串 | |
| 注释 | 该版本的注释。<br> 会显示换行符。 | 空字符串 | |
| ChangeReason | 此版本的更改原因。<br> 会显示换行符。 | 空字符串 | |
| WithoutComparison | 指定是否进行比较。 如果不进行比较（Y），即使与前一版本没有差异，也会创建一个新版本。 | Y： 不进行比较。 N： 执行比较。 | N |
| SilentMode | 指定 VDogAutoCheckIn.exe 是否可以在比较过程中打开信息。 | Y： 可以打开信息。 N： 未打开信息。 | N |
| UserId | 生成版本控制的用户 ID。格式为{ID，32 个字符}。 | 登录用户 | |
| ComputerName | 要生成版本的计算机名。 | 运行 VDogCheckIn 的计算机名 | |
| TimeStamp | 版本创建的时间戳。格式：{yyyymmdd hhmmss}。 | 当前时间戳 | |
| 标签名称 | 要分配给生成版本的标签。此密钥为可选项。 | ||
| CreateTagIfNotAlreadyExists | 指定在版本控制中不存在标签时是否创建标签。 | Y： 如果标签尚不存在，则创建该标签。 N： 只有现有标签会被链接到创建的版本控制。 如果标签不存在，则应用失败。生成的版本仍然没有标签。 | |
| 标签评论 | 如果创建了新标签，可在此处为该标签添加注释。 |
第 [签到] 部分
| 键 | 描述 | 值 | 默认 |
|---|---|---|---|
| ReleaseAfterCheckIn | 指定是否应在检入后发布组件版本。 | Y：版本已发布。 N： 版本控制未发布。 | Y |
| SilentMode | 指定 VDogAutoCheckIn.exe 是否可以在检入期间打开信息。 | Y： 可以打开信息。 N： 未打开信息。 | N |
| 忽略项目数据未版本控制 | 指定在检入过程中，VDogAutoCheckIn.exe 是否应忽略编辑器中未版本控制的项目变更。 | Y：如果工作目录中有未版本控制的项目更改，则会出现警告。已保存的版本会被检入。 N：如果工作目录中有未版本控制的项目更改，则会出现错误消息。检入将被取消。已保存的版本不会被检入。 | N |
第 [主数据] 部分
| 键 | 描述 | 值 | 默认 |
|---|---|---|---|
| 数据{1...10} | 指定要更改的主数据。 以下内容适用于此处：如果输入数值，则该数值将输入主数据字段。要清除主数据字段，请勿输入数值。 | 默认情况下不做任何更改。 |
[Result] 部分
| 键 | 描述 |
|---|---|
| 错误文本{0...n}。 | 出现错误时的错误消息 |
| 错误代码{0...n}. | 错误代码（如果发生错误）。 格式：{显示类型}{空格}{十六进制表示的错误代码} 显示类型 0：错误代码以无符号十进制数显示。 显示类型 1：错误代码以有符号十进制数显示。 显示类型 2：错误代码以十六进制数显示。 |
| H 版本 | 所建版本的版本号（如果创建了一个版本） |
| JobId | 已创建作业的 ID。只有使用 [JobConfig] 部分中的键时才需要。 |
示例
在呼叫中转移用户和密码
命令行调用：
C:\Programs\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:D:\vdClientArchive" /account:{User} /domain:Testdomain /password:{Password} /CFile:d:\AutoCheckIn.ini
配置文件 AutoCheckIn.ini：
在配置文件中转移用户和密码
命令行调用：
配置文件 AutoCheckIn.ini：
[User]
Account={User}
Domain={Testdomain}
Password={Password}
[Component]
Dir=\Werk 1\Halle 1\Bereich 1\110 S7
在调用中传递密码，在配置文件中传递用户
命令行调用：
C:\Programs\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:D:\vdClientArchive" /password:{password} /CFile:d:\AutoCheckIn.ini
配置文件 AutoCheckIn.ini：
应用示例：创建新组件
批处理文件：
@echo off
set VDTOOL=C:\Program Files (x86)\vdogClient\VDogAutoCheckIn.exe
set CLIENTARCHIVE=D:\vdClientArchive
set PASSWD=********
set USERNAME=Administrator
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=Administrator
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 has finished (%ERRORLEVEL%)
文件 CheckIn.ini
Loop.bat 文件
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