1. Open the Import and Update? tool and click to create a new configuration.
2. Enter the Import Name.
3. General Tab
   • Select the part of the Lucity program into which the records will be imported.
   • Designate a Output Directory for any bad records.
   • On the right side of the tab, select the options you wish to enable for the import.
4. Data Source Tab
   • Use the fields provided to to select and configure the data source.
5. Mapping Tab
   • Map the fields in the import data to fields in Lucity.
6. Correlations Tab
   • If you are mapping text fields into codes, or, if you have any other data that need to be converted during the import, create the necessary correlations.
7. Email Tab
   • Fill out the information on this tab if you want Lucity to send out an email notification when the import is complete.
8. Click to save the configuration.

1. Navigate to the configuration record.
2. Click the button.
   • If you have Prompt for Data Source checked you will receive a Prompt asking for the data you are importing.
   • If you are using the %PromptForDocumentDirectory% reserved word on the mapping tab you will be prompted for the location of your attached documents.
3. The import process will begin and the following progress bar will appear.

   

4. Depending on settings, if there are no records that fail to import, the program will import everything and be done.
5. If there are records that fail to import the following 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 Continue to import the records and complete the import.

1. Open the Import and Update tool and click to create a new configuration.
2. Enter the Import Name.
3. General Tab
   • Select the part of the Lucity program into which the records will be imported.
   • Designate a Output Directory for any bad records.
   • On the right side of the tab, select the options you wish to enable for the import.
   • Create a Group Name. This name will be used for all other configurations in the Group Import.
   • Enter the Group Order. This is a number that tells the Import program in which order to run the different configurations in during a Group Import.
4. Data Source Tab
   • Use these fields to select and configure the data source.
5. Mapping Tab
   • Map fields in the import data's to fields within Lucity.
6. Correlations Tab
   • If you are mapping text fields into codes, or, if there are any other data that need to be converted during the import, create correlations.
7. Email Tab
   • Complete these fields if you would like the system to send out an email notification when the import is complete.
8. Click to save the configuration.
9. Repeat Steps 1-8 to create configurations for each element of the Group Import.

   Notes: On the General Tab, the Group Name must be the same for all configurations. The Group Order value must be different for each element of the Group Import.

1. Locate a saved import configuration record that is part of the group you want to run.
2. Click the drop-down arrow on the button and select Group Import.
3. The import process begins, and a progress bar appears:

   

4. Depending on settings, if there are no records that fail to import, the program will import everything and be done.
5. If any records fail to import, the following screen appears:

   

6. If there are simple issues with the data, they can be fixed directly in the Import Review grid. After fixing the data, click Retry.
7. Click Continue to import the fixed records and continue with the remainder of the Group Import.

1. If your import records include information about documents or pictures that should be attached to the imported/updated record you can update Lucity with a link to that file.

   Important: The import and Update does not upload the file to Lucity's Document Hive. The import will only add a link to the file's existing location. You must place the files in the desired storage location and point Lucity to these files for the system to operate.

2. On the Mapping Tab create mappings for the following information
   • Document Description - A required description for the document. This can be the file name.
   • Document Path - The entire path to the document including the filename and extension. If the document is stored in a location that the Lucity Document Server has access to it will be able to serve the document to web and mobile users.
   • Document is a Web Page - Flag this if the document is actually a web url.
   • Document Open Directly- Marks whether the Lucity Document Server should attempt to open the file, or give the user a path, when a user attempts to open the document. Usually used for large files.
   • Document Publicly Available - Flag documents that are attached to Work Requests to control if the document will be available via the Lucity Citizen Portal RESTAPI.
   • Document Copy to Work Order - Flags a document attached to a record. When a work order is created from that record the document will be attached to the work order.
3. Save the import configuration.

1. Open the Import and Update? tool and click to create a new configuration.
2. Enter the Import Name.
3. General Tab
   • Select the part of the Lucity program into which the records will be imported.
   • Designate a Output Directory for any bad records.
   • On the right side of the tab, select the options you wish to enable for the import.
   • Check the Picklist Import box.
4. Data Source Tab
   • Use the fields provided to to select and configure the data source.
5. Mapping Tab
   • Map the data source field that contains the code values to a code field in the Lucity Module. (Required)
   • Map the data source field that contains the corresponding type value for the code field you already mapped to.
   • Note: You can only map to one code/type combination.
