KeyCom definitions
  • 01 Aug 2024
  • 10 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

KeyCom definitions

  • Dark
    Light
  • PDF

Article summary

Defining duct types

Select Keyrns_core -> Duct types

  • Duct type: duct type identifier
  • Manufacturer: define the manufacturer
  • Product code: include a product code
  • Product code 2: include an alternative product code
  • Outer diameter: the duct’s outer diameter in numerals
  • Inner diameter: the duct’s inner diameter in numerals
  • Outer X-diameter: the duct’s outer X-diameter in numerals
  • Outer Y-diameter: the duct’s outer Y-diameter in numerals
  • Inner X-diameter: the duct’s inner X-diameter in numerals
  • Inner Y-diameter: the duct’s inner Y-diameter in numerals
  • Sheath color: duct's color shown in the user interface
  • Duct shape: the shape of the duct. Define the available options in the DUCT_FORM group. (Editing text constants)
  • Favorite: define a filter for the duct type in the Duct types admin page
  • Availability starts: the date from which a duct of the specified type will be available for construction purposes.
  • Availability ends: end date of the availability of a duct of the specified type.

Save after filling the desired fields.

Duct defaults

To set the defaults, go to a Conduit form in the application and click Save as defaults in the drop-down menu for Save. The selection is only visible to admin users.

Defining cable types

Select Keyrns_core -> Cable types

The Cable types admin page is used to manage the CABLE_TYPE group under Text constants, and the group can also be accessed through Text constants (Editing text constants).

  • Numeric value: the field specifies whether the object type in question is displayed in the safe-to-dig.com service.

0

not displayed

1

displayed

  • Numeric value 2: the field specifies whether the cable’s installation type is buried or aerial. This information is used in the safe-to-dig.com services to define whether certain cable types are displayed on the map provided to diggers.

NULL/0

Buried

Negative

Shallow depth, estimated depth in metres, for example, -0.2

1

Aerial

  • Cable type: cable type identifier.
  • Technology: cable technology. Define the available options in the CABLE_TECHNOLOGY group. (Editing text constants)
  • Copper capacity: the number of the cable’s copper pairs.
  • Resistance: not in use.
  • Fiber threads: the number of the cable’s fiber threads.
  • Unit cost:
  • Default installation: the default installation method for the cable. Define the available options in the CABLE_TYPE group. (Editing text constants)
  • Color coding: the old method for defining the color coding of cable fibers. Define the available options in the CABLE_COLORCODING group. (Editing text constants).
  • Color coding: Color coding of cable fibers (see Color coding of cable fibers).
  • Availability starts: the date from which a cable of the specified type will be available for construction purposes.
  • Availability ends: the end date of the availability of a cable of the specified type.

Color coding of cable fibers

Fiber colors

  • To add colors, select Keycom_fibercolor>fibercolor codes
  • Text [fi]...Text [en]: name of the color in the user’s selected language.
  • Abbreviation [fi]…Abbreviation [en]: the abbreviation of the color in different languages.
  • Text value: the rgb code for the color, for example, 0 0 0 for black and 255 255 255 for white

Duct colors

  • Duct colors are defined in the KEYCOM_DUCT_COLOR group under Text Constants.
  • Text [fi]...Text [en]: name of the color in the user’s selected language.
  • Abbreviation [fi]…Abbreviation [en]: the abbreviation of the color in different languages.
  • Text value: the rgb code for the color, for example, 0 0 0 for black and 255 255 255 for white

Defining the color coding

To define color coding, select Keycom_fibercolor › Fiber color coding configs. Color coding is defined for a cable type (see the Defining cable types chapter) in order for them to be displayed in the application.

  • Name: name of the color coding.
  • Color coding type:

Maximum number of threads:

  • Description: a user-friendly description of the coding.
  • Thread color coding configs: a definition of the appearance of each thread.
  • Thread icon: the appearance of the thread. This will be updated after the data has been saved and the application reloaded again.
  • Thread number: the number of a single thread, starting from 1, with the largest number being the maximum number of threads.
  • Fiber color:
  • Inner tube number:
  • Inner tube color:
  • Show inner tube number:
  • Outer tube number:
  • Outer tube color:
  • Show outer tube number:
  • Inner yarn color:
  • Outer yarn color:
  • Stripe color:
  • Number of stripes:

Cable defaults

To set the defaults, go to a Cable form in the application and click Save as defaults in the drop-down menu for Save. The selection is only visible to admin users.

Defining the types of telecom premises

