IMPORT AND UPDATE. This manual covers the Import and Update tool. Version: 2017

Similar documents
TRAINING GUIDE. Overview of Lucity Spatial

Using the Swiftpage Connect List Manager

These tasks can now be performed by a special program called FTP clients.

Using the Swiftpage Connect List Manager

ClassFlow Administrator User Guide

STIDistrict AL Rollover Procedures

CaseWare Working Papers. Data Store user guide

ROCK-POND REPORTING 2.1

TRAINING GUIDE. Lucity Mobile

Integrating QuickBooks with TimePro

Outlook Web Application (OWA) Basic Training

I - EDocman Installation EDocman component EDocman Categories module EDocman Documents Module...2

REFWORKS: STEP-BY-STEP HURST LIBRARY NORTHWEST UNIVERSITY

Enabling Your Personal Web Page on the SacLink

BANNER BASICS. What is Banner? Banner Environment. My Banner. Pages. What is it? What form do you use? Steps to create a personal menu

The Reporting Tool. An Overview of HHAeXchange s Reporting Tool

Proper Document Usage and Document Distribution. TIP! How to Use the Guide. Managing the News Page

Adverse Action Letters

Campuses that access the SFS nvision Windows-based client need to allow outbound traffic to:

MOS Access 2013 Quick Reference

Please contact technical support if you have questions about the directory that your organization uses for user management.

INSTALLING CCRQINVOICE

Wave IP 4.5. CRMLink Desktop User Guide

MyUni Adding Content. Date: 29 May 2014 TRIM Reference: D2013/ Version: 1

Copyrights and Trademarks

Exporting and Importing the Blackboard Vista Grade Book

August 22, 2006 IPRO Tech Client Services Tip of the Day. Concordance and IPRO Camera Button / Backwards DB Link Setup

INSERTING MEDIA AND OBJECTS

Constituent Page Upgrade Utility for Blackbaud CRM

TRAINING GUIDE. Crystal Reports for Web

Exosoft Backup Manager

BI Publisher TEMPLATE Tutorial

Relius Documents ASP Checklist Entry

RISKMAN REFERENCE GUIDE TO USER MANAGEMENT (Non-Network Logins)

Graduate Application Review Process Documentation

Procurement Contract Portal. User Guide

Using MeetingSquared as an Administrator

Class Roster. Curriculum Class Roster Step-By-Step Procedure

WorldShip PRE-INSTALLATION INSTRUCTIONS: INSTALLATION INSTRUCTIONS: Window (if available) Install on a Single or Workgroup Workstation

$ARCSIGHT_HOME/current/user/agent/map. The files are named in sequential order such as:

InformationNOW Letters

1on1 Sales Manager Tool. User Guide

Renewal Reminder. User Guide. Copyright 2009 Data Springs Inc. All rights reserved.

CLIC ADMIN USER S GUIDE

Municode Website Instructions

Xerox Phaser 3635 MFP User Instructions

DIVAR IP 3000 Field Installation Guide

Enterprise Installation

Area Governors Module

InformationNOW Letters

EBSCOhost User Guide Print/ /Save. Print, , Save, Notetaking, Export, and Cite Your Search Results. support.ebsco.com

Entering an NSERC CCV: Step by Step

Tips For Customising Configuration Wizards

Announcing Veco AuditMate from Eurolink Technology Ltd

Network Rail ARMS - Asbestos Risk Management System. Training Guide for use of the Import Survey Template

InformationNOW Standardized Tests

OASIS SUBMISSIONS FOR FLORIDA: SYSTEM FUNCTIONS

Element Creator for Enterprise Architect

E2Open Multi-Collab View (MCV)

VISITSCOTLAND - TOURS MANAGEMENT SYSTEM Manual for Tour Operators

Gmail and Google Drive for Rutherford County Master Gardeners

AvePoint Perimeter Pro 1.9

Element Creator for Enterprise Architect

STIQuery Basics. A second example is included at the end of this document.

CROWNPEAK DESKTOP CONNECTION (CDC) INSTALLATION GUIDE VERSION 2.0

InformationNOW Letters

Secure File Transfer Protocol (SFTP) Interface for Data Intake User Guide

IMPORTING INFOSPHERE DATA ARCHITECT MODELS INFORMATION SERVER V8.7

Moving your MedicalDirector Clinical / PracSoft Data to a New Server

Manual for installation and usage of the module Secure-Connect

Whitepaper. Migrating External Specs to AutoCAD Plant 3D. Set Up the Required Folder Structure. Migrating External Specs to AutoCAD Plant 3D

The screenshots/advice are based on upgrading Controller 10.1 RTM to 10.1 IF6 on Win2003

TRAINING GUIDE. Geodatabase Configuration Tool Overview

UiPath Automation. Walkthrough. Walkthrough Calculate Client Security Hash

Summary. Server environment: Subversion 1.4.6

Your Project Plan and Smartsheet

Kaltura MediaSpace User Manual. Version: 4.6

TRAINING GUIDE. Work Flow Setup

Managing Your Access To The Open Banking Directory How To Guide

Backup your Data files before you begin your cleanup! Delete General Ledger Account History. Page 1

Delete General Ledger Account History

Importing data. Import file format

161 Forbes Road Braintree MA Phone: (781) Fax: (781) What's in it? Key Survey & Extreme Form

To start your custom application development, perform the steps below.

INFocus Health Screenings Report

TRAINING GUIDE. Lucity Geodatabase Configuration Tool

RxAXIS Security Module 09/25/2013

Uploading Files with Multiple Loans

TRAINING GUIDE. Geodatabase Configuration Tool Overview

VMware AirWatch Certificate Authentication for Cisco IPSec VPN

TRAINING GUIDE. Lucity Geodatabase Configuration Tool

User Guide. Document Version: 1.0. Solution Version:

USER MANUAL. RoomWizard Administrative Console

Backing Up and Restoring Assured Complete

UnivRS Information Guide: CV Activities and Contributions

Scroll down to New and another menu will appear. Select Folder and a new

PowerTeacher Classroom Management Tool Quick Reference Card

What s New in Banner 9 Admin Pages: Differences from Banner 8 INB Forms

TaiRox Mail Merge. Running Mail Merge

Dear Milestone Customer,

Transcription:

IMPORT AND UPDATE This manual cvers the Imprt and Update tl. Versin: 2017

CONTENTS WELCOME... 1 Imprt and Update... 2 Tlbar and Header... 3 General Tab... 6 Data Surce Tab... 8 Mapping Tab...13 Crrelatins Tab...20 PrePrcessing Tab...22 PstPrcessing Tab...24 Prcessed Tab...26 Frmulas...38 Reserved Wrds...40 INDEX...55 WELCOME Welcme t the Imprt and Update help guide, which explains hw t use the Imprt and Update tl.

