Pasos personalizados de Workflow Manager

Este tema se aplica a ArcGIS for Desktop Standard y ArcGIS for Desktop Advanced exclusivamente.

La extensión ArcGIS Workflow Manager for Desktop proporciona varios pasos personalizados. El código de origen de cada uno de estos se proporciona como parte del kit del desarrollador. La siguiente tabla describe los pasos del proceso y qué pueden hacer.

Biblioteca de pasos

La biblioteca de pasos contiene pasos que se pueden ejecutar en los entornos del escritorio y del servidor. Los pasos y sus argumentos y códigos de devolución se describen a continuación.

1. Revisar el AOI:
   JTXSteps.CheckAOI

   Revisa si existe un Área de interés (AOI) para el trabajo actual.

   Códigos de devolución:
   • 1 = si el trabajo tiene un AOI
   • 2 = si el trabajo no tiene un AOI
2. CleanUp:
   JTXSteps.CleanUp

   Limpia el trabajo, basándose en los argumentos.

   Habilite Administración - Configuración del sistema para permitir que los usuarios eliminen versiones propiedad de otros usuarios. Se le pedirá un nombre de usuario y una contraseña.

   Nota:

   Cuando elimine una versión propiedad de otro usuario, deberá especificar las credenciales de usuario de SDE.

   Version Cleanup:
   
   	/version|v (optional)
   MXD Cleanup:
   	/mxd|m (optional)
   Attachment Cleanup:
   	/attachments|a (optional)
   

   Códigos de devolución:
   • 0 = Correcto
3. CloseJob:
   JTXSteps.CloseJob

   Cierra un trabajo como un paso, a diferencia de ser un proceso manual una vez que se completa el flujo de trabajo.

   No Argument
   

   Códigos de devolución:
   • 0 = Correcto
4. CreateJob:
   JTXSteps.CreateJob

   Crea un trabajo secundario, basándose en los argumentos.

   Job Type ID:
   	/jobtypeid:<job type id> (required)Assign to Group:
   	/assigngroup:<group to assign to> (optional)Assign to User:
   	/assignuser:<user to assign to> (optional)
   

   Códigos de devolución:
   • 0 = Correcto
5. CreatePDF
   JTXSteps.CreatePDF

   Crea un documento en PDF del mapa base del trabajo y lo adjunta al trabajo.

   Initial Directory:
   	/initdir:<initial directory> (optional)
   Do not Attach File To Job:
   	/noattach (optional)
   Resolution (dpi):
   	/resolution:<dpi> (optional)
   Attach File To Job:
   	/attach (deprecated)
   

   Códigos de devolución:
   • 0 = Correcto
6. CreateVersion
   JTXSteps.CreateVersion

   Crea la versión del trabajo. El nivel de protección de la versión lo especifica uno de los siguientes argumentos: Version Access Scope:

   /scope
   

   Códigos de devolución:
   • 0 = Correcto
7. ExecuteGPTool
   JTXSteps.ExecuteGPTool

   Ejecuta una herramienta GP sin mostrar el cuadro de diálogo GP.

   Toolbox Path (explicit full path to the tbx file combined with toolbox name):
   		/toolboxpath:<toolboxpath> (required)
   Display Name of the Tool in the toolbox:
   	/tool:<tool> (required)
   Parameter to override on the tool (can be specified multiple times):
   /param:<ParamName>:<ParamValue> (optional)
   Flag to attach the log to the job once the tool has completed:
   /attach:(optional)
   

   Códigos de devolución:
   • 0 = Correcto
   • 1 = Error
8. Ejecutar SQL
   JTXSteps.ExecuteSQL

   Ejecuta una declaración de SQL.

   Database to Send SQL:
   	/database:<jtxsystem|data> (required)SQL Command:
   	/sql:<sql command>
   

   Códigos de devolución:
   • 0 = Correcto
