Lucity Module Tool

The Lucity Module tool allows users to click on a feature(s) in the map and view all its related records in Lucity. It also allows users to create Work Orders, Requests, and Inspections inside of Lucity, based on a feature in the map. Using this tool requires that a feature class that is connected to Lucity must be in the map. After selecting the tool and right-clicking in the map, a menu will appear with the following options:

How To Use the Lucity Module tool

1. Select the Lucity Module tool from the Analyst toolbar.
2. In the map, right-click on the feature with which you would like to work.

   Note: The Lucity Module tool uses a default search tolerance of 7 map units to obtain a list of features at the location of the mouse-click. The default tolerance can be changed using the settings button on the Lucity Edit toolbar. This value can also be modified for this map session by pressing Shift + F7 when the desktop Module tool is active. For more information about modifying this search tolerance go here.

   Note: To work with multiple features, use the Lucity Module tool to select several features and then right-click anywhere in the map.

3. A dialog box will appear.

   

4. Select one of the options:

   View Feature Relationships

   1. After selecting View Feature Relationships a sub-menu will appear listing the features located within the search tolerance of the mouse-click. If there are any selected features in the map, there will also be an item in the list for all selected features of a specific type.

      

   2. Select the item in the sub-menu to view relationships for. After an item is selected a dockable window will appear. By default, this window will be docked to the right of the ArcMap window.

      

      • The window displays a list of related modules based upon the type of asset chosen. Next to the module description is the number of related records in parentheses. Modules that have related records will be listed in bold.
      • The window includes two buttons, Open Module in Lucity Desktop and Open Module in Lucity Web.
   3. Select the module in the dockable window then click the Open Module in Lucity Desktop or Open Module in Lucity Web button.
   4. Lucity will open up to the related record(s).

   Create a Request

   1. After selecting Create Requests the following options will appear:

      

      • X/Y: This option creates a request with the X/Y coordinate at the right-click or against a single asset plus the X/Y coordinate.
      • For a Single Asset: This option creates a request for the asset.
      • For Each Asset: This option will create a separate request for each of the selected assets. This includes multiple asset types.
   2. After selecting the desired option a grid will appear. By default this grid contains the required fields from the request module. This includes both fields required by Lucity and fields set as required by users.
   3. Populate the fields in the grid.

      

      • Additional fields can be configured so they also appear in the grid. Each row in the grid represents a separate work request record. Refer to the Default Fields Setup tool available on the Lucity toolbar in ArcCatalog for more information.
      • It is strongly recommended to populate the CategoryCode column first. This is due to the fact that other columns may populate automatically based upon the category chosen.
      • To assign the same value to multiple rows, select the desired rows by holding down the Shift key, then while still holding the Shift or Ctrl key click in the field to update and set the value. After updating the cell click on another cell for the grid to be refreshed and show the updated values.

        Note: The grid automatically detects data type errors after another cell is selected. If the entered value is not valid a message similar to the following will appear:

      

      • Work flow setup columns will be followed by a white button. Clicking the button will open a popup list of selectable values. Select the appropriate item from the list. If the user has permission, the Show All button will be enabled allowing them to toggle between seeing just the items associated to the category or all items in the system.
   4. If desired check the box for Export the current map display and attach it to the request(s) to create and attach a pdf of the current map extent to each request.
   5. After filling out all of the required fields, submit the request. There are several submission options:
      • Submit and View in Desktop: This option will submit the request(s) and automatically open it in desktop application. The first record will be opened in edit mode.
      • Submit and View in the Web: This option will submit the request(s) and automatically open it in the web application.
      • Submit Only: This option will submit the request(s), but Lucity will not be opened.
      • Cancel: This will cancel the request(s).

   Create a Work Order or PM/Template

   1. After selecting Create Work Orders or Create PM/Work Templates the following options will appear:

      

      • X/Y: This option creates a work order or PM/Template with an associated X/Y coordinate.
      • For a Single Asset: This option creates a work order or PM/Work template for the asset.
      • For All Assets: This option creates a SINGLE work order or PM/work template for ALL of the selected assets.
      • For Each Asset: This option creates a separate work order or PM/work template for each selected asset.
   2. If For all assets or For each asset is selected an option will be in the list to choose For all selected features in the map.
   3. If an asset doesn't have a Default Work Category or if For all selected features in map is selected the following popup will appear prompting for a category for each type of asset. This is required in order to properly populate the category associated with each asset selected.

      

      Note: The Select button is only enabled if a valid category is selected.

   4. After selecting the desired option a grid will appear. By default this grid contains the required fields for the work order or pm/work template. This includes both fields required by Lucity application and fields set as required by users in the desktop.
   5. Populate the fields in the grid.

      

      • Additional fields can be configured so they also appear in the grid. Each row in the grid represents a separate work order or pm/PM template record. Refer to the Default Fields Setup tool available on the Lucity toolbar in ArcCatalog for more information.
      • It is strongly recommended to populate the CategoryCode column first as other columns may populate automatically based upon the category chosen.
      • To assign the same value to multiple rows, select the desired rows by holding down the Shift key, then while still holding the Shift key click in the field to update and set the value. After updating the cell click on another cell for the grid to be refreshed and show the updated values.

        Note: The grid automatically detects data type errors after another cell is selected. If the entered value is not valid a message similar to the following will appear:

      

      • Work flow setup columns will be followed by a white button. Clicking the button will open a popup list of selectable values. Select the appropriate item from the list. If the user has permission, the Show All button will be enabled allowing them to toggle between seeing just the items associated to the category or all items in the system.
   6. If desired check the box for Export the current map display and attach it to the Work Order(s) to create and attach a pdf of the current map extent to each Work Order.
   7. After filling out all of the required fields, submit the work order or PM/template. There are several submission options:
      • Submit and View in Desktop: This option will submit the work order or PM template and automatically open them up in desktop application. The first record will be opened in edit mode.
      • Submit and View in the Web: This option will submit the work order or PM template and automatically open them up in the Web application.
      • Submit Only: This option will submit the work order or PM template, but Lucity will not be opened.
      • Cancel: This will cancel the work order or PM template.

   Create an Inspection

   1. After clicking Create an Inspection the following options will appear:

      

      • For a Single Asset: This option will create an inspection for the asset.
      • For All Assets: This option will allow the user to create a separate inspection for each selected asset.
   2. After selecting an option a form similar to the following will appear:

      

   3. Select the type of inspection to create and select an inspection date.
      • The list of inspection types is based upon the asset type of the feature. Some asset types will have multiple inspection types, while others only have one. There are a few asset types that don't have an inspection module. In those cases you will receive the following prompt:

      

   4. Once the type of inspection, and inspection date are selected, click Submit. A grid similar to the following will appear. By default this grid contains the required fields for the inspection. This includes both fields required by the Lucity and fields set required by users in the desktop application.
   5. Populate the fields in the grid.

      

      • Additional fields can be configured so they also appear in the grid. Each row in the grid represents a separate inspection record. Refer to the Default Fields Setup tool available on the Lucity toolbar in ArcCatalog for more information.
      • To assign the same value to multiple rows, select the desired rows by holding down the Shift key, then while still holding the Shift key click in the field to update and set the value. Once the cell is updated and a different cell is selected the grid will be refreshed to show the updated values.
      • The grid automatically detects data type errors after another cell is selected. If the entered value is not valid a message similar to the following will appear:

      

      • A document can be attached to an inspection by clicking the white button in the associated document column. The following window will appear:

      

      • Type or browse to the document location and enter a description, then click Attach.
   6. After filling out all of the required fields, submit the inspection. There are several submission options:
      • Submit and View in Desktop: This option will submit the inspections and automatically open them up in desktop application. The first record will be opened in edit mode.
      • Submit and View in the Web: This option will submit the inspections and automatically open them up in the Web application.
      • Submit Only: This option will submit the inspections, but Lucity will not be opened.
      • Cancel: This will cancel the inspections.
   7. The following screen will appear

      

   View Associated Documents

   1. After selecting View Associated Document(s) a sub-menu will appear listing the features located within the search tolerance of the mouse-click.

      

   2. Click on the desired asset and the Associated Documents window will appear.

      

   3. All modules related to the feature will appear in the list on the left. Following the module description will be the number of associated documents in parenthesis. Selecting a module will update the grid to the right that lists the associated documents.
   4. To view a document, simply double-click it and a separate window will open with the associated document.

   Associate Documents

   1. After selecting Associate New Document a sub-menu will appear listing the features located within the search tolerance of the mouse-click. If there are any selected features in the map, there will also be an item in the list for all selected features of a specific type.

      

   2. After selecting the desired option the Select Document to Associate window will appear. Browse to the document or enter in a website or hyperlink. The Document Description must be filled out.

      

   3. After entering in the appropriate information, click Attach.