User Guide. Geocortex Workflow Designer 3.7

Transcription

1 User Guide Geocortex Workflow Designer 3.7

2 Copyright 2012 Latitude Geographics Group Ltd. All Rights Reserved. Printed in Canada The information contained in this document is the exclusive property of Latitude Geographics Group Ltd. This work is protected under Canadian and US copyright law and copyright laws of the given countries of origin and applicable international laws, treaties, and/or conventions. No part of this work may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying or recording, or by any information storage or retrieval system, except as expressly permitted in writing by Latitude Geographics Group Ltd. All requests should be sent to Attention: Contracts Manager, Latitude Geographics Group Ltd, Wharf Street, Victoria, British Columbia V8W 1T7. This information is subject to change without notice. US Government Restricted Rights The Software and documentation are provided with restricted rights. Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause at DFARS , or subparagraphs (c)(1) and (2) of the Commercial Computer Software - Restricted Rights at 48 CFR , as applicable. The Contractor/Manufacturer is Latitude Geographics Group Ltd., Wharf Street Victoria, British Columbia V8W 1T7. Latitude Geographics, Geocortex Internet Mapping, and the Product are trademarks of Latitude Geographics Group Ltd. Geocortex is a registered trademark of Latitude Geographics in Canada and the United States. Latitude Geographics is a registered trademark in Canada and the United States. Esri, ArcIMS and the Esri globe logo are trademarks of Environmental Systems Research Institute. Microsoft and the Windows logo are registered trademarks and the Microsoft Internet Explorer logo is a trademark of Microsoft Corporation. Other companies and products mentioned herein are trademarks or registered trademarks of their respective trademark owners.

3 Contents About Geocortex Workflow Designer 1 Welcome 1 This Document 1 What is a Workflow? 1 Geocortex Workflow Designer 1 Simulation and Testing 2 About Geocortex Workflows 2 Deployment of a Workflow 3 Workflow Designer Interface 3 Architecture 4 Xaml 5 Workflow Controllers 5 Extensions to Microsoft Workflow Foundation 5 Key Concepts 6 Activities 6 Activity Toolbox and Categories 6 Variables 7 Variable Types 8 Scope 8 Variables Tab 8 Arguments 9 Workflow Arguments 9 Activity Arguments 9 Expressions 10 Expressions and Visual Basic 10 Compiler Errors 10 Queries 12 Typical Queries 12 Create Workflows 14 About Workflow Features 14 Create a New Workflow 14 Validation Errors 15 Navigate Around a Workflow 16 Import a space 17 Export the Workflow Image 17 Save a Workflow 18 Publish a Workflow 19 Configure a Workflow in the Viewer 23 Workflow Container Configuration 27 Set up 27 Examples of Workflow Containers 28 i

4 Geocortex Workflow Designer 3.7 User Guide Use Activities 30 Add, Move, Remove Activities 30 Add an Activity 30 Move an Activity 30 Remove an Activity 31 About Activity Properties 31 Find the Data Type of an Activity Property 31 Required Properties 32 Configure Activity Properties 32 Use Variables 33 Scope 33 Create a Variable 33 Delete a Variable 35 Select Data Types 35 Activity Library 37 Control Flow Activities 37 Do While Activity 37 For Each <T> Activity 37 If Activity 38 Parallel Activity 39 Parallel For Each <T> Activity 40 Pick Activity 41 Pick Branch Activity 41 Sequence Activity 42 Switch <T> Activity 43 While Activity 43 Flow Chart Activities 44 Flowchart Activity 44 Flow Decision Activity 45 Flow Switch <T> Activity 46 Common Client Activities 46 Alert Activity 46 Capture Geometry Activity 47 Confirm Activity 48 Display Form Activity 49 Display Hyperlink Activity 50 Dynamic External Activity 51 External Delay Activity 52 Get Map Extent Activity (New!) 52 Get Map Service Info Activity (New!) 53 Prompt Activity 54 Refresh Map Activity 54 Report Activity 55 ii 2011 Latitude Geographics Group Ltd. All Rights Reserved.

5 Set Layer Definition Activity (New!) 57 Set Layer Visibility Activity (New!) 58 Set Map Extent Activity (New!) 58 Set Map Service Visibility Activity (New!) 59 Common Server Activities 60 Assign Activity 60 Delay Activity 60 Cast <T> Activity (New!) 61 Download String Activity (New!) 61 Get Current User Activity (New!) 62 Include Workflow Activity 63 Invoke Method Activity 63 Send Mail Activity 65 Sort FeatureSet Activity 66 Template Report Activity 66 Web Request Activity (New!) 68 Common Viewer Activities 69 Collect External Event Args Activity 69 Configure Workflow Container Activity 70 Display Capture Geometry Activity 71 Listen For External Event Activity 72 Run External Command Activity 73 Select Features Activity 73 ArcGIS Server Activities 74 Buffer Task Activity 74 Difference Task Activity (New!) 75 Generate Token Activity (New!) 76 Geocode Activity 77 Geoprocessor Activity 78 Intersect Task Activity (New!) 79 Project Task Activity 80 Query Task Activity 81 Relationship Query Task Activity (New!) 83 Reverse Geocode Activity 84 Route Task Activity 86 Simplify Task Activity 87 Union Task Activity 87 ArcGIS Server Attachments Activities 88 Add Attachment Activity (New!) 88 Delete Attachment Activity (New!) 89 Query Attachment Infos (New!) 90 Geometry Activities 91 Get FeatureSet Extent Activity 91 Get Geometries Activity 92 iii

6 Geocortex Workflow Designer 3.7 User Guide Collections Activities 93 Add To Collection <T> Activity 93 Clear Collection <T> Activity 94 Exists In Collection <T> Activity 94 Remove From Collection <T> Activity 95 Error Handling Activities 96 Rethrow Activity 96 Terminate Workflow Activity 96 Throw Activity 97 Try Catch Activity 98 Debugging Activities 99 Log Activity 99 Write Line Activity 99 Modeling Activities 100 Client Placeholder Activity 100 Server Placeholder Activity 101 Transfer From Client <T> Activity 101 Transfer To Client <T> Activity 102 Conversion Activities 103 Object To DataItem Activity 103 List To Data Item List Activity 103 Obsolete Activities 104 ArcGIS -> Geocortex Geometry Activity (Obsolete) 104 Buffer Geometry Activity (Obsolete) 104 Geocortex Geometry -> ArcGIS Activity (Obsolete) 105 Merge Geometries Activity (Obsolete) 105 Create Forms 106 About Forms 106 Searches in a Form 107 Form Designer Interface 107 Form Items 108 Use the Workflow Simulator 112 About the Workflow Simulator 112 Testing Workflows 112 The Simulator Interface 112 Open the Simulator 113 Start and Stop a Workflow Simulation 113 Run a Simulation 114 Exit the Simulator 118 Configure the Log Activity 118 Logging Menu 118 References 119 Table of Workflow Activities 119 iv 2011 Latitude Geographics Group Ltd. All Rights Reserved.

7 Argument Types 126 Glossary 130 v

8 About Geocortex Workflow Designer About Geocortex Workflow Designer Welcome Welcome to the Geocortex Workflow Designer Guide. The Geocortex Workflow Designer is used to create and test workflows. This Document This Guide describes how to use the Workflow Designer to create workflows. The implementation of workflows includes the following steps: 1. Plan and define the steps of the process that you want to model. 2. Create the workflow in Geocortex Workflow Designer. 3. Publish the workflow to the Geocortex Essentials REST API by configuring the workflow in a site and deploying the site. 4. Consume the workflow in your viewer. For more information on workflow design, see Microsoft's A Developer's Introduction to Windows Workflow Foundation (WF) in.net 4. What is a Workflow? A workflow is the automation of a business process, in whole or part, during which documents, information, or tasks are passed from one resource (machine or human) to another for action, according to a set of procedural rules. Using workflows to automate processes can improve efficiency by standardizing and streamlining the processes. Workflows can also provide audit trails that offer greater accountability and consistency. Geocortex Workflow Designer In Geocortex Essentials, a workflow offers a relatively simple way to automate a sequence of activities. Workflows can be very simple, or extremely complex. You create workflows in the Geocortex Workflow Designer, where you group activities into a logical sequence. Because workflows are represented as an image that you build by adding activities, it is possible to plan and visualize the workflow as it will happen. Each activity has properties that you set and that govern how that activity behaves and how it relates to other activities. You pass information (values) from one activity to the next using variables, arguments, and expressions. Geocortex Workflow Designer displays your workflow in a visual representation within a design area. The Workflow Designer contains a library of activities that you drag-and-drop into the design area. A simulator then allows you to simulate your workflow as you are designing it, providing inputs and inspecting outputs without having to deploy a host application. The Workflow Designer ships with several sample workflows to help you get started. Geocortex Workflow modularizes common activities that occur between the client and server, providing a quick and easy way to program complex, interactive, GIS and business processes. Workflow Designer's drag-and-drop interface, library of activities, and built-in simulator accelerate development and free you from handling low-level details like serialization. 1

9 Geocortex Workflow Designer 3.7 User Guide The Workflow Designer ships with several sample workflows. In a standard installation of Geocortex Essentials, the sample workflows are installed in the following folder: C:\Program Files (x86)\latitude Geographics\Geocortex Essentials\Default\REST Elements\Sites\Resources\Workflows Simulation and Testing The Workflow Designer also provides a simulator for testing workflows. The built-in simulator enables you to run workflows in a simulated environment. Simulation saves you from having to deploy your workflow to the REST API, which reduces the time and effort it takes to test your workflows. However, if you are using the Geocortex Viewer for Silverlight and have published the workflow and configured it in the Viewer, you can make changes to your workflow in the Workflow Designer and when you save, the changes are immediately visible in the Viewer for testing. About Geocortex Workflows At its simplest, a workflow is a sequence of activities. However, there are several factors that affect the power of a workflow. A simple workflow takes several inputs, performs an operation on the inputs, from which it produces the output. Many GIS workflows fit this pattern. The set of inputs is fed in at the beginning of the workflow, the GIS operations are performed, and the outputs are available at the very end. The Geocortex Essentials workflows go well beyond this simple model. Geocortex workflows: Include business processes: Workflows can be made up of a combination of business activities and GIS activities. Can pause for user input: Workflows can pause and wait for user input as many times as needed and for as long as needed, so they can model your business or GIS process precisely. Are extensible: Workflows can be expanded by creating custom activities. Once created, the new activities appear in Workflow Designer beside the original activities and the Designer treats them just like any other activity. Are dynamically interactive: Workflows are interactive all the way through. You do not only input data at the start and then collect outputs at the end. Workflows allow you to insert user decision points and interactions at any point in the workflow. Interactivity example: For example, you might start a workflow by having someone in the Viewer select points on the map, to which the workflow would add some buffering and a query on the server. Then the workflow would go back to the client with the list of features found by the query and get input about which features to include in a report. The list of user-selected features would then be returned to the server, where the report would be generated, and then sent back to the Viewer for display. Include enterprise and GIS processes: Workflows have the power to mimic enterprise activities in the process, combining GIS with business processes. For example, a workflow could interact with an existing backend system or database. Are REST endpoints: Workflows are exposed as REST endpoints, which allows third-party applications to interact with them. Are API agnostic. Workflows can interact with Flex, Silverlight or Java APIs. Can contain GIS data types: Workflows have built-in GIS data types like Esri geometries and feature sets that allow interaction with Esri objects Latitude Geographics Group Ltd. All Rights Reserved.

10 Deployment of a Workflow These factors mean that a Geocortex workflow provides a quick and easy way to first model, and then program, complex, interactive, GIS, and business processes. Deployment of a Workflow Once created, a workflow is configured in one or more REST Elements sites using Geocortex Essentials Manager. When the sites are deployed, the workflow is automatically published in the REST API for consumption by the Essentials client APIs, just like the other features configured in your site, like printing and reporting. The Geocortex Workflow Designer provides a new approach to developing RESTful applications that work with Geocortex Essentials. The benefits are two-fold: Workflows provide a relaltively simply way to define your system's logic and control flow. Workflows handle many of the low-level complexities associated with software development, like serialization, client-server communication, and coordination of asynchronous processes. This frees you to focus on the business problem. See also... Publish a Workflow on page 19 Configure a Workflow in the Viewer on page 23 Workflow Designer Interface This section describes the Workflow Designer's interface. For information about the simulator interface, see Simulator Interface. Workflow Designer interface The numbers in the screen capture correspond to the numbers in the table below. 3

11 Geocortex Workflow Designer 3.7 User Guide # Component More information Menu bar The menu bar contains standard File, Edit, and Help menus. In addition, the Edit menu has commands for exporting the workflow image. The Logging menu has commands related to the Log Debugging activity. Export the Workflow Image on page 17 Ribbon The ribbon contains a subset of the commands available through the File menu, plus an icon to start the simulator. Use the Workflow Simulator on page 112 Toolbox The Toolbox contains a complete list of the activities you can use in workflows, including any custom activities you have created. To see a description of an activity, hover over the activity in the Toolbox. To add an activity, drag it into the design area. Activities on page 6 Add, Move, Remove Activities on page 30 Table of Workflow Activities on page 119 ActivityBuilder The Activity Builder is the design area where you build your workflow. Along the bottom of the design area are tabs that you use to add variables, arguments, and to import namespaces. Navigate Around a Workflow on page 16 Add, Move, Remove Activities on page 30 Use Variables on page 33 Properties Variables, Arguments, Imports Tabs The Properties pane displays all the properties of the currently selected activity and any assigned values. The Variables, Arguments and Imports tabs allow you to create and edit variables and arguments, and to import libraries and namespaces for use within a workflow. Click any tab to open it. The zoom toolbar on the right adjusts the size of the workflow within the design area. Configure Activity Properties on page 32 Import a space on page 17 Architecture Geocortex Workflow is based on Microsoft Workflow Foundation 4.0, which is part of the.net 4.0 stack. Being implemented in.net on the server has many advantages. The main advantage is that it places the power of Windows Communication Foundation (WCF) and other.net technologies at your command. Another advantage is having access to the libraries of the.net Framework, which makes interaction with other systems straightforward. It also allows you to leverage existing knowledge in.net programming for creating custom activities. To learn more about Microsoft Workflow Foundation, read A Developer's Introduction to Windows Workflow Foundation (WF) in.net 4 at Latitude Geographics Group Ltd. All Rights Reserved.

12 Xaml Xaml Workflows are stored as.xaml files. When you create a workflow in Workflow Designer, you are actually creating a.xaml file. The.xaml file contains all the information needed to run the workflow. Because they are based on XML, workflows are not compiled. This means that you can inspect and edit a workflow in a text editor or XML editor if you want to there is no need to edit through the Workflow Designer, although the Designer does make it much easier to build and visualize the flow of activities. Workflow Controllers The workflow.xaml file is a configuration file that describes the workflow steps. It is stored on the server. In addition to the.xaml file, there are two workflow controllers; one on the client and one on the server: The server-side controller runs the workflow on the server and accepts the input sent by the client. It is a.net component that runs within the Essentials REST API. The client-side controller activates the workflow on the server and handles the client-side interaction with the user when the workflow includes these. The client-side workflow controller is either a Flex, Silverlight, or Javascript module. Workflow architecture Extensions to Microsoft Workflow Foundation Geocortex Workflow extends Microsoft Workflow Foundation (WF) in several ways: Interactivity:Geocortex workflows are interactive. Because workflows are served through REST, which is stateless, the entire state of the workflow is packaged and sent to the client for execution of client-side activities. No server resources are tied up while the workflow is waiting for input or displaying alerts on the client. 5