9. ExecuteURL
   JTXSteps.ExecuteURL

   Ejecuta una dirección URL sin mostrar un navegador para mostrar la respuesta.

   Por ejemplo, puede ejecutar un servicio de geoprocesamiento o cualquier otro servicio Web como un paso del flujo de trabajo.

   URL to execute:
   	/url:<url> (required)
   Request Timeout:
   	/timeout:<timeout in seconds> (optional)
   Proxy Server: 
    /proxy:<proxy> (optional)
   Flag to add a comment to the job with the response:
    /addjobcomment(optional)
   Post Data:
    /postdata:<data to post> (optional)
   

10. Ejecutar flujo de trabajo
    JTXSteps.ExecuteWorkflow

    Ejecuta otro flujo de trabajo asociado con un tipo de trabajo.

    Job Type Name:
    	/jobtype:<job type name> (required)Flag to not use AOI:
    	/donotuseaoi (optional)Flag to not use version:
    	/donotuseversion (optional)Flag to not copy activities to the parent job's history:
     /donotcopyactivities (optional)
    

    Códigos de devolución:
    • 0 = Correcto
11. ReturnValue
    JTXSteps.ReturnValue

    Recupera el valor de la propiedad extendida o token aprobado que es el código de devolución de la siguiente ruta en el flujo de trabajo.

    Return value:
    	/value:<Extended properties field> (required):
    

12. ReassignJob
    JTXSeteps.ReassignJob

    Reasigna el trabajo.

    Assign Type:
    	/assignType:<user|group> (required)
    Assign To:
    	/assignTo:<user or group name> (required)
    

    Códigos de devolución:
    • 0 = Correcto
13. SendNotification
    JTXSteps.SendNotification

    Envía una notificación del tipo especificado por los primeros argumentos; tipo de notificación.

    /notifType:<type> (required)
    

    Códigos de devolución:
    • 0 = Correcto
14. SetVersion
    JTXSteps.SetVersion

    Configurar la versión de la tarea a una versión denominada, por ejemplo, versión QC para validar las ediciones que se publican y una versión QC. Si no hay ningún argumento de paso, la versión del trabajo se restablecerá a la versión original.

    Version to use as job version: 
    /version:<versionName> (optional)
    

    Códigos de devolución:
    • 0 = Correcto
15. UpdateExtentFeatureClass
    JTXSteps.UpdateExtentFeatureClass

    Actualiza una clase de entidad con la información de trabajo para proporcionar el estado visual.

    Feature Class to Update (must be in data geodatabase):
    	/fclass:<fully qualified feature class name> (required)
    Job ID Field (field to put job ID in):
    	/jobfield:<field name> (optional)
    Date Field (field to put date/time):
    	/datefield:<field name> (optional)
    

    Códigos de devolución:
    • 0 = Correcto
16. VersionExists
    JTXSteps.VersionExists

    Revisa si el trabajo ya tiene una versión de geodatabase.

    No Argument
    

    Códigos de devolución:
    • 1 = Existe la versión
    • 2 = No existe la versión
    • 3 = No está seleccionado ningún espacio de trabajo de datos

Biblioteca DesktopSteps

La biblioteca DesktopSteps contiene pasos que se pueden ejecutar solo desde el escritorio debido a las interfaces del usuario emergentes. Los pasos y sus argumentos y códigos de devolución se describen a continuación.

1. CopyFile
   JTXDesktopSteps.CopyFile

   Copia un archivo desde una ubicación a otra.

   Source File:
   	/src:<source file path> (optional)
   Destination File:
   	/dest:<destination file path> (optional)
   File Title:
   	/title:<file title> (optional)
   

   Códigos de devolución:
   • 0 = Correcto
