Check-in

Con el AutoCheckIn es posible ejecutar el check-in de los componentes a través de las líneas de comando y a la vez, crear una nueva versión. Configurando el archivo de configuración es posible modificar los datos maestros y el tipo de componente.

En la línea de comando, escriba la siguiente ruta:

C:\Archivos de programa (x86)\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:<ClientArchive>" [/account:<usuario> [/domain:<dominio>] [/password:<contraseña>] /CFile:d:<archivo de configuración>

Puede copiar los parámetros necesarios y los valores para la activación a través de las líneas de comando de la siguiente tabla:

Parámetro	Descripción
/rd:<ClientArchive>	Ruta absoluta del archivo del cliente
/account:<Usuario>	Nombre del usuario que ejecuta el check-in Solo se requiere, si el nombre de usuario no es asignado en el archivo de configuración.
/domain:<Dominio>	Dominio del usuario Solo se requiere, si el nombre de usuario no es asignado en la línea de comando.
/password:<Contraseña>	Contraseña del usuario Solo se requiere, si el nombre de usuario no es asignado en la línea de comando.
/CFile:<Archivo de configuración>	Ruta absoluta del archivo de configuración
/JobConfig	Indica que se debe crear una tarea. Solo requerida si no se deben realizar cambios en la configuración de tarea y no se debe crear un componente, una versión o un Check-in.

Archivo de configuración

Para ejecutar el check-in o el versionado de un componente a través de las líneas de comandos, debe configurar un archivo INI. La siguiente tabla contiene las secciones, las claves y los valores necesarios de configuración del archivo.

Si un valor contiene espacios vacíos al comienzo o al final, debe estar escrito entre comillas en el archivo de configuración. Si a la clave debe asignarse un valor predeterminado, no es necesario que esta se encuentra en el archivo de configuración.

Sección	Clave	Descripción
[User]	Account	Nombre del usuario que ejecuta el check-in Solo se requiere, si el nombre de usuario no es asignado en la línea de comando. El valor predeterminado es una línea de caracteres vacía.
	Domain	Nombre del usuario Solo se requiere, si el nombre de usuario no es asignado en el archivo de configuración. El valor predeterminado es una cadena de caracteres vacía.
	Password	Contraseña del usuario Solo se requiere si el nombre de usuario también es asignado en el archivo de configuración. El valor predeterminado es una cadena de caracteres vacía.
	PasswordMode	Indica cómo la contraseña debe ser tratada. Valores disponibles: 0: La contraseña será considerada como no codificada y será asignada directamente. 2: La clave es ignorada y la contraseña debe ser ingresada a través de la línea de comando. Solo se requiere, si el nombre de usuario es asignado en el archivo de configuración.
[Component]	Dir	Ruta relativa del componente Al comienzo hay una barra invertida, al final, no.
[Component]	ComponentTypeId	Id válido del tipo de componente, que será reemplazado por el Id del tipo de componente existente.
[CreateComponent]	ComponentTypeId	Si el componente todavía no existe, puede ser creado nuevamente. Como requisito, se debe asignar un Id válido de tipo de componente, que será extraído como muestra. Si se dispone de ambas claves ComponentTypeId y ComponentId, se extraerá la clave ComponentId (es decir que si asignó un valor para la clave ComponentId, no es necesario asignar un valor para la clave ComponentTypeId).
	ComponentID	Si el componente todavía no existe, puede ser creado nuevamente. Como requisito, se debe asignar un Id válido de componente, que será extraído como muestra. Si se dispone de ambas claves ComponentTypeId y ComponentId, se extraerá la clave ComponentId (es decir que si asignó un valor para la clave ComponentId, no es necesario asignar un valor para la clave ComponentTypeId).
	WorkingDir	Directorio de trabajo externo
	Source	Es posible ubicar archivos en el directorio de trabajo. La fuente es un directorio o un archivo ZIP. Si en el directorio de trabajo ya hay archivos disponibles (p. ej. si se usa un componente existente o una importación de una estructura de directorios), el componente no será creado y el proceso de AutoCheckIn fallará.