Past Help Guide Versins Versin 2016r2 (http://help.lucity.cm/webhelp/v165/imprt) Versin 2016 (http://help.lucity.cm/webhelp/v160/imprt) Versin 2015r2 (http://help.lucity.cm/webhelp/v155/imprt) Versin 2015 (http://help.lucity.cm/webhelp/v150/imprt) Versin 2014r2 (http://help.lucity.cm/webhelp/v145/imprt/) Help File Versin 2017 IMPORT AND UPDATE The Imprt and Update tl is designed t: imprt data sets frm an external surce int individual Lucity tables; imprt multiple data sets frm an utside surce int multiple Lucity tables in a specific rder; and update recrds in Lucity tables with new data frm an utside surce. Overview Vide Launching the Imprt and Update There are tw ways t run the Imprt and Update tl: 1) Frm the Lucity Desktp - In the main menu, click General > Imprt & Update. 2) Manually - Find the lcatin in which Lucity Desktp was installed n the machine. Open the bin flder, and duble-click n Lucity.ImprtAndUpdate.exe. Users must have the Admin > Imprt and Update > Run permissin t lgin t this tl. 2

TOOLBAR AND HEADER At the tp f the Imprt and Update tl is a tlbar that allws users t add imprt cnfiguratins and t lcate and use existing cnfiguratins. 3

Navigatin Keys Add New Add Template Enable users t navigate between saved settings. The Add New buttn adds a new blank imprt cnfiguratin. The drp dwn arrw gives the ptin t Add Template. This adds a new imprt cnfiguratin based n a template. This requires the Admin > Imprt and Update > General - Add permissin. Edit Cnfiguratin Mdifies the current imprt cnfiguratin. This requires the Admin > Imprt and Update > General - Edit permissin. Save Cnfiguratin Save as Template Cancel Edits Imprt Recrds Imprt Grup Delete Cnfiguratin The Save buttn saves any changes made t the current imprt cnfiguratin. The drp dwn arrw gives the ptin t Save As Template. This saves the current cnfiguratin as a template which yu can then lad later t create new cnfiguratins. Revkes any edits made and exits edit mde fr the current imprt cnfiguratin. The Imprt buttn runs the current imprt cnfiguratin. The drp dwn arrw gives the ptin t Grup Imprt. multiple imprts tied t the current imprt cnfiguratin. Deletes the current imprt cnfiguratin. This runs This requires the Admin > Imprt and Update > General - Delete permissin. Scheduler Schedules the imprt and update t be run by the Lucity Services n a scheduled basis. Change Lgin Enables the user t lg in as a different user. This feature is disabled if the tl was launched frm inside Lucity Desktp. Setting Setting Selectr Enables users t quickly select a saved imprt cnfiguratin. Imprt Name ** Imprt Descriptin Exprt Cnfiguratin Email Lucity Exprts an.xml cpy f the Imprt and Update cnfiguratin. Launches an email message t Lucity Supprt with attached cpies f the Imprt and Update cnfiguratin and the Errr Lg. Name used t identify the current imprt cnfiguratin. Brief verview f what the imprt is designed t d. 4

*Required. *Must be unique. 5

GENERAL TAB The General tab stres attributes f the imprt.. Destinatin Prgram Destinatin Mdule Destinatin Cmpnent Output Directry Designates the lcatin in Lucity in which the imprted recrds will be stred. Enables the user t select a prgram, a mdule, and ne f its cmpnents. Identifies the netwrk directry t which the prgram will exprt a list f bad recrds. When the Exprt Bad Data ptin is checked, a list f any data that culd nt be imprted is exprted t this wrk lcatin. Gruping Name Identifies a cmpnent f a Grup Imprt. Cmplete this field if the cnfiguratin is part f a grup f imprts that must/can ccur tgether in a specific rder. Althugh each part f such an imprt has a different cnfiguratin, they shuld all share the same Gruping Name. Example: A PACP imprt will have a cnfiguratin fr the PACP Inspectin data and a cnfiguratin fr the PACP bservatins. These tw cnfiguratins will share the same Gruping Name. 6

Gruping Order Dictates the rder in which Grup Imprts shuld ccur. The first cnfiguratin t imprt is marked as 1, the next, 2, etc. Email T * Email Subject Line * Example: A PACP inspectin imprt will have a Gruping Order f 1 and the PACP bservatin imprt will have a Gruping Order f 2. When the Grup Imprt is run the inspectins are imprted and then the bservatins are imprted. The rder is imprtant because the bservatins must be attached t an inspectin. Lists the email addresses (delimited by cmmas) t which the system shuld send the ntificatin after cmpleting an imprt. Specifies the Subject line that shuld appear n the ntificatin. * Emails sent ut by the Imprt and Update are sent via the Lucity Email Generatr (http://help.lucity.cm/webhelp/v170/services/index.htm#25578.htm). Imprt Optins Allw Adding New Recrds Allws the imprt t create new recrds in Lucity. Allw Updating f Existing Recrds Allws the imprt t update attribute fields n existing Lucity recrds when imprt data bear a matching Cmmn ID. Nte: If yu are imprting child recrds and Lucity des nt prvide a way t uniquely identify the child recrd, then this bx will autmatically be unchecked and disabled. All imprted recrds will be treated as new recrds. Recrds that fall int this categry can be identified in the Mapping tab. Fields that uniquely identify a recrd r that link the child t a parent recrd are marked in green. Child recrds that have a parent linking field but n unique field marked in green fall int this categry. Imprt null/empty values Tells the system whether it shuld imprt null r empty values. If this ptin is checked, null r empty values can verwrite nn-null values in the database. Check fr Duplicates Always Shw Review Screen Exprt Bad Data Directs the imprt prgram t check fr duplicate recrds in the imprt data based n the unique fields in the destinatin mdule. When enabled, any recrds identified as duplicates will nt be imprted. When the imprt prcess encunters bad recrds, a review screen appears t allw the user t review the data. If this ptin is enabled, the review screen appears every time the imprt is run, whether r nt any bad recrds exist. Exprts recrds that cannt be imprted int a cmma-separated values (.csv) file. 7

Prmpt fr Data Surce Send Email n Errrs Always Send Email Autmatically prmpts the user fr the data surce when they run the imprt instead f using the saved data surce. Nte: If yu are imprting a Grup the user will nly be prmpted fr the imprt that is currently displayed n the screen. Nte: If the prgram is run silently the prgram will nt prmpt and will use the saved data surce. Ntifies designated email addresses that there were errrs in an imprt. (Requires the Email T and Email Subject Line t be filled ut.) Ntifies designated email addresses that the imprt is cmplete. (Requires the Email T and Email Subject Line t be filled ut.) Track Prcessed Recrds Tells the system t track the recrds that are prcessed. When this is enabled the TrackingIdentifier field is enabled, and must be filled ut, n the Mapping tab. DATA SOURCE TAB The Data Surce tab cntains infrmatin abut the data set that will be imprted. 8

Data Surce Type Data Surce Lists the types f data surces the imprt prgram can use: Micrsft Access, ODBC, OLE, Oracle, SQL Server, Text File, Web Service, r XML. Identifies the lcatin f the data t be imprted. The fllwing field appears if the Data Surce is set t Access, ODBC, OLE, Oracle, r SQL Server. Data Select SQL Enables the user t select a SQL statement t tell the imprt which recrds frm the data surce shuld be imprted. The fllwing fields appear if the Data Surce is set t Text File. Data Delimiter Indicates which delimiter the data surce uses t indicate breaks in data. Select either Tab, Space, r Other. If yu select ther type the delimiter int the prvided field. First Rw Cntains Header Infrmatin Indicates that the first rw f data in the data surce is header infrmatin and shuld nt be imprted. Fixed Width Schema Sme data surces d nt use delimiters. Instead, they cntain a cntinuus string f data, in which each piece f data is a standardized length. This sectin is used t break up such data int clumns. The fllwing fields appear if the Data Surce is set t XML. XML File Schema Retrieve Schema Displays the data clumns included in the.xml file. Reads the.xml file selected in the Data Surce field and displays the clumns f data it stres in the XML File Schema. The fllwing fields appear if the Data Surce is set t Web Service. Raw Web Request Build Web Service Schema Retrieve Schema Displays the request that will be sent t the web service. Opens a dialg allwing yu t build a web request using several cmpnents. Displays the data clumns returned by the Raw Web Requests. Runs the Raw Web Request Cllects the clumns returned by the Raw Web Request. Hw t cnfigure a Data Surce 1) Using the Data Surce Type drp-dwn, select the type f database cnnectin t be used fr this imprt. Chse either Access, ODBC, OLE, Oracle, r SQL Server. 9

2) Click the... buttn next t the Data Surce field. The fllwing pp-up appears: 3) Cmplete all available fields; r, if a field yu need isn't editable, change the DBMS Type. 4) Click Test t check if the prgram can cnnect t the database. 5) Click Ok t accept the settings and clse the pp-up. 6) In the Data Select Sql field, enter a SQL statement t select a set f recrds. Only the recrds that are part f the SELECT statement will be cnsidered fr imprt. Example: SELECT * FROM db.hydrants WHERE Imprted = 0 Hw t cnfigure a Text-Delimited Surce 1) In the Data Surce Type drp-dwn menu, select Text. 2) Click the... buttn next t the Data Surce field. Brwse t the lcatin f the surce file and select it. 3) In the Data Delimiter field, enter the type f character used t break up the data. If the data is SPACE- r TAB-delimited, use the drwn-dwn t select that ptin. 4) Mark the First Rw Cntains Header Infrmatin check bx if necessary. Hw t cnfigure a XML Surce 1) In the Data Surce Type drp-dwn menu, select XML. 2) Click the... buttn next t the Data Surce field. Brwse t the lcatin f the.xml file and select it. 10

