Linking to Lucity Web

At times, an agency might find it useful to create a URL that links directly to Lucity Web to view a particular asset, without navigating through the Lucity Web interface. For example, an agency may want to to embed such a URL into a Crystal report.

Use the following URL as a template for jumping directly into the Lucity Web program to view an Asset:

http://[myserver]/[virtualdirectory]/Public/Routing.aspx?RouteTarget=Internal&RouteSubTarget=Views&RouteAction=OpenDefault&RouteParam1=[moduleid]&RouteParam2=[viewname]&RouteParam3=[Filter[tablename]+WHERE+[autoNumberField]=[autoNumber]]

The following URL will open Lucity Web and display the Work Order with WO_ID = 33945:

http://ExampleServer/LucityWeb/Public/Routing.aspx?RouteTarget=Internal&RouteSubTarget=Views&RouteAction=OpenDefault&RouteParam1=48&RouteParam2=WO%20%2312-2343&RouteParam3=WKORDER+WHERE+WO_ID+%3D+33945

Users can create links to blank or existing Lucity forms using the Share with Others

feature from a form's Menu

. This tool produces a link similar to the example above but with slight variations to access a form rather than a view. After using this tool to create a form link, you then have the following advanced options for formatting a form link to fit a specific purpose:

The following example and parameters specify parts of the link to configure for advanced form routing:

http://[myserver]/[virtualdirectory]/Public/Routing.aspx?RouteTarget=Internal&RouteSubTarget=Views&RouteAction=OpenDefault&RouteParam1=[moduleid]&RouteParam2=[viewname]&RouteParam3=[defaultvalues]&RouteParam4=[tabdisplayname]&RouteParam5=[urlencodedjsonobject]

Create link to form:

Open a blank or existing form.
- To share a blank form, proceed to step 2.
- To share a specific record, complete the desired fields and select Save .
In the form, select the Menu button and select Share with Others .
Note: You must select Share with Others from the form's Menu. This button functions differently from a view.

The following dialog appears:
- The Dataset Name displays the unique ID for the record you are sharing. If you are sharing a blank record, the Dataset Name will be 0.
Select Copy.
Note: A message may appear asking if the program can access the clipboard. If such a message appears, select Yes.

Advanced form routing to pre-populate field values:

Write a JSON file that includes the specific field name(s) and data contents you want to pre-populate on the form.
- Use the Field Name that can be found in Form Design Mode's Component Information pop-up.
Use a JSON URL-encoder to translate your JSON to URL script:
Copy the resulting URL script.
In your form link, enter the following to the end of the link after RouteParam4:
- &RouteParam5=[urlencodedjsonobject]
Paste the completed form link into an email or document, or link to your dashboard.
- Example: http://LCT-TLB-01/201/LUCITYWEB/Public/Routing.aspx?RouteTarget=Internal&RouteSubTarget=Forms&RouteAction=Open&RouteParam1=48&RouteParam2=24920&RouteParam3=390972&RouteParam4=Work+Orders+%23390972&RouteParam5=%7B%20%0A%20%20%22StartDate%22%3A%2203%2F23%2F2020%22%2C%0A%20%20%22StartTime%22%3A%2214%3A07%22%0A%7D

[myserver]	The name of the server hosting Lucity Web.
[virtualdirectory]	The virtual directory in which Lucity Web is installed. By default: LucityWeb.
[moduleid]	The identifying number for the module you wish to open. To zoom to a specific Sewer Pipe record, use the module ID for the Sewer Pipes module. To zoom to a specific Work Order, insert the ID for the Work Order module. All module IDs are stored as KeyIDs in the Lucity.dbo.Modules table.
[viewname]	The name you wish to appear at the top of the View when it is loaded. Use + or %20 to represent spaces.
[Filter......]	The remaining parameters fall within this section of the URL. These parameters are provided as an example; however, the intent is to enter a filter that starts with the table found in the From clause of a SQL statement in order to filter the records that are displayed in the View. Use %3D to replace an = sign.
[tablename]	The name of the table in which the feature or record is stored.
[autoNumberField]	The name of the field in which the autonumber is stored.
[autoNumber]	The database record number that the program assigned to identify the desired feature. For the Lucity.dbo.SWNET table, the [autoNumber] would be NT_ID.

RouteParam#	Link content	Purpose
RouteParam1	[moduleid]	The identifying number for the module you wish to open. To zoom to a specific Sewer Pipe record, use the module ID for the Sewer Pipes module. To zoom to a specific Work Order, insert the ID for the Work Order module. All module IDs are stored as KeyIDs in the Lucity.dbo.Modules table.
RouteParam2	[formORrecordname]	The unique ID for the form to be opened. To open the default record, this value should be the unique ID for the specific record you want to populate the form with.
RouteParam3	[defaultvalues]	The values of fields that are typically defaulted on this form.
RouteParam4	[tabdisplayname]	The name you want displayed on the form tab that opens. This will default to module name and ID for a specific record. Ex: Work+Orders+1234
RouteParam5	[urlencodedjsonobject]	A url-encoded json object to populate specific fields such as start date/time.