6. Click to save the configuration.

1. Open the Import and Update tool and click the drop down arrow next to the . Select Add Template.
2. The following pop-up will appear:

   

3. Select one or more templates from the list.

   Note: Most Lucity provided templates are part of a group. You will need to load and edit every template in that group.

4. Click Load.
5. The selected template(s) will be added into the import and update tool.
6. For each loaded template, edit the Template, change the Name so that it is unique and does not match the original template name and press Save.  This is necessary before making any additional changes to the loaded Template(s) so that they are initially saved to the Lucity database.
7. Each template is as filled out as much as possible. You will need to provide the following
   • General Tab > Output Directory - The location that you want bad records exported to.
   • Data Source Tab > Data Source - Point this to your import database.
8. Click to save the configuration.
9. When the save is successful the following pop-up will appear:

   

10. Click the Yes button all the other templates in this group use the same Data Source.
11. Go to each other template you imported and click .

1. Open the Import and Update? tool and click to create a new configuration.
2. Enter the Import Name.
3. Fill out the following information on the General Tab.
   • Select the part of the Lucity program into which the records will be imported.
   • Designate a Output Directory for any bad records.
   • Fill out the Group Name and Group Number if this template will be part of a group.
   • On the right side of the tab, select the options you wish to enable for the import.
4. If your template will contain mappings go to Data Source Tab and select a sample of your data.
5. Use the Mapping tab and Correlation tabs to complete your configuration.
6. Return to the Source Data tab and clean out the Source Data field.
7. Click the drop down arrow next to the and select Save as Template.

1. Open the Import and Update tool and click the drop down arrow next to the . Select Add Template.
2. The following pop-up will appear:

   

3. Select a Template in the list and click Delete.
4. The template will be deleted.

   Note: Lucity provided templates cannot be deleted.

1. Open the Import and Update.
2. Click the button on the toolbar to export all configurations. Skip to step 4.

   OR

3. Click the drop-down next to the button on the toolbar and select Export Selected Configurations to pick one or more configurations from a list. The following pop-up appears.

   

   • Select one or more configurations from the list.
   • Click Export.
4. The save pop-up will appear. Select a location and set a file name as desired.

   

5. Click Save.
6. A single XML file will be exported with the desired configurations.

1. Open the Import and Update.
2. Click the drop-down next to the button and select Add from XML. The following pop-up will open.

   

3. Select an .xml file and click Open. A pop-up similar to the following will open with a list of configurations saved in the xml file.

   

4. Select one or more configurations and click Load.
5. The configurations will be loaded into the import and configuration.
6. Click the button.

An administrator can also run an Import as part of a command line or script.

Use the following syntax and parameters when running the import in a script:

Lucity.ImportAndUpdate.exe [/S] [/P][Path] [/L][Configuration] [/C][Client] [/G]

Example: C:\Program Files\bin\Lucity\Lucity.ImportAndUpdate.exe /S /LHydrants /Cclint001

Note: There is a /T Token function. This is used internally by the program and should not be used when setting up the program as part of a script.

1. After configuring your import use the following steps to schedule the import.
2. Access the server that is running the Lucity Services.
3. Login as a windows users that is associated to a Lucity login and has windows administrative privileges.
4. Find and run the Lucity.ImportandUpdate.exe.
   • Login using windows authentication.
   • Navigate to the import you are setting up to run on a schedule and click the button.
5. Go to the computer's Control Panel and open Administrative Tools.
6. Open the Task Scheduler.
   • On the left side select Task Scheduler Library.

     

   • Right-click on it and select New Folder.
   • Name the new folder Lucity.
7. Right-click on the Lucity folder and select Create Task...
8. On the General tab...
   1. Enter the Name of the task. It is suggested to name it the same as the Import and Update Configuration that the task will run.
   2. Enter a Description of the task.
   3. Select the Run whether user is logged on or not button.
   4. Check the Run with highest privileges box.
9. Select the Triggers tab.
   1. Click the New... button.
   2. On the new trigger pop-up enter the schedule that you want the task to follow.
   3. Click OK.
10. Select the Actions tab.
    1. Click the New... button.
    2. In the Program/script field browse to the Lucity.ImportandUpdate.exe.
    3. Enter the parameters you would like to use in the Add arguments field. These are listed in the previous How To.
    4. In the Start In field enter the path to the Lucity Services folder. C:/Program Files (x86)/Lucity Services
    5. Click OK.
