Text constants

The various picklists of the application forms are retrieved from the text constants. If the content of the text constants is edited, the picklists on the forms will be changed accordingly when the application page is reloaded. Text constants are also used for other purposes. For example, they can be used to specify the privacy policy website.

Note! KeyAqua’s text constants are available in two different text constant tables: Aqua’s text constants (Keyaqua_Core – Text constants) and Text constants (Txt_Constant group – Text constants).

When creating new text constants or when editing existing constants, you should check the spelling. The group name field for text constants must not contain spaces because they may result in system malfunction. Normally, there is no reason why the Group name field should be modified when text constants are modified. However, if a space is incorrectly included in the Group name field of the text constant, the text in the Group name field for the text constant should be modified. The group name for the text constant must already exist in the system. In other words, no new text constants should be created. In addition, it is good to note that Aqua’s text constants and the Txt_Constant text constants have groups with the same names (e.g. DUCT_STATE).

Deleting text constants should be avoided. However, if you want to delete text constants that belong to a text constant group, we recommend that you contact Keypro support. Text constants not mentioned in this document should not be modified without the permission of Keypro Oy. If you have created a new common text constant (Txt_Constant) and want to delete it, you should follow the instructions in the Deleting common text constants chapter.

Editing and deleting text constants

In the admin user interface, click the Text constants link under Keyaqua Core or the Text constants link.

On the displayed list, click the ID of a text constant to edit it. To limit the list content to a single group, click the group in question on the Filter list.

General text constant columns

Text constants include the following information for each setting:

• Group name: text constants have been divided into groups, which are used to categorise the settings related to various topics.
• Logical text: the text that the application uses internally.
• Text [fi]…Text [en]: the translations of the Text field that are displayed in the browser in the selected language.
• Numeric value: is used, for example, as the numeric value equivalent to the text value, to provide information on whether the object is included in the safe-to-dig.com service, whether the feature is in use and to indicate the type of technology. Further information is available in the chapter that discusses each specific group.
• Abbreviation: the internally used default abbreviation of the text constant. 
• Abbreviation [fi]...Abbreviation [en]: the translations of the Abbreviation field that are displayed in the browser in the selected language. If the selected language is not supported, the Abbreviation field will be displayed.
• Numeric value 2…Numeric value 4:
• Text value: varies depending on the group. As a rule, this is not in use.

Category: Four-digit data. E.g. 7012 (Gas) or 7022 (District heating). Specifies the forms on which specific shared (e.g. VALVE_OPEN_STATE) text constant group data is displayed.

• Description: May contain descriptive information. As a rule, this is not in use.
• Value…Value 4: these fields are usually related to the description techniques of old systems. You can ignore these fields if you are using the browser application.

Optional data: Typically contains longer text. As a rule, this is not in use.

• Order no: a sequence number for settings. For example, if the values of a group are retrieved for a picklist, the values will be displayed in the order specified by the order number. For some groups, values with negative order numbers are not displayed on the picklists.
• Availability start and end:displayed/can be modified through the group’s own admin interface if the field is in use. If data has been entered in these fields, selections with availability start or end dates in conflict with the current date (not available anymore or availability period has not yet started) will be displayed either in grey or not at all depending on the group.

Text constant columns in KeyAqua

To edit KeyAqua’s text constants, select Keyaqua_Core - Text constants:

• Group name: text constants have been divided into groups, which are used to categorise the settings related to various topics. You should pay attention when spelling a group name.
• Txt (fi)... Txt (en): texts that are displayed in the browser in the selected language.
• Txt 2: contains various data in text format depending on the purpose of the text constant group. For example, color codes in the form of #RRGGBB (Hex).
• Order: a sequence number for settings. For example, if the values of a group are retrieved for a picklist, the values will be displayed in the order specified by the order number. For some groups, values with negative order numbers are not displayed on the picklists.
• Numeric value: is used, for example, as the numeric value equivalent to the text value, to provide information on whether the object is included in the safe-to-dig.com service, whether the feature is in use and to indicate the type of technology. Further information is available in the chapter that discusses each specific group.
• Abbreviation [fi]...Abbreviation [en]: Abbreviations that are displayed in the browser in the selected language.
• Value: A text value, such as a URL or a string of characters describing a state, such as CLOSED.

Deleting common text constants

You must use a separate delete function to delete common text constants (Txt_Constant). You can use the delete function to delete one or more text constants from the list at one go. Before deleting a text constant, make sure that it is not used in KeyAqua. If a constant is used by the system, the deletion will fail.

Select Text constants:

Find the text constant you want to delete. Click the first check box for a text constant row to select a constant. Then select Delete constant(s) with no checks in the Action drop-down menu and click Go. 

Click Yes, I’m sure to confirm the deletion of the text constant.

KeyCore text constants

Login screen terms

The terms and conditions link available in the login screen is defined in the TERMS_AND_CONDITIONS group under Text constants. To activate the link in the login screen, fill in the following fields:

• Group name: TERMS_AND_CONDITIONS
• Logical text (TXT): private_terms
• Order number: 1 (order number)
• Text value: Link of for the terms and conditions. For example, “https://www.company.com/terms_and_conditions”.
• Text [en]: Yksityiset ehdot (value that is visible to the user)
• Text [en]: Private terms (the value shown to the user on the English login page)
• Text [en]: Private villkor (the value that is displayed to the user on the login page in Swedish)

Defaults

To set the defaults, go to an object form in the application and click Save as defaults in the drop-down menu for Save. The selection is only visible to admin users. You can define defaults for nearly all forms, such as Plan, Point object, Address, Text, Line and Area forms.

Placement scale

The placement scales available in the map tools are defined in the SCALE group under Text constants.

• Text…Text (en): a scale value that is appropriate for the user, for example, 1:500.
• Numeric value: the numeric value equivalent to the text for scaling objects.
• Value: not available in the browser application. A reference to a Feature table. Contact Keypro’s application support for help.
• Value 2: not available in the browser application. A reference to a Feature table. Contact Keypro’s application support for help.
• Numeric value 2: defines the default placement scale. The default placement scale when the application is launched is a placement scale with a Numeric value 2 = 1.

Location accuracy and height accuracy

Location accuracies are defined in the LOCATION_ACCURACY group, while the H_ACCURACY group is used to define height accuracies. Both are used on some of the object forms in the relevant picklists on the Common settings tab.

• Text…Text (sv): text specifying the location accuracy, for example, “+-5 m”
• Numeric value: a numeric value equivalent to the text field, for example, 5.0. The value in this field is the radius of a circle in metres, within which the actual location of an object is when measured from the object’s saved location and at the applied level of certainty.

