Check-in¶

AutoCheckIn le permite comprobar componentes a través de la línea de comandos y, si es necesario, crear una nueva versión. Los datos maestros y el tipo de componente pueden modificarse mediante ajustes en el archivo de configuración.

El siguiente comando debe ser introducido en la línea de comandos:

C:\Program Files (x86)\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:{vdClientArchive}" [/account:{User}] [/domain:{domain}] [/password:{password}] /CFile:d:{configuration file}

Los parámetros y valores necesarios para la llamada a la línea de comandos se encuentran en la siguiente tabla.

Parámetros	Descripción
/rd:{ArchivoCliente}	Ruta completa al archivo de cliente
/account:{usuario}	Nombre del usuario que realiza el Check-In Sólo se requiere si el nombre de usuario no se transfiere en el archivo de configuración.
/dominio:{dominio}	Dominio del usuario Sólo es necesario si el nombre de usuario se transfiere a través de la línea de comandos.
/contraseña:{contraseña}	Contraseña del usuario Sólo se requiere si el nombre de usuario se transfiere a través de la línea de comandos.
/CFile:{archivo de configuración}	Ruta completa al archivo de configuración
/JobConfig	Indica que se va a crear una tarea > Sólo es necesario si se va a cambiar la configuración de la tarea y no se va a crear ningún componente, no se va a versionar y no se va a realizar ningún Check-In.

Archivo de configuración¶

Para ejecutar el check-in de un componente a través de la línea de comandos, versionarlo o crear una tarea, se requiere un archivo INI de configuración. Las secciones, claves y valores necesarios del archivo de configuración se pueden encontrar en la siguiente tabla.

Info

Si un valor tiene espacios iniciales o finales, debe ir entre comillas en el archivo de configuración. Si se especifica un valor por defecto para una clave, no es necesario transferir esta clave en el archivo de configuración.

Sección [User]¶

Clave	Descripción	Valores	Predeterminado
Account	Nombre del usuario que realiza el Check-In. Sólo se requiere si el nombre de usuario no se transfiere en el archivo de configuración.		Cadena vacía
Domain	Dominio del usuario. Sólo es necesario si el nombre de usuario se transfiere a través de la línea de comandos.		Cadena vacía
Password	Dominio del usuario. Sólo es necesario si el nombre de usuario se transfiere a través de la línea de comandos		Cadena vacía
PasswordMode	Dominio del usuario. Sólo es necesario si el nombre de usuario se transfiere a través de la línea de comandos.	0: La contraseña se trata como no cifrada y se transfiere directamente. 2: La clave se ignora y la contraseña debe introducirse a través de la línea de comandos.

Sección [Component]¶

Clave	Descripción
Dir	Ruta relativa al componente. Hay una barra invertida al principio, no al final.
ComponentTypeId	ID de tipo de componente válido con el que se sustituye el ID de tipo de componente existente.

Sección [CreateComponent]¶

Clave	Descripción
ComponentTypeId	Si el componente aún no existe, puede crearse. El requisito previo para ello es que se haya almacenado un ID de tipo de componente válido, que se utilizará como plantilla. Si existen las claves ComponentTypeId y ComponentId, siempre se utiliza la clave ComponentId (es decir, si se ha introducido un valor para la clave ComponentId, no es necesario introducir un valor para la clave ComponentTypeId).
ComponentId	Si el componente aún no existe, puede crearse. El requisito previo para ello es que se haya almacenado un ID de componente válido, que se utilizará como plantilla. Si existen las claves ComponentTypeId y ComponentId, siempre se utiliza la clave ComponentId (es decir, si se ha introducido un valor para la clave ComponentId, no es necesario introducir un valor para la clave ComponentTypeId).
WorkingDir	Especificación de un directorio de trabajo externo
Fuentes	El directorio de trabajo puede llenarse directamente con archivos. El origen puede ser un directorio o un archivo ZIP. Si ya hay datos en el directorio de trabajo (por ejemplo, en el caso de reutilizar un componente o importar una estructura de directorios), el componente no se crea y falla todo el proceso de AutoCheckIn.

Sección [Version]¶