11. Click OK.
12. The task will ask for the windows credentials that it should run under. This windows users must:
    • Have permissions to run the .exe
    • Be mapped to a Lucity login that has permission to make updates to the modules that this Lucity Import configuration will be updating
    • Optionally it should have a non-expiring password

1. After configuring your import use the following steps to schedule the import.
2. Login the server that is running the Lucity Services. The windows credentials you use must be mapped to a Lucity login that has permission to make updates to the modules that this Lucity Import configuration will be updating
3. Locate and run the Lucity.ImportandUpdate.exe. This is typically located in the C:\Programs FIles (x86)\Lucity Services directory.
4. Login using windows authentication.
5. Select your import configuration. If it is part of a grouped import select the first configuration for the group.
6. Click the on the toolbar. The following pop-up will appear:

   

7. Enter a Name for the schedule.
8. If desired you can change the Lucity user the program Runs As. By default it runs as the services user.
   • Note that if you change this user you must make sure they have the necessary permissions to add/update records in the target module. You also need to make sure that a license is available for the module you are importing into.
9. Make sure the Enabled box is checked.

   Note: Currently the Lucity Scheduler only supports running once a Day at a specific time or every few minutes. Other sections of the form are disabled.

10. Use the Frequency section to set which days the import will run on.
    • Use the Occurs dropdown to select whether the import will run Daily or Weekly.
    • Use the Recurs Every field to set how many days should pass between when the import runs.
    • If Weekly is selected use the checkboxes to mark which days of the week the import should run.
11. Use the Daily frequency section to determine what time the import runs on the days that it is set to run.
    • To run once at a set time click the Occurs once at: button and select the time the import will run at..
    • To run all day on a time interval:
      • Click the Occurs every: button.
      • Select whether the import will be happeing at an interval of Hours or Minutes.
      • Select the number of minutes between times that the service will run.
      • Set the Starting at time and Ending at time. The schedule will only run between the indicated times on the appointed day..
12. Set a Duration.
    • Set a Start Date. The import will start running on that date. It will automatically be set to the current date.
    • If desired set and End Date. The import will stop running on that date.
13. Click OK.
14. Save the changes to the import configuration.

Example: In the below example the import will run every day, and will run every 5 minutes between 2 am and midnight. It will start this schedule on August 21, 2018, and will never stop on its own.

1. On the General tab check the Track Processed Records box.
2. On the Mapping tab map some data to the TrackingIdentifier field. It should be mapped to a field that uniquely identifies the record.
   • Ideally this is the same field you used for the Common ID
   • This may include a formula that builds a unique tracking ID based on one or more fields from the import data. (ex. Asset ID + Inspection Date for an inspection)
3. These records will now appear on the Processed tab.

1. Setup the ability to track processed records.
   • Make sure that you use the Common ID used in your data source to map to the TrackingIdentifier field.
2. If you are using Microsoft Access you will need open the database and link in the CMIMPPROCESSED table from the SQL database.
3. If you are using Microsoft SQL server your databases will need to be in the same sql instance.
4. Go to the Data Source tab
5. Update your Data Select SQL to exclude records that overlap 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.dbo.CMIMPPROCESSED INNER JOIN Lucity.dbo.CMIMPORTUPDATE ON IMP_ID = PRC_IMP_ID WHERE IMP_NAME = 'Your Import Name')

1. Setup the ability to track processed records.
   • Make sure that you use the Common ID used in your data source to map to the TrackingIdentifier field.
2. On the Mapping tab find the SkipProcessingIfNotBlank field.
3. Add the following formula
   • +SELECT TOP 1 PRC_ID FROM CMIMPPROCESSED INNER JOIN CMIMPORTUPDATE ON IMP_ID = PRC_IMP_ID WHERE IMP_NAME = 'Your Import Name' AND PRC_UNIQUE_ID = '=A12'
4. Replace the Your Import Name with the Name field for your Import Configuration.
5. Replace the =A12 with the field or formula you used to map the TrackingIdentifier field.
6. When running the import the will check each record to see if there is a matching record in the processed tracking table. If there is it will skip that record. If there isn't the record will be processed.