Nte: When cnfiguring this it is suggested that yu select an.xml file that cntains all f the types f data that yu will ever need t imprt using this template. Ding s ensures that the schema takes int accunt all the pssible fields yu will need t imprt even if any given xml file might nt include all f thse fields. 3) Click the Retrieve Schema buttn. This lads and lcks the schema that the imprt will used. 4) The Fixed Width Schema grid will be filled ut with all the fields fund within the selected.xml file. Nte: If the XML file is cmplicated yu may see Rt items duplicated t display child cllectins. If this is the case it is suggested t nt use the Check Fr Duplicates functin n the General Tab. Hw t cnfigure a Web Service Surce 1) In the Data Surce Type drp-dwn menu, select Web Service. 2) Paste a web request int the Raw Web Request field OR 3) Click the Build buttn t the right f the Raw Web Request field. The fllwing pp-up will appear: a. Select the Methd yur request will use. b. Enter the URI t cnnect t. c. Select the Prtcl t use. d. Enter the Header and Bdy t yur request. 11

Nte: The values in these fields will vary depending n the web service yu are accessing. e. Click Ok. Nte: When cnfiguring this it is suggested that yu select a web service that cntains all f the types f data that yu will ever need t imprt using this template. Ding s ensures that the schema takes int accunt all the pssible fields yu will need t imprt even if any given service call might nt return all f thse fields. 4) Click the Retrieve Schema buttn. This lads and lcks the schema that the imprt will used. 5) The Web Service Schema grid will be filled ut with all the fields fund within the selected.xml file. Nte: If the web service supprts it request the data in XML frmat. smething like Accept: applicatin/xml in the Header. This is dne by including Nte: JSON is supprted If the web service des nt supprt XML frmat. Hwever if the returned bject des nt indicate it is JSON the Imprt and Update will assume it is XML. In this case include smething like Accept: applicatin/jsn in the Header. ESRI services are an example f this. Hw t cnfigure an Excel data surce Nte: The specific syntax used here nly wrks fr Excel 2003 r earlier. Nte: Fr simplicity it is suggested that yu save yur excel dcument as a.csv file and imprt that file. 1) In the Data Surce Type drp-dwn menu, select OLE. 2) Click the... buttn next t the Data Surce field. 3) Click the... buttn next t the OLE field. 4) On the Prvider tab select Micrsft Jet 4.0 OLE DB Prvider frm the list. 5) On the Cnnectin tab use the first bx t enter r brwse t the path fr the Excel file. 6) On the All tab select Extended Prperties and click Edit Value. 7) Click OK. In the Prperty Value field enter Excel 8.0;HDR=Yes;IMEX=2 Hw t cnfigure a Fixed-Width Schema Text surce 1) In the Data Surce Type drp-dwn, select Text. 2) Click the... buttn next t the Data Surce field. Brwse t the lcatin f the surce file and select it. 12

3) Click in the the Fixed Width Schema grid and enter the number f characters that make up the first clumn f data. 4) Press Enter. 5) Repeat Steps 3 and 4 fr all ther clumns. 6) The prgram will then break up the data int clumns based n the values entered in the grid. MAPPING TAB The Mapping tab enables users t link fields frm the data surce t fields in Lucity. 13

Surce Grid The Surce grid lists all f the fields fund in the surce data and displays examples f the data in thse fields. # Supplies an identifier fr each field. This number is used t identify a field during the mapping. Field Name Specifies the name used by the data surce fr the field. Value (A) Prvides an example f the field cntents. The data displayed cmes frm the first recrd in the data surce. Refresh Refreshes the Surce grid. Click this buttn if the data surce has been changed in any way since the last time the Settings recrd was saved. Destinatin Grid This grid displays a list f all the prperties fund in the Lucity mdule and enables users t link thse prperties t a field in the Surce grid. Lucity prperties ften indicate a specific field; hwever, this isn't always true. Smetimes, a prperty represents multiple fields in Lucity. Fr example, the Street prperty links t the XX_ADR_STR field, hwever the Street prperty actually maps the entire street value. The imprt autmatically splits the data between the different address fields. Prperty Table Field(s) Indicates the alias name fr the Lucity field. Indicates the name f the Lucity table int which this infrmatin will be imprted. Nt every part f the imprt data will be imprted int the same table. Example: Yu are imprting a selectin f Equipment data. One clumn f that data stres a path t the lcatin f a pdf cpy f the user manual fr the equipment. When the data is imprted the equipment data is stred in the equipment table but the path t the dcument is stred in the dcument table and linked back t the equipment recrd. Specifies the name f the field within the destinatin table. Captin Displays the captin set in the sftware fr the field. This makes it easier t identify fields. Mask Value * Shws what type and hw much data the field will hld. Displays the value that will be imprted fr the first recrd in the surce data based n the frmula. 14

