Secciones generales del archivo de interfaz¶
Archivo de interfaz¶
Cuando se produce un evento para el que existe una interfaz de script, se crea un archivo de interfaz. El archivo de interfaz es un archivo de inicialización que proporciona a las aplicaciones de secuencias de comandos e información sobre el componente, su estado y sobre el usuario que activó el evento. Está disponible en el formato de archivo INI y está codificado en UTF-16.
A continuación se enumeran las secciones y claves generales del archivo de interfaz. Las secciones y claves que sólo están disponibles en los archivos de interfaz de eventos individuales se pueden encontrar en las descripciones de los eventos.
[Common]¶
| Clave | I/O | Descripción |
|---|---|---|
| RootDirAdmin | I | Ruta completa del directorio con los archivos de administración de octoplant. Esta clave no se especifica para los eventos BeforeUpload y AfterUpload. |
| DirPrjData | I | Ruta completa del directorio que contiene los archivos del proyecto. Esta clave no se especifica para los eventos BeforeUpload y AfterUpload. |
| Language | I | ID del idioma que se establece en octoplant (por ejemplo, en o, más concretamente, en-gb, en-us, de-de, fr-fr, etc.) |
| ComputerName | I | Nombre del equipo en el que se ejecutan las aplicaciones de scripting Formato: [Dominio].NombreDelEquipo Para los eventos del lado del cliente, se especifica el nombre del cliente. Para los eventos del lado del servidor, se especifica el nombre del servidor. |
| DirTemp | I | Ruta completa del directorio en el que las aplicaciones de scripting almacenan los datos temporales. Cada aplicación de scripting debe eliminar los datos temporales de forma independiente. Todas las aplicaciones de scripting comparten un directorio para los datos temporales. Por lo tanto, debe ser posible asignar claramente subdirectorios y archivos para garantizar que las aplicaciones de scripting sólo eliminen sus propios datos temporales. |
| PathLog | I | Ruta completa del directorio en el que se almacena la información registrada. Algunas aplicaciones de script ponen esta información a disposición de todo el sistema. Cada aplicación de script debe eliminar estos datos de forma independiente. |
| TimeOutInMin | I | Tiempo de espera en minutos. Si se supera el valor establecido aquí, la aplicación de script se cierra inmediatamente y sin notificación. |
| Licencia | I | Información sobre las funciones contenidas en la licencia |
| PathExeVdog | I | Ruta completa de la aplicación que llamó a las aplicaciones de script (por ejemplo, C:\Archivos de programa\vdog\VDogClient.exe o la ruta de la aplicación del servidor) |
| SilentMode | I | Indica si la aplicación de scripting puede solicitar información al usuario (por ejemplo, a través de mensajes) Y: No se puede solicitar información. N: Se pueden solicitar entradas. Esto no significa que la aplicación de scripting solicite la entrada de datos. El valor por defecto es Y para aplicaciones de script del lado del servidor y N para aplicaciones de script del lado del cliente. |
[Component]¶
Algunas aplicaciones de script no son compatibles con esta sección.
| Clave | I/O | Descripción |
|---|---|---|
| Dir | I | Ruta relativa del directorio del componente. La ruta comienza con una barra invertida. No hay barra invertida al final de la ruta. |
| ID | I | ID del componente |
| ComponentTypeId | I | ID del tipo de componente |
| MasterData1 | I | Contenido del primer campo de datos maestros |
| MasterData2 | I | Contenido del segundo campo de datos maestros |
| MasterData3 | I | Contenido del tercer campo de datos maestros |
| MasterData4 | I | Contenido del cuarto campo de datos maestros |
| MasterData5 | I | Contenido del quinto campo de datos maestros |
| MasterData6 | I | Contenido del sexto campo de datos maestros |
| MasterData7 | I | Contenido del séptimo campo de datos maestros |
| MasterData8 | I | Contenido del octavo campo de datos maestros |
| MasterData9 | I | Contenido del noveno campo de datos maestros |
| MasterData10 | I | Contenido del décimo campo de datos maestros |
[User]¶
Algunas aplicaciones de script no son compatibles con esta sección.
| Clave | I/O | Descripción | Valores |
|---|---|---|---|
| ID | I | Id de usuario | Una cadena de 32 caracteres |
| Nombre | I | User name | |
| FullName | I | Nombre de usuario completo. La clave sólo se especifica si el nombre está definido en el módulo Administración de usuarios. | |
| Domain | I | Dominio en el que el usuario ha iniciado sesión. | |
| LocalLogon | I | Muestra si el usuario está conectado localmente o en el servidor. | Y: El usuario está conectado localmente. N: El usuario ha iniciado sesión en el servidor. |
| Admin | I | Muestra si el usuario pertenece al grupo de administradores. | Y: El usuario forma parte del grupo de administradores. N: El usuario no forma parte del grupo de administradores. |
| Groups | I | ID de los grupos a los que pertenece el usuario. | cadenas de 32 caracteres, separadas por comas |
[Version]¶
Algunas aplicaciones de scripting no son compatibles con esta sección. En algunas aplicaciones de scripting, esta sección recibe un nombre diferente.
| Clave | I/O | Descripción |
|---|---|---|
| Hversión | I | Número de versión |
| HversionUserDefined | I | Número de versión definido por el usuario |
| TimeStampUtc | I | Hora de versionado en formato UTC (AAAAMMDDHHHMMSS) |
| TimeStampLocal | I | Hora de la versión en formato de hora local (AAAAMMDDHHHMMSS) |
| Comentario | I | Comentario sobre esta versión. Los saltos de línea (LF, CR, CRLF) se convierten en <br>. |
| ChangeReason | I | Motivo del cambio para esta versión Los saltos de línea (LF, CR, CRLF) se convierten en <br>. |
| UserId | I | ID del usuario que creó la versión como cadena de 32 caracteres. |
| UserName | I | Nombre del usuario que creó la versión. |
| UserFullName | I | Nombre completo del usuario que ha creado la versión. La clave sólo se especifica si el nombre se establece en el módulo Administración de usuarios. |
| UserDomainName | I | Dominio en el que el usuario ha iniciado sesión. |
| ComputerName | I | Nombre del equipo en el que se creó la versión. |
| DnameStorage | I | Nombre del subdirectorio en el que se almacena el archivo de la versión, en el formato AAAAMMDD.{NNN}. |
| State | I | Estado de bloqueo de la versión/archivo |
[QuickSave]¶
Esta sección sólo está disponible si se ha restaurado un Quicksave del componente.
| Clave | I/O | Descripción | Valores |
|---|---|---|---|
| Enabled | I | Indica si el guardado rápido está activado para este componente. | Y: Guardados rápidos activados. N: Guardados rápidos desactivados. Si no se especifica ningún valor para esta clave, el sistema asume N como valor. |
| Dir | I | Ruta relativa del directorio del componente, que comienza con una barra invertida. No hay barra invertida al final de la ruta. Esta clave sólo se especifica si la clave habilitada tiene el valor Y. | |
| ID | I | ID del componente Esta clave sólo se especifica si la clave Enabled tiene el valor Y. |
[ExclusiveUse]¶
| Clave | I/O | Descripción |
|---|---|---|
| UserID | I | ID del usuario que ha bloqueado el componente para otros usuarios, como cadena de 32 caracteres. Si no se especifica ningún valor o se especifica el valor cero, el componente no está bloqueado. |
| UserName | I | Nombre del usuario que ha bloqueado el componente para otros usuarios. |
| UserFullName | I | Nombre completo del usuario que ha bloqueado el componente para otros usuarios. La clave solo se especifica si el nombre está definido en el módulo Administración de usuarios. |
| DomainName | I | Dominio en el que el usuario ha iniciado sesión. |
| ComputerName | I | Nombre del equipo desde el que se bloqueó el componente para otros usuarios |
| TimeStampUtc | I | Hora a la que el componente pasó a este estado, en formato UTC (AAAAMMDDHHMMSS) |
| TimeStampLocal | I | Hora a la que el componente pasó a este estado, en formato de hora local (AAAAMMDDHHMMSS). |
[UnderDevelopment]¶
| Clave | I/O | Descripción |
|---|---|---|
| UserId | I | ID del usuario que marcó el componente como En desarrollo, como cadena con 32 caracteres. Si no se introduce ningún valor o se introduce el valor cero, el componente no se marca como En desarrollo. |
| UserName | I | Nombre del usuario que marcó el componente como En desarrollo |
| UserFullName | I | Nombre completo del usuario que ha marcado el componente como En desarrollo. La clave sólo se especifica si el nombre está definido en Administración de usuarios. |
| DomainName | I | Dominio en el que el usuario ha iniciado sesión. |
| ComputerName | I | Nombre del equipo desde el que se marcó el componente como En desarrollo |
| TimeStampUtc | I | Hora a la que el componente pasó a este estado, en formato UTC (AAAAMMDDHHMMSS) |
| TimeStampLocal | I | Hora a la que el componente pasó a este estado, en formato de hora local (AAAAMMDDHHMMSS). |
[ClientInformation]¶
| Clave | I/O | Descripción |
|---|---|---|
| ComputerName | I | Nombre del equipo y, si aplica, el dominio asociado del equipo desde el que se ejecutó el check-in o el check-out. |
| IpAddress | I | Dirección IP del equipo desde el que se ejecutó el check-out o el check-in. |
[Result]¶
| Clave | I/O | Descripción |
|---|---|---|
| ErrorText | O | Indica si la aplicación de script ha finalizado con un error y se ha emitido un mensaje de error. Los mensajes bloquean los programas hasta que han sido reconocidos. Por lo tanto, no deben utilizarse para aplicaciones de script del lado del servidor. Si se especifica el valor <na>, no se escribe ningún mensaje de error. |
| Advertencias | O | Muestra si la aplicación de script ha finalizado con una advertencia. |