2. CreatJobAdvanced
   JTXDesktopSteps.CreateJobAdvanced

   Crea un trabajo y le permite definir la relación principal/secundaria con las dependencias en el trabajo.

   Job Type Name:
   	/jobtypename:<job type name>(required)
   Assign To Group:
   	/assigngroup:<group to assign to>(optional)
   Assign To User:
   	/assignuser:<username to assign to> (optional)
   Dependency will be created and current job held at this step:
   	/dependThisStep (optional)
   Dependency will be created and current job held at the next step in the workflow:
   	/dependNextStep (optional)
   Dependency status (current job held until new job reaches this status):
   	/dependStatus:<Status Type Name> (optional)
   Use the current job's AOI as the new job's AOI:
   	/useparentaoi (optional)
   Create new jobs based on the overlap between the current job's AOI and this feature class:
   	/aoiOverlapFeatureClassName:<fully qualified feature class name >(optional)
   Default number of jobs to create:
   	/numberJobs:<number of jobs to create> (optional)
   A version will be created for the new job(s) based on this selection:
   	/createVersionSetting:<the version to use as the parent version> (optional)
   A version will be assigned to the new job(s) based on this selection:
   	/assignVersionSetting:<the existing version the job will be assigned to>(optional)
   New job(s) extended properties value will be set to: 
   one of the current job's extended properties values (specified by JTX Token) or to the given string value:
   	/setExtendedProps: 
   <ChildJobFullyQualifiedExtendedPropertiesTableName.FieldName=
   [JOBEX:ParentJobFullyQualifiedExtendedPropertiesTableName.FieldName]> (optional)
   Due date of the new job:
   	/dueDate:<due date of the new job>(optional)
   Job duration:
   	/jobDuration:<duration of the new job >(optional)
   New Job will be created as a child of the existing job:
   	/child:(optional)
   

   Códigos de devolución:
   • 0 = Correcto
   • 1 = Error
3. DefineAOI
   JTXDesktopSteps.DefineAOI

   Muestra una herramienta para permitir al usuario definir un área de interés.

   No Argument
   

   Códigos de devolución:
   • 1 = Correcto
   • 0 = Error
4. EditExtendedProperties
   JTXDesktopSteps.EditExtendedProperties

   Muestre las propiedades extendidas del trabajo en forma de menú emergente para que el usuario pueda especificar las propiedades necesarias.

   No Argument
   

5. LaunchArcMap
   JTXDesktopSteps.LaunchArcMap

   Cuando se ejecuta, iniciará ArcMap. Las capas se asignarán a la versión de trabajo y el mapa se acercará al AOI de trabajo y haga clic en el botón Agregar datos para que el usuario permita agregar datos adicionales al mapa. Consulte la sección que se muestra a continuación para obtener detalles relacionados con los argumentos de este paso.

   Códigos de devolución:
   • 0 = Correcto
6. LaunchGPTool
   JTXDesktopSteps.LaunchGPTool

   Ejecuta las herramienta de geoprocesamiento desde dentro de sus flujos de trabajo.

   Toolbox Path (explicit path to the tbx file):
   	/toolboxpath:<toolboxpath> (optional)
   Toolbox Name (if in system toolboxes):
   	/toolbox:<toolbox> (optional)
   Display Name of the Tool in the toolbox:
   	/tool:<tool> 
   Parameter to override on the tool (can be specified multiple times):
   	/param:<ParamName>:<ParamValue> (optional)
   Flag to attach the log to the job once the tool has completed:
   	/attach (optional)
   License enumeration code for any additional license that should be used in the execution of the tool:
   	/license:<enum value> (optional)
   

   Códigos de devolución:
   • 1 = Correcto
7. SelectDataWorkspace
   JTXDesktopSteps.SelectDataWorkspace

   Muestra un formulario que permite seleccionar el espacio de trabajo de datos para su trabajo desde una lista de espacio de trabajo de datos ya configurada.

   No Argument
   

   Códigos de devolución:
   • 0 = Correcto

Paso Iniciar ArcMap

El comportamiento esperado del paso Iniciar ArcMap sin argumentos se detalla en la siguiente tabla.