Plan state

The state of a plan is defined in the PLAN_STATE group.

• Numeric value 2: if the state of a plan is changed to Ready, the user will be asked whether the usage states of the related objects should be updated (they will be updated to a usage state with the numeric value 1. Further information is available in the Usage state chapter).

If the Numeric value 2 is not zero or NULL, the plan-related objects with the usage state “planned” will be displayed in the safe-to-dig.com service. (Objects with the usage state “in use” are always displayed in the safe-to-dig.com service, regardless of the plan’s state.) This means that it is possible to specify, for example, that objects linked to plans that are in the pre-planning phase or under planning are not displayed in the safe-to-dig.com service. If a planned object is not linked to any plans, it will be displayed in the safe-to-dig.com service.

• Numeric value 3: For example, for a constant in the PLAN_STATE group the logical text of which is In preplanning, the numeric value is 1. You must not edit this.

Plan type

The plan type is defined in the PLAN_TYPE group:

Numeric value: defines the type of plan in question:

If the plan’s type is deconstruction and the plan’s usage state is changed to Ready (see the Plan state chapter for more information), the user will be asked whether the objects related to the plan should be deleted or scrapped. If the user selects deletion, the objects will be deleted. If the user selects scrapping, the usage state of the objects will be changed to a usage state (see Usage state for more information) with a numeric value of 3. This feature is activated with the setting PLAN_AUTOMATIC_SCRAPPINGS.

Work type tab for Plan

The Work type tab for the Plan form is a feature that can be ordered separately.

The values for the picklists are defined in the following text constant groups:

Point object types

Name: name that the application uses internally.

Label [fi]…Label [en]: localised name that is visible to users.

Symbol name: the symbol that is displayed on the map.

Point object type category: the category that the type belongs to. See the Point object type categories chapter for further information.

Point object type categories

The type categories of point objects are defined in the POINT_TYPE_CATEGORY group.

• Logical text: the text that the application uses internally:

• Text [fi]…Text [en]: the translations of the Text field that are displayed in the browser in the selected language.
• Numeric value: the type of the category:

Line

The content of the Type picklist on the Line form is defined in the FREE_LINE_TYPE group. The logical texts and numeric values for the default constants in the system (Redline and Measurement) must not be edited without Keypro’s consent.

• Logical text: the text that the application uses internally:

• Text [fi]…Text [en]: the translations of the Text field that are displayed in the browser in the selected language.
• Order no.: Defines the order of the type on the picklist.
• Numeric value: For system-internal use (must not be modified):

The options for the Usage state picklist are defined based on the constants in the FREELINE_STATE group. In most environments, there are two options: Planned and In use.

• Logical text: the text that the application uses internally.
• Text [fi]…Text [en]: the translations of the Text field that are displayed in the browser in the selected language.
• Order no.: Defines the order of the type on the picklist.
• Numeric value: For system-internal use (must not be modified):

Text

The contents of the Type picklist on the Text form is defined in the FREE_TEXT_TYPE group. The system has one option by default: Redline. The logical text and numeric value for the constant in question must not be modified without Keypro’s consent.

• Logical text: the text that the application uses internally.
• Text [fi]…Text [en]: the translations of the Text field that are displayed in the browser in the selected language.
• Order no.: Defines the order of the type on the picklist.
• Numeric value: For system-internal use (must not be modified):

The options for the Usage state picklist on the Text form are defined based on the constants in the FREETEXT_STATE group. In most environments, there are two options: Planned and In use.

• Logical text: the text that the application uses internally.
• Text [fi]…Text [en]: the translations of the Text field that are displayed in the browser in the selected language.
• Order no.: Defines the order of the type on the picklist.
• Numeric value: For system-internal use (must not be modified):

Address usage purposes

The usage purposes of addresses are defined in the APARTMENT_USAGE group (the usage purpose of an apartment) and the BUILDING_USAGE group (the usage purpose of a building).

• Numeric value...numeric value 4: these fields specify the addresses that will be excluded in various situations, for example, if you do not want to include addresses with the usage state Demolished. If no value has been entered or the value entered into the field is 0, the address will be included. Otherwise the address will not be included. Addresses are displayed in accordance with the table below.

• Text value: The Text value of the BUILDING_USAGE group specifies the color of the address symbol.

Address usage purpose 2

The values for the Address usage purpose 2 field are defined in the KN_ADDR_SPEC group.

• Text value: The text value defines the color used to display the address number on the map.

Usage state of an apartment

The contents of the Usage state picklist on the Apartment form is defined in the APARTMENT_STATUS group.

Coordinate system options

To define the Coordinate system options that are displayed to users, go to the KEYCORE_IMPORT_SRS groups under Text constants.

• Text value: the code equivalent to the coordinate system. This code must be included in the Code column of the Coordinate systems. See the Coordinate systems chapter for more information.

Note! The KEYCORE_IMPORT_SRS group under Text constants defines the options displayed to the users. The equivalent information must be included in the coordinate system definitions (see the Coordinate systems chapter).

Area types

Area types are defined in the FREEAREA_TYPE group.

• Numeric value: defines the area type

Area categories

Area categories are defined in the FREEAREA_CATEGORY group. The Txt constant links chapter provides information on linking area types to categories.

Txt constant links

• Parent id: Area category (see Area categories).
• Child id: Area type (see Area types).

Usage states of areas

The usage states of areas are defined in the FREEAREA_STATE group.

• Numeric value:

Privacy policy and help texts