Sequence * Surce Field * Frmula Cntrls the rder that the fields are ppulated. This shuld nly be used if there is a prblem with imprting the data that is caused by the data added t ne clumn being needed in anther clumn. In this case the clumn that shuld be ppulated first must have a lwer sequence number. Shws the name f the Surce data field yu mapped t if yu mapped directly t the data. Enables users t enter a frmula fr what shuld appear in the Lucity field. Additinal details are prvided belw. Test Frmula Enables users t enter a frmula and see a preview f the results. This allws users t see exactly what wuld be inserted int the Lucity database if that frmula was used. If the frmula includes data frm a data surce, the system will pull the test data frm the first recrd in that data surce. * Hidden by default. Shw/Hide Clumns Right click in the grid fr a list f fields. Check/uncheck fields t have them shw/hide in the grid. The changes t the grid will reset when the prgram is clsed. Simple Mapping Click n a value in the Surce grid and drag it t a related Frmula field in the Destinatin grid. Or, in the Frmula field in the Destinatin grid, type =A+#. (The # refers t the first clumn in the Surce grid.) Mre Infrmatin abut writing Frmulas (see "Frmulas" n page 38) 15

SPECIAL FIELDS PICKLIST FIELDS Picklist fields are made up f tw fields. *_TY. When mapping t these fields: One field stres the Cde *_CD and the ther stres the Type Make sure that yur data matches yur picklists in Lucity. Only map t ne f the tw fields. Whichever field yu chse t map t, the prgram will autmatically determine the crrespnding value fr the ther field based n the picklist in Lucity. Yu d nt need t use crrelatins t d this. LINKING\ASSOCIATING RECORDS It is pssible when imprting t link\assciate the imprted recrds t ther recrds in Lucity. Find the field that links the recrd yu are imprting t anther type f recrd. In the Imprt this will be labeled smething like: LinkingTXXXXX. (example: LinkingTCMADDR) This field needs t hld the Aut ID (Recrd #) f the recrd yu are linking t. If yur imprt data has this number map that t the linking field. If yur imprt data des nt have Auth ID, but has the Cmmn ID (Alt ID) yu will need t create a frmula in that field that gathers the Aut ID. (example: +SELECT AD_ID FROM CMADDR WHERE AD_PROPTAG = '=A12') 16

DOCUMENT LINKING FIELDS The Imprt and Update prgram supprts linking dcuments t recrds but will nt uplad them t the dcument hive. These dcuments already need t be in their final lcatin befre the Imprt is run. This final lcatin des nt have t be in the dcument hive, but the dcument server will need access t that lcatin if thse dcuments shuld be accessible t yur web and mbile users. Imprting dcuments is dne n the mapping tab using the DcumentPath and DcumentDescriptin prperties in the Destinatin grid. Yu use these tw fields t fill ut the path t the dcument and the descriptin that will be used in Lucity. If yur imprt cntains the path t the dcument in ne field and the file name in anther field yu will need t use a frmula t cmbine them int the DcumentPath prperty. Reserved Wrds A reserved wrd autmatically updates yur imprt with a value set elsewhere. Fr dcuments there are several reserved wrds yu can use t autmatically fill ut part f yur dcument path. %DcumentServerHive% Autmatically enters the path fr the dcument server. This is taken frm the Lucity Web > Admin Prtal > Settings > System Settings > Dcuments > Path where upladed dcuments are stred (Internal)(Dcument Hive) setting. %DataSurcePath% Autmatically enters the path fr yur data surce. This is useful when yur data and images are stred tgether in the same lcatin and will stay there. %PrmptFrDcumentDi rectry% When a user begins an imprt they will be prmpted the lcatin f their dcuments. Nte: In all f these cnfiguratins all dcuments must be in the same lcatin. Hw t use the DcumentServerHive reserved wrd Create a flder within the dcument hive fr yur imprted files. Example: \\ExampleServer\DcumentHive\Inventry\MSDSSheets\ Mve the dcuments int this flder. In the Imprt and Update tl edit yur imprt cnfiguratin g t the Mapping tab and find the DcumentPath prperty. Enter a frmula t build yur dcument path using the reserved wrd. Example: If yur attached Filename is in the tenth cell f the imprt file the frmula will lk smething like this: +'%DcumentServerHive%\Inventry\MSDSSheets\=A10' Result: \\ExampleServer\DcumentHive\Inventry\MSDSSheets\PipeCleanerspray.pdf 17

Save yur changes. Hw t use the DataSurcePath reserved wrd Place yur imprt data and dcuments in the lcatin that they will be. Example: \ExampleServer\SewerImprts2016\JuneImprt In the Imprt and Update tl set yur data surce fr this imprt. Example: Data Surce = \\ExampleServer\SewerImprts2016\JuneImprt\062016 Nte: It is highly suggested that yu use UNC pathing fr data surce. This will make it mre likely that ther users will be able t access the data. If yu use mapped letter drive pathing (ex D:/) then ther users will need t have the exact same mapped letter drive t access the attached dcuments. G t the Mapping tab and find the DcumentPath prperty. Enter a frmula t build yur dcument path using the reserved wrd. Example: If yur attached Filename is in the tenth cell f the imprt file the frmula will lk smething like this: +'%DataSurchPath%\images\=A10' Result: \\ExampleServer\SewerImprts2016\JuneImprt\images\SWP1056_06052016_1.jpg Save yur changes. Hw t use the %PrmptFrDcumentDirectry% reserved wrd In the Imprt and Update tl g t the Mapping tab and find the DcumentPath prperty. Enter a frmula t build yur dcument path using the reserved wrd. Example: If yur attached Filename is in the tenth cell f the imprt file the frmula will lk smething like this: +'%PrmptfrDcumentDirectry%\images\=A10' 18

Run the Imprt. Yu will be prmpted fr the lcatin f yur dcuments. Example: \\ExampleServer\SewerImprts2016\JuneImprt\images\ Nte: It is highly suggested that yu use UNC pathing fr data surce. This will make it mre likely that ther users will be able t access the data. Yu can use mapped letter drive pathing (ex D:/) but then ther users will need t have the exact same mapped letter drive t access the attached dcuments. This can be dne by brwsing via the Netwrk sectin f the prmpt. After yu select the dcument lcatin the path will be calculated Result: \\ExampleServer\SewerImprts2016\JuneImprt\images\SWP1056_06052016_1.jpg Save yur changes. 19

PROCESSING FIELDS The imprt and update has the ability t track recrds prcessed and skip recrds. fields tied t thse cnfiguratins. The fllwing fields are special TrackingIdentifier A field that uniquely identifies the imprted recrds. The imprt/update template will track which recrds have been updated based n this field. This must be mapped when the the Track Prcessed Recrds flag n the General tab is checked. Mre infrmatin but hw t track prcessed recrds (see "Tracking Prcessed Recrds" n page 36). SkipPrcessingIfNtBlank A field that helps the prgram decide if it shuld prcess a recrd r nt. If data is mapped t this field and that is reslved as a nn-blank value the prgram will skip prcessing that recrd. Mre infrmatin abut hw t skip recrds during prcessing (see "Skip Prcessing Recrds" n page 36). CORRELATIONS TAB The Crrelatins tab enables users t crrelate values in the imprt data t values in Lucity when values d nt already match between the tw systems. The primary purpse f the Crrelatins tab is t crrelate values frm tw picklists that d nt match; hwever, it's functin is nt limited t pick-list fields. Only fields identified in the Mappings tab can be crrelated. 20

Lucity Prperty The Lucity prperty that requires a crrelatin. This is the Prperty frm the Mapping tab. Lucity Value Imprt Value The value that will be filled int Lucity when the related Imprt Value is imprted. The value that must be translated t the Lucity Value during the imprt. When t use Crrelatins Crrelatins are fr when yu have data in ur imprt data that yu want r need it t be cnverted t smething else. Fr example, if the surce data utilizes "Cncrete Masnry Blcks", but in Lucity, that crrelates t "CMU" a crrelatin wuld be created t cnvert "Cncrete Masnry Blcks" t "CMU". Yu d nt need t use crrelatins if yu are attempting t imprt data int the cde r type field n a pick-list but d nt have anther field with the crrespnding cde r type. Map the ne field yu have. As lng as the cdes r the types yu have match what is in Lucity, the prgram will autmatically find the match. Hw T Set Up a Crrelatin 1) Click in the Lucity Prperty clumn and select the field fr this crrelatin. 2) In the Lucity Value field, enter the value that will be stred in Lucity. 3) In the Imprt Value field, enter the value that is stred in the surce data. 21