¿Está definido el documento de mapa de tipo de trabajo?	Iniciar ArcMap con espacio de trabajo de datos y con versión	Iniciar ArcMap con espacio de trabajo de datos y sin versión	Iniciar ArcMap sin espacio de trabajo de datos
Sí	ArcMap se inicia con el documento de mapa definido. Las capas son asignadas a la versión de trabajo basada en el nombre corto de la clase de entidad. * El mapa se acerca al área de interés.	Esto funciona igual que el escenario cuando existe una versión, excepto la versión predeterminada del espacio de trabajo de datos se usa para la asignación de capas.	No hay cambios realizados a las fuentes de capas. El mapa se acerca al AOI.
No	Abra ArcMap con un documento en blanco. En este caso, ya que no existe ningún mapa, no hay capas que asignar. Una vez que se agregan las capas al mapa, el botón Agregar datos en la barra de herramientas de Workflow Manager dirigirá al usuario directamente a la versión definida para el trabajo o la versión predeterminada del Espacio de trabajo de datos seleccionado.	Esto funciona igual que el escenario cuando existe una versión.	Abra ArcMap con un documento en blanco. El botón Agregar datos en la barra de herramientas de Workflow Manager está deshabilitado. Si existe un AOI para el trabajo, la herramienta Zoom al AOI se puede utilizar.

Esto proporciona una descripción del comportamiento esperado para el paso Iniciar ArcMap proporcionado con Workflow Manager.

*El nombre abreviado es el nombre de clase de entidad en su versión reducida (por ejemplo Streets en lugar de NIS.Streets). También observe que no importa cómo se definió originalmente el mapa base, cualquier coincidencia de nombre corto se debe asignar.

Nota:

El JTXMxLaunch.exe ejecutable para iniciar ArcMap ya no se incluye con la instalación de Workflow Manager. Actualice cualquier paso que está utilizando esa utilidad para iniciar ArcMap para utilizar el objeto de paso personalizado JTXDesktopSteps.LaunchArcMap.

Descripciones del argumento

El paso Iniciar ArcMap tiene muchos parámetros opcionales disponibles, que le permiten personalizar su ejecución para sus necesidades sin el código de escritura.