If the KeyCore text constants include the text constant for group TERMS_AND_CONDITIONS, a link to the terms of service and privacy policy will be displayed on the KeyAqua home page. The link text is retrieved from the Text [fi]... Text[en] field and the link address from the Text value field (in the format: http://...). More than one link can be added by using a constant. A comma and space are automatically used to separate the links. The web page defined for the link is opened on a new tab.

The menu texts for the user manuals are derived from the HELP_MANUALS text constant fields: Text [fi]… Text [en]. You can edit the text in those fields, but the contents of other fields may only be modified by Keypro.

You can add links to instructions in the Help menu by adding text constants to the HELP_REST group. By default, the HELP_REST group includes Keypro Oy, which opens Keypro Oy's homepage on a new tab. You can create your own link to a page (Figure 21) by using the default page as a template and by completing the mandatory fields. The order number must be different for each text constant in the HELP_REST group.

You can change the description text that appears in the About window by editing the values of the HELP_ABOUT group’s constant: Text [fi]… Text [en]. Other fields may only be edited by Keypro. The HELP_ABOUT group may include only one constant.

Consumer point

Some of the information in the picklists for the Consumer point form is defined in the common text constants (Txt_Constants) and some in the Keyaqua_Core text constants. For more information on the KeyAqua text constants, see the Consumer point chapter.

The logical text for the CP_TYPE group constants must not be edited. The texts for the picklists can be modified in the Text [fi]…Text [en] fields. The options for the Heating form field are defined in the HEATING_FORM group and they are mainly related to external interfaces.

Customer registration (This feature is subject to a separate order.)

Some of the texts for the Customer registration feature (which is subject to a separate order) can be updated by modifying the optional information for the CUSTOMER_REG_TEXT constants in the common text constants (Txt_constants) group. In addition, the text in the additional header on the Contact Update form is also derived from the constants in that group. At the moment, only texts in Finnish can be modified through the admin user interface. Keypro modifies the texts in English and Swedish.

KeyAqua text constants

Customer

Customer-related groups are defined in Keyaqua_Core text constants – usually in groups whose names start with CUSTOMER.

Invoicing languages are defined in the CUSTOMER_INV_LANG group:

• Txt (fi)…Txt (en): Invoicing language, e.g. Finnish.
• Numeric value: Reserved for the following values:

Customer roles are defined in the CUSTOMER_ROLE group:

• Txt (fi)…Txt (en): Description of the role, e.g. Tenant.
• Numeric value: Reserved for the following values:

Customer states are defined in the CUSTOMER_STATE group:

• Txt (fi)…Txt (en): Description of the state, e.g. Active.
• Numeric value: Reserved for the following values:

Customer types are defined in the CUSTOMER_TYPE group:

• Txt (fi)…Txt (en): Type description, e.g. Private or Municipality.
• Numeric value: Reserved for the following values:

Consumer point

Groups related to consumer points are defined in the Keyaqua_Core text constants and usually in groups whose names start with CONSUMERPOINT or CONSUMER_POINT.

Text constants related to the amount of asbestos and the required protection are defined in the CONSUMERPOINT_ASBEST group. These can be used to modify the values in the Asbestos fields on the Consumer Point form.

• Txt (fi)…Txt (en): Description of the amount of asbestos, e.g. 4 - requires protection.
• Numeric value: Reserved for the following values:

The groups for the consumer point are defined in the group CONSUMERPOINT_GROUP. Txt (fi)... Txt (en) is the description of the group. No numeric values are used.

The states for the consumer point are defined in the group CONSUMERPOINT_STATE as follows:

• Txt (fi)…Txt (en): Description of the state, e.g. Active or Extinct.
• Numeric value: Reserved for the following values:

The values for the Consumer Point form’s fields Sprinkler customer and Industrial wastewater are defined in the SPRINKLER_CUSTOMER and INDUSTRIAL_WW_CONT groups (in this order). In these, Txt (en)... Txt (en) specifies the description, which is usually Yes or No. In addition, the numeric values are reserved as follows:

The values for the Consumer Point form’s field Critical customer are defined in the CRITICAL_CUSTOMER group. Txt (fi)... Txt (en) specifies the description, which is usually Yes or No.

If the customer has ordered the Supply interruption functionality, the values may be as presented in the table below. The numerical values must not be edited without Keypro’s consent. Txt 2 defines the color on the Supply interruption form (Supply interruption (a district heating function subject to a separate order)).

User of a consumer point

Text constants related to the consumer point’s user are defined in KeyAqua_Core’s text constants in groups that usually start with CP.

Activity values are defined in the group CP_ACTIVITY:

• Txt (fi)…Txt (en): Description of activity, e.g. In use.
• Order no.: Reserved as follows:

The categories for the consumer point’s users are defined in the CP_CATEGORY group:

• Txt (fi)…Txt (en): Description of the category, e.g. Normal customer.
• Order no.: Reserved as follows:

Sources are defined in the CP_SOURCE group:

• Txt (fi)…Txt (en): Description of the source, e.g. KeyAqua or External.
• Txt_2: Usually empty, or Bisnode if the consumer point’s user is imported from an external source.
• Order no.: Reserved as follows:

• Numeric value: Reserved as follows:

Usage state

Usage states are defined in Keyaqua_Core text constants in the USAGE_STATE group. It is used on several different forms, including the Valve, Manhole and Node forms.

• Txt (fi)…Txt (en): Description of the usage state, e.g. Planned or Discarded.
• Numeric value: Reserved for the following values:

Error report

Text constants related to error reports are defined in Keyaqua_Core text constants. The names of the groups start with ERROR. Txt (en)... Txt (sv) defines the description. No numeric values are used:

Error and investigation area

The areas used in the error reports and investigations are defined in Keyaqua_Core text constants in the SN_DISTRICT group. Txt (en)... Txt (sv) defines the area description. No numeric values are used.

Maintenance and repair

The types of Maintenance and Repair forms are defined in Keyaqua_Core text constants in the SN_OPERATION_TYPE group. There are two types: Maintenance and Repair, which must not be deleted. The translated texts can be edited if necessary.

• Txt (fi)…Txt (en): Description, usually either Maintenance or Repair.
• Numeric value: Reserved for the following values:

Type of operating area

Operating area types are defined in Keyaqua_Core text constants in the COOPAREA_TYPE group.

• Txt (fi)…Txt (en): Description of the operating area type, e.g. Water.
• Numeric value: Reserved for the following values:

Occurrence

Occurrence types are defined in Keyaqua_Core text constants in the OCCURRENCES group:

• Txt (fi)…Txt (en): Description of the occurrence, e.g. Error report.
• Numeric value: Reserved for the following values:

Measure

Measures are defined in Keyaqua_Core text constants in the SERVICE_TYPE group. The types are used on the Failure report and Maintenance forms. Txt (fi)... Txt (en) is the description of the procedure, e.g. Replacing a meter.

CCTV

CCTV descriptions are defined in Keyaqua_core text constants in the TV_INSPECTION_CODES group. These are related to the CCTV functionality, which can be purchased separately.

• Txt (fi)…Txt (en): Description, e.g. Surface damage. Do not edit.
• Value: Type of damage in accordance with the table below:

Importing phone numbers

The SMS sending service is accompanied by a phone number import function, where you can import phone numbers from a file into the system. You can select the customer name and phone number columns in the file using drop-down menus, which are defined in the Keyaqua_Core text constants in the MESSAGING_COLUMN group.

• Txt (fi)…Txt (en): Description of the column, e.g. In column 1 of the file.
• Numeric value: Specifies the location of the column in the file starting from zero. In other words, 0 is the first column, 1 the second, 2 the third, etc.

Work program

Text constants related to work programs are defined in the Keyaqua_Core text constants in groups whose names start with PROGRAM. These mainly affect the options that are selected from the drop-down menus of the Work Program form.

Program types are defined in the PROGRAM_TYPE group:

• Txt (fi)…Txt (en): Description of the program type, e.g. Renovation program.
• Numeric value: Not in use.

The values in the drop-down menu for Renovation are defined in the PROGRAM_RETYPE group:

• Txt (fi)…Txt (en): Description of the program type, e.g. Renovation program.
• Numeric value: Reserved for the following values:

Invoicing

Text constants related to invoicing are defined in Keyaqua_Core text constants in groups whose names start with INVOICE. These are related to the invoicing functionality, which is available as a separate purchase, and there is usually no need to change them.

Invoicing groups are defined in the AQUA_INVOICE_GROUP group:

• Txt (fi)…Txt (en): Description of the invoicing group, e.g. Water billing.
• Numeric value: Defines the invoicing group in accordance with the table below. Do not edit!

The types of invoicing are defined in the INVOICE_TYPE group:

• Txt (fi)…Txt (en): Description of the invoicing type, e.g. Estimate or Meter reading.
• Numeric value: Defines the invoicing type in accordance with the table below. Do not edit!

Device source

Device sources are defined in the common text constants (Txt_Constant) in the DEVICE_SOURCE group. Source selections are used on the Device form. Text [fi]... The text [en] is a description of the source, e.g. AqvaRex.

• Text [fi]… Text [en]: Description of the source, e.g. Aqvarex.
• Text value: Defines the source in accordance with the table below. Do not edit!

Unconnected real estate

Text constants related to unconnected real estate are defined in the Keyaqua_Core text constants. These mainly affect the options available in the drop-down menus of the Unconnected real estate form.

The audit status drop-down menu options are defined in the LICENSE_STATE group:

• Txt (fi)…Txt (en): Description, e.g. Pending or Not handled.
• Numeric value: Not in use.

The types of unconnected real estate are defined in the UNCONN_REALEST_TYPE group:

• Txt (fi)…Txt (en): Type of real estate, e.g. Row house or Apartment house.
• Numeric value: Not in use.

Fireplug

Text constants related to fireplugs are defined in the Keyaqua_Core text constants in groups whose names start with FIREPLUG. These primarily define the options available in the drop-down menus on the Fireplug form.

The categories of fireplugs are defined in the FIREPLUG_CLASS group:

• Txt (fi)…Txt (en): Description of the category, e.g. Wall fireplug or Ground fireplug.
• Numeric value: Not in use.

Two groups are required to define the fireplug types: FIREPLUG_TYPE and NEW_FIREPLUG_TYPE. For each type definition in the FIREPLUG_TYPE group, an identical type definition is required in the NEW_FIREPLUG_TYPE group.

• Txt (fi)…Txt (en): Description of the category, e.g. Stockholm.
• Numeric value: Not in use.

In addition, a new row must be added to the AQUA_FIREPLUG_TYPE table, with the row referring to the value in the NEW_FIREPLUG_TYPE group.

The manufacturers of fireplugs are defined in the FIREPLUG_MANUFAC group:

• Txt (fi)…Txt (en): Description of the category, e.g. Undefined.
• Numeric value: Not in use.

Hydrant

Text constants related to hydrants are defined in the Keyaqua_Core text constants in the HYDRANT_KEYTYPE and HYDRANT_MANUFACTURER groups.

The key hydrant types are defined in the group HYDRANT_KEYTYPE:

• Txt (fi)…Txt (en): Description of the key type, e.g. Triangle or Square.
• Numeric value: Not in use.

Hydrant manufacturers are defined in the HYDRANT_MANUFACTURER group:

• Txt (fi)…Txt (en): Description of the manufacturer, e.g. Undefined.
• Numeric value: Not in use.

Modeling

Text constants related to modeling are defined in Keyaqua_Core text constants in groups whose names start with MODELING. Modeling is a feature that can be purchased separately.

The MODELING group is used to define the general modeling constants:

Modeling types are defined in the MODELING_TYPE group:

• Txt (fi)…Txt (en): Description of the type, e.g. Planned network.
• Value: Reserved as follows:

Modeling states are defined in the MODELING_STATUS group:

• Txt (fi)…Txt (en): Status description, e.g. Modeling in progress.
• Value: Reserved as follows:

The properties of the modeling results are defined in the MODELING_RESULT_PROPERTIES group:

• Txt: The internal field name in the data model, e.g. avg_head.
• Value: The properties displayed in JSON format. JSON may include the following features:

The colors of the water origin legends in the modeling results are defined in the MODELING_NODE_RESULT_ORIGIN_COLOR group:

• Order no.: Specifies the order of colors used.
• Value: Color code, e.g. "#FF0000".

SmartWater

Text constants related to the SmartWater functionality are usually defined in Keyaqua_Core text constants or, in some cases, in common text constants (Txt_Constants).

The measurement criteria and the data displayed as a graph are defined in the AREA_MEASURE_CRITER group:

• Txt (fi)…Txt (en): Description of the measurement criterion, e.g. daily, pumped and precipitation.
• Numeric value: Reserved as follows:

The input directions for connections between the area and equipment are defined in the INPUT_DIRECTION group:

• Txt (fi)…Txt (en): Direction, e.g. In or Out.
• Numeric value: Reserved as follows:

The measuring targets for input are defined in the INPUT_MEASURE group:

• Txt (fi)…Txt (en): Description of the target, e.g. Water.
• Numeric value: Reserved as follows:

The MEAS_AREA_LIMITS group defines the limit values indicating whether the area’s flow values are within the normal limits. Three categories are defined for water and sewage systems: below normal, normal, and above normal.

• Txt: Description of the limit, e.g. SEWER_RANGE_1.
• Txt_2: The colour displayed on the form for the limit in question, e.g. #FFFF00.
• Value: Limit value for the group, e.g. -25 or -25.25.

Example values:

The networks of the measuring device are defined in the DEVICE_MEASURES group:

• Txt (fi)…Txt (en): Description, e.g. Clean water.
• Numeric value: Reserved as follows:

The PRECIPITATION_LIMITS group defines the limit values (similar to the MEAS_AREA_LIMITS group) that indicate whether the precipitate values are within the normal range. Three categories are defined for water and sewage systems: below normal, normal, and above normal.

• Txt: Description of the limit, e.g. RANGE_1.
• Txt_2: The color displayed on the form for the limit in question, e.g. #A0FB0D.
• Value: Limit value for the group, e.g. 0, 0.5 or 10.

Example values:

The constants related to the alarms generated by automation equipment are defined in the ALARM_MIN_PRESSURE and ALARM_MAX_PRESSURE groups. The text value defines the pressure limit (psi), for example:

The height reference systems for the marine water level measurement values are defined in general text constants (Txt_Constants) in the HEIGHT_REF_SYSTEM group:

• Txt (fi)…Txt (en): The name of the height reference system in the user interface, e.g. N2000.
• Txt: An internal height reference system identifier transmitted over the interface, e.g. N2000.

The observation station data related to the measurement of sea water levels is defined in the SEAWATER_OBSERVATORY group in the general text constant group (Txt_Constant). The group defines the nearest observation station and the height reference system used by default.

• Numeric value: The observation station ID that refers to the SEAWATER_OBSERVATORY table in the measurement database.
• Numeric value 2: The height reference system ID that refers to the HEIGHT_REF_SYSTEM group in the common text constants (Txt_Constants).

The SEAWATER_CRITICAL_LIMIT group has one constant whose numerical value can be used to determine the critical sea level. For example, the numeric value 60 draws a horizontal red line at a height of 60 centimetres in the Sea Level chart.

Epanet

Text constants related to the Epanet functionality are defined in the Keyaqua_Core text constants in the EPANET_DUCT_STATUS and EPANET_FLOW_UNIT groups. In addition, some Epanet functionalities are also affected by the Keyaqua_Core text constants DUCT_STATE and FLOW_METER_CLASS.

The EPANET_DUCT_STATUS group is used to define the duct status:

• Txt (fi)…Txt (en): State description, e.g. Open or Closed.
• Value: State identifier:

The units used for unit conversions in Epanet calculations are defined by using the EPANET_FLOW_UNIT group.

• Txt (fi)…Txt (en): Description of the unit of measurement, e.g. LPM (litres/min).
• Order no.: Indicates whether the SI system or U.S. units of measurement are used. If the order number is between 6 and 10, the unit is interpreted as a U.S. unit of measurement, in which case the Epanet calculation uses U.S. units of measurement. Otherwise, the unit is interpreted as an SI unit.
• Value: Coefficient when converting from the m³/year unit of measurement to the selected unit of measurement.

The default values for text constants are as follows:

Water ducts and sewer ducts

Constants related to water ducts and sewer ducts are defined in Keyaqua_Core text constant groups whose names usually start with or contain DUCT. In general, they are used on the Water duct and Sewer duct forms, but they can also be used for other duct-related functions, such as duct annotations and leak reports.

General groups:

Groups related to duct annotations:

Groups of common text constants (Txt_Constant):

Types of water ducts and sewer branches

The types of water ducts and sewer branches are defined in Keyaqua_Core text constants in the BRANCH_TYPE group. Txt (fi)... Txt (en) is the description of the type. No numeric values are used.

Network follower

Text constants related to network follower are defined in the Keyaqua_Core text constants in groups whose names start with NF.

The maximum depth of network monitoring (number of tracked network objects) is defined in the group NF_DEPTH. The numeric value indicates the maximum depth at which following is ended. The default value is 500.

Route selections are defined in the NF_FOLLOW_VALVE group:

• Txt (fi)…Txt (en): Description, e.g. Continue over open valves.
• Numeric value: One of the following:

Network Type

Network types are defined in the Keyaqua_Core text constants in the NET_TYPE group. There is usually no need to change these. Network types are used in particular to define duct types. See Defining duct types.

• Txt (fi)…Txt (en): Description of the network type, e.g. Water duct.
• Numeric value: Network type:

Network subtype

The sewage system may include various network subtypes, e.g. Wastewater, Storm water and Mixed Water. Network subtypes are defined in the Keyaqua_Core text constants in the NETWORK_TYPE group. There is usually no need to change these. Network subtypes are used in particular to define duct types; See Defining duct types.

• Txt (fi)…Txt (en): Description of the network subtype, e.g. Storm water.
• Numeric value: Network type:

Network abbreviation

Network abbreviations are defined in Keyaqua_Core text constants in the NETWORK_PREFIX group. Do not edit!

• Txt (fi)…Txt (en): Abbreviation, e.g.SN or PMWN.
• Numeric value: Must be defined as follows:

Symbol references

Symbol references are defined in Keyaqua_Core text constants in the AQUA_SYMBOLS group.

• Txt (fi)…Txt (en): The description displayed in the drop-down menu, e.g. Flow direction.
• Txt 2: Defines the symbol in accordance with the table below. Do not edit!

Yes/No text constants

The Yes and No constants used on many different forms are defined in the common text constants (Txt_Constant) in the GENERAL_YES_NO group. The logical text must not be edited.

Manhole

The several text constants related to manholes are defined in KeyAqua_Core’s text constants in groups that usually start with MANHOLE. In general, only the texts Txt (fi)... Txt (en) that define the text displayed in the user interface can be modified.

General text constants related to manholes:

Please note that adding a new node only to the text constants in the NEW_MANHOLE_TYPE group is not sufficient, as the node must be selected as the manhole type on the Lid types page.

Text constants related to data on manhole condition:

Other text constants related to manholes:

Manhole lids

The several text constants related to manhole lids are defined in the Keyaqua_Core text constants in groups that start with LID. Text constants define the capacities, diameters, lid states and lid types. Texts Txt (fi)... Txt (en) define the descriptions that are displayed in the user interface. No numeric values are used.

The following text constant groups can be edited:

Locking

Locking is defined in the common text constants (Txt_Constant) in the ACCESS_INFO_LOCK group. Locking options are used on the Access information form. Text [fi]…Text [en] is the description of locking. No numeric values are used.

Condition index

Condition index is a feature that can be purchased separately. The Keyaqua_Core text constant ENABLED_CONSTANT_LINK_TAB group is used to activate it. The numeric value 1 activates the Condition index tab on the Water duct and Sewer duct forms. Do not edit!

Classification

Classification is defined in the Keyaqua_Core text constants in the FAULT_CODE group. Txt (fi)... Txt (en) is the classification code, which is usually a number between 0 and 4. The values in the FAULT_CODE group are displayed in the Classification fields in the picklists for the Classification field on the Water valves and Sewer valves forms. No numeric values are used.

The Txt 2 fields in the FAULT_CODE group include color information that determines the color used to display the valve on the map, provided that the map layers corresponding to the valves (SN valves dh, PSN valves dh, WS valves kl) are activated. For example, if the classification of the distribution duct valve is saved as 3, the valve is displayed in red on the map. The values of the constants in the FAULT_CODE group must not be changed without the consent of Keypro.

Fire water station manufacturer

The manufacturers of fire water stations are defined in the Keyaqua_Core text constants in the FIREWATER_MANUFAC group. Txt (fi)... Txt (en) is the name or description of the manufacturer. No numeric values are used.

Duct renovation

Text constants related to duct renovation are defined in the Keyaqua_Core text constants. The names of the groups related to renovation start with DRENOVATION.

Renovation categories are defined in the DRENOVATION_CATEGORY group:

• Txt (fi)…Txt (en): Description of the renovation category, e.g. Injection.
• Txt 2: Internal abbreviation. Do not edit!
• Numeric value: Specifies the type of renovation internally in the system. Do not edit!

Renovation methods are defined in the DRENOVATION_METHOD group:

• Txt (fi)…Txt (en): Description of the renovation method, e.g. Slip lining.
• Numeric value: Specifies the renovation type for the method:

The renovated section is defined in the DRENOVATION_PART group:

• Txt (fi)…Txt (en): Description of the section, e.g. Whole manhole distance or Given length.
• Numeric value: Specifies the duct section:

Types of pumping station

Pumping station types are defined in the Keyaqua_Core text constants in the PUMPSTATION_TYPE group. Txt (fi)... Txt (en) is the name of the type, e.g. Concrete ring. No numeric values are used. The order number can be used to define the order in the drop-down menus.

Roles of pumping stations

The roles of pumping stations are defined in the Keyaqua_Core text constants in the PUMP_STATION_ROLE group.

• Txt (fi)…Txt (en): Text describing the role of the pumping station, e.g. Line pumping station.
• Numeric value: Specifies the role of the pumping station:

Survey file import

Location and height accuracies and source codes related to survey file import. They are defined in the Keyaqua_Core text constants in the ACCURACY, HEIGHT_ACCURACY, and SOURCE_CODE groups.

Note! When modifying text constants related to survey file import, you should be very careful as the group definitions must correspond to the definitions in the common text constant groups (Txt_Constant) LOCATION_ACCURACY, H_ACCURACY and MAPPING_METHOD!

The ACCURACY group must have a corresponding text constant for each text constant in the LOCATION_ACCURACY group, and their numeric values must be the same. Similarly, the HEIGHT_ACCURACY group must have a corresponding text constant for each text constant in the H_ACCURACY group, with corresponding numeric values used, and the rows in the MAPPING_METHOD group must have corresponding rows in the SOURCE_CODE group. If the numeric values do not match, survey file import may create incorrect accuracy values for network objects.

• Txt (fi)…Txt (en): text specifying the location accuracy, for example, +-5 m.
• Numeric value: a numeric value equivalent to the text field, for example, 5.0. The value in this field is the radius of a circle in metres, within which the actual location of an object is when measured from the object’s saved location and at the applied level of certainty. Note that the common text constants (Txt_Constant) must have a text constant with the same numeric value.

Junction

JUNCTION text constants can be found in the common text constants (Txt_Constant). They define the options included in the drop-down menus on the Junction form. Edit the text fields to change the text displayed in the user interface. The numeric value for all is 0. You can change the order in the drop-down menus by editing the value in the Order no. field.

Manhole inspection

Text constants related to manhole inspections can be found in the common text constant (Txt_Constant) groups that start with MH. They are mainly text values that describe the structure, condition and defects of manholes. You can change the order in the drop-down menus by changing the value in the Order no. field.

The groups related to manhole inspections are:

Valves

Text constants related to valves are defined in KeyAqua_Core’s text constants, usually in groups that start with VALVE. In the Txt 2 field of the VALVE_STATE group whose state is Closed, there is a color value that determines the color of the valve displayed on the map when the valve’s state is “Closed”. The Txt 2 field has three RGB color values between 0 and 255, separated by spaces. The default value for the VALVE_STATE field is '0 0 0', i.e. black. You should note that there is also a group named VALVE_STATE in Text constants (Txt_Constant).

The most common text constant groups:

State report for water network nodes

Text constants related to state reports for nodes are defined in Keyaqua_Core text constants.

Node classes are defined in NODE_GROUP:

• Txt (fi)…Txt (en): Description of the node class, e.g. Survey point.
• Numeric value: Specifies the node class:

Other text constants related to state reports:

Water leak report

Text constants related to leak reports are defined in the Keyaqua_Core text constants. The names of the groups start with LEAK. No numeric values are used. You can modify the texts.

Meter class

Water meter classes are defined in the Keyaqua_Core text constants in the FLOW_METER_CLASS group. Meter classes are used, for example, on the Consumer point form.

• Txt (fi)…Txt (en): Description of the meter class, e.g. Main meter or Submeter.
• Numeric value: Defines the meter class as follows:

Types of measurements

Types of measurements are defined in the Keyaqua_Core text constants in the FLOW_METER_WATER group. Typical types of measurements are water for households and water for agriculture.

• Txt (fi)…Txt (en): Description of the type of measurement, e.g. Water for household.
• Numeric value: Defines the type of measurement as follows:

Meter type

Meter types are defined in the Keyaqua_Core text constants in the FLOW_METER_TYPE group. Meter types are used, for example, on the Consumer point form. Txt (fi)... Txt (en) is a description of the meter size, e.g. Type 1.

Meter size

Meter sizes are defined in the Keyaqua_Core text constants in the FLOWMETER_SIZE group. The sizes defined in the FLOWMETER_SIZE group are used, for example, for district heating meters and water meters on the Consumer point form. The Txt (fi)... Txt (en) fields include a description of the meter size, e.g. DN10.

Note! The values displayed in the picklists for Measur. center DN and Branch line DN on the Consumer point form are defined in the Keycore text constant (Txt_Constant) group DH_CP_DN.

Measuring methods

Measuring methods are used on the Device form and on the Remote measurement service and the Remote measurement area forms. Measuring methods are defined in the Keyaqua_Core text constants in the FLOW_MEASURING_METHOD group.

• Txt (fi)…Txt (en): Description of the measuring method, e.g. Container measurement.
• Txt 2: Color code in the format #RRGGBB. The coloring is used on the Remote measurement service and Remote measurement area forms.
• Numeric value: Defines the measuring method in accordance with the table below.

The default values are as follows:

Classification

The KU_RESTRICTED_TYPE group in the common text constants (Txt_Constant) defines classifications for forms that may contain personal data. These classifications (e.g. Private or Normal) are included, for example, on the Consumer point and Customer forms.

• Txt (fi)…Txt (en): Description of the classification, e.g. Private.
• Numeric value: Determines the classification. Possible values:

Investigation

Data in the drop-down menus on the Investigation form is mainly downloaded from text constants starting with EXMN (Keyaqua_Core text constants). You can change the order in the drop-down menus by changing the value in the Order no. field. You can change the text of the text constants displayed in the drop-down menu by editing the values in the Txt (fi/en/sv) fields. Numeric values are not used.

picklists for the Investigation form and the corresponding groups:

Constants related to defects

The following defect-related constants are included on the Error report, Failure report and Quality reclamation forms. In addition to these constants, when the value of SN_FAILUREREPORT_ENABLE is 1, the failure report is available in the Reporting tools. There must be only one SN_FAILUREREPORT_ENABLE constant, and values other than the value in the Numeric value field should not be edited.

Apart from the FLR_YEAR_SEASON group, the data in the groups in question is included in the drop-down menus on the forms. You can change the order in the drop-down menus by changing the value in the Order no. field. You can change the text of the text constants displayed in the drop-down menu by editing the values in the Txt (fi/en/sv) fields. Unless separately stated, the contents of the Numeric value and Value fields for the constants related to defects must not be edited. When creating new constants for groups, you should not enter a value in the fields in question unless the others also have a value, such as 0.

For each constant in the FLR_YEAR_SEASON group, a new selection button is displayed on the Basic information tab on the Failure report form. Like the picklists, you can change the order of presentation by modifying the Order number value.

Repair

The constants included in the Repair form usually start with REPAIR. In addition, the Repair form also includes several groups used for the Water leak report. You can change the order in the drop-down menus by changing the value in the Order no. field. You can change the text of the text constants displayed in the drop-down menu by editing the values in the Txt (fi/en/sv) fields. Numeric values are not used.

TYPE constants

TYPE constants mainly affect the contents of the Node fields on the forms available under Water node tools and Sewer node tools. In general, the values in the Numeric value and Value fields of the TYPE constants must not be modified, and no values should be entered in those fields when creating new constants. For many TYPE constants, there is a page for editing their default values. The ID of the constant in question is entered in the Value field for the default values.

The standard ID in the drop-down menu for the Node field on the Water tank form must exist in the WATERTANKTYPE_ID field in the AQUA_WATERTANK_TYPE table in the database. Therefore, adding a new TYPE_WATERTANK constant does not add a new constant to the drop-down list for Node. The defaults for water tanks can be modified from Keyaqua_Core Water Tank Defaults.

The Numeric value and Value fields of TYPE_OTHER_NODE constants must not be modified because the values in the fields may affect the application logic. By default, the Value field for the Temporary Water Intake constant under the TYPE_OTHER_NODE group contains the text TEMP_WATER _INTAKE, which must not be edited.

The TYPE_BRANCH group may contain only one constant and its Numeric value and Value fields must not be edited. The default values for water branches are defined in Keyaqua_Core Water branch defaults. The default values for sewer branches may be edited from Keyaqua_Core Sewer branch defaults.

The values in the Numeric value and Value fields for the NEW_VALVE_TYPE and NEW_MANHOLE_TYPE constants may not be edited. Only one constant for the NEW_VALVE_TYPE and NEW_MANHOLE_TYPE constants may have 1 as the numeric value. Adding new NEW_MANHOLE_TYPE constants does not automatically add additional options to picklists (see Manhole and Manhole and lid types). Further information on the NEW_VALVE_TYPE constants is available under Valves.

Supply interruption (A district heating function subject to a separate order)

This chapter presents the constants related to interruptions. The values of the constants must not be changed without the consent of Keypro.

States of supply interruptions:

CRITICAL_CUSTOMER

The row colors for rows listed on the Consumer points tab on the Supply interruption form can be defined by editing the value in the Txt 2 field for the CRITICAL_CUSTOMER constants under Keyaqua_Core text constants. The color information must be in a format that the browser understands. 

In the figure below you can see that green has been set as the value for the constant named Standard.

The options for the Consumer Point form’s field Critical customer are defined in the CRITICAL_CUSTOMER group. More information on the values of the constants in this group is available in the Consumer point chapter.

Colors can be defined based on the HTML name (Green, Red, Blue, Aqua, ...) or in the HEX format. E.g. “#00FFFF”.

Filtering order for Type in Notifications

The types have their order set in TXT_CONSTANTS table row which has groupname called POPUP_TYPE_MAPPING.

• Additional data (fi)…Additional data (en): For example, by using this mapping Notificationtype_4 would be shown first, then Notificationtype_3 etc:

"Notificationtype_1": { "text": "Tyyppi 1", "order": "4" },

"Notificationtype_2": { "text": "Tyyppi 2", "order": "3" },

"Notificationtype_3": { "text": "Tyyppi 3", "order": "2" },

"Notificationtype_4": { "text": "Tyyppi 4", "order": "1" }

KeyGas constants

Some KeyGas constants are Aqua’s text constants (Keyaqua_Core text constants) and some are Txt_Constant text constants. In general, no new constants should be added to text constant groups where constants have a value in the Numeric value or Value field. In addition, the values in the Numeric value and Value fields must not be modified, unless separately specified.

The options in the picklists on the KeyGas duct form mainly depend on the values defined in the SN_GAS_DUCT_TYPE table. As a result, only certain predefined options are included in the various picklists and therefore adding new constants to groups such as GAS_DUCT_MATERIAL, GAS_DUCT_PRESSURE, and GAS_DUCT_DIAMETER does not add new options to the drop-down menus. However, changes to the Txt values for existing constants are displayed in the drop-down menu options.

Values for the picklists on the KeyGas manhole form are retrieved in a similar manner as for the KeyGas duct form. For example, you can edit the GAS_LID_TYPE constant text, but adding a new GAS_LID_TYPE constant does not automatically add additional options to the picklist because the constant’s ID must be on a row that corresponds to the node selected in the LID_TYPE_ID field in the GAS_MANHOLE_TYPE table.

The contents of the Placement field on the Annotate gas duct form come from Aqua’s text constants group DUCT_ANNOT_PLACEMENT, so editing the constants in that group also affects the contents of the Placement fields on the Annotate gas duct and Conduit annotation forms (see chapter: Water ducts and sewer ducts).

Keyaqua_Core text constants:

Txt_Constant:

The Text[fi]…Text[en] values for the constants in the GAS_SYMBOLS group may be modified, but you should not add new GAS_SYMBOLS constants.

When adding text constants (Txt_Constant) to specific groups, such as the VALVE_OPEN_STATE group, you must also define the value 7012 (Gas category) in the Category field. For example, if the Category field for a new constant in the VALVE_OPEN_STATE group is set to 7022, the new constant will be available in the options for the Valve state field on the District heating valve form. Please note that the value in the Category field is not relevant for all constants. For example, regardless of the value of the category, the values in the ANNOTATION_PLACEMENT group are displayed in the picklists for both the Annotate DH cable form under DH annotations and the Annotate gas cable form under Gas annotations.

KeyDH constants

Some district heating-related (DH) constants are Aqua’s text constants (Keyaqua_Core text constants) and some are Txt_Constant text constants. In most cases, the groups for DH constants include values for the picklists on the various KeyDH forms, but the DH constants are also used for the picklists on the District heating tab on the Consumer point form and for the district heating meters on the consumer point form.

No new constants should be added without Keypro’s consent to text constant groups where constants have a value in the Numeric value or Value field. In addition, the values in the Numeric value...Numeric value 4 fields for existing constants in the system must not be modified if they have predefined values and are not discussed in this document. For example, modifying the numeric values of the VALVE_OPEN_STATE constants can result in incorrect system operation.

The contents of the Placement field on the Annotate DH conduit form come from Aqua’s text constants group DUCT_ANNOT_PLACEMENT, so editing the constants in that group also affects the contents of the Placement fields on the Annotate duct and Annotate gas duct forms (see chapter Water ducts and sewer ducts).

We recommend that constant groups related to observations and starting with DH_OBSERVATION are modified through KeyDH administration (for more information, please see the Settings for observations chapter).

Keyaqua_Core text constants:

Txt_Constant:

Constants related to district heating often start with DH, but district heating-related forms also use many of the same constants that, for example, KeyGas uses. In many cases, when adding or modifying Txt_Constant text constants, you should note that the Category field contains the value 7022, which is the District Heating category (for example, the KeyGas category is 7012). Please note that the value in the Category field is not relevant for all constants. For example, regardless of the value of the category, the values in the ANNOTATION_PLACEMENT group are displayed in the picklists on both the Annotate DH cable form under DH annotations and the Annotate gas cable form under Gas annotations.

DH constants related to consumer points:

Other KeyDH constants:

Setting constants for KeyDH

KeyDH has some text constants the values of which can be modified to define information displayed in form fields or header bars.

The value of the DH_DUCT_DIAM_PRESENT text constant defines whether the outer or inner diameter information for a conduit is displayed in the header of the District heating conduit form, in the Diameter column in the table displayed on the District heating tab and in the Diameter picklist (Figure 24). The default value in the Text field for the DH_DUCT_DIAM_PRESENT text constant is %OUTER%, which means that the outer diameter is displayed on the form by default.

When the value in the Text field of the DH_DUCT_DIAM_PRESENT text constant is %INNER%, the inner diameter of the district heating conduit is displayed on the form (Figure 25). If the inner diameter has not been defined for a conduit type to be displayed in the Diameter picklist, the value displayed on the picklist is 0.

In the figure below, the outer diameter is displayed by default on the District heating conduit form.

In the figure below, when the value of the DH_DUCT_DIAM_PRESENT text constant is %INNER%, the inner diameter defined for the district heating conduit in the Diameter field in the table is displayed.

Note! The %OUTER% or %INNER% value must be completed in the Text[fi]…Text[en] fields in addition to the Logical text field in order for the setting to work correctly.

Various constants for settings

KeyAqua has a small number of various settings that can be adjusted through the common text constants (Txt_Constant).

KEYCORE_HCOLOR

Edit the text value of the KEYCORE_HCOLOR text constant to change the highlighting colors for Highlight and Highlight all. The color information must be given in hexadecimal format and the first character must be a hashtag (#). There can be only one constant in the KEYCORE_HCOLOR group. Only the value in the text value field can be changed.

Some example colors:

Red: #FF0000, green: #00FF00, blue: #0000FF, lilac: #7F00FF

PAPER_SIZE

The constants in the PAPER_SIZE group define the paper sizes for printing. The values must not be edited without Keypro’s consent.

PRINT_LEGEND_POS

Use the PRINT_LEGEND_POS constants to force a printout legend to be included in a specific corner on printouts. With this, the legend will always be in the same place regardless of the Position selection for printing.

Below you can see an example of how the Internal printout legend already created in KeyAqua is forced to the top-left corner.

1. Select Keygwt-Print > Printout legends (Figure 27).
2. Make a note of the ID of the Internal printout legend (2).

1. Add a new text constant and name the group PRINT_LEGEND_POS (Figure 28). Enter the ID of the Internal printout legend in the Logical text field and enter zero (0) as the value in the Numeric value field. Then complete the mandatory Text and Abbreviation fields. For example, you can enter Internal in the fields.

After saving, the Internal legend should be displayed in the top-left corner, even if another location was selected from the Position picklist (Figure 29).

KEYCORE_ADDR_SOURCE

The constants in the KEYCORE_ADDR_SOURCE group are used to adjust address source settings. The text values for constants are displayed in the Source picklist on the Address form. They must not be edited without Keypro’s consent. 

DEFAULT_HIGHLIGHTING_ENABLED

When the Numeric value for the constant in the DEFAULT_HIGHLIGHTING_ENABLED group is 1, three additional options for positioning are displayed under the Locate button’s options on the Consumer point form (Figure 30). The value of the constant must not be modified without Keypro’s consent.

DH_CONDUIT_PERMISSION_TYPE

Use the constants in the DH_CONDUIT_PERMISSION_TYPE to prevent users belonging to a specific group from modifying district heating conduit information, for example, for conduits whose Usage state is In use. The DH_CONDUIT_PERMISSION_TYPE group may only include one constant. The limitation does not apply to users with Admin rights.

• Numeric value: The ID of the constant in the CONDUIT_STATE group under Text constants (Txt_Constants) whose logical text is, for example, In use (Numeric value 1).
• Description: In the following format: {"<The group to which the restriction applies>": {"state_id__in":[<the ID of the constant in the CONDUIT_STATE group>]}}. For example: {"DH_CONDUIT_PREVENT_CHANGE_STATE": {"state_id__in":[9220]}}

1. Create a new group called DH_CONDUIT_PREVENT_CHANGE_STATE:
2. Select the group DH_CONDUIT_PREVENT_CHANGE_STATE for the user to which the restriction will apply:
3. In the CONDUIT_STATE group, check the ID of the constant with the Logical text In use and the numeric value 1:
4. Create or modify the text constant with the Group name DH_CONDUIT_PERMISSION_TYPE. In addition, enter e.g. ”dh conduit pt” in the mandatory fields. Text for the description field: {"DH_CONDUIT_PREVENT_CHANGE_STATE": {"state_id__in":[9300]}}.