PREPROCESSING TAB The PrePrcessing Tab prvides a way t setup prcesses that shuld happen befre the imprt prcess begins. These prcesses can take the frm f a file dwnlad, r running a script. This allws yu t dwnlad files t imprt and then mve them t a new lcatin befre imprting. When a file is dwnladed it is autmatically renamed t match the name f the file specified n the Data Surce tab. Therefre the file dwnlad will typically be used with the Text r XML data surce type 22

FILE DOWNLOAD This sectin allws yu t make a call t an external file strage lcatin and dwnlad a file Dwnlad Surce The file strage service that cntains the file. Supprts Amazn S3 and FTP. Delete Surce File after Dwnlad Prperty Name EXTERNAL PROCESS(ES) Instructs the surce lcatin t delete the file after the dwnlad is cmplete. Displays a list f prperties that need t be filled ut t cnnect t the Dwnlad Surce. The list displayed is specific t the selected Dwnlad Surce. This sectin indicates any executables r batch files t be run. Name Order Prgram * Arguments * Enter a name t identify the prcess. If there is mre than ne prcess enter a number fr the rder that each prcess shuld ccur in. Enter the path t the.exe r.bat file that yu will run. Nte: The path shuld nt include " ". Enter any parameters that will be passed t the prgram. Nte: File Dwnlads ccur befre External Prcesses. Nte: Failed pre-prcesses will cause the imprt t fail. * Supprts using frmulas (n page 38). Must be enclsed in [[ ]]. Example: [[+GETDATE()]] 23

POSTPROCESSING TAB The PstPrcessing Tab prvides a way t setup prcesses that shuld happen after the imprt prcess is cmplete. Examples: Mving a file t a new lcatin fllwing the imprt. Running an executable Issuing SQL Statements n the DataSurce. Call an external batch r executable file t execute a SQL statement n anther database. 24

EXTERNAL PROCESS(ES) Name Order Prgram ** Arguments ** Every Recrd Web Service Enter the name f the pst prcess. If there is mre than ne prcess enter a number fr the rder that each prcess shuld ccur in. Enter the prgram/cmmand t run. Enter the path t the.exe r.bat file that yu will run. Enter the SQL statement t be run n the data surce if the data surce supprts SQL statements. Nte: The path shuld nt include " ". Enter any parameters that will be passed t the prgram. Indicates if the prcess shuld ccur after each recrd is imprted r after the entire imprt prcess is cmpleted. Fr example yu may create a prcess that will update a web service with infrmatin frm an imprted recrd. In this case yu will mark Every Recrd s that the prcess sends the infrmatin with every recrd that is imprted. Mark if the pst prcess is cnnecting t a web service. SQL Statement Mark if the pst prcess is a SQL statement issued n the data surce. The SQL statement is entered int the Prgram field. * Supprts using frmulas (n page 38). Must be enclsed in [[ ]]. Example: [[+GETDATE()]] * If the Every Recrd bx is checked these frmulas als supprt mapping fields frm the surce data (ex '=A12') r Prperties frm the Imprted recrd. 25

PROCESSED TAB The Prcessed tab displays a list f all the recrds frm the surce that have been prcessed in the past. Nte: By default this grid will display the last 90 days f tracking infrmatin. This can be mdified in the Lucity.ImprtUpdate.xml in the DisplayTrackingDays setting. The database table stres the tracking data indefinitely. Hw t manually add a prcessed recrd While editing the imprt update cnfiguratin click n the Prcessed tab. Type in the recrd ID in the Recrd field. Set the Prcessed date. Click Add. Hw t track prcessed recrds 1) On the General tab check the Track Prcessed Recrds bx. 2) On the Mapping tab map sme data t the TrackingIdentifier field. It shuld be mapped t a field that uniquely identifies the recrd. Ideally this is the same field yu used fr the Cmmn ID 26

This may include a frmula that builds a unique tracking ID based n ne r mre fields frm the imprt data. (ex. Asset ID + Inspectin Date fr an inspectin) 3) These recrds will nw appear n the Prcessed tab. HOW TOS The fllwing sectins cver hw t use the Imprt and Update prgram t d different things. STANDARD IMPORT Hw t set up a Standard Imprt 1) Open the Imprt and Update? tl and click t create a new cnfiguratin. 2) Enter the Imprt Name. 3) General Tab (n page 6) Select the part f the Lucity prgram int which the recrds will be imprted. Designate a Output Directry fr any bad recrds. On the right side f the tab, select the ptins yu wish t enable fr the imprt. 4) Data Surce Tab (n page 8) Use the fields prvided t t select and cnfigure the data surce. 5) Mapping Tab (n page 13) Map the fields in the imprt data t fields in Lucity. 6) Crrelatins Tab (n page 20) 7) Email Tab If yu are mapping text fields int cdes, r, if yu have any ther data that need t be cnverted during the imprt, create the necessary crrelatins. Fill ut the infrmatin n this tab if yu want Lucity t send ut an email ntificatin when the imprt is cmplete. 8) Click t save the cnfiguratin. 27

Hw t run a Standard Imprt 1) Navigate t the cnfiguratin recrd. 2) Click the buttn. If yu have Prmpt fr Data Surce checked yu will receive a Prmpt asking fr the data yu are imprting. If yu are using the %PrmptFrDcumentDirectry% reserved wrd n the mapping tab yu will be prmpted fr the lcatin f yur attached dcuments. 3) The imprt prcess will begin and the fllwing prgress bar will appear. 4) Depending n settings, if there are n recrds that fail t imprt, the prgram will imprt everything and be dne. 5) If there are recrds that fail t imprt the fllwing screen will appear: 6) If there are simple issues with the data it can be fixed directly in this grid. After fixing the data click Retry. 7) Click Cntinue t imprt the recrds and cmplete the imprt. 28