Nombre descriptivo	Ejemplo del argumento	Comportamiento
Zoom al AOI	/aoifactor:3 o bien, /nozoomaoi	Con el comportamiento predeterminado, el mapa se desplazará al AOI del trabajo y se acercará por un factor de 1 a la geometría de formas. De manera opcional, puede elegir no desplazar o acercar el mapa con la opción /nozoomaoi. O puede acercarse al AOI con un factor de zoom más grande con el argumento /aoifactor:
Reasignar MXD	/norepoint	El comportamiento predeterminado, cuando no se utiliza /norepoint, cambia todas las capas del mapa al espacio de trabajo de datos actual y, de manera opcional, la versión del trabajo.
Cambiar solo las versiones MXD	/changeversiononly	Si decide utilizar la opción /changeversiononly, cambiará la versión de las capas del documento de mapa del tipo de trabajo. La información de conexión y de usuario de los datos se dejará tal como se configuró originalmente.
Conservar las versiones de capa del mapa base	/nochangebasemaplayerversion	El comportamiento predeterminado, cuando no se utiliza el argumento /nochangebasemaplayerversion, conserva la información de conexión de las capas en una capa de mapa base. Por ejemplo, puede agregar capas desde una base de datos que desea utilizar como capas de referencia en su mapa. De manera predeterminada cuando se ejecuta el paso iniciar ArcMap, estas capas se reasignarán a la versión del trabajo actual. Al revisar este argumento, éste no reasignará el origen de datos de las capas en este grupo. Dado que las capas de mapa base son relativamente estáticas y no cambian con frecuencia, su visualización se puede calcular una vez y volver a utilizarla otras veces. Consulte Trabajar con capas de mapas base para obtener más información.
Guardar MXD	/nosavemxd	El comportamiento predeterminado, cuando no se utiliza el argumento /nosavemxd, guardará el documento de mapa del trabajo en la base de datos de Workflow Manager. Si sus documentos de mapa son grandes, es posible que necesite ajustar la configuración MAXBLOBSIZE SDE. Si decide utilizar la opción /nosavemxd, entonces el documento de mapa del trabajo no se guardará. Esta opción también le permite cambiar trabajos en ArcMap sin borrar el documento de mapa.
Recortar el marco de datos al AOI	/cliptoaoi	El comportamiento predeterminado, cuando no se utiliza el argumento /cliptoaoi, mostrará todos los datos en el documento de mapa que se puede visualizar. Cuando se utiliza la opción /cliptoaoi, el marco de datos en el documento de mapa del trabajo se cortará según la forma del AOI. Nota: Esto no crea una consulta de definición en las capas. Todas las entidades en las capas en el mapa aún son accesibles a través de sus respectivas tablas.
Espere que se cierre ArcMap (suspenda Workflow Manager)	/nowait	El comportamiento predeterminado de la aplicación de Workflow Manager, cuando no se utiliza el argumento /nowait, es ocultarse mientras ArcMap se está ejecutando. Esto significa que el usuario no puede interactuar con la aplicación de Workflow Manager mientras está trabajando en ArcMap. Cuando se utiliza la opción /nowait, ArcMap se iniciará en un proceso separado, permitiéndole al usuario interactuar con la aplicación de Workflow Manager mientras ArcMap se está ejecutando.*
Utilice la sesión de ArcMap existente	/useexisting	El comportamiento predeterminado, cuando no se utiliza el argumento /useexisting, es abrir una nueva sesión de ArcMap durante la ejecución del paso. Con la opción /useexisting, si se abre una sesión de ArcMap cuando se ejecuta el paso, Workflow Manager abrirá el documento de mapa del trabajo en esa sesión existente. Si no existe una sesión de ArcMap abierta, entonces Workflow Manager abrirá una nueva.
Almacenar MXD en una ubicación compartida	/mxdfolder:"D:\Data\JTXMapDocuments"	Con el comportamiento predeterminado, no está configurada ninguna ubicación, y los documentos de mapa del trabajo se almacenarán en la base de datos de Workflow Manager. Si sus documentos de mapa son grandes, es posible que necesite ajustar la configuración MAXBLOBSIZE SDE. Si decide almacenar los documentos de mapa en una ubicación alternativa, Workflow Manager no guardará los documentos de mapa en la base de datos, pero los guardará en esa ubicación para su uso en el futuro.
Uso de MXD alternativo	/mxd:"D:\Data\JTXTemplates\Editing.mxd"	Con el comportamiento predeterminado, el paso utilizará el documento de mapa predeterminado del tipo de trabajo como el documento de mapa base que se utilizará al iniciar ArcMap. Si decide utilizar esta opción, Workflow Manager cargará el documento de mapa o la plantilla configurada para el argumento.
Comando Ejecutar ArcMap	/guid:esriArcMapUI.AddDataCommand	Una vez que ArcMap haya terminado de cargar, el botón representado por el ProgID introducido se presionará de acuerdo a un esquema.
Cargar el flujo de trabajo del Asistente de tareas	/taworkflow:"LotSplit"	Con este argumento configurado, una vez que se abre ArcMap, Workflow Manager abrirá el flujo de trabajo del Administrador del asistente de tareas configurado. El nombre del flujo de trabajo aprobado es el alias del flujo de trabajo del TAM almacenado en el sistema de Workflow Manager. Se pueden pasar varios flujos de trabajo agregando entradas /taworkflow: adicionales o seleccionando flujos de trabajo específicos en el editor de argumentos.
Almacenar un Historial del asistente de tareas en el Historial de trabajo	/storetahistory	Con este argumento configurado, el flujo de trabajo del Administrador del asistente de tareas se agregará al historial de trabajo de manera predeterminada. Aún puede decidir adjuntar esto como un archivo de texto con las herramientas de Workflow Manager.

*Esta opción se agregó ya que la opción asíncrona del proceso de Inicio de los pasos del flujo de trabajo no está disponible para los Objetos del paso personalizado.