Select Keyrns_Prem -> Telecom premises types

  • Telecom premises type: type of telecom premises. Define the available options in the PREM_TYPE group. (Types of telecom premises types)
  • Manufacturer: manufacturer of the telecom premises.
  • Product code: product code of the telecom premises.
  • Cost: cost of the telecom premises in numerals.

Types of telecom premises types

The telecom premises type (Defining the types of telecom premises) is defined in the PREM_TYPE group.

  • Numeric valuethis field specifies whether the telecom premises in question can be deemed to be large (centre) telecom premises. The information is used in connection with the exporting of FPI Comsof plans:

10

The telecom premises could be used as a centre

20

Transmission system equipment is located in the telecom premises

30

The telecom premises are the primary cross-connection point of the access network

4

The telecom premises are the secondary cross-connection point of the access network

50

The telecom premises are the initial point of a drop cable

60

The telecom premises are the subscriber point

<other values>

no meaning

Note: Numbers 1-6 are outdated values that are being replaced.

  • Numeric value 2: The group will grant access to restricted premises on premises form to the user who is part of the group.

1

defines a restricted premises type inaccessible from normal users. Only accessible to members of PREM_ADMIN group or superusers

  • Numeric value 3: Defines the description used in the circuit diagram

1

all the corners of the telecom premises have been cut (splices)

2

the upper right corner of the telecom premises has been cut (ODF)

  • Value, Value 2, Value 3Specifies the multiplier for the placement scale. The multiplier is selected based on the numeric value of the usage state.
  • Availability starts: the date from which a duct of the specified type will be available for construction purposes.
  • Availability ends: end date of the availability of a duct of the specified type.

Telecom premises defaults

To set the defaults, go to a Telecom premises form in the application and click Save as defaults in the drop-down menu for Save. The selection is only visible to admin users.

Defining conduit types

Select Keyrns_core -> Conduit types

The Conduit types admin page is used to manage the CONDUIT_TYPE group under Text constants, and the group can also be accessed through Text constants (Editing text constants).

  • Numeric value: the field specifies whether ducts can be added to the conduit type in question

0

cannot be added (= a ditch-type conduit)

1

can be added (so-called standard conduit type)

  • Numeric value 2: the field specifies whether the route’s installation type is buried or aerial. This information is used in the safe-to-dig.com service to define whether certain conduit types are displayed on the map provided to diggers.

NULL/0

Buried

Negative

Shallow depth, estimated depth in metres, for example, -0.2

1

aerial

Conduit defaults

To set the defaults, go to a Conduit form in the application and click Save as defaults in the drop-down menu for Save. The selection is only visible to admin users.

Defining manhole types

On the Admin site, select Keyrns_core -> Manhole types

The Manhole types admin page is used to manage the MANHOLE_TYPE group under Text constants, and the group can also be accessed through Text constants (Editing text constants).

  • Numeric value: the field specifies the profile’s modification point, which is used in splitting the conduit. Conduit splitting uses the point that has the smallest order number and that has the value of 1.

1

The manhole type used for conduit splitting

  • Numeric value 2: the field specifies the manhole’s installation type: buried or aerial (Manholes can in some cases connect Arina-type conduits, which are typically installed overhead). This information is used in the safe-to-dig.com services to define whether certain manhole types are displayed on the map provided to diggers.

NULL/0

Buried

Negative

Shallow depth, estimated depth in metres, for example, -0.2

1

Aerial

  • Logical text: the safe-to-dig.com service does not display objects for which the logical text is “Change point of profile”.
  • Value, Value 2, Value 3specifies the multiplier for the placement scale. The multiplier is selected based on the numeric value of the usage state.

Manhole defaults

To set the defaults, go to a Manhole form in the application and click Save as defaults in the drop-down menu for Save. The selection is only visible to admin users.

Defining splice types

On the Admin site, select Keyrns_core -> Splice types

The Splice types admin page is used to manage the SPLICE_TYPE group under Text constants, and the group can also be accessed through Text constants (Editing text constants).

  • Numeric value: the field specifies whether the object type in question is displayed in the safe-to-dig.com service.

0

not displayed

1

displayed

  • Numeric value 2: the field specifies whether the splice’s installation type is buried or aerial. This information is used in the safe-to-dig.com services to define whether certain splice types are displayed on the map provided to diggers.

NULL/0

Buried

Negative

Shallow depth, estimated depth in metres, for example, -0.2

1

Aerial

  • Value, Value 2, Value 3specifies the multiplier for the placement scale. The multiplier is selected based on the numeric value of the usage state.

Splice defaults