GROUP IMPORT Hw t set up a Grup Imprt 1) Open the Imprt and Update tl and click t create a new cnfiguratin. 2) Enter the Imprt Name. 3) General Tab (n page 6) Select the part f the Lucity prgram int which the recrds will be imprted. Designate a Output Directry fr any bad recrds. On the right side f the tab, select the ptins yu wish t enable fr the imprt. Create a Grup Name. This name will be used fr all ther cnfiguratins in the Grup Imprt. Enter the Grup Order. This is a number that tells the Imprt prgram in which rder t run the different cnfiguratins in during a Grup Imprt. 4) Data Surce Tab (n page 8) Use these fields t select and cnfigure the data surce. 5) Mapping Tab (n page 13) Map fields in the imprt data's t fields within Lucity. 6) Crrelatins Tab (n page 20) 7) Email Tab If yu are mapping text fields int cdes, r, if there are any ther data that need t be cnverted during the imprt, create crrelatins. Cmplete these fields if yu wuld like the system t send ut an email ntificatin when the imprt is cmplete. 8) Click t save the cnfiguratin. 9) Repeat Steps 1-8 t create cnfiguratins fr each element f the Grup Imprt. Ntes: On the General Tab, the Grup Name must be the same fr all cnfiguratins. Order value must be different fr each element f the Grup Imprt. The Grup Hw t run a Grup Imprt 1) Lcate a saved imprt cnfiguratin recrd that is part f the grup yu want t run. 2) Click the drp-dwn arrw n the buttn and select Grup Imprt. 29

3) The imprt prcess begins, and a prgress bar appears: 4) Depending n settings, if there are n recrds that fail t imprt, the prgram will imprt everything and be dne. 5) If any recrds fail t imprt, the fllwing screen appears: 6) If there are simple issues with the data, they can be fixed directly in the Imprt Review grid. After fixing the data, click Retry. 7) Click Cntinue t imprt the fixed recrds and cntinue with the remainder f the Grup Imprt. TEMPLATES Hw t setup an imprt frm a template 1) Open the Imprt and Update tl and click the drp dwn arrw next t the. Select Add Template. 30

2) The fllwing pp-up will appear: 3) Select ne r mre templates frm the list. Nte: Mst Lucity prvided templates are part f a grup. template in that grup. Yu will need t lad and edit every 4) Click Lad. 5) The selected template(s) will be added int the imprt and update tl. 6) Fr each laded template, edit the Template, change the Name s that it is unique and des nt match the riginal template name and press Save. This is necessary befre making any additinal changes t the laded Template(s) s that they are initially saved t the Lucity database. 7) Each template is as filled ut as much as pssible. Yu will need t prvide the fllwing General Tab > Output Directry - The lcatin that yu want bad recrds exprted t. Data Surce Tab > Data Surce - Pint this t yur imprt database. 8) Click t save the cnfiguratin. 9) When the save is successful the fllwing pp-up will appear: 10) Click the Yes buttn all the ther templates in this grup use the same Data Surce. 11) G t each ther template yu imprted and click. Hw t create yur wn template 1) Open the Imprt and Update? tl and click t create a new cnfiguratin. 31

2) Enter the Imprt Name. 3) Fill ut the fllwing infrmatin n the General Tab (n page 6). Select the part f the Lucity prgram int which the recrds will be imprted. Designate a Output Directry fr any bad recrds. Fill ut the Grup Name and Grup Number if this template will be part f a grup. On the right side f the tab, select the ptins yu wish t enable fr the imprt. 4) If yur template will cntain mappings g t Data Surce Tab (n page 8) and select a sample f yur data. 5) Use the Mapping tab and Crrelatin tabs t cmplete yur cnfiguratin. 6) Return t the Surce Data tab and clean ut the Surce Data field. 7) Click the drp dwn arrw next t the and select Save as Template. Hw t delete a template 1) Open the Imprt and Update tl and click the drp dwn arrw next t the. Select Add Template. 2) The fllwing pp-up will appear: 3) Select a Template in the list and click Delete. 4) The template will be deleted. Nte: Lucity prvided templates cannt be deleted. 32

SCRIPTING IMPORTS Hw t run an Imprt as part f a script An administratr can als run an Imprt as part f a cmmand line r script. Use the fllwing syntax and parameters when running the imprt in a script: Lucity.ImprtAndUpdate.exe [/S] [/P][Path] [/L][Cnfiguratin] [/C][Client] [/G] /S Indicates the prgram shuld run silently, withut displaying frms r errr messages. /P Indicates the path fr the setup file(s) and the default lcatins f bjects. This prtin f the script is required nly if the Lucity.ImprtAndUpdate.exe file was mved t a new lcatin. If the file was mved, this parameter shuld pint t the riginal lcatin where all the accmpanying files are still stred. Path Indicates the path t the Setup file. Nte: If there is a space in this value yu must start and end the value with " ". Example: P/"C:\example lcatin\lucity.imprtandupdate.exe" /L Specifies which saved imprt cnfiguratin t run. Cnfiguratin * The name f the cnfiguratin. Nte: If there is a space in this value yu must start and end the value with " ". Example: L/"Hydrant Inspectin Imprt" /C Indicates the Lucity client. Client The name f the Lucity client. /G Indicates that if the cnfiguratin is part f a grup, the cnfiguratins with a greater rder shuld als run. Example: C:\Prgram Files\bin\Lucity\Lucity.ImprtAndUpdate.exe /S /LHydrants /Cclint001 Nte: There is a /T Tken functin. This is used internally by the prgram and shuld nt be used when setting up the prgram as part f a script. Hw t run an Imprt as part f the Windws Scheduler 1) After cnfiguring yur imprt use the fllwing steps t schedule the imprt. 2) Access the server that is running the Lucity Services. 33

3) Lgin as a windws users with administrative privileges. 4) G t the cmputer's Cntrl Panel and pen Administrative Tls. 5) Open the Task Scheduler. On the left side select Task Scheduler Library. Right-click n it and select New Flder. Name the new flder Lucity. 6) Right-click n the Lucity flder and select Create Task... 7) On the General tab... a. Enter the Name f the task. It is suggested t name it the same as the Imprt and Update Cnfiguratin that the task will run. b. Enter a Descriptin f the task. c. Select the Run whether user is lgged n r nt buttn. d. Check the Run with highest privileges bx. 8) Select the Triggers tab. a. Click the New... buttn. b. On the new trigger pp-up enter the schedule that yu want the task t fllw. c. Click OK. 9) Select the Actins tab. a. Click the New... buttn. b. In the Prgram/script field brwse t the Lucity.ImprtandUpdate.exe. c. Enter the parameters yu wuld like t use in the Add arguments field. These are listed in the previus Hw T. d. In the Start In field enter the path t the Lucity Services flder. C:/Prgram Files (x86)/lucity Services e. Click OK. 10) Click OK. 11) The task will ask fr the windws credentials that it shuld run under. This windws users must: 34

