Codelist manager

<< Click to Display Table of Contents >>

Administration > Menu reference > Administration > Codelists >

Codelist manager

 

The Code list manager is used to administrate the code lists in the system. Go to Administration > Codelists > Codelist manager to open the tool.

Using the code list manager you may:

Edit existing values in code lists

Add new values in code lists

Delete values in code lists

Activate or inactivate values in code lists

Add specific documents to code lists

 

Edit existing value

1.Mark the row you wish to edit the field value for. Simply press Edit row . An edit dialog opens that shows the content of the selected row.

2.All fields in a code list are editable, with the exception of key fields and the dp_subtype field. Mandatory fields in the code list are highlighted with an asterisk.

3.Press Save to save the changes to data base.

4.To make sure the changes has been saved and activated, press the Update server button in the codelist manager window.

 

Add new row

Do not add new rows in a code list if not necessary. Since there might be complicated to delete these rows later on when there are objects attached to them.  

1.Press the Add button in the codelist manager. A dialog containing the new row and all ingoing value fields opens.

2.Mandatory fields are displayed in pink. Numerical key values are generated automatically, while text based keys must be entered by the user.

3.Press Save in the dialog to save the new row to data base.

4.To make sure the changes has been saved and activated, press the Update server -button in the codelist manager window.

 

Delete rows

 

Deleting rows in codelists are not supported in the codelist manager. The reason is that it should not be possible to delete a code list row that the system is using, since that might cause imbalance in the system. You may use the Disable row function, see more information in the next chapter.

Cleaning of code lists is most suitable in consultation with Digpro AB.

 

If you wish to delete a row from a code list, you must follow these steps:

1.Make sure the key value of the row is not used by any objects in the system.

2.Delete the row manually in the data base using SQL.

 

Activate or inactivate rows

If a code list contain a field with field name "active value" (ACTIVE) it may be possible to enable or disable row values in the code list.To enable instead of delete a value may have benefits.

It's easy to perform on your own and it's easy to restore disabled values.

 

Enabled and disabled values are represented as follows in the code list:

”1” (true) Marked check box. The value is enabled and displayed in the code lists drop down menus.

”0” (false). Unmarked check box. The value is disabled and may be displayed in the code lists drop down menus by the choose historical value option.

 

Activate or inactivate a value

1.Mark the row in the codelist that contains the value you wish to enable or disable. The editing window opens.

2.Mark/unmark the check box Active value to enable or disable the value.

3.Press Save in the editing dialog to save the changes to data base.

4.To make sure the changes has been saved and activated, press the Update server -button in the codelist manager window.

 

Activate or inactivate fields

It is also possible to disable certain fields in the code list manager by configuration. These fields will then not be visible in the code list manager.

The configuration is made in the codelist_translation.conf by specifying the parameter <column name>.hide=true

It is possible to enable a previously disabled field if needed.

Do not hesitate to contact your customer manager at Digpro or the Digpro support  for more information or if any further questions.  

 

Edit column order

By configuration it is possible to change column order in the code list manager. Example: if adding a new row or editing an existing row it is possible to configure the column order.  

The configuration is made in the codelist_translation.conf by specifying the parameters columnOrder=column1,column2,column3 etc.

Do not hesitate to contact your customer manager at Digpro or the Digpro support  for more information or if any further questions.

 

Edit several rows

By configuration it is possible to edit column values for several rows at the same time in the code list manager.

The configuration is made in the codelist_translation.conf by specifying the parameters multiEditColumns=column1,column2 etc.

Contact your customer manager at Digpro or the Digpro support  for more information.

Settings

Drop down menus

Function

Code list owner

Select code list owner. Example: FFP, PIPING, or DSG.

Code list

Select code list. The code list drop down menu will display all codelists owned by the selected code list owner.

Subtype

Select subtype. Selectable code list values may be defined to be controlled by an objects subtypes. The value for each subtype ,where applicable, will be typed in the code list. Note, subtype is selectable only if the code list take subtype into consideration.  

 

 

Mandatory fields

Code value (CODENUM)

The code lists primary key field that contains code list value.

Text (CODETEXT)

Text string describing an object- or subtypes attributes. This is the same text that is displayed as text options in the drop down menu in the object types attribute form.

 

 

Function fields

DP_SUBTYPE

The field is required to use the subtype-dependent code list values. Existing values are locked for editing in the code list manager.

ACTIVE (Active value)

The field is required to enable / disable selected code list values.

 

 

Read only fields

Rendered value

Some texts in CODETEXT are html formatted. Rendered value shows how the text looks converted.

 

 

Buttons

 

Update server

Depending on the operative system settings for caching, it may be necessary to update the server for saved changes to be activated.  

Edit row

Edit individual values ​​in the code list

Add

Add new values to the code list

Assign display flag

Assigns display flag values ​​from a database sequence. The button is activated if there is a display flag column in the code list.

Export to spreadsheet

Export code list content to spreadsheet

Close

Close the code list manager. Note, changes that has been made will not be saved by default.

 

Edit row dialog

Save

Save changes to data base.

Reset

Reset changed code list values that has not yet been saved.

Cancel

Cancel the editing and close the window.

Attach

Makes it possible to attach documents to code list.

Delete

Use the Delete button to delete an attached document.

Show

Use the Show button to show attached documents.

More information

 

Select a inactive codelist value in the attribute form

Open the attribute form. Click on the drop down list for Accuracy and select Choose historical value.

 

Show codelist that is available in the system

Go to Administration > Metadata Manual. The Metadata manual will display a list of all components, object types and code lists in the system. The manual will display how code lists are connected to the different object type attributes. At the bottom of the metadata manual all code lists will be sorted by code list owner.

 

Show which codelist a drop down menu is using in the attribute form

You find more details regarding the actual code list by simply right click on the arrow in the drop down menu and select Show all codelist values.

For this function to work, the drop down menu need to display a code listed value. Therefore select a new value if the existing value is Undefined. In the Codelist value dialog that opens, the code list being used is displayed.