13 Geocortex Workflow Designer 3.7 User Guide Activities: Many of the activities in the Workflow Designer's built-in library of activities complement out-of-thebox Microsoft Workflow. A minority are out-of-the-box Microsoft Workflow activities. The Workflow Designer's extended set of activities includes a wide variety of activities that work with ArcGIS Server and GIS objects and data types. Simulation:The Workflow Designer's built-in simulator enables you to run workflows in a simulated environment. Simulation saves you from having to deploy your workflow, which reduces the time and effort it takes to test your workflows. Key Concepts Activities Activities are units of work that are chained together to form workflows. Activities are the building blocks of a Workflow. When you create a new workflow, you typically start with a Sequence, which is actually a Sequence activity with nothing in it yet. As you build the workflow, you drag activities from the Toolbox into the original sequence. The Sequence activity is designed to execute a series of activities in order. Activities can be grouped together into larger Activities. Some activities represent actions and others control the flow of activities. When control flow activities execute, the result is a decision about which execution path to follow. Geocortex workflows use control flow activities that are similar to those you would find in an imperative programming language, such as conditions and loops. Geocortex Workflow also offers more complex control flow activities such as the parallel processing activity. The Flowchart activity makes it easy visualize and add activities as well as to link activities to decisions that branch based on user or machine responses. Activity Toolbox and Categories The Toolbox in the Workflow Designer contains a comprehensive library of activities organized by category. Some of the activities in the Toolbox are taken directly from Microsoft Workflow Foundation, others are specific to Geocortex Workflow. The activities supplied by the Workflow Designer include ArcGIS Server-specific activities like geoprocessing and querying as well as general GIS activities like buffering and data transformations. There are also activities that support the interactivity of Geocortex workflows, such as prompting users for input or displaying alerts to the user. If you have custom activities contained in.dlls, simply add them to the root folder of the application and they appear in the Toolbox. The activities in the Toolbox are grouped into categories to make them easier to identify and locate. To see details about each activity, click the links in the table below. Category Control Flow of Activities Control Flow activities include basic ways to control the flow of how activities execute, for example the Sequence activity, which provides a container to execute steps in order. Other Control Flow activities include common branching logic such as the If and Switch activities. The Control Flow activities also include looping logic based on data (ForEach) and Conditions(While) Latitude Geographics Group Ltd. All Rights Reserved.

14 Variables Category Flowchart Common Client Common Server Common Viewer ArcGIS Server Collections Error Handling Debugging Modeling Conversion of Activities The Flowchart section of the Toolbox contains Microsoft-provided activities that present the workflow as a connected flow diagram with decisions and branching. These activities are those that would be used most frequently for client activities like sending users alerts, capturing a geometry, running a report, or creating forms to collect use input. These activities are supported by Essential client APIs. These activities are those that would be used most frequently for server activities like invoking methods, merging geometries, sending an , buffering a geometry, etc. These activities are those that would be used most frequently for Viewer-related activities like collecting external event arguments, listening for events, selecting features, or running external commands. The level of support for these activities may vary depending on the technology used. These activities are ArgGIS specific and include geocoding and reverse geocoding, buffering, querying, unioning, and routing tasks. The Collection activities are used manipulate collections of data. The Error Handling activities manage exception handling. They allow you to include activities that throw or catch exceptions. These activities provide ways to debug activities by writing text messages to log files or the console. These activities are used to model either a transfer of data between servers and clients, or as visual placeholders for activities that have not been implemented yet. These activities enable conversion of various objects from one data type to another. Variables In a workflow, variables are used to refer to pieces of data of a specific type. You use variables to refer to the data in other parts of a workflow. You can think of variables as labeled boxes that store different types of data. A variable is actually a storage area in memory for holding data that you'll need later. Workflow arguments are used to supply an activity with inputs or provide access to its outputs, often through referencing the names of variables where the input data is found or is to be stored. You store a value in a variable so that you can refer to it unambiguously. For this, a variable needs a unique name. If you think of the variables in your workflow as a set of cubbyholes, the name is the label that identifies a particular cubbyhole and allows you to find and identify it. The value would be like a slip of paper that you place inside the cubbyhole. The size and shape of the cubbyhole determines what kind of data it can contain the variable type. It is advisable to name a variable according to the Visual Basic naming conventions, but as you variable names appear in different contexts dialogs and drop-down lists within a workflow, it makes sense to give your variable a name that is meaningful and associated with its function and scope. 7

15 Geocortex Workflow Designer 3.7 User Guide Variable Types Variables come in different types that determine what kinds of values it can store. So you must specify the data type for each variable. Arguments can only work with variables that have the same data type, so the data type for an Argument and Variable that work together, must be compatible. Because the data types used for variables are essentially the same as those used by arguments, you can refer to the Argument Types table to learn more about each data type available in the Geocortex Workflow Designer. Scope Geocortex variables have scope, which means that you can specify the parts of the workflow in which they can operate. This is useful if you want to limit where a particular variable will be effective. This implies that the scope of a variable also defines the lifetime of the variable during the execution of the workflow. So when the workflow is executing activities outside the scope of the variable, the variable does not exist. When you set the scope of a variable, it is usually a good idea to use as narrow a scope as possible. The benefit of a narrow scope is that it improves performance and keeps your workflow organized. Variables Tab In the Workflow Designer, the Variables tab is located at the bottom of the design area where you can click the tab and create a variable regardless of where you are in the workflow. Variables tab with several kinds of variable types See also... Argument Types on page 126 Use Variables on page Latitude Geographics Group Ltd. All Rights Reserved.

16 Arguments Arguments When you design workflows, arguments are used at the workflow level and at the activity level. Workflow Arguments You use arguments to control the flow of data into and out of the workflow. An arguments can be In, Out, or In/Out and has a name and data type. You could, for example, define an argument that loads data into your workflow as it begins. You define arguments in a similar way to variables. One way is to use the Arguments tab, which is beside the Variables tab at the bottom of the design area. Usually though, arguments are defined in workflow per activity. Activity Arguments Arguments are defined within an activity. You use arguments to control the flow of data into and out of the activity. As you add activities to your workflow, you configure the arguments for each activity. The primary way to define an argument is to reference a variable or to use an expression. Most arguments are defined in the properties of an activity in the Properties pane. Variables may be assigned to activity output arguments in order to store the results of execution of the activity. You can type expressions that represent literal values, or use a variable name to reference a variable as shown in screen shot below, where addressvar is a variable defined in the workflow. Configuring an argument in the Properties pane The data type of a variable (Variable type) must be compatible with the data type of the argument you wish to use it with, to function correctly. Certain form elements of workflows use specific data types for their arguments. Usually, you can find out which data type the argument requires by hovering over the argument field and reading its tooltip. See also... Argument Types on page 126 9