[Version]	Enabled	Valor para crear o no crear una nueva versión antes del check-in. Valores disponibles: Y: se creará una nueva versión N: no se creará una nueva versión Valor predeterminado: N.
	HversionUserDefined	El número de versión de la versión creada El valor predeterminado es una línea de caracteres vacía.
	Comment	Comentario sobre la versión El salto de párrafo se representa con <br>. El valor estándar es una línea de caracteres vacía.
	ChangeReason	Razón de cambio de creación de la versión El salto de párrafo se representa con <br>. El valor predeterminado es una línea de caracteres vacía.
	WithoutComparison	Valor para ejecutar o no ejecutar una comparación. Valores disponibles: Y: no se ejecutará una comparación N: se ejecutará una comparación Valor predeterminado: N. Si no se ejecuta una comparación (Y), solo se creará una nueva versión si no hay diferencias con la version anterior.
	SilentMode	Valor para que VDogAutoCheckIn.exe abra o no abra una ventana de mensaje durante la comparación. Valores disponibles: Y: abrir las ventanas de mensajes N: no abrir las ventanas de mensajes Valor predeterminado: N.
	UserId	Id del usuario bajo el cual la versión es creada Formato: <ID con 32 caracteres> El valor predeterminado es el usuario bajo el cual se inició sesión.
	ComputerName	Nombre del equipo donde se crea la versión El valor predeterminado es el nombre del equipo donde se ejecuta VDogCheckIn.
	TimeStamp	Etiqueta de fecha y hora e creación de la versión Formato: <YYYYMMDD HHMMSS> El valor predeterminado es la etiqueta actual.
	TagName	Etiqueta a asignar a la versión creada Esta clave es opcional.
	CreateTagIfNotAlreadyExists	Valor para crear una etiqueta, en el caso que no exista una etiqueta para la versión. Y: Crear una etiqueta si esta no existe. N: Solo las etiquetas disponibles serán asignadas a la versión creada. Si la etiqueta no existe, la aplicación fallará. La versión creada no tiene etiqueta.
	TagComment	Si se crea una nueva etiqueta es posible agregar aquí un comentario sobre la etiqueta.
[CheckIn]	ReleaseAfterCheckIn	Valor para publicar la versión del componente después del check-in. Valores disponibles: Y: publicar la versión N: no publicar la versión Valor predeterminado: Y.
	SilentMode	Valor para que VDogAutoCheckIn.exe abra o no abra una ventana de mensaje durante el check-in. Valores disponibles: Y: abrir las ventanas de mensajes N: no abrir las ventanas de mensajes Valor predeterminado: N.
	IgnoreProjectDataIsNot Versioned	Valor para indicar a VDogAutoCheckIn.exe si debe ignorar los cambios de proyecto realizados en el editor que no fueron versionados. Y: Si no hay cambios de proyectos versionados en el directorio de trabajo, aparece una advertencia. Las versiones ya almacenadas serán cargadas al servidor. N: Si no hay cambios de proyecto versionados en el directorio de trabajo, aparece un mensaje de error. El check-in será cancelado. Las versiones ya almacenadas no serán cargadas al servidor. Valor predeterminado: N.
[MasterData]	Data{1..10}	Asignación de los datos maestros que deben ser modificados. Para esto tenga en cuenta: Si asigna un valor, este valor será ingresado en el campo de los datos maestros. Para dejar vació el campo de los datos maestros, no asigne ningún valor. De manera predeterminada, los campos de los datos maestros no serán modificados.
[Result]	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}{Espacio en blanco}{Código de error escrito de manera hexadecimal} Tipo 0: el código de error será representado como número decimal sin signo Tipo 1: el código de error será representado como número decimal con signo Tipo 2: el código de error será representado como número hexadecimal
	HVersion	El número de versión de la versión creada
	JobId	Id de la tarea creada Solo se requiere si en la sección [JobConfig] se usa la clave

Ejemplos:

Asignación del usuario y contraseña en el archivo de configuración

Llamada de líneas de comandos

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

Archivo de configuración AutoCheckIn.ini:

[User]

Account=<Usuario>

Domain=<Dominio>

Password=<contraseña>

[Component]

Dir=\Werk 1\Halle 1\Bereich 1\110 S7

Asignación de la contraseña en la llamada y del usuario en el archivo de configuración

Llamada de líneas de comandos:

C:\Programas\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:D:\vdClientArchive" /password:<contraseña> /CFile:d:\AutoCheckIn.ini

Archivo de configuración AutoCheckIn.ini:

[User]

Account=<Usuario>

Domain=<Dominio>

PasswordMode=2

[Component]

Dir=\Werk 1\Halle 1\Bereich 1\110 S7

Ejemplo de aplicación: crear un nuevo componente

Archivo Batch:

@echo off

set VDTOOL=C:\Archivos de programa (x86)\vdogClient\VDogAutoCheckIn.exe

set CLIENTARCHIVE=D:\vdClientArchive

set PASSWD=********

set USERNAME=<Usuario>

set CFGFILE=CheckInTest.ini

SET mypath=%~dp0

set CFGFILE=%directorio%%archivo CFG%

echo [ * ] Inicio de check-in

"%VDTOOL%" "/AT:C" "/RD:%archivo del cliente%" "/CFile:%archivo CFG%" "/Password:%contraseña%" "/Account:%nombre de usuario%"

echo [ * ] check-in finalizado (%nivel de error%)

pause

Archivo de configuración CheckInTest.ini:

[Component]

Dir=\Test\NewComponent

[CreateComponent]

// Binario

ComponentTypeId=D565D656350A428E8B286F834C4F74BA

Ejemplo de aplicación: Configurar los datos maestros de varios componentes simultáneamente

Archivo CheckIn.bat

@echo off

set VDTOOL=C:\Archivos de programa (x86)\vdogClient\VDogAutoCheckIn.exe

set CLIENTARCHIVE=D:\vdClientArchive

set PASSWD=********

set USERNAME=versiondog

set CFGFILE=CheckInTest.ini

SET mypath=%~dp0

set CFGFILE=%directorio%%archivo CFG%

echo [ * ] Inicio de check-in

"%VDTOOL%" "/AT:C" "/RD:%archivo del cliente%" "/CFile:%archivo CFG%" "/Password:%contraseña%" "/Account:%nombre de usuario%"

echo [ * ] check-in finalizado (%nivel de error%)

pause

Archivo CheckIn.ini

[Component]

Dir=\Test\NewComponent

[CreateComponent]

// Binario

ComponentTypeId=D565D656350A428E8B286F834C4F74BA

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

Crear y configurar tareas

Además, con las líneas de comando se pueden crear o actualizar tareas.

Para ello se debe ingresar la siguiente línea de comandos:

C:\Archivos de programa (x86)\vdogClient\VDogAutoCheckIn.exe" /RD:d:\vdClientArchive /at:c /JobConfig /CFile:d:\AutoCheckIn.ini /Password:******** /Account:<Usuario>

Además de los parámetros listados, para crear tareas, deben escribir el parámetro /JobConfig.

Parámetro	Descripción
/JobConfig	Indica que se debe crear una tarea. Solo requerida si no se deben realizar cambios en la configuración de tarea y no se debe crear un componente, una versión o un check-in.

Parámetro

Descripción

/JobConfig

Indica que se debe crear una tarea.

Solo requerida si no se deben realizar cambios en la configuración de tarea y no se debe crear un componente, una versión o un check-in.

Archivo de configuración

Además de las entradas listadas, el archivo de configuración para la configuración de tareas, contiene la sección [Jobconfig] con la siguiente clave:

Clave	Descripción
JobId	Id de la tarea que debe ser configurada
TemplateJobId	Id de la tarea cuya configuración (a excepción del Id de tarea) debe ser asignada
JobName	Nombre de la tarea Si el nombre está vacío, se debe encontrar una tarea existente mediante la clave JobId o TemplateJobId. El valor predeterminado es una cadena de caracteres vacía.
UploadType	Nombre del tipo de carga Si el nombre está vacío, se debe encontrar una tarea existente mediante la clave JobId o TemplateJobId. El valor predeterminado es una cadena de caracteres vacía.
ComponentId	Id del componente Si el nombre está vacío, se debe encontrar una tarea existente mediante la clave JobId o TemplateJobId. El valor predeterminado es una cadena de caracteres vacía.
UploadAgentId	Id del agente de carga El valor predeterminado es una cadena de caracteres vacía. Para averiguar el Id del agente de carga de su sistema, existen dos posibilidades: Abra el archivo AgentStations.ini (`\vdServerArchive\VD$A\Configuration`), los ID de los agentes se encuentran bajo el prefijo U_ Haga clic en AdminClient, en el módulo Tareas, seleccione la tarea para cual fue configurado el agente y luego en la pestaña Ayuda, haga clic en el botón Copiar parámetro de tarea en memoria temporal. Pegue el contenido de la memoria temporal en un editor de textos. El Id del agente de carga se muestra bajo la clave 4959.
ComparePolicy	Muestra la estrategia de comparación. Valores disponibles: 0: no comparar 1: comparar la copia de seguridad anterior y la copia de seguridad 2: comparar la versión del servidor y la copia de seguridad 3: comparar la versión del servidor y la copia de seguridad, la copia de seguridad anterior y la copia de seguridad Valor predeterminado: 3.
Execute	Muestra cuándo debe ejecutarse la tarea. Valores disponibles: 0: la ejecución no se realiza de manera programada 1: la ejecución se realiza de manera programada 2: Para la ejecución se usa el BackupClient Valor predeterminado: 0.
RollOver	Cantidad de copias de seguridad retenidas (por sustitución) Se conservan al menos 1 copia de seguridad y 999 copias de seguridad como máximo. Valor predeterminado: 5.
RepetitionOnError	Sección para configurar si la tarea debe ejecutarse nuevamente en caso de error y cuándo debe ser ejecutada. El valor consiste de tres números separados por coma: Valor que determina si la tarea debe ejecutarse nuevamente (0 o 1) Tiempo de espera (en minutos) para ejecutar nuevamente la tarea Cantidad máxima de repeticiones Ejemplo: 1,30,2 (la tarea será ejecutada nuevamente si ocurre un error, con una espera de 30 minutos y habrá 2 intentos de ejecución de la tarea).
StartTime	Si asignó el valor 1 a la clave Execute, la ejecución de la tarea se ejecuta de manera programada y aquí puede configurar cuándo ejecutar la tarea. El valor es una cadena de caracteres que contiene los siguientes valores separados por comas: Inicio: hora de ejecución de la tarea Periodicidad de la ejecución (3: por hora, 2: por día, 1: por semana, 0: por mes) Los otros valores dependen de la periodicidad de ejecución seleccionada: Por hora Hora Minutos Ejemplo: 16:00,3,2,45: La tarea será ejecutada a partir de las 16:00 con un intervalo de 2 hs 45 min. Por día No hay otros valores. Ejemplo: 16:00,2 (la tarea será ejecutada cada día a las 16). Por semana Cantidad de semanas entre las ejecuciones Día de semana (1: Domingo, 2: Lunes, 4: Martes, 8: Miércoles, 16: Jueves, 32: Viernes, 64: Sábado) Para ejecutar la tarea en diferentes días de la semana, sume los números. Por ej. para ejecutar las tareas los días lunes y sábados (2+64) debe asignar el valor 66. Ejemplo: 16:00,1,4: La tarea será ejecutada cada 4 semanas, los días martes, a las 16 horas. 16:00,1,2,24: La tarea será ejecutada cada dos semanas, los miércoles y los jueves a las 16 horas. Por mes Periodicidad mensual de ejecución de la tarea (0: cada n. día, n. es la fecha, 1: día determinado de la semana) Si selecciona 0 como primer valor, el segundo valor determina el día del mes a ejecutar la tarea. Si selecciona 1 como primer valor, el segundo valor determinada la semana del mes y el tercer valor el día de la semana a ejecutar la tarea (0: Domingo, 1: Lunes, 2: Martes, 3: Miércoles, 4: Jueves, 5: Viernes, 6: Sábado). La tarea puede ser ejecutada unicamente en un determinado día del mes. No se pueden seleccionar varios días de la semana. Mes a ejecutar la tarea (1: Enero, 2: Febrero, 4: Marzo, 8: Abril, 16: Mayo, 32: Junio, 64: Julio, 128: Agosto, 256: Setiembre, 512: Octubre, 1024: Noviembre, 2048: Diciembre) Para ejecutar la tarea en diferentes meses, sume los números. Por ej. para ejecutar la tarea en marzo, julio y octubre (4+64+512) asigne el valor 580. Ejemplo: 16:00,0,0,5,32: La tarea será ejecutada el 5 de junio a las 16:00. 16:00,0,1,2,3,512: La tarea será ejecutada en la segunda semana de octubre, el miércoles a las 16:00 horas. El valor predeterminado es una cadena de caracteres vacía.
EmailRecipients	Lista de usuarios o de Id de grupos separados por comas que serán notificados por correo electrónico. El valor predeterminado es una línea de caracteres vacía.
<Id de parámetro como número>	Muestra el Id de parámetro El valor predeterminado es una cadena de caracteres vacía.

Si se creó una tarea, en la sección [Result], en la clave JobId, se escribirá el Id de la tarea creada.

Contenido relacionado
UserClient -> Check-in