Clave	Descripción	Valores	Predeterminado
Enabled	Especifica si debe crearse una versión antes del check-in.	Y: Se crea una nueva versión. N: No se crea una nueva versión.	N
HversionUserDefined	Número de versión de la versión que se puede crear.		Cadena vacía
Comentario	Comentario para esta versión. Se muestra un salto de línea con `<br>`.		Cadena vacía
ChangeReason	Razón de cambio de esta versión. Se muestra un salto de línea con `<br>`.		Cadena vacía
WithoutComparison	Especifica si se va a realizar una comparación. Si no se realiza ninguna comparación (Y), se crea una nueva versión aunque no haya diferencias con la versión anterior.	Y: No se realiza una comparación. N: Se realiza la comparación.	N
SilentMode	Especifica si VDogAutoCheckIn.exe puede abrir un mensaje durante la comparación.	Y: Se pueden abrir mensajes. N: No se abre ningún mensaje.	N
UserId	ID de usuario con el que se generará la versión. Formato: {ID con 32 caracteres}.		El usuario que inició sesión
ComputerName	Nombre del equipo en el que se va a generar la versión.		Equipo en el que se ejecuta VDogCheckIn
TimeStamp	Fecha de creación de la versión. Formato: {AAAAAMMDD HHMMSS}.		La fecha y hora actuales
TagName	Etiqueta que se asignará a la versión generada. Esta clave es opcional.
CreateTagIfNotAlreadyExists	Especifica si se crea una etiqueta si no existe ninguna etiqueta para la versión.	Y: La etiqueta se crea si aún no existe. N: Sólo las etiquetas existentes se vinculan a la versión creada. Si la etiqueta no existe, la aplicación falla. La versión generada permanece sin etiqueta.
TagComment	Si se crea una nueva etiqueta, se puede añadir un comentario a la etiqueta aquí.

Sección [CheckIn]¶

Clave	Descripción	Valores	Predeterminado
ReleaseAfterCheckIn	Especifica si la versión del componente debe publicarse después del check-in.	Y: La versión se publica. N: La versión no se publica.	Y
SilentMode	Especifica si VDogAutoCheckIn.exe puede abrir un mensaje durante el check-in.	Y: Se pueden abrir mensajes. N: No se abre ningún mensaje.	N
IgnoreProjectDataIsNot Versioned	Especifica si VDogAutoCheckIn.exe debe ignorar los cambios no versionados del proyecto en el editor durante el check-in.	S: Si hay cambios de proyecto no versionados en el directorio de trabajo, aparece un mensaje de advertencia. Se cargan las versiones que ya se han guardado. N: Si hay cambios no versionados del proyecto en el directorio de trabajo, aparece un mensaje de error. El check-in se cancela. No se cargan las versiones de las cuales se ejecutó el check-in.	N

Sección [MasterData]¶

Clave	Descripción	Valores	Predeterminado
Datos{1..10}	Especifique los datos maestros que deben modificarse. Aquí se aplica lo siguiente: Si introduce un valor, éste se introduce en el campo de datos maestros. Para borrar el campo de datos maestros, no introduzca ningún valor. Por defecto no se modifica nada.		No se modifica nada por defecto.

Sección [Result]¶

Clave	Descripción
ErrorText{0..n}	Mensaje(s) de error en caso de error
ErrorCode{0..n}	Código(s) de error en caso de error. Formato: {Tipo de visualización}{Espacio}{Código de error en notación hexadecimal} Tipo de visualización 0: El código de error se muestra como un número decimal sin signo. Tipo de visualización 1: El código de error se muestra como un número decimal con signo. Tipo de visualización 2: El código de error se muestra como un número hexadecimal.
HVersion	Número de versión de la versión creada (si se ha creado una versión).
JobId	ID de la tarea creado. Sólo se requiere si se utilizan las claves de la sección [JobConfig].

Ejemplos¶

Transferencia del usuario y contraseña en la llamada¶

Llamada de la línea de comandos:

C:\Programs\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:D:\vdClientArchive" /account:{User} /domain:Testdomain /password:{Password} /CFile:d:\AutoCheckIn.ini

Archivo de configuración AutoCheckIn.ini:

[Component]
Dir=\Factory 1\Hall 1\Area 1\110 S7

Transferencia del usuario y la contraseña en el archivo de configuración¶

Llamada de la línea de comandos:

C:\Programs\vdogClient\VDogAutoCheckIn.exe /at:c"/rd:D:\vdClientArchive" /CFile:d:\AutoCheckIn.ini

Archivo de configuración AutoCheckIn.ini:

[User]
Account={User}
Domain={Testdomain}
Password={Password}
[Component]
Dir=\Werk 1\Halle 1\Bereich 1\110 S7

Pasar la contraseña en la llamada y el usuario en el archivo de configuración¶

Llamada de la línea de comandos:

C:\Programs\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:D:\vdClientArchive" /password:{password} /CFile:d:\AutoCheckIn.ini

Archivo de configuración AutoCheckIn.ini:

[User]
Account=User
Domain=Testdomain
PasswordMode=2
[Component]
Dir=\Werk 1\Halle 1\Area 1\110 S7

Ejemplo de aplicación: Crear un nuevo componente¶

Archivo batch:

@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

Archivo de configuración CheckInTest.ini:

[Component]
Dir=\Test\NewComponent
[CreateComponent]
// Binary
ComponentTypeId=D565D656350A428E8B286F834C4F74BA

Ejemplo de aplicación: Personalización de los datos maestros de varios componentes al mismo tiempo¶

Archivo 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%)

Archivo CheckIn.bat

[Version]
Enabled=Y
WithoutComparison=Y
[MasterData]
Data1="Offline"

Archivo Loop.bat

for /F "tokens=*" %%A in (myfile.txt) do checkin.bat %%A

Archivo 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

Contenido relacionado¶

UserClient -> Check-in