17 Geocortex Workflow Designer 3.7 User Guide Expressions Expressions are program statements. An expression is a combination of literal values, variables, and operators. You use expressions in your workflow to perform a manipulation or calculation based on data. You can use expressions in setting values for activity and workflow input arguments or to define conditions on activities like the While or If activities. Expressions can be a literal string, a conditional statement, or an expression that concatenates several strings or calls a method.the table below includes a small sampling of the types of expressions you can use when defining arguments in the Workflow Designer. When you create expressions in code, there are several more options including the use of lambda expressions. Expressions and Visual Basic Expressions are written using Visual Basic syntax. This means the following: Case (capitalization) does not matter. Comparison is performed using a single equals sign instead of ==. Boolean operators are the words "And" and "Or" instead of the symbols "&&" and " ". Example expressions Expression "hello world" Expression Type Literal string value 10 Literal Int32 value System.String.Concat("hello",","world") Imperative method invocation "hello" & "world" Visual Basic expression arginputstring Argument reference (argument name) varresult Variable reference (variable name) "hello:" & arginputstring Literals and arguments/variables mixed Compiler Errors When you define an expression, it must comply with Visual Basic (VB) syntax and compilation rules. If you enter an invalid expression in a text box, the error icon displays to indicate that it is invalid. You can hover your mouse over the error icon to see more information about the error. These compiler error messages are written for programmers. Non-programmers may find them cryptic and unhelpful. The following list provides examples of common compilation error messages with simple explanations of each Latitude Geographics Group Ltd. All Rights Reserved.

18 Compiler Errors Example compiler errors Error Message Compiler error(s) encountered processing expression <Expression>. Value of type <Type1> cannot be converted to <Type2>. Compiler error(s) encountered processing expression <Expression>. Option Strict ON disallows implicit conversions from <Type1> to <Type2>. Compiler error(s) encountered processing expression <Expression>. <Variable> is not declared. It may be inaccessible due to its protection level. Cause You have assigned an argument of an activity to a variable that is the wrong data type. The variable type must match the type of the argument. You have assigned a variable to an in argument that is the wrong data type. The variable type must match the type of the input argument. In some cases you may be able to cast the variable to the correct type inline. Your expression contains a variable or method that is not defined. Check the spelling of the variable or method name. or Compiler error(s) encountered processing expression <Expression>. <Method()> is not declared. It may be inaccessible due to its protection level. Compiler error(s) encountered processing expression <Expression>. Invalid L-value expression. Compiler error(s) encountered processing expression <Expression>. You are attempting to assign an output argument of an activity to an expression rather than a variable or argument. You cannot assign an output argument value to an expression. You can only assign it to a variable or argument. Your expression contains text that is not enclosed by double quotes. String constants must end with a double quote. Compiler error(s) encountered processing expression <Expression>. The syntax of the expression is incorrect. Expression expected. or Compiler error(s) encountered processing expression <Expression>. End of expression expected. or Compiler error(s) encountered processing expression <Expression>. <> is a type and cannot be used as an expression or 11

19 Geocortex Workflow Designer 3.7 User Guide Error Message Cause Compiler error(s) encountered processing expression <Expression>.. expected. Queries Queries are used extensively in Workflows to search for data and data sets. A query is a precise request to retrieve information from a table in a database or to access information from an information system. In workflows, queries are usually performed on a layer or table resource, and target either ArcGIS or Geocortex. The result of a query is usually data in the form of a feature set. Each feature in a feature set may have a field value and/or geometry data associated with it. For tables, the feature set does not include geometries. Queries are defined by a SQL-like "where" clause. SQL (Structured Query Language) is the standard universal language used by most relational database management systems (RDBMS), including ORACLE, Microsoft SQL server, Informix, etc. Geodatabases usually consist of multi-tiered architecture that layers an RDBMS with a Geodatabase like ArcSDE that acts as a gateway and manages geographic data. SQL has a number of wildcard characters: % percent is a substitute for zero or more characters. _ underscore is a substitute for exactly one character. [charlist] Any single character in a charlist. [^charlist] or [!charlist] any character not in a charlist. See SQL Wildcards at W3Schools.com for more information. For more information: Esri Article on Geodatabases Typical Queries The syntax in the examples below assumes the query is being run against a layer that has the following fields: OBJECTID (esrifieldtypeoid) (esrifieldtypestring) Height (esrifieldtypedouble) Example Query: "OBJECTID>1000 AND LIKE 'Victoria' AND Height>5.5" You can incorporate variables of type string and int32 into any string-typed property in any activity, for example: the value of my variable is & variable1. To add a new line, use the Visual Basic command: Latitude Geographics Group Ltd. All Rights Reserved.

20 Typical Queries "Line 1" & Environment.newline & "Line 2" To get the attribute value of a feature, use: queryresult.features.first().attributes("myattribute").tostring() On the ArcGIS Resource Center: Building a query expression SQL reference for query expressions used in ArcGIS 13

21 Geocortex Workflow Designer 3.7 User Guide Create Workflows About Workflow Features Workflow Designer has many features that facilitate the creation of workflows: Drag-and-drop interface: Workflows are built by dragging activities from the Toolbox and dropping them onto the design surface. Built-in library of activities: The Toolbox contains a wide range of activities that include specialized Geocortex Essentials, ArcGIS Server, and GIS activities. In addition, there are common client and server activities, control flow activities, error handling, debugging, and more. Auto-completion: Designer provides auto-completion suggestions when you are creating variables and other elements. Quick access to common data types: When selecting a data type for a variable, Designer allows you to select from lists pre-populated with common data types for working with ArcGIS Server and Essentials objects. Validation and error checking: The Designer automatically performs error checking and displays an icon if there is an error. Hovering the mouse over the icon displays a tool tip that describes the error(s). Simulation: The Simulator saves you from having to deploy your workflow to REST and create a web application to test it, which reduces the time and effort it takes to test your workflows. Create a New Workflow When you begin a new workflow, the default is to start with a Sequence activity that functions as a container but also runs all the activities within it in order. To build the workflow, you drag activities from the Toolbox onto the design area one at a time and set the activities' properties. The design area displays a visual model of the business process that you are automating. When you have added and configured all the activities in the workflow, you test the workflow using Workflow Designer's built-in simulator. Creating a new workflow closes the workflow that is currently open and creates a new workflow in the design area. The new workflow consists of an empty Sequence activity and nothing else. New workflow in the design area Latitude Geographics Group Ltd. All Rights Reserved.

22 Validation Errors To create a new workflow: 1. Do one of the following: Click the New icon in the ribbon. Or Select File New. 2. To rename the Sequence activity, click on the title (name) and type in a new name. All references to this activity are then automatically updated to the new name in the Workflow Designer, for example, in the Variable Scope drop-down list. Type in a new name for the Sequence activity Validation Errors Geocortex Workflow Designer displays an icon in the design area whenever it encounters a validation error. To see a tool tip describing the error, hover the mouse pointer over the icon.the error icon appears right away when you add an activity with required properties. The icon disappears as soon as you enter values for the required properties. Tooltip describing an error The Workflow Designer detects several types of validation errors, including invalid syntax in a Visual Basic (VB) expression. You can save a workflow that has validation errors, but you cannot run it in the simulator. 15

23 Geocortex Workflow Designer 3.7 User Guide Navigate Around a Workflow The table lists ways to move around and see different parts of a workflow in the design area. To: Do this: Fit the whole workflow image within the existing design area: Open and view a nested activity (which could contain other activities): Click the Fit to screen icon at the bottom of the design area. Double-click the activity in the workflow image. (Do not click within a field.) or Right-click the activity and select Open. Zoom out one or more levels, when viewing a nested activity: Click Expand All or Collapse All at the top of the design area. or Click a specific link in the breadcrumb at the top of the design area to go to that part of the workflow. View the image at 100%: Click the Reset zoom to 100% icon. Select 100% from the magnification drop-down list at the bottom of the design area. Maximize the area available for the image within Designer: Click Variables / Arguments / Imports at the bottom of the design area to minimize the Variables, Arguments, or Imports area. Find the currently visible part of the image within the workflow: Click the Overview icon at the bottom of the display area. Pan the image: Click the Overview icon at the bottom of the display area and drag the yellow box in the Overview window. or Use the scroll bars. Zoom in or out a preset amount: Select a zoom level from the magnification drop-down list at the bottom of the design area. or Hold down the Ctrl key and scroll your mouse wheel. Hide or show nested activities and the properties for all activities: Click Collapse All / Expand All at the top of the design area. Undo Collapse All or Expand All: Click Restore at the top of the design area Latitude Geographics Group Ltd. All Rights Reserved.

24 Import a space Import a space The Imports tab is beside the Variables and Arguments tabs at the bottom of the design area. The Imports tab contains a configurable list of the most commonly used namespaces for use in web GIS applications. The.NET Framework uses namespaces to organize classes and create globally unique types. When you import these.net namespaces, you gain the ability to use the unique types they contain. In order to use a specific type in a workflow, you must be able to uniquely reference that type. There are two ways to do this: Use the fully qualified name of the type. Import the namespace that contains the type and then use the short name of the type. If you import the namespace, it provides a shortcut so you don t need to specify fully qualified type names. Fully qualified type names are not usually required for simple types (primitives), such as Boolean values and numbers. Example: Create a new MapPoint object from Esri s WPF API: Option 1: Reference the type using the fully qualified type name: New ESRI.ArcGIS.Client.Geometry.MapPoint(1.0, 1.0) Option 2: Import the ESRI.ArcGIS.Client.Geometry namespace, then use: New MapPoint(1.0, 1.0) To import a namespace: 1. At the bottom of the design area, select the Imports tab. 2. Do one of the following: Click the down arrow of the drop-down list at the top of the Imported namespaces list and select the namespace you want to import. Type the name of the namespace into the drop-down box. The namespace is added to the Import drop-down list, where you can select it. When you save your workflow, any unused imported namespaces are removed from the drop-down list. Export the Workflow Image You can export the image of a workflow in two ways: Save As Image: Saves the image of the current workflow to a JPG file. Copy As Image: Copies the image of the current workflow to the clipboard. You can then paste the image anywhere the Windows Paste command works, for example, in a Microsoft Office application. Everything that is visible in the design area can be exported. You can control which parts will be saved or copied by selecting that part of the workflow in the breadcrumb links at the top of the design area. 17

25 Geocortex Workflow Designer 3.7 User Guide For example, if you select a particular part of the workflow: ActivityBuilder > Sequence > If only that part, in this case the If activity, and everything within its scope, is exported. To export the entire image, select the activity that contains the whole workflow, which is the first activity in the breadcrumb links. In this example, it would be Activity Builder. The Save As Image and Copy As Image commands are available from the Edit menu or by right-clicking anywhere in the workflow image. To export a workflow Image to a folder: 1. Do one of the following: Right-click anywhere within the workflow image and select Save as Image. Or Click Edit Save As Image. 2. In the Save As dialog box, navigate to the folder where you want to save the image and select it. 3. Type a name for the workflow image in the File name box. 4. If you want to change the file format of the image, click the Save as type drop down list and select either JPEG, PNG, GIF, or XPS. 5. Click Save. To copy and paste the image into another application: 1. Do one of the following: Right-click anywhere within the workflow image and select Copy as Image. Or Click Edit Copy As Image. The image is copied to the clipboard and you can paste it into any application that accepts the Windows Paste command. Save a Workflow When you save your workflow, by default, it saves as a XAML file. A good practice is to save your custom workflows in a directory within the Sites folder of Geocortex Essentials, as this is the top folder that can be accessed through Geocortex Essentials Manager. The advantage is that all your workflows will be in a central location and can be found and used by multiple sites. In a standard installation, the Sites folder is here: C:\Program Files (x86)\latitude Geographics\Geocortex Essentials\Default\REST Elements\Sites Latitude Geographics Group Ltd. All Rights Reserved.

26 Publish a Workflow To save a workflow: 1. Do one of the following: Click the Save icon on the application ribbon. Or Click File Save. 2. Navigate to the folder where you want to keep the workflow file. 3. In the File name box, type in a name for your workflow. If you give the workflow a name that describes what it does, it will be easy to identify. 4. Click Save. Publish a Workflow Once you have created a workflow in the Workflow Designer, you must publish (add) it to a particular site. You can have any number of workflows published to any one site. Once the workflow has been added to a site, you can configure it to be used in the Viewer. You need to add the workflow to each site that will use it. Once you have added a workflow to one site in Essentials, you can import it from one site into another. This means that there are two ways to add a workflow to a site: Specify the location of a workflow so that the site can find it. Import a workflow that is already attached to a different site. In a standard installation, Geocortex Essentials sites are installed in the following folder: C:\Program Files (x86)\latitude Geographics\Geocortex Essentials\Default\REST Elements\Sites It is important that you save your custom workflows in a directory within the Sites folder as this is the top folder that can be accessed through Geocortex Essentials Manager. When you save your files here, all your workflows are in a central location and can be found and used by multiple sites. In a standard installation, the Sites folder is here: C:\Program Files (x86)\latitude Geographics\Geocortex Essentials\Default\REST Elements\Sites To add a workflow to a site: 1. Open Geocortex Essentials Manager and log in. 2. On the Site List, click the Edit Site button of the site that you want to attach the workflow to. 3. In the Site menu, click Workflows. 19

27 Geocortex Workflow Designer 3.7 User Guide Site menu in Geocortex Essentials Manager 4. In the Workflows area, click Add Workflow. Click Add Workflow 5. In the Display box, type the name of your workflow. This name will be listed in the Display column on the Workflows page. 6. To locate your workflow, click the Browse button. Notice that the Sites folder is the highest folder that you can browse to. To be accessible from Geocortex Essentials, you need to have saved your workflow to a directory beneath the Sites folder Latitude Geographics Group Ltd. All Rights Reserved.

28 Publish a Workflow The Workflow folder under Resources 7. Navigate to the folder where you saved the workflow file. 8. Select the workflow file, and then click OK. Display and Uri for the workflow If you have not saved your workflow in an accessible location, you can use the Upload button to add it to your site. In the Browse Workflow Location window, click to open the Upload dialog that allows you to upload the workflow file to a folder under the Sites directory. 9. Click OK, and then click Save Site. When the new workflow is listed on the page, an ID for this workflow has been created and listed in the ID column. You will use this ID when you configure the Viewer to run the workflow. Workflow with new ID listed under Workflows 21

29 Geocortex Workflow Designer 3.7 User Guide The workflow is now published and you can access it through the REST endpoints or when you are navigating the REST directory pages. You can also run the workflow from the REST pages. Now you need a Viewer or other application to use the workflow. To import a workflow from a site: 1. Open Geocortex Essentials Manager and log in. 2. On the Site List, click the Edit Site button of the site that you want to attach the workflow to. 3. In the Site menu, click Workflows. Site menu in Geocortex Essentials Manager 4. In the Workflows area, click. The Workflow Import wizard opens. 5. In the drop-down list, select the site that the workflow is already attached to, and then click Next. Workflow Import Wizard - site selected The workflows attached to this site display in the Workflows to import box. 6. Select the workflow that you want to import. To select multiple workflows, hold down the Ctrl key while you select other workflows Latitude Geographics Group Ltd. All Rights Reserved.

30 Configure a Workflow in the Viewer Workflow Import Wizard - select workflows 7. Click Finish. The wizard closes and the imported workflows are listed on the Workflows page. The workflow has been assigned an ID, which appears in the ID column beside the workflow. Imported workflows now attached to the site Make a note of the workflow ID as you will need it when you configure the workflow to run in the Viewer. 8. Click Save Site to save the changes to the site. Configure a Workflow in the Viewer When you configure a workflow to run in the Geocortex Viewer for Silverlight, you can add a button to the toolbar to run the workflow, or add a menu item to the I Want To menu. The easiest way to configure a workflow is in Geocortex Essentials REST Manager, but it can be configured in the XML file directly. The instructions below explain how to configure a workflow in REST Manager. Before you can configure a workflow in the Viewer, the workflow must be published to a site and have an ID, which you use when you are configuring the workflow in the Viewer. Before you can configure a workflow in a Viewer, it has to be associated with the site too. Instructions for adding a Viewer to a site are therefore included below. To add a Viewer to a Site: 1. Open Geocortex Essentials REST Manager and log in. 2. On the Site page, click the Edit Site button of the site that you want to add a Viewer to. 23

31 Geocortex Workflow Designer 3.7 User Guide 3. In the Site menu, click Viewers. 4. Click Add Viewer. 5. In the Display box, type in the name you want to give this Viewer. 6. From the Template drop-down list, select the template of the Viewer you want to add to the site. The Viewer template is added to Geocortex Essentials during the installation process. 7. Click OK and then Apply Details. The Viewer has been added, but you need to configure some of the features to ensure that it displays correctly. To configure a workflow to run from the Viewer Toolbar: The procedure below assumes that the Viewer has already been added to the site. 1. Open Geocortex Essentials REST Manager and log in. 2. Click the Edit Site button of the site that you have published the workflow to. 3. In the Site menu, click Viewers. 4. In the Viewers list, click the Edit icon of the Viewer you want to add the workflow to. 5. Click Toolbar. Toolbar option 6. To copy the default configuration from the template, click Copy Defaults. 7. In the Configured Toolbar area, beside Tasks, click the Add Group icon. Add a group to the Tasks tab in the Viewer toolbar 8. In the Add Group dialog box, type a Display for the group, and then click OK. Type a name for the group to display in the toolbar 9. Beside the new Workflows item, click the Add Toobar Item icon Latitude Geographics Group Ltd. All Rights Reserved.

32 Configure a Workflow in the Viewer Add a Toolbar Item 10. From the menu, select the Add Button option. Select Add Button from the menu 11. In the Add Button dialog box, do the following: : Type in a for the button. The name is a reference and does not appear on the interface. Display : type in the button name that will appear on the toolbar. Image URI: (Optional) Browse to the location of the image file that you want to use. You can also use the button in the Select File dialog to add a new graphic to the site. : Type in the tooltip that will display when the cursor hovers over the button. Command: Select RunWorkflowByID. This command runs the workflow based on the ID allocated to that workflow when you added the workflow to the site. CommandParameter: The ID of the workflow. Module:?? 12. In the Command box, select RunWorkflowById. This command allows you to simply enter the ID of the workflow in the Command Parameter box. 13. In the Command Parameter, enter the ID of the workflow that was assigned to it when you added the workflow to the site. Enter the Command Parameter 25

33 Geocortex Workflow Designer 3.7 User Guide 14. Click OK, and then Apply Changes and Save Site to add your button to the Viewer toolbar. Button to run the workflow added to the toolbar To configure a workflow to run from the I Want To Menu: 1. Open Geocortex Essentials REST Manager and log in. 2. Click the Edit Site button of the site that you have published the workflow to. 3. In the Site menu, click Viewers. 4. In the Viewers list, click the Edit icon of the Viewer you want to add the workflow to. 5. In the Viewer menu, click I Want To Menu. I Want To Menu option 6. Click Copy Defaults. 7. To add a new item to the menu, click Add Menu Item. 8. Enter the following values for the attributes: Text: The name that appears on the I Want To Menu. Command: Select RunWorkflowByID. This command runs the workflow based on the ID allocated to that workflow when you added the workflow to the site. CommandParameter: The ID of the workflow. Image URI: Browse to the location of the file that you want to use. You can also use the button in the Select File dialog to add a new graphic to the site. 9. Click Ok,and then Apply Changes and Save Site to add the icon to the I Want To Menu. The new menu item to run the workflow appears at the bottom of the list Latitude Geographics Group Ltd. All Rights Reserved.

34 Workflow Container Configuration Menu item to run the workflow added to the I Want To menu Once you have set up your workflow to function in the Viewer, you can edit the workflow in the Workflow Designer and when you save, the changes will be visible in the Viewer immediately. Workflow Container Configuration A workflow container is a visual element that allows you to specify where and how to display a workflow in the Viewer. You can use a workflow container to display workflows in a separate pop-up dialog or in the frame on the left side of the user interface. You can show or hide a workflow container either through the ConfigureWorkflowActivity or by using the ShowWorkflowContainer or HideWorkflowContainer commands. Workflow containers persist between activities. This means that you can use a container to show users the transitions between activities or to display feedback messages during a workflow's execution to indicate that an activity is running and to ask them to wait. Set up The simplest setup for a workflow container is to reference the workflow container from certain activities, so that the content of the activity displays inside the workflow container. The workflow activities that currently support containers include: DisplayForm DisplayHyperlink DisplayCaptureGeometry When you use a workflow container to display the content of an activity, you get natural transitions between activities, which are more suitable for displaying workflows that have a wizard-like functionality. 27

35 Geocortex Workflow Designer 3.7 User Guide In the Workflow Designer, the property that you use to reference a workflow container is Workflow Container. If you wish to use the same container for all activities in your workflow, we recommend that you store the container name in a variable rather than hard coding each activity to the same container name. Workflow Container property in the DisplayHyperlink activity The DisplayForm activity also supports a Region property, which has similar but less functionality than workflow containers. It is therefore better to use the Workflow Container property rather than Region where possible. In addition, a workflow container can be re-configured or modified by using and changing the properties of a specific activity - the ConfigureWorkflowContainer activity. The properties of the ConfigureWorkflowContainer allow you to configure the title, a message, a busy indicator, as well as the visibility of the container during the execution of a workflow. You can change the properties of the workflow container at any point, even while the workflow is running. To do so, you set up the ConfigureWorkflowContainer properties so that they change during the execution of the workflow. For example, you can reset the message of a single ConfigureWorkflowContainer activity so that it displays a series of different messages as the workflow executes. Any properties that are not set will be ignored. Examples of Workflow Containers You can use a workflow container with a DisplayForm activity, to ensure that the workflow does not disappear from the interface between activities but displays a spinner to indicate that something is happening. Workflow containers will gray out or disable their content between activities to indicate to the user that they should wait. If the workflow container is displayed in the DataRegion, then a spinner also displays between activities. You can use a container to show a Loading... (or any other) message at the beginning of a workflow to give users feedback before the first activity displays. You could then change the message in the middle of the workflow to ask the user to wait while significant data processing completes, for example during geoprocessing. The message can also be updated periodically within an intensive data processing routine, to display status updates on a single long process. Parameters The following Workflow Container parameters can be configured in the Viewer.xml file of a Geocortex Viewer for Silverlight: : The name of your workflow. DefaultTitle="Workflow" DefaultRegion="DataRegion" DefaultIconUri="/Resources/Images/Form.png": Default parameters used to construct a new workflow container when a reference cannot be found with a specified name Latitude Geographics Group Ltd. All Rights Reserved.

36 Examples of Workflow Containers Title: The title of the container as it appears in the title bar of the region where the workflow displays. In the Geocortex Viewer for Silverlight the two most common regions are DataRegion and ModalWindowRegion. Region: Defines where on the Viewer interface the workflow will display. If DataRegion, the workflow opens in the frame to the left. If ModalWindowRegion, the workflow opens in a modal dialog. IconUri: (Optional) The Uri to the icon that will display in the tab area at the bottom of the frame so that you can return to this workflow if several are stacked one above the other. For example, /Resources/Images/Form.png. Example Configuration <Workflow> <Configuration> <RunAtStartup> <!--<Workflow Id="YourWorkflowId" />--> </RunAtStartup> <WorkflowContainers DefaultTitle="Workflow" DefaultRegion="DataRegion" DefaultIconUri="/Resources/Images/Form.png"> <WorkflowContainer ="Default" Title="Workflow" Region="DataRegion" IconUri="/Resources/Images/Form.png"/> <WorkflowContainer ="Extract" Title="Extract Data" Region="DataRegion" IconUri="/Resources/Images/LayersExtract.png"/> <WorkflowContainer ="ModalWindow" Title="Workflow" Region="ModalWindowRegion"/> </WorkflowContainers> </Configuration> </Workflow> 29

37 Use Activities Use Activities Add, Move, Remove Activities To add an activity to a workflow, you drag it from the Toolbox into the design area. You place an activity into position where you want it, but you can move them after they have been added. You can add an activity wherever you see a landing spot or where you see the Drop activity here message in the workflow image. When you drag an activity to a landing spot, it automatically splits to accommodate the new activity. Activity being added into a workflow Add an Activity To add an activity: 1. Click and drag an activity from the Toolbox to its position within the workflow. You can pan the workflow and add an activity at the same time. The workflow image scrolls automatically when you bump the frame of the design area with an activity you are dragging. You can also copy and paste activities using Ctrl+C and Ctrl+V. This is a quick and easy way to add a particular activity multiple times. If you add an activity that has properties that are required, the error icon displays in the activity's header. It will disappear once you have entered values for the required properties. Move an Activity You can move activities around on the design surface to change their position within the workflow. To move an activity after it has been placed in the design area: 1. Drag the activity to its new position and drop it. 30

38 Geocortex Workflow Designer 3.7 User Guide Remove an Activity To remove an activity from the workflow: 1. Do one of the following: Right-click the activity on the design surface and select Delete. Select the activity and press Delete on your keyboard. About Activity Properties Each activity is represented in the design area as a box with a header and several property fields. To configure an activity, you enter values for the required properties. You can configure properties in the design area or in the Properties pane, but only the Properties pane provides a complete list of all the properties for a particular activity. The properties of many of the activities are very specific. To be valid, the value of a property must be of the correct data type for that property. Activity properties are Visual Basic expressions. Many of the values that you enter are one of the following: Variables:The name of a variable that appears in the Variables table is a valid expression, provided the activity is within the variable's scope. Strings: In Visual Basic, strings are surrounded by double quotation marks. For more information on Visual Basic expressions, refer to Find the Data Type of an Activity Property In all the properties in the Properties pane, you can find the data type to use for for that property before you configure it. To find the data type of an activity property: 1. Select the activity in the workflow design area. 2. In the Properties frame, hover your mouse over the name of the property. A tool tip that includes the data type will appear. Data types shown in property tooltips Latitude Geographics Group Ltd. All Rights Reserved.

39 Required Properties Required Properties An error icon appears in the header of an activity in the design area if one or more required properties have not been assigned a value. To determine which properties are required, hover the mouse pointer over the error icon to see tooltip explanation. Tooltip showing required properties Configure Activity Properties After you add an activity to your workflow, you must configure the activity by setting its properties. You can set properties in two places: In the activity in the design area. In the Properties frame. Only the Properties frame lists all of an activity's properties. When an activity is in the design area, you see only the most important of an activity's properties, so configuring all the properties of an activities in design area does not guarantee that you have configured all the required properties. Properties of the Send Mail activity in the design area and Properties pane The title bar of an activity in the ActivityBuilder contains the activity's display name. To change the display name, select the name in the title bar and type in a new name. Alternatively, in the Properties pane, change 32

40 Geocortex Workflow Designer 3.7 User Guide the name beside the Display property. Change the name of an activity To configure an activity: 1. Do one of the following: Select the activity in the design area and enter the values in the activity within the design area. Select the activity in the design area and enter the values in the Properties pane. Use Variables Variables are used in Geocortex workflows to pass values from one activity to another. For example, you could use a variable to pass user input gathered on the client to a server-side activity to be operated on. When you create a variable, you give it a name that you will use in activities to refer to the variable. Scope Geocortex variables have scope, which means that you can specify the parts of the workflow in which they can operate. This is useful if you want to limit where a particular variable will be effective. This implies that the scope of a variable also defines the lifetime of the variable during the execution of the workflow. So when the workflow is executing activities outside the scope of the variable, the variable does not exist. When you set the scope of a variable, it is usually a good idea to use as narrow a scope as possible. The benefit of a narrow scope is that it improves performance and keeps your workflow organized. Create a Variable When you create a variable, you give it a name, and select a data type that is appropriate for the value that will be assigned to it. You also set the scope the parts of the workflow this particular variable will function within. You can also give the variable a default value if you want to or if your workflow requires it. To create a variable: 1. Do one of the following: Right-click anywhere within the workflow in the design area and select Create Variable. The Variables tab opens with a Create Variable line, which you click to define the variable. Click the Variables link at the bottom of the design area. The Variables tab opens with a Create Variable line, which you click to define the variable. 2. Click Create Variable in the cell and type a name for the variable. You refer to this name when you use the variable within activities. You can name a variable anything at all, but as you will use and see this name in different contexts, it makes sense to give your variable a name that is meaningful and associated with its function Latitude Geographics Group Ltd. All Rights Reserved.

41 Create a Variable 3. Click the Variable Type cell and select a data type from the drop-down list. The data type of a variable (Variable type) must be compatible with the data type of the argument you wish to use it with, to function correctly. Certain form elements of workflows use specific data types for their arguments. Usually, you can find out which data type the argument requires by hovering over the argument field and reading its tooltip. 4. If the data type you need is not in the Variable type drop-down list, click Browse for Types at the bottom of the list to open the Browse and Select a.net Type window, where you can locate additional spaces containing other data types. 5. To set the Scope of the variable, click the Scope cell and select which activity the variable will operate within. The Scope drop-down list contains a list of the activities within the current workflow that you can set as the scope for the variable. If you change the name of an activity, the name automatically changes in this drop-down list as well. 6. You can also click in the Default cell and enter a default value for the variable. For example, if your variable is to store user input from a form, you may want to enter a default value so that there is a value in the field should the user not enter one. New variable in Variable tab and Properties pane 34

42 Geocortex Workflow Designer 3.7 User Guide Delete a Variable To delete a variable: 1. To open the Variables tab, click Variables at the bottom of the design area. 2. Select the table row that contains the variable you want to delete. Be sure to select the entire row. 3. Press Delete on the keyboard. See also... Variables on page 7 Activities on page 6 Arguments on page 9 Select Data Types The Type drop-down lists that appear in various places in Workflow Designer, already contain several types that are frequently used in web GIS applications. Type drop-down list in the Properties pane To select a data type: 1. In any of the Type drop-down lists, select the Browse for Types option at the bottom of the list. The Browse and Select a.net Type window displays a complete list of.net assemblies. The list contains all the loaded Microsoft, Geocortex, Esri, and third-party assemblies. You can click the arrows to expand the tree and see other levels Latitude Geographics Group Ltd. All Rights Reserved.

43 Select Data Types The Browse and Select a.net Type window 2. Select the type you want to import and click OK. The type is added to the drop-down list where you can select it. 36

44 Activity Library Activity Library Control Flow Activities Do While Activity : A looping activity that runs contained activities at least once, until a condition is no longer true. Runs one or more activities at least once until a condition is False. The Do While activity is similar to the While activity, except that the activities contained within a While may never run if the condition initially evaluates to False. Condition Display The condition that, while evaluating to True, will cause the workflow to loop over and run the contained Body activities. The condition is first evaluated after the contained Body has run once. DoWhile You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Body A container for an activity. If you want more than one activity in the Body, use a composite activity such as a Sequence or Parallel activity. For more information: For Each <T> Activity : A looping activity that executes activities contained within it, once for each value provided in the Values collection. Runs one or more activities once for each value within a specified collection of Values. The Body of the ForEach activity may be designed to sequentially process each value in the collection in a similar way. 37

45 Geocortex Workflow Designer 3.7 User Guide In a Workflow: The ForEach<T> activity could be used with the Query Task and Get Geometries activities as follows: Use the Query Task activity to obtain a feature set. Use the Get Geometries activity to extract those geometries from the feature set. Use the ForEach<T> activity to process each geometry. Properties/Parameters: Display TypeArgument Values Foreach Body ForEach<T> You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. The type T of the values provided in the Values collection. The activity s collection of input values for the execution of the Body activities. Activity-scoped variable name that references a single instance from the Values collection during each iteration of the loop. A container for an activity that runs for each value in the Values collection. If you want more than one activity in the Body, use a composite activity such as a Sequence or Parallel activity. For more information: If Activity : Models an If-Then-Else condition. Evaluates a given condition and executes one of two sets of activities depending on whether the condition evaluates to True or False. In a Workflow: The If activity could be used to decide if a form should be opened or not based on a prompted user response Latitude Geographics Group Ltd. All Rights Reserved.

46 Parallel Activity Condition Display A logical expression that evaluates to either True or False. If You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Then Else A container for an activity that runs if the Condition evaluates to True. If you want more than one activity in the Body, use a composite activity such as a Sequence or Parallel activity. A container for an activity that runs if the Condition evaluates to False. If you want more than one activity in the Body, use a composite activity such as a Sequence or Parallel activity. For more information: Parallel Activity : An activity that executes all child activities simultaneously and asynchronously. Runs several activities in parallel. In a Workflow: The Parallel activity is used to run several activities at the same time. CompletionCondition Display If this property evaluates to True, then the other scheduled child activities are canceled. If this property is not set, all activities run until completion. Parallel You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Body A container for an activity that will be run asynchronously in parallel. If you want more than one activity in the Body, use a composite activity such as a Sequence or Parallel activity. For more information: 39

47 Geocortex Workflow Designer 3.7 User Guide Parallel For Each <T> Activity : Enumerates the elements of a collection and executes an embedded statement for each element of the collection in parallel. Runs a set of activities against each item in parallel. In a Workflow: The ParallelForEach activity could be used to generate several reports at the same time. CompletionCondition Display If the logical condition evaluates to True, then the scheduled pending iterations are canceled. If this property is not set, all scheduled statements execute until completion. ParallelForEach<T> You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. TypeArgument Values /in Body The type of the values provided in the Values collection. The activity s collection of inputs for the execution of the Body activities. A container for an activity that will be executed for each value in the Values collection. If you want more than one activity in the Body, use a composite activity such as a Sequence or Parallel activity. For more information: Latitude Geographics Group Ltd. All Rights Reserved.

48 Pick Activity Pick Activity : Provides event-based control flow modeling. The Pick activity makes it possible to control a workflow based upon which of several trigger activities completes first. The Pick activity is often used with the PickBranch activity. Display Pick You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Branch1, Branch 2, etc Trigger Action The branches that each define a Trigger activity and an Action activity that is run if the branch s Trigger is the first in the Pick to complete. An activity that, upon completion, triggers the Action activity to run and indicates to the parent Pick activity that any other PickBranch activities should be deactivated. If you want to use more than one activity in the Trigger, use a composite activity such as a Sequence or Parallel activity. An activity that is run when the Trigger activity has completed if, and only if, the Trigger was the first in the parent Pick activity to complete. If you want to use more than one activity in the Action, use a composite activity such as a Sequence or Parallel activity. For more information: Pick Branch Activity : A potential path of execution within a Pick activity. The Pick Branch activity is used with the Pick activity. The PickBranch activity has both a Trigger and an Action that are each activities. When a Trigger activity completes, the parent Pick activity deactivates any other child PickBranch activities; only the Action associated with the first-completed PickBranch Trigger within a Pick activity is run. 41

49 Geocortex Workflow Designer 3.7 User Guide Display PickBranch You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Trigger Action An activity that, upon completion, triggers the Action activity to run and indicates to the parent Pick activity that any other PickBranch activities should be deactivated. If you want to use more than one activity in the Trigger, use a composite activity such as a Sequence or Parallel activity. An activity that is run when the Trigger activity has completed if, and only if, the Trigger was the first in the parent Pick activity to complete. If you want to use more than one activity in the Action, use a composite activity such as a Sequence or Parallel activity. For more information: Sequence Activity : Executes a set of child activities according to the order they appear in the sequence. The Sequence activity runs an ordered collection of activities in sequential order. A workflow has to be created within a Sequence activity, which can contain other workflows nested within a Sequence activity. Display Sequence You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Activities An ordered collection of activities to be run one at a time in sequential order. For more information: Latitude Geographics Group Ltd. All Rights Reserved.

50 Switch <T> Activity Switch <T> Activity : Selects one activity to execute from a number of possible activities based on the value of a given expression. The Switch<T> activity selects one out of several activities to run based on the value of a given expression. Display Switch<T> You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Expression The expression that evaluates to a value of type T. Default Case(s) The activity run when the Expression value does not equal any defined Case key value. You can define Zero or more Cases that specify a Case key value of type T, and an activity to run if the Expression value equals the Case key value. If you want to have more than one activity in the Case, use a composite activity such as a Sequence or Parallel activity. For more information: While Activity : A looping activity that executes contained activities 0 or more times, until a condition is no longer true. The While activity evaluates a condition and runs a specified activity 0 or more times until the condition evaluates to False. The While activity is similar to DoWhile except that an activity contained within a DoWhile is guaranteed to run once before the condition is evaluated. 43

51 Geocortex Workflow Designer 3.7 User Guide Condition Display The condition that, while evaluating to True, causes the workflow to loop over and run the contained Body activities. The condition is first evaluated before the contained Body has run. While You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Body A container for an activity. If you want more than one activity in the Body, use a composite activity such as a Sequence or Parallel activity. For more information: Flow Chart Activities Flowchart Activity : Models workflows using the familiar flowchart paradigm. Makes it possible to design and visualize a workflow using flow chart elements. The activity provides a container that can hold a collection of activities in combination with branching flow control elements such as FlowDecision and FlowSwitch. Execution of the Flowchart begins at the Start node and possible execution paths between Flowchart elements are defined using directed connections between elements. While the Flowchart activity helps with the design and visualization of some workflows, the same functionality and runtime behavior can be achieved using Control Flow activities without using the Flowchart activity. In a Workflow: The Flowchart activity is usually used in combination with other activities to construct a complex non-sequential workflow. The workflow may include user decisions and input with different outcomes based on each decision or response. For example, a form could be created to collect a zip code from the user. Then, when the zip code is selected, the workflow presents a list of schools within the zip code. The user can select one school and click Search or click Search to display all the schools Latitude Geographics Group Ltd. All Rights Reserved.

52 Flow Decision Activity Display Flowchart You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Start The Flowchart element where execution begins. Execution continues through subsequent child elements connected via directed links. For more information: Flow Decision Activity : A specialized FlowNode that provides the ability to model a conditional node with two outcomes. A FlowChart control flow element, similar to an If activity, that passes execution to one of two possible child elements based on whether a condition evaluates to True or False. Condition FalseLabel An expression that evaluates to True or False. False You can change the name of this label to make it meaningful in the context. The label appears on the connector that branches to the next activity. TrueLabel True You can change the name of this label to make it meaningful in the context. The label appears on the connector that branches to the next activity. For more information: 45

53 Geocortex Workflow Designer 3.7 User Guide Flow Switch <T> Activity : A specialized FlowNode that allows you to model a switch construct with one expression and one outcome for each match. A FlowChart control flow element, similar to a Switch activity, that passes execution to one of several possible child elements based on the value of the given expression. Output connections from a FlowSwitch represent either a discrete value case, i.e. the child element is executed if the FlowSwitch expression evaluates to the particular case value assigned to the connection, or a default case, i.e. the child element is executed if the expression evaluates to a value that does not match any case value for any other output connection. The case value or Default appears on the connector that branches to a child activity. Expression The expression that evaluates to a value of type T. For more information: Common Client Activities Alert Activity : Displays an alert dialog in a client application. Used to relay information to the client application using an alert dialog. In a Workflow: This activity is used to provide feedback to the user. For example, at the end of a workflow that collects and stores user inputs, an Alert would send the message: Your information has been recorded. In Arguments Title Text The title of the alert dialog. The text of the alert dialog Latitude Geographics Group Ltd. All Rights Reserved.

54 Capture Geometry Activity Misc Display Alert You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Capture Geometry Activity : Interactively captures a geometry within a client application. Capture Geometry is used to interactively obtain a geometry (point, polygon, line or similar) from the user. Usage: This activity is used to collect geometries from the client for use within other activities. For example, you might ask the user to choose a parcel to trigger a flood area report. In Arguments Geometry Type The type of geometry to capture (for example, Line) Misc Display CaptureGeometry You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments Result The Esri geometry captured by the client. 47

55 Geocortex Workflow Designer 3.7 User Guide Confirm Activity : Displays a confirmation dialog in a client application. Similar to the Alert activity, but the Confirm Activity requests a decision from the user (OK or Cancel). Usage: This activity could be used to ask the user to confirm a create, update, or delete operation, for example, the deletion of an incident report. In Arguments Text Title The text of the Confirm dialog. The title of the Confirm dialog. Misc Display Confirm You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments Result The result of the Confirm dialog (true or false) Latitude Geographics Group Ltd. All Rights Reserved.

56 Display Form Activity Display Form Activity : Displays a form in the client. The Display Form activity is a powerful way to gather multiple inputs of various types from the user all in one step. This activity provides access to the Form Designer where you can create complex forms collecting multiple pieces of information that can be passed to subsequent activities. Usage: A form could be used, for example, within a 911 incident reporting workflow. You could create a form that would collect all the details about the incident such as the incident type, the incident details, as well as the name, , and phone number of the person reporting the incident. All this information could then be used by an activity that would record that information into a database. In Arguments Input Geometry The geometry that will be used to filter the Query Task (of ComboBox and ListBox). Filter by geometry must be specified in the Form Item. Region Gets or sets the name of the region where the form should be placed. This argument is only valid for viewer technologies that implement the concept of regions, such as the Geocortex Viewer for Silverlight. Instead, you can use the WorkflowContainer property. Workflow Container The name of the workflow container that the visual output of the activity will display in. Misc Display DisplayForm You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments Button Result Value The text of the button that the user clicked on the form. 49

57 Geocortex Workflow Designer 3.7 User Guide Other Properties Design Form Form Preview Buttons Input Data Click to open the Form Designer where you can create or edit a form. In the Form Designer, a dynamic preview of the form as you create it. Opens the Button Editor dialog where you add or remove buttons to display on the form. The ID of the Form Item. A collection of DataItems that will populate the Form Item when the form loads. Display Hyperlink Activity : Displays a hyperlink to the user. This activity allows you to show a message and a configurable hyperlink inside a workflow container. Usage: You could use this activity to present an active hyperlink to the user with an optional message. The link would open a file to download or could be a link to another application Example In Arguments Hyperlink Target Hyperlink Text The name of the frame or window to target with the hyperlink. The alias to apply to the hyperlink. If not specified, the Hyperlink URI is displayed. "_blank" "Click here to download" Hyperlink URI The URI of the hyperlink. " Message The message to display above the hyperlink. "Your data extract is complete." Title The text to display in the title bar. "Extract Data" Workflow Container Misc The name of the workflow container to host the visual output of the activity in. "Default" Display DisplayHyperlink You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain Latitude Geographics Group Ltd. All Rights Reserved.

58 Dynamic External Activity Example External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments Button Result Value Buttons The value of the button that the user clicked on the form. Click to open the Button Editor where you can create or remove a button. Dynamic External Activity : Has input and output arguments that can be defined at design time. This activity is the Swiss Army knife of external activities. It allows inputs and outputs to be created at design time, so you can create an external activity handler without having to use Visual Studio on the server. You still need to handle that activity with custom code on the client. The External ID is used to trigger the correct handler on the client. Usage: Building custom external activities requires the creation of a.net class on the server and custom code on the client (the coding language is dependent on the Client API you are using). The Dynamic External activity eliminates the need for the.net class on the server. Display DynamicExternal You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id Inputs Outputs An activity handler within a client can reference this particular activity using this external identifier. Create Input Argument Create Output Argument 51

59 Geocortex Workflow Designer 3.7 User Guide External Delay Activity : Causes the client application to pause for the specified duration. This activity waits on the client for the specified amount of time before returning to the server and continuing with the next activity. In a Workflow: You might use an External Delay in a loop to have your workflow wake up and perform some logic on an interval. In Arguments Milliseconds The time of the delay set in milliseconds. Misc Display ExternalDelay You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Get Map Extent Activity (New!) : Gets extent of a map in a client application. This activity obtains the current extent of the user s map. In a Workflow: You would use this activity if you need to perform logic based on the user s current extent or provide the current extent as input to another activity such as a query or geometry operation. Misc Display GetMapExtent You can change the name of an activity to one that describes what it does. A Latitude Geographics Group Ltd. All Rights Reserved.

60 Get Map Service Info Activity (New!) descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments Extent The current extent of the map. Get Map Service Info Activity (New!) Tooltip An activity to obtain information about a map service in a client application. This activity allows a workflow to control layer visibilities in the user s map. In a Workflow: You would use this activity if you need obtain information about a client map service, such as its URL, or obtain the Id of a layer in the map service given a layer name. This activity helps avoid configuration problems in workflows when Layer Ids change in an ArcGIS Server map service. In Arguments Map Service Id Layer The id of the map service to retrieve information from. The name of a layer to retrieve the Layer ID for. Misc Display GetMapServiceInfo You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments Map Service Url Proxy Url Layer Id The URL of the map service. The proxy URL of the map service. The id of the layer that corresponds to the supplied layer name. 53

61 Geocortex Workflow Designer 3.7 User Guide Prompt Activity : Displays a prompt dialog in a client application. This activity prompts the user to enter text using a single-line text box. In a Workflow: The Prompt activity is a quick way to get a single piece of information from the user without resorting to the more heavy-weight Display Form activity. This activity does not perform any validation. In Arguments Default Text Title The text of the Prompt dialog. The description on the Prompt dialog. The title of the Prompt dialog. Misc Display Prompt You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments Result The result of the Prompt dialog. Refresh Map Activity : Refreshes a map in a client application. This activity causes the client side map control to refresh itself. You can specify a single map service to refresh or all of the map services currently in use Latitude Geographics Group Ltd. All Rights Reserved.

62 Report Activity In a Workflow: You would use this activity if, in a previous activity, you had made a modification to the data in a layer, and you want to redraw the map layer immediately. In Arguments Map Service ID The ID of the Geocortex map service to refresh. If none is specified, all map services that support refreshing, are refreshed. Misc Display RefreshMap You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Report Activity : Executes a report in a client application. This activity triggers a report to run on the client. The report must exist in the site. Once the report has been run, a download report link displays in the client (optional). The URL of the report is an output of the activity. The URL returned by the report activity is a short-lived URL (5 minutes from time of most recent access). It should not be ed or stored for later use. In a Workflow: The Report activity can be used as the final activity at the end of a complex workflow that guides the user through a set of activities to collect or transform data or a geometry and then finally creates a report on the collected data. In Arguments Custom Extent The custom extent to use for the map rendered in the report if the Report Extent Type property is set to CustomExtent. Geometry The geometry filter to apply to the report data. The spatial relationship as 55

63 Geocortex Workflow Designer 3.7 User Guide specified by spatialrelationship is applied to this geometry while performing the query. The valid geometry types are Envelope, Point, Multipoint, Polyline, or Polygon. Layer Id Layer MapService Id Out Spatial Reference Output Format Report Extent Type Report Id Resolution ShowOpenReport Spatial Relationship The Id of the Geocortex layer the report is in. The name of the Geocortex layer this feature set is related to. If a Layer Id is also supplied the Id will be preferred. (New!) The Id of the Geocortex Map Service this feature set is related to. The spatial reference for the returned geometries in the query to filter the data. If not specified, the geometry is returned in the spatial reference of the containing map. The format of the report output. The extent type to use for the map rendered in the report. The Id of the Geocortex report to run. Image resolution that will be used to print the map image in the report. Indicates if the open report dialog should be shown after the report run has completed. The spatial relationship to be applied to the input geometry filter when performing the query. The default is esrispatialrelintersects. Text Where Shorthand for a literal search text on the display field, equivalent to: where<displayfield>like'%%'. The text is case sensitive. This parameter is ignored if the where parameter is specified. You can determine what the display field is for a layer using the ArcGIS Services Directory. A where clause for the query to get the data. Any legal SQL Where clause operating on the fields in the layer is allowed, for example: where=pop2000> Misc Display Report You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments Result Url The URL to the report that was generated Latitude Geographics Group Ltd. All Rights Reserved.

64 Set Layer Definition Activity (New!) Set Layer Definition Activity (New!) Tooltip Sets the definition expression of an ArcGIS Dynamic map layer in a client application. This activity allows a workflow to control layer definition expressions in the user s map. In a Workflow: You would use this activity if you need to apply a layer definition expression to filter the content of a layer in the user s map. In Arguments Map Service Id Layer Id Layer The id of the Geocortex map service that contains the layer. The id of the Geocortex layer who's definition expression will be set. The name of the Geocortex layer who's definition expression will be set. If a Layer Id is also supplied the Id will be preferred. Visibility The desired layer definition expression. For example: POPULATION > Misc Display ofactivity You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. 57

65 Geocortex Workflow Designer 3.7 User Guide Set Layer Visibility Activity (New!) Tooltip Sets the visibility of a layer in a client application. This activity allows a workflow to control layer visibilities in the user s map. In a Workflow: You would use this activity if you need to show or hide a layer in the user s map. In Arguments Map Service Id Layer Id Layer Visibility The id of the Geocortex map service that contains the layer. The id of the Geocortex layer who's visibility will be set. The name of the Geocortex layer who's visibility will be set. If a Layer Id is also supplied the Id will be preferred. True or False. The desired visibility of the layer. Misc Display SetLayerVisibility You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Set Map Extent Activity (New!) : Sets extent of the map in a client application. This activity changes the extent of the map on the client to a specified extent. In a Workflow: Set Map Extents is usually used after an activity that acquires a new map extent, perhaps through a query or through a union of geometries. The map extent is then sent to the Set Map Extent activity, which sets the map to the given extent. For example, you may use Set Map Extents to zoom to the envelope enclosing a feature Latitude Geographics Group Ltd. All Rights Reserved.

66 Set Map Service Visibility Activity (New!) In Arguments Extent The extent to set the map to, for example, [an existing Esri Geometry].Extent().Expand(2) Be sure that the spatial reference of the extent matches that of the map. Misc Display SetMapExtent You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Set Map Service Visibility Activity (New!) Tooltip Sets the visibility of a map service in a client application. This activity allows a workflow to control the visibility of map services in the user s map. In a Workflow: You would use this activity if you need to show or hide a map service in the user s map. In Arguments Map Service Id The id of the map service who's visibility will be set. Visibility True or False. The desired visibility of the map service. Misc Display SetMapServiceVisibility You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. 59

67 Geocortex Workflow Designer 3.7 User Guide Common Server Activities Assign Activity : Sets Argument values from within a workflow. This activity assigns a value to a variable or to an argument from within a workflow. To Value The name of the variable or argument to assign a value to. The value to assign to the To variable or argument. To set the value to null, use the value Nothing. For more information: Delay Activity : Creates a timer for a specified duration, using a TimerExtension. This activity causes a delay in the workflow for a specified amount of time. In a Workflow: The Delay activity could be used to simulate an activity that takes a certain amount of time to complete. This activity is rarely used in a production workflow. Display Delay You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Duration The amount of time to delay the workflow. For more information: Latitude Geographics Group Ltd. All Rights Reserved.

68 Cast <T> Activity (New!) Cast <T> Activity (New!) : An activity that casts a value to a specified type and assigns it to a variable or argument. This activity allows you to cast an object of a particular type into a different type and assign it to a variable or argument. In a Workflow: A cast is a programming term that refers to the explicit conversion of an object of one data type to another type. You would use this activity to cast a variable value to a different type and assign it to a different variable. This activity is similar to the Assign activity, but in addition, it allows you to perform the desired type conversion operation. For a cast to be valid, the Value must be convertible to the type of the To variable otherwise an System.InvalidCastException will be thrown. In Arguments Value The value to cast and assign to the To variable or argument. Misc Display Cast<T> You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments To The variable or argument to assign the casted value to. For more information: Download String Activity (New!) : Downloads the requested resource at the Uri as a string. This activity allows you to perform an HTTP GET request and download the content of a resource as a string. 61

69 Geocortex Workflow Designer 3.7 User Guide Usage: You would use this activity to download a resource, perform a REST request or interact with a web service. In Arguments Uri The absolute URI of the resource to download. Relative URIs are not supported. Misc Display DownloadString You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Result The string content of the requested resource. Get Current User Activity (New!) : Gets the name of the current user. This activity finds the name of the user who is currently running the workflow. This activity only has access to a user name if the workflow is hosted in a secured Site, or Windows Integrated Authentication is enabled for the host application. When running this activity in the Workflow Designer simulator the user name is shown as the user running the Workflow Designer application. In a Workflow: You would use this activity if you need to perform logic based on the current user or provide the user name as input to another activity such as a database insert. Misc Display GetCurrentUser You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments User the name of the current user Latitude Geographics Group Ltd. All Rights Reserved.

70 Include Workflow Activity Include Workflow Activity : A place holder that allows a designer to include an existing workflow within the current workflow. This activity is used as a place holder for another workflow which is run in its place. This activity can be used until the actual workflow is ready when the Include Workflow activity is replaced with the new workflow. After replacement, the Include Workflow activity is no longer a part of the workflow. The included workflow is copied into the current workflow, it is not referenced, so any changes will not be reflected in the original workflow. In a Workflow: The Include Workflow activity is usually used as a time saver in a workflow, as it makes it possible to re-use existing workflows within a new workflow. Display IncludeWorkflow You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Include Click to select the workflow that you want to include in the current workflow. Invoke Method Activity : Calls a public method of a specified object or type. Calls a specified public instance method of an object or public static method of a type. 63

71 Geocortex Workflow Designer 3.7 User Guide Display InvokeMethod You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. GenericTypeArguments Method Parameters Result RunAsynchronously: The generic type arguments of the contained method. The name of the method to run, specified without parameters. The parameter collection of the method to be invoked. The name of a variable or argument that will hold the return value from the method s execution. True if the method should be run asynchronously, False otherwise. TargetObject If the Method specifies a public instance method, the TargetObject should specify the name of a variable or argument that the method should be invoked upon. One of TargetObject or TargetType must be specified. TargetType If the Method specifies a public static method, the TargetType should specify the type that the method is defined for. One of TargetObject or TargetType must be specified. For more information: Latitude Geographics Group Ltd. All Rights Reserved.

72 Send Mail Activity Send Mail Activity : Sends an . This activity sends an message to specified recipients. In a Workflow: Could be used to send an to an administrator reporting on the successful completion of a workflow, for example, when a report is completed. In Arguments Attachments Bcc Body CC From Subject Test Mail To To Attachment collection used to store data attached to this message. The blind carbon copy (BCC) recipients for this message. Multiple recipients are separated by semicolon (;). The message to send. (Required.) The carbon copy (CC) recipients for this message. Multiple recipients are separated by semicolon (;). The From address for this message. Must be a valid, formatted address. The content to appear in the Subject box of the . (Required.) The recipient of an to test the activity. The recipients of this message. Multiple recipients are separated by semicolon (;). Misc Display SendMail You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Enable SSL Host Is Body Html Password Specifies whether Secure Sockets Layer (SSL) should be used to encrypt the connection. Address of the SMTP server host. Whether the message of the contains HTML formatting. Password to set up the credentials to authenticate the sender with the Host. 65

73 Geocortex Workflow Designer 3.7 User Guide Port User Failed Exception Port of the SMTP service in the Host. User name to set up the credentials to authenticate the sender with the Host. If the attempt to send an fails, the activity will populate this exception. For more information: Sort FeatureSet Activity : Sorts the features of a feature set based on a specified attribute. This activity allows you to sort the features of a feature set in ascending or descending order based on the values of an attribute. In a Workflow: You would use this activity to sort a feature set before displaying it as a result. In Arguments Sort Attribute Sort Direction The name of the attribute to sort on (case sensitive). The sort direction (ascending or descending). In/Out Arguments FeatureSet The FeatureSet to sort. Misc Display SortFeatureSet You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Template Report Activity : Generates template-based reports Latitude Geographics Group Ltd. All Rights Reserved.

74 Template Report Activity This activity generates a report on the server. Using this activity is more complex than using the Report activity. The activity does not generate a URL and data has to be collected using other activities and then passed to the report. In a Workflow: This activity is useful in any scenario where you need fine-grained control over the inputs of a report. This activity usually requires supporting custom code to construct the report data source and to handle the formatted output. In Arguments Data Table The name of the table in the DataSet that contains the data for the report. If a Data Table is not specified the first table in the DataSet will be used. DataRows The DataRows that contain the data for the report. DataSet The DataSet that contains the data for the report. Output Format Template Assembly Template Class Template Uri The output format of the report. The name of the template report assembly. The name of the template report class. The URI of the template report. 67

75 Geocortex Workflow Designer 3.7 User Guide Misc Display TemplateReport You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Report Data The report output as a byte array. Web Request Activity (New!) Tooltip An activity that performs a web request to the resource identified by the specified URI. This activity allows you to send and receive data from a resource identified by a URI. Typically this would be a HTTP GET or POST request. In a Workflow: You would use this activity to make a web request to a resource, such as performing a REST request or interacting with a web service. This activity is similar to the Download String activity, but it offers much more control over the request. In Arguments Headers Uri Values* A collection of header name/value pairs associated with the request. The absolute URI of the resource to make the request to. Relative URIs are not supported. In the designer you will be able to add arbitrary name/value parameters that represent the data to send to the resource. Misc Display WebRequest You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Method The HTTP method used to send the data to the resource. For example: POST or GET. The default is POST Latitude Geographics Group Ltd. All Rights Reserved.

76 Common Viewer Activities Out Arguments Response Headers A collection of header name/value pairs associated with the response. This is an advanced concept. Result A System.Byte array containing the body of the response from the resource. Common Viewer Activities Collect External Event Args Activity : Collects arguments from an external event. This activity works with the Listen for External Event activity. When a listener has been set up, this activity collects the arguments returned by the event. In the Workflow: A workflow using these two activities may consist of a Listen for External Event activity that is set to listen for a tool in the toolbar being used. The Collect External Event Args activity would then collect the name of tool used and send this information to a log file. In Arguments Event Wait for Event Wait Timeout The name of the event to collect arguments for. (Required.) Whether or not to wait for the event to fire before continuing. (Required.) How long, in milliseconds, to wait for the event to fire before timing out and continuing. Misc Display CollectExternalEventArgs You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments 69

77 Geocortex Workflow Designer 3.7 User Guide EventArgs A container object for the actual client object collected from the event. Configure Workflow Container Activity : Configures the workflow container in the viewer. Use this activity to do things like show or hide the workflow container. You can use this activity to control various aspects of the workflow container implemented in a viewer. For example, you could show or hide the container, change the title, configure a visual busy indicator, and change the display message. In a Workflow: Typically, workflow containers are used to display feedback to the user between activities, or at the beginning of the workflow to let the user know that something is happening. This activity could be used to display a "Loading" message to the user while execution of a long-running workflow activity is progressing. This gives the user immediate feedback that something is happening instead of waiting until the long-running activity completes before displaying a result. Workflow Container Icon URI Is Busy Message Show Container Title The name of the client workflow container. The Uri to the icon that will display with the container. Specifies whether or not the client should display a visual indicator that it is busy. The text to display in the workflow container. Specifies whether the workflow container should be shown or hidden. The text to display in the title bar of the workflow container. Misc Display ConfigureWorkflowContainer You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier Latitude Geographics Group Ltd. All Rights Reserved.

78 Display Capture Geometry Activity Display Capture Geometry Activity : Displays a form with a toolbar that allows you to select a geometry based on the configured allowable geometry types. Allows the end user to define a geometry by selecting from a few different geometry types (point, polygon, etc.), with the allowable types defined by this activity. In a Workflow: A workflow could allow the user to choose to extract features within a certain area of interest. This activity could be used to collect that area of interest, where the user can choose between defining the geometry using a rectangle, polygon, or the current extent. In Arguments Geometry Required Graphics Layer Input Geometry Message Required Message Show Captured Geometry Show Captured Message Title Workflow Container Specifies whether a geometry is required, and whether the form should enforce the selection of a geometry. The name of the graphics layer to render the captured geometry in. The pre-determined geometry to use as the initial value for the geometry. Instructional text to explain to the user what they should do. The text to display to the user if they have not selected a geometry and it is required. Specifies whether or not to show the captured geometry on the map. Specifies whether or not to show a message when the user captures a geometry. The text to display in the title bar. The name of the client workflow container in which to display this geometry. Misc Display DisplayCaptureGeometry You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments 71

79 Geocortex Workflow Designer 3.7 User Guide Button Results Value Result The text on the button that the user clicks on the form. The geometry created by the user. In Design Area Geometry Types Markup Layer Buttons The valid geometry types an end user can specify. You can select multiple types. The name of the markup layer to render the geometry in. Opens the Button Editor where you can add or edit buttons. Listen For External Event Activity : Sets up a client side event listener. In order to react to the event actually being raised, the CollectExternalEventArgs activity should be used. This activity prepares the client application to listen for a specified event. The CollectExternalEventArgs activity is then used to collect the event arguments. In a Workflow: A workflow using these two activities may consist of a ListenForExternalEvent activity that listens for a tool selected in a toolbar. A CollectExternalEventArgs activity may then collect the name of the tool used and send this information to a log file. In Arguments Event The name of the external event to listen for. Misc Display ListenForExternalEvent You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier Latitude Geographics Group Ltd. All Rights Reserved.

80 Run External Command Activity Run External Command Activity : Runs a command on the client. The command must exist/be implemented on the client. This activity executes a specified command on the Client. In a Workflow: The Silverlight Viewer contains a command called PanToPoint that accepts an ESRI.ArcGIS.Client.Geometry.Geometry object as its parameter. To invoke this command from within a workflow, you could use the RunExternalCommand activity and specify PanToPoint as the Command and your geometry object as the Command Parameter. The command you wish to invoke must be implemented in the target client application. Not all client application commands can be called from a workflow. In Arguments Command Command Parameter The name of the external command to run. The parameter being passed to the command. Note that not all commands require a parameter. Misc Display RunExternalCommand You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Select Features Activity : Selects the features on the client. This activity is used to add a set of features to the named collection in a client. In the Silverlight Viewer (version 1.1 or above), this activity additionally adds a feature set to the Feature Set Manager for display. 73

81 Geocortex Workflow Designer 3.7 User Guide In a Workflow: A workflow could use a QueryTask to fetch some features, and then use SelectFeatures to display those features in the client. In Arguments Clear Collection First Collection Feature Set Layer Id Layer Map Service Id If set to True, the target feature set collection is cleared before the feature set is added. Otherwise the feature set is left as it is. If the name of a feature set is entered, the Feature Set features are added to the named feature set collection. If not, the default collection is used. The feature set to display. The ID of the Geocortex feature set layer that this feature set is related to. The name of the Geocortex layer this feature set is related to. If a Layer Id is also supplied the Id will be preferred. (New!) The ID of the Geocortex map service that this feature is related to. Misc Display SelectFeatures You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. ArcGIS Server Activities Buffer Task Activity : Uses the ArcGIS Geometry Service to buffer a geometry. This activity applies a buffer around a given geometry surrounding it with a new geometry that should be larger than the initial geometry by a specified distance. In a Workflow: A workflow could consist of an activity that captures a point on the map from the user. The Buffer Task activity would then add a buffer to the point to create a polygon. The polygon could then be used in subsequent activities Latitude Geographics Group Ltd. All Rights Reserved.

82 Difference Task Activity (New!) In Arguments Distance FeatureSet Geometry Geometry service Url Out Spatial Reference Token The distance value that the input features are buffered. A collection of points, multipoints, polylines or polygons. The input types cannot be mixed. The FeatureSet for which all features will be buffered. The geometry to buffer. The URL of the ArcGIS Server Geometry service. For example: The spatial reference for the returned geometries. The token for accessing a secure ArcGIS task. UnionResults If true, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is returned. The default is false. Unit The units for calculating each buffer distance. The units are derived from the input features. Misc Display BufferTask You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Result The resulting buffered geometries. Difference Task Activity (New!) : Uses the ArcGIS Geometry Service to construct the set-theoretic difference between a collection of graphics and a specified geometry. This activity allows you compute the difference between geometries. In a Workflow: You would use this activity to compute the difference between geometries. 75

83 Geocortex Workflow Designer 3.7 User Guide In Arguments Geometry Service Url Geometry FeatureSet Token ProxyUrl The URL of the ArcGIS Server Geometry service. For example: A collection of points, multipoints, polylines or polygons. A single geometry of any type, of dimension equal to or greater than the elements of the FeatureSet. The token for accessing a secured geometry service. The URL to proxy the request through. Misc Display DifferenceTask You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Result The resulting graphics with the computed differences. Generate Token Activity (New!) Tooltip Generates tokens that grant access to secured ArcGIS Server services. This activity will throw a System.Net.WebException "(403) Forbidden" if the credentials are invalid. This activity obtains the a token for accessing secured ArcGIS Server services. In a Workflow: You would use this activity if you need to use another ArcGIS Server activity with a secured service, such as the Query Task activity. This activity will generate the token needed as input to the other activity Latitude Geographics Group Ltd. All Rights Reserved.

84 Geocode Activity In Arguments Token Service Url User Password IP Address Referrer Expiration The Url of the ArcGIS Server token service. For example: The user name for the user on the system. The password for the user on the system. The IP address of the client that will use this token. For example: The base URL of the web application where this token will be used. For example: The duration in minutes specifying how long the token will be valid from the time issued. If this parameter is not included, expiration will use the shortlived token time-out setting. The expiration cannot be longer than the maximum allowed time for a long-lived token. Misc Display GenerateToken You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Token The token generated by ArcGIS Server. Geocode Activity : Performs an ArcGIS Server geocode operation. This activity takes an address and searches for matches using a geocode service. In a Workflow: The Geocode activity usually needs input from the user, so usually a DisplayForm activity would be used to collect an text input (address) from the user and the Geocode activity would then return any matching locations. 77

85 Geocortex Workflow Designer 3.7 User Guide In Arguments Proxy Url Token The URL to proxy the request through. The token for accessing a secure ArcGIS task. Misc Display Geocode You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. GeocodeService Url Outfields The URL of the ArcGIS Server Geocode service. For example: A common-separated list of attribute names to return for each address candidate. Out Arguments Results The collection of address candidates returned from the geocode service. Geoprocessor Activity : Uses the ArcGIS Geoprocessing Service to perform geoprocessing tasks. You can use the Geoprocessing Activity to access a geoprocessing task service in order to either execute a synchronous task or submit a job for a task that will run asynchronously. In a Workflow: You could use this feature to make use of ArcGIS geoprocessing services, for example, the Extract Data geoprocess that allows a user to select an area on a map. The geoprocessor then clips the data from that area and zips it for use later. The Extract Data feature in the Viewer, which is implemented as a workflow, uses this activity Latitude Geographics Group Ltd. All Rights Reserved.

86 Intersect Task Activity (New!) In Arguments Geoprocessor Url Output Spatial Reference Process Spatial Reference Proxy Url Token The URL of the ArcGIS Server Geoprocessing service task. For example: The spatial reference of the output geometries. If this is not specified, the output geometries are in the spatial reference of the input geometries. If ProcessSpatialRference is specified and OutputSpatialRefernce is not specified, the output geometries are in the spatial reference of the process spatial reference. The spatial reference that the model uses to perform geometry operations. If specified, and OutputSpatialReference is not specified, the output geometries are in the spatial reference of the process spatial reference. The URL used to proxy the request through. The token needed to access a secure ArgGIS task. Update Delay The time interval in milliseconds between each job status request sent to an asynchronous geoprocessing task. The default is Misc Display Geoprocessor You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Job Id The unique job ID assigned by ArcGIS for Server. The unique ID is only set if the geoprocessing task runs asynchronously. Intersect Task Activity (New!) Tooltip Uses the ArcGIS Geometry Service to construct the set-theoretic intersection between a collection of graphics and a specified geometry. This activity allows you compute the intersection of geometries. In a Workflow: You would use this activity to compute the intersection of geometries. 79

87 Geocortex Workflow Designer 3.7 User Guide In Arguments Geometry Service Url Geometry FeatureSet Token ProxyUrl The URL of the ArcGIS Server Geometry service. For example: A collection of points, multipoints, polylines or polygons. A single geometry of any type, of dimension equal to or greater than the elements of the FeatureSet. The token for accessing a secured geometry service. The URL to proxy the request through. Misc Display IntersectTask You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Result The resulting graphics with computed intersections. Project Task Activity : Uses the ArcGIS Geometry Service to project a collection of graphics. This activity will take a collection of graphics and apply a geographic projection onto them. You can use this activity to transfer graphics between projection systems. In a Workflow: If your data is in a specific projection for the area your business focuses on, but you then you need to access a layer or service like geocoding that covers a broader geographical region using a different projection, you could use the Project Task activity to convert those results/data to your operation projection Latitude Geographics Group Ltd. All Rights Reserved.

88 Query Task Activity In Arguments FeatureSet Geometry service Url Proxy Url Spatial Reference Token The graphics containing the geometry to project. The FeatureSet for which all feature's geometry will be projected in the desired spatial reference. The URL of the ArcGIS Server Geometry service. For example: sampleserver1.arcgisonline.com/arcgis/rest/services/geometry/geometryserver. The URL used to proxy the request through. The spatial reference to project each feature. The token needed to access a secure ArgGIS task. Misc Display ProjectTask You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Results The graphics that have been projected into a new spatial reference. Query Task Activity : Performs an ArcGIS Server query operation. This activity performs a query task on an ArcGIS map service, stand-alone table, or feature service. It then returns a feature set. In a Workflow: The Query Task activity could be used in a workflow that collected data or geometries from a user using a form, for example. The workflow would then use that data to perform a query using the Query Task activity. Then the results could be sent to the user using the Select Features activity. In Arguments 81

89 Geocortex Workflow Designer 3.7 User Guide Geometry The geometry to apply to the spatial filter. The spatial relationship as specified by spatialrelationship is applied to this geometry while while performing the query. The valid geometry types are Envelope, Point, Multipoint, Polyline, or Polygon. The geometry that will be used to filter the query. Layer Id Obsolete: The ID of the layer to query. Map Service Url Obsolete: The URL of the REST MapService layer to query. Out Fields Attribute fields to include in the FeatureSet. Fields must exist in the map layer. You must list the actual field names rather than the alias names. Returned fields are also the actual field names. However, you are able to use the alias names when you display the results. For optimal results, limit the output fields to only those you expect to use. Each query must have access to the Shape and Objectid Fields for a layer, but your list of fields does not need to include these two fields. To return all fields, specify the wildcard '*' as the value of this parameter. In this case, the query results include all the filed values. Note that the wildcard also implicitly implies returngeometry=true and setting returngeometry to false will have no effect. Out Spatial Reference The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the underlying service. Requires ArcGIS for Server v.10+. Query Service Url The URL of the ArcGIS Server query service. For example: Return Geometry If true, each feature in the FeatureSet includes the geometry. Since the geometry makes up a significant portion of the response, only use when you plan to use the geometry of the feature, for example to include them on a map. By default, this is false. Text Shorthand for a literal search text on the display field, equivalent to: Where <displayfield> like'%%'. The text is case sensitive. This parameter is ignored if the where parameter is specified. You can determine what the display field is for a layer using the ArcGIS Services Directory. Time Extent The time instant or the time extent to query. (New!) Token The token for accessing a secure ArcGIS task. Where A where clause of the query. Any legal SQL where clause operating on the fields in the layer is allowed, for example: where=pop2000 > Misc Latitude Geographics Group Ltd. All Rights Reserved.

90 Relationship Query Task Activity (New!) Display QueryTask You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Max Allowbale Offset Out Spatial Reference WKID Spatial Relationship The maximum allowable offset to be used for generalizing geometries returned by the query operation. (Supported in ArcGIS REST Server v.10+.) The well-down ID of the spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the containing map. The spatial relationship to be held between the input Geometry and each of the returned feature geometries. The default is esrispatialrelintersects. Out Arguments Results The FeatureSet returned by the query task. Relationship Query Task Activity (New!) Tooltip An activity that performs an ArcGIS Server query related records operation. This activity performs a query using a relationship defined in an ArcGIS server map service. This query will relate records with known IDs from one layer or table to records in another layer or table. The nature of the relationship (join) is defined in the map service (MXD). In a Workflow: The Relationship Query Task activity could be used in a workflow where there are known IDs for features of a layer and the map service defines a relationship between those features to some other business data. The known feature IDs are supplied as an argument and the query would return the related records from the other table. In Arguments Query Service Url Token Proxy Url Object Ids Out Fields The URL of the ArcGIS Server query service. For example: The token for accessing a secure ArcGIS task. The URL to proxy the request through. The object IDs of this layer/table to be queried. Records related to these object IDs will be queried. This list is a comma delimited list of object ID integers. The list of fields from the related table / layer to be included in the returned featureset. 83

91 Geocortex Workflow Designer 3.7 User Guide This list is a comma delimited list of field names. To return all fields, specify the wildcard '*' as the value of this parameter. In this case, the query results include all the field values. Note that the wildcard also implicitly implies returngeometry=true and setting returngeometry to false will have no effect. Relationship Id Out Spatial Reference Definition Expression Max Allowable Offset Return Geometry The ID of the relationship to be queried. The relationships that this layer/table participates in are included in the Layer/Table Resource response. Records in tables/layers corresponding to the related table/layer of the relationship are queried. The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the containing map. Note that this parameter only applies to related layers. It will be ignored for related tables. The definition expression to be applied to the related table / layer. From the list of records that are related to the specified objectids, only those records that conform to this expression will be returned. For example: POP2000 > The maximum allowable offset to be used for generalizing geometries returned by the query operation. Requires ArcGIS Server v.10+. If true, each related records includes geometry. Since the geometry makes up a significant portion of the response, only use this when you plan to use the geometry of the feature, for example, to include them on a map. By default, this is true. Misc Display RelationshipQueryTask You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Results The results of the related records query. Reverse Geocode Activity : Performs an ArcGIS Server reverse geocode operation. This activity takes a point and returns the closest address to that point within the specified distance. In a Workflow: A Capture Geometry activity could retrieve a point from the user, perform a reverse geocode, and then use the Report activity to display a property assessment report Latitude Geographics Group Ltd. All Rights Reserved.

92 Reverse Geocode Activity In Arguments Distance Geocode Service Url Location Token The distance in meters from the specified location within which to search for a matching address. The URL of the ArcGIS Server Geocode service. For example: The point at which to search for the closest address. The location should be in the same spatial reference as that of the geocode service. The token for accessing a secure ArcGIS task. Misc Display ReverseGeocode You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Result The address found by the reverse geocode operation. 85

93 Geocortex Workflow Designer 3.7 User Guide Route Task Activity : Find a route between point locations. This activity helps you solve a routing problem by finding a least-cost path between multiple locations using a network service exposed by the ArcGIS Server REST API (available in ArcGIS Server and later). You can route between two or more locations, optionally avoiding barriers, and finding the best sequence and getting driving directions. In a Workflow: This activity is useful in any scenario where you need to generate a route or directions, for example, to determine an optimal route to drive, stopping at a set of defined locations along a road network. In Arguments Proxy Url Route Closest Facility Parameters Route Parameters Route Service Area Parameters Route Service Url Token The URL to proxy the request through. Route Closest Facility Parameters. Parameters indicate guidelines that are required when determining what the route is to the closest facility. The input parameters for the route task. Parameters indicate guidelines that are required when determining what the service area is of each facility. The URL of the ArcGIS Server Route service. For example: The token for accessing a secure ArcGIS Task. Misc Display RouteTask You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Result The route returned by the route task. For more information: tasks/011q / Latitude Geographics Group Ltd. All Rights Reserved.

94 Simplify Task Activity Simplify Task Activity Tool tip: Uses the ArcGIS Geometry Service to alter the given geometries to make their definitions topographically legal with respect to their geometry type. This task may be used to simplify a topologically illegal feature so that it can be used in an application. For example, you may supply a polygon graphic whose outline crosses itself and use this task to break it up into a three-part feature that is legal. In Arguments Geoprocessor Url Graphics Proxy Url Token The URL of the ArcGIS Server Geometry service. For example: sampleserver1.arcgisonline.com/arcgis/rest/services/geometry/geometryserver. A collection of points, multi-points, polylines, or polygons. The input types cannot be mixed. The URL used to proxy the request through. The token needed to access a secure ArcGIS task. Misc Display SimplifyTask You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Result The Esri geometry resulting from the Simplify task. Union Task Activity : Uses the ArcGIS Geometry Service to union a collection of graphics. This activity unions a set of geometries and then returns the resulting geometry (the union of all the geometries in the input collection). In a Workflow: A Union activity could be used after performing Buffer Geometry activity on features in separate layers. The union activity would then be used to combine the 2 areas of the separate buffers into a single geometry. 87

95 Geocortex Workflow Designer 3.7 User Guide In Arguments Feature Set Geometry service Url Proxy Url Token The FeatureSet for which all features' geometry will be unioned. A collection of points, multipoints, polylines or polygons. The input types cannot be mixed. The URL of the ArcGIS Server Geometry service. For example: The URL to proxy the request through. The token for accessing a secure ArcGIS task. Misc Display UnionTask You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Result The Esri geometry resulting from the union task. For more information: Geometry/GeometryServer/union ArcGIS Server Attachments Activities Add Attachment Activity (New!) : Adds an attachment to a feature of an ArcGIS Server feature layer. This activity allows you to upload a file as an attachment to a feature in a feature layer. In a Workflow: You would use this activity to add new files as attachments to a feature in a feature layer Latitude Geographics Group Ltd. All Rights Reserved.

96 Delete Attachment Activity (New!) In Arguments Feature Layer Url Feature Id Token Proxy Url File File Uri Content Type The URL of the ArcGIS Server feature layer. The layer must support attachments. For example: The ID of the feature to add the attachment to. The token for accessing a secure ArcGIS task. The URL to proxy the request through. The name of the attachment. If no value is provided the name of the file from the File Uri will be used. The absolute URI to the file to attach. For example: C:\Temp\MyFile.txt or The MIME type of the file. If no value is provided the content type will be derived from the extension of the file name. Misc Display AddAttachment You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Result The attachment operation result. Delete Attachment Activity (New!) : Deletes attachments from a feature of an ArcGIS Server feature layer. This activity allows you remove attachments from a feature in a feature layer. In a Workflow: You would use this activity to remove file attachments of a feature in a feature layer. 89

97 Geocortex Workflow Designer 3.7 User Guide In Arguments Feature Layer Url Feature Id Token Proxy Url Attachment Ids The URL of the ArcGIS Server feature layer. The layer must support attachments. For example: The ID of the feature to add the attachment to. The token for accessing a secure ArcGIS Server feature layer. The URL to proxy the request through. The IDs of the attachments to delete. Misc Display DeleteAttachment You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Results The attachment operation result. Query Attachment Infos (New!) : Queries for the list of attachments of a feature of an ArcGIS Server feature layer. This activity allows you to obtain information about the file attachments of a feature in a feature layer. In a Workflow: You would use this activity to discover the file attachments of a feature in a feature layer Latitude Geographics Group Ltd. All Rights Reserved.

98 Geometry Activities In Arguments Feature Layer Url Feature Id Token Proxy Url Attachment Ids The URL of the ArcGIS Server feature layer. The layer must support attachments. For example: The ID of the feature to add the attachment to. The token for accessing a secure ArcGIS Server feature layer. The URL to proxy the request through. The IDs of the attachments to delete. Misc Display QueryAttachmentInfos You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Results The attachments of the specified feature. Geometry Activities Get FeatureSet Extent Activity : Gets the union of the extents of the geometries in an ArcGIS Server FeatureSet or collection of Graphics. This activity provides a simple way to determine the combined extent of all the features in a FeatureSet. In a Workflow: In a workflow, it is very common to perform a query to obtain a FeatureSet. You then want to zoom the map to the extent of all the features. The GetFeatureSetExtent activity loops through all the features in the FeatureSet and calculates the combined extent. This is possible using multiple activities running a loop, but the GetFeatureSetExtent activity simplifies the process. 91

99 Geocortex Workflow Designer 3.7 User Guide In Arguments FeatureSet The name of the feature set or collection of graphics to get the collection of graphics from which to extract the extent. Misc Display GetFeatureSetExtent You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id Out Arguments Result The extent of the feature set. Get Geometries Activity : Gets the ArcGIS Server geometries from a FeatureSet. This activity extracts geometries from a feature set so that they can be used by other activities. In a Workflow: The Get Geometries activity could be used with the Query Task and the For Each activities. A Query Task activity would generate a feature set. The Get Geometries activity would then extract those geometries from the feature set so that the For Each activity could process each geometry in the feature set. In Arguments Feature Set The Esri FeatureSet to get the geometries from. Misc Display GetGeometries You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Out Arguments Result The collection of geometries Latitude Geographics Group Ltd. All Rights Reserved.

100 Collections Activities Collections Activities Add To Collection <T> Activity : Adds an item to a specified collection. Adds a new item to an existing collection. In a Workflow: A collection is an array objects. For example, if you want to create buffers at three user-defined distances, you could: Create a collection of type int32. Use the AddtoCollection activity to store the user input values in the collection. Use the For Each activity to access each value. Tips/Example Collection The Collection to add an Item to. The type of elements held in the Collection are specified by the TypeArgument. This activity requires a variable to hold the collection. The variable must already exist. Collection variables are arrays (fixed length) by default. So to create a collection with a dynamic length allow the addition or removal of items use the variable type: System.Collections.Generic.List<T>. Display AddToCollection<Int32> You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Item The Item to add to the Collection. Item must be of the type specified by TypeArgument. TypeArgument The type of the elements in the Collection. From the drop-down list, choose the data type you wish to use (i.e. int32, String, etc) for the items in the collection. When a collection variable is created, it must be initialized, so give the variable an initial value such as: "New List(Of String) 93

101 Geocortex Workflow Designer 3.7 User Guide For more information: Clear Collection <T> Activity : Clears a specified collection of all items. Removes all the items from an existing collection. Collection The Collection to clear all elements from. The type of the elements held in the Collection are specified by the TypeArgument. Display ClearCollection You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. TypeArgument The type of the elements in the Collection. For more information: Exists In Collection <T> Activity : Indicates whether a given item is present in the given collection. Identifies whether an item is within the given collection and returns a value of true or false accordingly. In a Workflow: This activity can be used to check for or find particular items in a collection and then be combined with the ForEach activity to determine if any of the items in one collection are also present in another collection. Collection The Collection to search for a specified Item. The type of the elements held in the Collection are specified by the TypeArgument. Display ExistsInCollection<T> Latitude Geographics Group Ltd. All Rights Reserved.

102 Remove From Collection <T> Activity You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Item The Item to test for existence within the Collection. Item must be of the type specified by TypeArgument. Result (Out Argument) True if the Item exists within the Collection, False otherwise. TypeArgument The type of the elements in the Collection. For more information: Remove From Collection <T> Activity : Removes an item from the specified collection. Removes one item from the specified collection. Collection The Collection to remove a specified Item from. The type of the elements held in the Collection are specified by the TypeArgument. Display RemoveFromCollection<T> You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Item The Item to remove from the Collection. Item must be of the type specified by TypeArgument. Result (Out Argument) True if the Item exists within the Collection, False otherwise. TypeArgument The type of the elements in the Collection. For more information: 95

103 Geocortex Workflow Designer 3.7 User Guide Error Handling Activities Rethrow Activity : Throws a previously thrown exception from within the Catch block of a TryCatch activity. Alerts the system of a user-defined error that occurs during the execution of the Catch block of a TryCatch activity. Display Rethrow You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. For more information: Terminate Workflow Activity This workflow should only be used to end a workflow when an error has occurred. : Terminates the running workflow instance, raises the Completed event in the host, and reports error information. Once the workflow is terminated, it cannot be resumed. Terminate workflow is used to cleanly exit the workflow after an exception has been caught. Display TerminateWorkflow You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Exception Reason Gets or sets the exception that provoked the instance termination. A string input argument with the reason for the workflow instance termination Latitude Geographics Group Ltd. All Rights Reserved.

104 Throw Activity For more information: Throw Activity : Throws an exception. Alerts the system of a user defined error. In a Workflow: Throw could be used within a workflow to indicate that a problematic condition has occurred. For example, if a user specifies an input value that is illegal in an application, then the part of the workflow that handles validation of user input could identify this value as illegal (possibly using an If activity) and throw an exception using the Throw Activity. Display Throw You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Exception The exception thrown by the activity. For more information: 97

105 Geocortex Workflow Designer 3.7 User Guide Try Catch Activity : Contains workflow elements to be executed by the workflow runtime with an exception handling block. Errors occur when a workflow cannot run as intended. The TryCatch activity makes it possible to undertake corrective action when an error occurs. Potentially errant activities can be placed in the Try block. If an error occurs, the activities in the Catch block will be executed. Activities within the Finally block will be executed when the Try and any necessary activities in the Catch block complete execution. The TryCatch activity does not catch exceptions thrown by external activities. In a Workflow: If you wish to run a query on a map service that is intermittently unavailable, you could put a Query Task Activity in the Try block of a TryCatch, and add an Alert activity and a TerminateWorkflow activity in the Catch block. If the service is down, an exception will be raised by the Query Task and handled within the Catch block by rendering an alert to the user and then terminating the workflow. Display TryCatch You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Try Catches Finally The workflow element first executed when the TryCatch executes. The collection of Catch elements to be checked when the Try activity throws an exception. The workflow element to be executed when the Try, and any necessary activities in the Catches collection, complete execution. For more information: Latitude Geographics Group Ltd. All Rights Reserved.

106 Debugging Activities Debugging Activities Log Activity : Writes a message to the system or access log. This activity writes an entry in the Geocortex Log system. This activity has an optional log level that can be set allowing logs to be written to the log if the entry level is of sufficient priority In a Workflow: This activity can be used to provide invaluable feedback when writing workflows. It is also useful in a production workflow to keep track of the success or failure of different parts of the workflow. In Arguments Message The message that will be logged. Misc Display Log You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Log Level Log Type The log level options for the message. Possible log levels in order of increasing priority are: debug, info, warn, error, fatal, off. If the configured log level for your instance of Geocortex Essentials is of a lower or equal precedence to that set for this log activity, the message will be logged. Indicates whether the Message will be logged to the System or Access log. Write Line Activity : Writes a specified string to a TextWriter object. This activity writes text to the specified Text Writer or to the Workflow Designer Simulator output window. 99

107 Geocortex Workflow Designer 3.7 User Guide In a Workflow: This activity provides immediate feedback when you are troubleshooting a workflow in the Workflow Designer Simulator. For example, the WriteLine activity can be used in the design phase of a workflow and to verify variable names. Display Writeline You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Text TextWriter The text to write. The TextWriter to write the Text to. Modeling Activities Client Placeholder Activity : A place holder for an activity that runs in a client application. This activity does nothing. Its function is to indicate that a client activity will be used at this place in a workflow at some point. In a Workflow: When designing a workflow, it may not be possible to have all the custom activities built right away. A place holder can be used to show where in the workflow the custom activity will be. Display A client placeholder is used to temporarily replace a custom activity during design. ClientPlaceHolder You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier Latitude Geographics Group Ltd. All Rights Reserved.

108 Server Placeholder Activity Server Placeholder Activity : A place holder for an activity that runs on the server. This activity does nothing. Its function is to indicate that a server activity will be used at this place in a workflow at some point. In a Workflow: When designing a workflow, it may not be possible to have all the custom activities built right away. A place holder can be used to show where in the workflow the custom activity will be. Display A server placeholder is used to temporarily replace a custom activity during design. ServicePlaceHolder You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. Transfer From Client <T> Activity : An activity that transfers arbitrary data from a client application to the server. This activity provides a simple way to send a object that is serializable from the client to the server. A custom handler must be provided on the client to process this activity and provide the data object. In a Workflow: This activity is useful in any scenario where you need to pass a single object or value from the client application to the server. 101

109 Geocortex Workflow Designer 3.7 User Guide Misc Display TransferFromClient<Int32> You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier. Out Arguments Data The data coming from the client Transfer To Client <T> Activity : An activity that transfers arbitrary data from the server to a client application. This activity provides a simple way to send an object from the server to the client. A custom handler must be provided on the client to process this activity. The Dynamic External Activity can accomplish the same thing with multiple objects at once. In a Workflow: This activity is useful in any scenario where you need to pass a single object or value from the server to the client application. In Arguments Data The data content being sent to the client Misc Display TransferToClient<int32> You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. External Id An activity handler within a client can reference this particular activity using this external identifier Latitude Geographics Group Ltd. All Rights Reserved.

110 Conversion Activities Conversion Activities Object To DataItem Activity : Create a DataItem object from an arbitrary object. This activity allows a DataItem to be created from an arbitrary object. DataItems can be used as input for certain Form elements such as ComboBox items (as a collection of DataItems). In a Workflow: You would use this activity to compute the difference between geometries. In Arguments Object The object to convert to a DataItem. Misc Display ObjectToDataItem You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. DisplayProperty ValueProperty The name of the property of the Object that will contain the Display data. The DisplayProperty of the Object should be of type string. The name of the property of the object that will contain the Value data. The ValueProperty of the Object can be of any type, but should be Data Contract Serializable if you intend to send the output DataItem to the client. Out Arguments DataItem The new DataItem that is a composite of the DisplayProperty and ValueProperty property values of the Object. List To Data Item List Activity : Create a list of DataItems from an arbitrary list of objects, preserving the type of the item. This activity allows a List of DataItems to be created from a list of arbitrary objects. DataItems can be used as input for certain Form elements such as ComboBox items (as a collection of DataItems). 103

111 Geocortex Workflow Designer 3.7 User Guide In a Workflow: Given a list (IEnumerable) of objects of any type, this activity can convert those objects into a list of strongly-typed DataItems, with a value and display name. DataItems can be used as input for certain Form elements such as ComboBox items (as a collection of DataItems). The objects in the list can either have defined values and display name properties, or they can be directly converted to strings with the ToString() method. In Arguments List The list of arbitrary items to be converted into a list of the DataItem objects. Misc Display ListToDataItemList You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain. DisplayProperty The name of the property of the Object that will contain the Display data. The DisplayProperty of the Object should be of type string. ValueProperty The name of the property of the object that will contain the Value data. The ValueProperty of the Object can be of any type, but should be Data Contract Serializable if you intend to send the output DataItem to the client. Out Arguments DataItemList The new list of DataItem objects, suitable to be passed into a form input. Obsolete Activities ArcGIS -> Geocortex Geometry Activity (Obsolete) : Converts an ArcGIS client geometry to a Geocortex geometry. This activity is obsolete. Please use Geocortex.Workflow.ArcGisClientGeometryConverter.FromArcGisClientGeometry(ESRI.ArcGIS.Client.Geometry.Geometry input). Buffer Geometry Activity (Obsolete) : Buffers a Geocortex geometry by a specified distance. This activity is obsolete. Please use Buffer Task Activity on page Latitude Geographics Group Ltd. All Rights Reserved.

112 Geocortex Geometry -> ArcGIS Activity (Obsolete) Geocortex Geometry -> ArcGIS Activity (Obsolete) : Converts a Geocortex geometry to an ArcGIS client geometry. This activity is obsolete. Please use Geocortex.Workflow.ArcGisClientGeometryConverter.ToArcGisClientGeometry(Geocortex.Gis.Geometries.Geometry input). Merge Geometries Activity (Obsolete) : Merges multiple Geocortex geometries into a single geometry. This activity is obsolete. Please use Union Task Activity on page

113 Create Forms Create Forms About Forms In the Toolbox in the Common Client section, you will find the Display Form activity.this activity contains within it the Form Designer, where you can build simple or complex forms to display to users in order to inform, instruct, request a response, or display outputs. The Form Designer is a key element in creating workflows that require interactions with users. To open the Form Designer: 1. From the Common Client section of the Toolbox, drag a Display Form activity into the design area. Drag the Display Form activity into a workflow The Display Form activity contains a number of features that help you to create a form. The DisplayForm activity is the shell inside which you create a form. The Design Form button opens the Form Designer where you design and configure the form. The Form Preview displays the form as the user will see it. As you enter properties, the Form Preview updates to include them. DisplayForm activity The Workflow Container displays the name of the container surrounding the form. It must first be configured in the Viewer. The Input Geometry is an option that specifies a spatial extent, for example, a polygon, for a form to act on. The Buttons feature opens the Button Editor where you add buttons and define their properties and function. 106

114 Geocortex Workflow Designer 3.7 User Guide Searches in a Form In the Form Designer, an item queries based on the value input by the user by using {0} so: To search for: Records matching the name selected by the user: Use this syntax: LIKE '{0}' Form Designer Interface The Form Designer is where you design and build forms to use in your workflow. First you select a Form Item the type of form you plan to use in your workflow. For each form item, you then define the properties and parameters to control the flow of data into and out of your form. The Add/Remove Form Items area is where you add and arrange items such as fields and controls to your form. As you add items, they appear in the Form tree-view. You can click the Move Up and Move Down buttons to change the order of the Form Items, or click Remove to delete them. The properties/parameters of a form element appear in this panel when you select the Form Item in the Form tree. The properties change depending on the type of Form Item selected. The Preview of the Form Item updates as you change any properties that will be visible on the final form, for example, the Label. See also... About Forms on page Latitude Geographics Group Ltd. All Rights Reserved.

115 Form Items Form Items There are a number of different types of forms that you can create in the Form Designer. Each is listed in the Forms drop-down list when you click the plus icon beside Group1. List of Form Items in the Form Designer You can include several different kinds of items in a form, including: AutoComplete: A special type of ComboBox that automatically presents a narrower selection based on the first letters typed into the box. For example, in a box where you have to select a country, if you type in "c" only the names of countries beginning with "C", such as Canada, Cambodia, Cameroon, etc., are presented. If you type in "Ce", the list narrows to a single country that begins with these letters - Central African Republic. This makes selection in long lists much easier for the user. AutoComplete form item to select a country CheckBox: A square box that is selected or cleared to turn an option on or off. When you select it, a check mark appears inside the box. You can select more than one. A label that describes what the checkbox does is shown beside the checkbox. 108

116 Geocortex Workflow Designer 3.7 User Guide Checkbox to select road closure type ComboBox: A text box that has an attached list. You can either select an item from the list, or type a value into the box. More than two comboboxes can be set in a cascading chain. A ListBox can be substituted for a ComboBox in cascading chain, on condition that it is only a singleselect ListBox. Autocomplete can also participate in cascading chain as the source. ComboBox to select a font Date Picker: A control that is used to display a calendar so that you can select a date. There is a time component option, which so this control can include a time picker with the date picker. You can set a default date for the Date Picker in the form. DatePicker for selecting a date Group: The ability to group several controls under a heading and arrange them horizontally or vertically Latitude Geographics Group Ltd. All Rights Reserved.

117 Form Items GroupBox: A frame or box that encloses a group of fields or options, usually with a faint gray line and a caption. It is a visual marker only, used to set apart a group of controls that work together. It indicates where a group of controls should or must be treated as one entity. GroupBox around a set of radio buttons Hyperlink: The Hyperlink form item displays a hyperlink. When clicked, the Hyperlink, navigates to an external Web page. The URI for the Hyperlink is set in the Navigate Uri property. The Target Window property specifies the target window or frame that the page should open in. The hyperlink form item returns a boolean value to the server indicating the user navigated to the the link or not. Image: A form item that is a control to display an image. The height and width of the image can be configured. If the height and width are not set, the image displays using the dimensions of the source image file. If the height and width set are different from the original image, it is scaled to fit and the aspect ratio maintained. If the Source Uri property is set to an invalid location, the image is not displayed.this image form item does not return any value to the server. ListBox: Any type of box containing a list of items the user can select. The user cannot type a selection into the list box like you can with a ComboBox. In some list boxes you can select only one item. In others you can select several items. In workflow, both single and multiple selections are supported. To select multiple items, hold down the Control or Shift key and select other options by clicking them. ListBox to select an image format RadioButton: Radio buttons are also referred to as Option buttons as they usually present a set of options to select that are mutually exclusive (you can only choose one). They are usuallly round buttons that darken when you select one. Radio buttons allow the selection of only one option TextArea: A multi-line box where you can type text that wraps to stay within the boundaries of the box. Some TextAreas limit the amount of text to a set number of words. Other TextAreas allow unlimited text. In this case, the text scrolls as you type. 110

118 Geocortex Workflow Designer 3.7 User Guide TextArea to collect information about issues with software. TextBox: A single-line box that allows the user to type in text information that will be used by the program. Only one line of text is allowed. TextBox to get the minimum property value from the user TimePicker: The TimePicker form item enables users to select a time of day within a form. It contains an editable text box allowing the user to type the time of day directly into the control. The time of day can be selected from the suggestion list found in the drop down. TimePicker may include up/down support using the keyboard or the up/down buttons. The Time Format can be configured to be either Short or Long. TimePicker control See also... About Forms on page 106 Form Designer Interface on page Latitude Geographics Group Ltd. All Rights Reserved.

119 Use the Workflow Simulator Use the Workflow Simulator About the Workflow Simulator The Workflow Designer has a built-in simulator that enables you to run workflows in a simulated environment. The simulator makes it possible to test your workflow step-by-step and fix any issues before you deploy it. Testing Workflows Typically, you go back and forth between designing a workflow and simulating it. You use the simulator to test and refine your workflow as you go. In other words, run the simulator to test your workflow, return to the design interface to make modifications, run the simulator again, and so on, until you are satisfied that your workflow does what you expect it to. The best way to learn about the simulator is by following a step-by-step example. The Simulator Interface This section describes Workflow Designer's simulator interface. For information about the Designer interface, see Workflow Designer Interface. Simulator interface 112

120 Geocortex Workflow Designer 3.7 User Guide The numbers in the screen shot correspond to the numbers in the table below. # Component Menu bar In the simulator, you have access to the Help menu and Logging menu. Having access to the Logging menu means you can change the application log level while your workflow is executing, to help with debugging. Ribbon The ribbon contains controls to start the workflow running, stop the workflow, and exit the simulator. Workflow view Workflow Console Output area The workflow image is the same image that appears in the design area, except that in the simulator it is read-only and shows a trace of the executing activities. This makes it easy to follow the execution path through the workflow. The activity that is currently executing is framed in yellow. The Workflow Console simulates the client. When the user or client application is prompted for input, you have to play the role of the client by entering the input into the Workflow Console. You click the Start icon to begin a workflow or resume a workflow that is paused and accepting client input. The Workflow Console also has an Advanced View tab that shows the JSON of communications from the server to the client. The Output area provides a textual trace of the execution. Log and WriteLine activities output to the Output area. See Also... About the Workflow Simulator on page 112 Open the Simulator To start the simulator: 1. Click the Start Simulator icon in the Designer's ribbon Start and Stop a Workflow Simulation You use the Start and Stop icons in the simulator's ribbon to start and stop the execution of your workflow. Use the Start button to launch the workflow or to resume after it has paused to interact with the user on the client. Use the Stop function to halt the workflow. You cannot resume after the workflow has stopped. You can stop your workflow when: The workflow completes. An error occurs. You want to halt execution Latitude Geographics Group Ltd. All Rights Reserved.

121 Run a Simulation Run a Simulation It is easier to understand how the Simulator works when you experience it. This topic walks you through a simple workflow as it executes in the Simulator. The workflow prompts the user for their name, then echoes it back to the user in an Alert. The workflow then writes the name to the Output area in the Simulator. The Ask For User Workflow used in the simulation Remember that in the Simulator, client-side interactions appear in the Workflow Console and server-side logging and actions appear in the Output area. To run a workflow through the Simulator: 1. In Workflow Designer, ensure that the workflow you want to run is open. 2. In the ribbon, click the Start Simulator icon 114

122 Geocortex Workflow Designer 3.7 User Guide The workflow opens in the Simulator The workflow view is read-only in the simulator you cannot edit it. 3. To begin the simulation, click Start. All workflows start with the outermost activity, which in this case, is a Sequence activity renamed to Ask for User. A yellow border surrounds each activity as it executes and a yellow arrow points to the activity name. For some activities, the yellow border moves quite quickly. The first activity running in the simulator Latitude Geographics Group Ltd. All Rights Reserved.

123 Run a Simulation The simulation pauses when it reaches an activity that requires user input. In this workflow, it pauses at the Prompt: Ask for user's name activity. If you look in the Workflow Console, you can see that the workflow has paused, as the Workflow Status is: WaitingForExternalActivities. The field contains the prompt that would be displayed to the user in the Viewer. The workflow pauses at the Prompt activity 3. To simulate the user's response, type the name Kelly in the Result box under Outputs. 4. Optional advanced step If you click the Advanced View tab in the Workflow Console, in the Output area, you see the line: External Activity : ** bytes received by client. External activity line in the Output area. The Advanced tab in the Workflow Console shows the JSON sent from the server to the client: The JSON provides the client application with the information about the state of the workflow, as well as the list of activities that the client needs to execute. If you are comfortable with JSON, you can edit the Advanced View JSON to simulate the response from the client to the server. But, in most cases, it is much easier to do this using the Basic View. JSON for Prompt in the Advanced tab The code below is indicating that the workflow has paused to get input from the user: "status" : "WaitingForExternalActivities" "Prompt" 116

124 Geocortex Workflow Designer 3.7 User Guide 5. To re-start the simulation, click the Start icon. This simulates the client application submitting it's response. The workflow continues with the If: User's responses activity. Because we typed in a response, the condition has been met, so the Then clause executes. The Then clause displays an Alert to the user and pauses again. The Text field contains the text of the alert: Kelly is a nice name! The If activity running in the simulator 6. To resume the simulation, click the Start icon. The workflow continues execution at the second If activity. The Output area shows the result of the WriteLine: The user's name is Kelly The Workflow Completed line indicates that the worklow is done. The Writeline activity completes the workflow 7. Click the Start icon to rerun the workflow or click the Exit icon to exit the Simulator and return to the Workflow Designer. See also... The Simulator Interface on page 112 Open the Simulator on page Latitude Geographics Group Ltd. All Rights Reserved.