To set the defaults, go to a Splice form in the application and click Save as defaults in the drop-down menu for Save. The selection is only visible to admin users.

Defining pole types

Select Keyrns_core -> Pole types

  • The Pole types admin page is used to manage the POLE_TYPE group under Text constants, and the group can also be accessed through Text constants (Editing text constants).
  • Text [fi]…Text [en]: name of the pole type and its translation displayed to the user.
  • Numeric value:
  • Abbreviation [fi]...Abbreviation [en]: abbreviation of the pole type name and its translation displayed to the user.
  • Numeric value 2… Numeric value 4: not in use.
  • Value, Value 2, Value 3: specifies the multiplier for the placement scale. The multiplier is selected based on the numeric value of the usage state.
  • Text value: not in use.
  • Category: not in use.
  • Description: not in use.
  • Availability starts: not in use.
  • Availability ends: not in use.
  • Order number: the order in which the types are displayed to users on the selection lists.

Pole defaults

To set the defaults, go to a Pole form in the application and click Save as defaults in the drop-down menu for Save. The selection is only visible to admin users.

Defining device types

Select Keyrns_core -> Device types.

  • Technology: device technology. Define the available options in the TERMINAL_TECH group under Text constants. (Editing text constants)
  • Class: device type class. Define the options for a telecommunications network in the DEVICE group and the options for a cable TV network in the CTV_DEVICE group. The device type classes are discussed in the Device type class chapter.
  • Type: device type identifier displayed to users. Enter a sufficiently descriptive text that helps identify the device type.
  • Connectors: number of connectors on the device.
  • Availability starts: date from which a device of the specified type will be available for construction purposes.
  • Availability ends: end date of the availability of the specified type of device.
  • Only as part of a group: this specifies whether the device can only be added as a part of a device group. A device group enables the saving of connection and connector property data and using that data when new devices are created. If a device that is not part of a device group is added, connectors will be created by using standard settings, with connector numbers as names and without any connections.
  • Device type’s documents: this feature will be removed.

Device defaults

To set the defaults, go to a Device form in the application and click Save as defaults in the drop-down menu for Save. The selection is only visible to admin users.

Defining connector types

Select Keyrns_Prem -> Connector types. 

  • Abbreviation: abbreviation of the connector type.
  • Description: a user-friendly description of the connector.
  • Thread count: number of the connector’s threads.
  • Technology id: only 0 and 1 can be used

0

Copper

1

Fiber

Defining service groups

Select Keyrns_Prem -> Service groups

  • Name: service group name.
  • Remarks: comments providing additional information on the service group.
  • Priority: not in use.
  • Primary: not in use.
  • Services: services belonging to the service group (see the Defining services chapter).

Defining services

Select Keyrns_Prem -> Services

  • Cable length: maximum cable length with which the service still functions.
  • Service usage: service usages are defined in the USAGE and CCP_SERVICE groups under Text Constants. See the Text Constants chapter.
  • Technology: The technology that the service uses. available options are defined in the CABLE_TECHNOLOGY group under Text Constants. See the Editing text constants chapter.
  • Service groups: service groups to which the service belongs. See the Defining service groups chapter. 

Defining radio channels

Select Keyrns_Radiolink -> Radio channels

  • Channel name: radio channel name.
  • A frequency: transmit frequency of the radio channel in MHz.
  • B frequency: receiving frequency of the radio channel in MHz.
  • Radio band: radio band of the radio channel. Define the available options in the RADIOBAND group under Text Constants. (Editing text constants) or add a new radio band by clicking the + button next to the drop-down menu.

Defining radio permits

Select Keyrns_Radiolink -> Radio permits

  • Permit number: number of the radio permit.
  • Start date: start date of the radio permit.
  • End date: end date of the radio permit.
  • Permit info: type of the radio permit.

Defining product types

Select Keyrns_Core -> Product types to define the product types to be linked to rental contracts.

  • Product class: product class. Define the available options in the PRODUCT_CLASS group under Text constants.
  • Type: product type name that is displayed to users.

Defining products

Select Keyrns_core -> Products

  • Product type: Product type (see Defining product types).
  • Name: product name that is displayed to users.
  • Abbreviation: product abbreviation.
  • Product code: product’s code.
  • Point value: product’s default point value, which users can modify when they add products to rental contracts.
  • Unit cost: product’s default unit cost. Users can modify the unit cost when adding products to rental contracts.

Bitrates (capacity)

Select Keyrns_Radiolink -> Bitrates

  • Bitrate: bitrate (capacity) in numbers.
  • Description: bitrate (capacity) description that is displayed to users.

Was this article helpful?