Have permissins t run the.exe Be mapped t a Lucity lgin that has permissin t make updates t the mdules that this Lucity Imprt cnfiguratin will be updating Optinally it shuld have a nn-expiring passwrd Hw t run an Imprt as part f the Lucity Services 1) After cnfiguring yur imprt use the fllwing steps t schedule the imprt. 2) Lgin the server that is running the Lucity Services. The windws credentials yu use must be mapped t a Lucity lgin that has permissin t make updates t the mdules that this Lucity Imprt cnfiguratin will be updating 3) Lcate and run the Lucity.ImprtandUpdate.exe. This is typically lcated in the C:\Prgrams FIles (x86)\lucity Services directry. 4) Lgin using windws authenticatin. 5) Select yur imprt cnfiguratin. If it is part f a gruped imprt select the first cnfiguratin fr the grup. 6) Click the n the tlbar. The fllwing pp-up will appear: 7) Enter a Name fr the schedule. 8) Make sure the Enabled bx is checked. 35

Nte: Currently the Lucity Scheduler nly supprts running nce a Day at a specific time r every few minutes. Other sectins f the frm are disabled. 9) T run it daily: Click the Occurs nce at: buttn. Select the time that the schedule shuld be run daily. 10) T run every few minutes: 11) Click OK. Click the Occurs every: buttn. Select the number f minutes between times that the service will run. 12) Save the changes t the imprt cnfiguratin. TRACKING PROCESSED RECORDS Hw t track prcessed recrds 1) On the General tab check the Track Prcessed Recrds bx. 2) On the Mapping tab map sme data t the TrackingIdentifier field. It shuld be mapped t a field that uniquely identifies the recrd. Ideally this is the same field yu used fr the Cmmn ID This may include a frmula that builds a unique tracking ID based n ne r mre fields frm the imprt data. (ex. Asset ID + Inspectin Date fr an inspectin) 3) These recrds will nw appear n the Prcessed tab. SKIP PROCESSING RECORDS Hw t Skip Prcessing Recrds When yur surce is a database 1) Setup the ability t track prcessed recrds. Make sure that yu use the Cmmn ID used in yur data surce t map t the TrackingIdentifier field. 2) If yu are using Micrsft Access yu will need pen the database and link in the CMIMPPROCESSED table frm the SQL database. 3) If yu are using Micrsft SQL server yur databases will need t be in the same sql instance. 36

4) G t the Data Surce tab 5) Update yur Data Select SQL t exclude recrds that verlap with the Lucity.CMIMPPROCESSED table. Example: SELECT * FROM DATASOURCE WHERE DATASOURCE_ID IS NOT NULL AND DATASOURCE_ID NOT IN (SELECT PRC_UNIQUE_ID FROM Lucity.db.CMIMPPROCESSED INNER JOIN Lucity.db.CMIMPORTUPDATE ON IMP_ID = PRC_IMP_ID WHERE IMP_NAME = 'Yur Imprt Name') Hw t Skip Prcessing Recrds When yu are using a nn-database surce 1) Setup the ability t track prcessed recrds. Make sure that yu use the Cmmn ID used in yur data surce t map t the TrackingIdentifier field. 2) On the Mapping tab find the SkipPrcessingIfNtBlank field. 3) Add the fllwing frmula +SELECT TOP 1 PRC_ID FROM CMIMPPROCESSED INNER JOIN CMIMPORTUPDATE ON IMP_ID = PRC_IMP_ID WHERE IMP_NAME = 'Yur Imprt Name' AND PRC_UNIQUE_ID = '=A12' 4) Replace the Yur Imprt Name with the Name field fr yur Imprt Cnfiguratin. 5) Replace the =A12 with the field r frmula yu used t map the TrackingIdentifier field. 6) When running the imprt the will check each recrd t see if there is a matching recrd in the prcessed tracking table. If there is it will skip that recrd. If there isn't the recrd will be prcessed. MIGRATING FROM AN OLD IMPORT PROGRAM If yu used the ld Lucity Imprt and are nw switching t the Imprt and Update check ut ur Supprt Center article fr step by step instructins (https://lucity.zendesk.cm/hc/en-us/articles/205030524). 37

FORMULAS Frmulas tell the Imprt prgram exactly what t imprt int Lucity. A frmula culd be as simple as "This surce data ges in t that Lucity field." Or, it culd utline mre cmplex peratins like frmatting, data cnversin, etc. Frmulas can be used in Data Surce Queries, Raw Web Requests, Mappings, and Pre & Pst prcessing. Nte that if the first character is a plus sign (+), the system expects a functin, and strings cntaining =A and a number are interpreted as clumn mappings. When a frmula cntains a plus sign (+) as the first character, the Imprt and Update tl generates a SQL statement and passes it t the underlying Lucity database platfrm t reslve the frmula. First, the system replaces the mapped values in the frmula with the data frm the imprt file, remving the +; then, it issues a SELECT statement with the resulting value. Fr example, if a user specifies a frmula f +CAST('=A1' AS VARCHAR), and the mapped data fr A1 is Test, the system issues the fllwing SQL statement: SELECT (CAST('TEST' AS VARCHAR)) AS TEXTVAL 38

DESCRIPTION FORMULA RESOLVES TO FINAL VALUE Map Surce Data t Lucity Insert a value int a Lucity Field =A2 5 5 "2" r "1/1/2015" r "Bill" 2 r 1/1/2015 r Bill 2 r 1/1/2015 r Bill Add values tgether +=A1 + =A2 10.97 + 5 15.97 Cncatenate values +'=A2 - =A3' '5 - Cncrete' 5 - Cncrete Extracting a value frm the left f a string Extracting multiple values frm a string and refrmatting them tgether (dates) Extracting part f a string and cnverting t a different frmat Setting a value based n anther value +LEFT('=A4', 3) LEFT('PLK000078FD', 3) PLK +SUBSTRING('=A5', 5, 2) + '/' + SUBSTRING('=A5', 7, 2) + '/' + LEFT('=A5', 4) +CAST(SUBSTRING('=A4', 4, 6) AS INT) +CASE WHEN '=A3' = 'Cncrete' THEN '1' ELSE '2' END SUBSTRING('20071023115523', 5, 2) + '/' + SUBSTRING('20071023115523', 7, 2) + '/' + LEFT('20071023115523', 4) CAST(SUBSTRING(' PLK000078FD', 4, 6) AS INT) CASE WHEN 'Cncrete' = 'Cncrete' THEN '1' ELSE '2' END 10/23/2007 Insert the Current Date +GETDATE() GETDATE() 12/7/2015 10:48:50 AM Set value based n the results f a lkup Example A +SELECT CT_ID FROM WKCAT WHERE CT_NAME = '=A6' Example B +SELECT DESCRIPTION FROM WKFIELDSDESC WHERE ID = 841 AND CODE = =A2 Example C +SELECT SUM(NT_LENGTH) FROM SWNET WHERE NT_MAT_TY = '=A3' SELECT CT_ID FROM WKCAT WHERE CT_NAME = 'Sewer Department' SELECT DESCRIPTION FROM WKFIELDSDESC WHERE ID = 841 AND CODE = 5 SELECT SUM(NT_LENGTH) FROM SWNET WHERE NT_MAT_TY = 'Cncrete' 78 1 89 Vacatin Time 1023 Prperty Names 39

Frmulas written fr the Pst Prcessing tab can include references t mdule prperties. Prperties are the prgrams way f referencing fields. Sme prperties reference multiple fields. The prgram will pull the value assciated with that prperty name frm the last saved recrd. Nte: Fr these t wrk in pst prcessing frmulas t wrk yu must have the Every Recrd bx checked fr the pst prcess. Prperty names must be entered int a frmula using the fllwing frmat: %%PrpertyName%% Hw t find a Prperty Name 1) Open Lucity Web 2) Open the mdule the imprt and update cnfiguratin is fr. 3) Find the field that cntains the value yu want t insert int the frmula. 4) Open the Field Prperties (http://help.lucity.cm/webhelp/latest/web/index.htm#33783.htm) fr that field and write dwn its PrpertyName. Reserved Wrds Reserved wrds are used t add data t a frmula based n when, and by whm, the imprt is run. The imprt and updates supprts using the standard Lucity Reserved Wrds as well as sme built in reserved wrds fr the dcument linking fields Reserved wrds must be entered int a frmula using the fllwing frmat: %RESERVEDWORD% Mre infrmatin n standard Reserved Wrds (see "Reserved Wrds" n page 40) Mre infrmatin abut dcument linking Reserved Wrds (see "Dcument Linking Fields" n page 17) Syntax fr Pre and Pst Prcessing Frmulas added t the Pre and Pst Prcessing tabs must be enclsed in [[ ]] RESERVED WORDS Reserved wrds are used t add data t a filter based n when, and by whm, the filter is run. Example: A user wants a filter f all the wrk that was cmpleted in the last week. He creates a filter that says: 40

SELECT * FROM WKORDER WHERE WKORDER.WO_END_DT >= '6/18/2012' AND WKORDER.WO_END_DT <= '6/22/2012' Hwever, this query statement wuld be ut f date the next week, requiring the user t adjust the dates. S, the user rewrites the statement using the %PREVIOUSWEEK% reserved wrd: SELECT * FROM WKORDER WHERE WKORDER.WO_END_DT = %PREVIOUSWEEK% The new filter displays all wrk rders with an end date that falls within the seven days previus t it being run. Nte: When using reserved wrds, enter them in all uppercase letters and enclse them in percent symbls (%) Available Reserved Wrds The fllwing is a list f all the reserved wrds available in Lucity Web. '%LOGGEDINUSERID%' - Returns the currently lgged in user's Lgin ID. Example When user Jsh runs the filter: SELECT * FROM WKORDER WHERE WKORDER.WO_EMP_TY = '%LOGGEDINUSERID%' it becmes: SELECT * FROM WKORDER WHERE WKORDER.WO_EMP_TY = 'JOSH' '%LOGGEDINEMPCODE%' - Returns the currently lgged in user's Emplyee ID, which is fund in the EM_EMPL_CD field in the WKUEMP table. When used in a filter, the system replaces the reserved wrd with the Wrk Emplyee Cde f the currently lgged in user. Requirements - An agency must wn the Wrk mdule t use this string. Als, the lgged in emplyee must have his r her Lgin ID assciated with an Emplyee recrd in the Wrk Flw Setup > Emplyees mdule. Example When user Jsh runs the filter: SELECT * FROM WKORDER WHERE WKORDER.WO_EMP_CD = '%LOGGEDINEMPCODE%' it becmes: SELECT * FROM WKORDER WHERE WKORDER.WO_EMP_CD = 'JshL ' 41

'%FISCALYEAR%' - Returns the Current Fiscal Year frm the Desktp applicatin's Planning and Budgeting, Fiscal Year mdule. Requirements - An agency must wn the Wrk mdule t use this string. Example On 6/27/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%FISCALYEAR%' It becmes: EFEQUIP.ge_cur_dt >= '01/01/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '01/01/2015 12:00 AM' '%CURRENTYEAR%' - Inserts the current calendar year. Example On 6/27/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTYEAR%' It becmes: EFEQUIP.ge_cur_dt >= '2014-01-01' and EFEQUIP.GE_CUR_DT < '2015-01-01' '%CURRENTQUARTER%' - Inserts the current quarter. Example On 6/27/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTQUARTER%' It becmes: SELECT * FROM EFEQUIP LEFT JOIN EFFLEET ON EFEQUIP.GE_FL_ID = EFFLEET.FL_ID WHERE EFEQUIP.ge_cur_dt >= '04/01/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '07/01/2014 12:00 AM' 42

'%CURRENTMONTH%' - Inserts the current mnth. Example On 6/27/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTMONTH%' It becmes: EFEQUIP.ge_cur_dt >= '06/01/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '07/01/2014 12:00 AM' '%CURRENTWEEK%' - the current date. Example Lks at the current date and inserts the dates fr the Sundays befre and after On Mnday, 6/30/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTWEEK%' It becmes: EFEQUIP.ge_cur_dt >= '06/29/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '07/06/2014 12:00 AM' '%CURRENTWEEK1%' - Lks at the current date and inserts the dates fr the Sundays befre and after the current date. (Results are identical t thse using the previus reserve wrd.) Example On Mnday, 6/30/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTWEEK1%' It becmes: EFEQUIP.ge_cur_dt >= '06/29/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '07/06/2014 12:00 AM' 43

'%CURRENTWEEK2%' - Lks at the current date and inserts the dates fr the Mnday in the same calendar week and the next Mnday. Example On Mnday, 6/30/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTWEEK2%' It becmes: EFEQUIP.ge_cur_dt >= '06/30/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '07/07/2014 12:00 AM' In this example, the user runs the filter n a Mnday; s, the system returns recrds frm the "previus" Mnday (12 a.m. that same day, 06/30) t 12 a.m. the fllwing Tuesday,07/07 (which catches all f Mnday, 7/6). '%CURRENTWEEK3%' - Lks at the current date and inserts the dates fr the Tuesday in the same calendar week and the next Tuesday. Example On Mnday, 6/30/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTWEEK3%' It becmes: EFEQUIP.ge_cur_dt >= '07/01/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '07/08/2014 12:00 AM' '%CURRENTWEEK4%' - Lks at the current date and inserts the dates fr the Wednesday in the same calendar week and the next Wednesday. Example On Mnday, 6/30/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTWEEK4%' It becmes: EFEQUIP.ge_cur_dt >= '07/02/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '07/09/2014 12:00 AM' 44

'%CURRENTWEEK5%' - Lks at the current date and inserts the dates fr the Thursday in the same calendar week and the next Thursday. Example On Mnday, 6/30/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTWEEK5%' It becmes: EFEQUIP.ge_cur_dt >= '07/03/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '07/10/2014 12:00 AM' '%CURRENTWEEK6%' - Lks at the current date and inserts the dates fr the Friday in the same calendar week and the next Friday. Example On Mnday, 6/30/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTWEEK6%' It becmes: EFEQUIP.ge_cur_dt >= '07/04/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '07/11/2014 12:00 AM' '%CURRENTWEEK7%' - Lks at the current date and inserts the dates fr the Saturday in the same calendar week and the next Saturday. Example On Mnday, 6/30/2014, a user runs the filter: EFEQUIP.ge_cur_dt = '%CURRENTWEEK7%' It becmes: EFEQUIP.ge_cur_dt >= '07/05/2014 12:00 AM' AND EFEQUIP.ge_cur_dt < '07/12/2014 12:00 AM' 45