ByggSøk plan Administration Guide - Dibk · Document Date/Version 30.03.2012/1.0 Document status...

ByggSøk plan Administration Guide of 20 Document Date/Version 30.03.2012/1.0

Document status Released

©Jotne EPM Technology AS 1998 - 2012

ByggSøk plan Administration Guide

Document id. 11240-doc-03 Doc version 1.0 Status Released Date Mar 30, 2012 Author(s) RF Checked by DK Approved by PH




Document revision history Rev Description Status Date Author Approved

Conventions used in this document Names of interface elements (buttons and text boxes) are given in the regular Bold font. Names of system parameters and environment variables are given in the Italics font.




Table of contents 1 Introduction 4

1.1 Objective .................................................................................................. 4 2 Administration pages 4

2.1 Database .................................................................................................. 4 2.2 Oppsett .................................................................................................... 5

2.2.1 Oppsett ......................................................................................... 5 2.2.2 Server Info .................................................................................... 7 2.2.3 Velkomsttekst ............................................................................... 8

2.3 Søknader ................................................................................................. 8 2.3.1 Application list ............................................................................... 8 2.3.2 Application .................................................................................... 9

2.4 Brukere .................................................................................................... 9 2.4.1 Liste brukere ................................................................................. 9 2.4.2 Bruker ......................................................................................... 10 2.4.3 Send e-post ................................................................................ 13

2.5 Oversettelser .......................................................................................... 14 2.5.1 Liste oversettelser ....................................................................... 14 2.5.2 Oversettelse ................................................................................ 15 2.5.3 Oversettelsesfiler ........................................................................ 15 2.5.4 Kontroll oversettelse ................................................................... 16

2.6 Log ......................................................................................................... 16 2.6.1 Logg ............................................................................................ 17 2.6.2 Hendelse ..................................................................................... 17

2.7 Statistikk ................................................................................................. 18 3 Using of the translation resources 18

4 Using of the image resources 19

5 Help text documents 19




1 Introduction ByggSøk plan (ePlansak) is a web-application to serve the application process for zoning plan proposals.

1.1 Objective This document describes how to make different administration actions with working ePlansak system. All described pages are accessible after login with administrator role.

2 Administration pages 2.1 Database This page is used for update of startup database configuration. Values in parenthesis are actual current values. Server should be restarted before changes will take effect. New database can be created only during server start up.

Figure 2-1

Element of interface Description

Database host name or IP A host name or IP for connection to database.

Database host port A port number for connection to database.

Database name A name of database for connection.

Database user name A user name for connection to database.

Database user password A user password for connection to database.

Table 2-1




2.2 Oppsett This section contains the system properties, server information and special editor for the text, which will be shown on welcome page.

2.2.1 Oppsett This page contains the different system properties, most of them can be changed.

Figure 2-2





Standard språk A default language of the system

DB versjon A current version of the database, read only field.

Maks størrelse for opplastet fil

A maximum allowed size of a file, which can be uploaded to the system

Data cache timeout (seconds)

A period of time for holding objects in the system cache

Antall dager søknad skal lagres etter sending

A period of time (days) for keeping application after sending

URL til Informasjonsserver

An URL for access to the info server (holding the help text documents)

ID til hjelpefil på Informasjonsserver

A list of the help document IDs for the system

URL til BE's godkjenningsbase

An URL for access to the catalog of the central approved companies

URL til GAB-register An URL for access to the property catalog. Not used.

SMTP Server An address of the SMTP server for sending any email messages

Administrators epost An email address of the system administrator, used for sending any email messages

Log level Current level of logging. The possible levels: Error, Warning, Info, Debug.

Time live log A period of time for keeping the log records

Nytt bygg An URL for access to the NyttBygg server. (NyttBygg is not relevant in ByggSøk plan, but field is present here as ByggSøk plan uses common code with ByggSøk byggesak).

IFC Validation Server An URL for access to the IFC validation server. (Not relevant for ByggSøk plan, but field is present here as ByggSøk plan uses common code with ByggSøk byggesak).

Validate Attachements type and size

Indicates whether the attachment files should be validated for the allowed types and size

BRREG Catalog URL An URL for access to the BRREG foretaks catalog (Enhetsregisteret).

Postnummer List URL An URL for access to the Postens postnummer catalog (postnummer - poststed).

Startsidens innhold A text content for the welcome page, one for all languages of the system

Table 2-2




Any changes on the page will be stored in the system after pressing button ‘Oppdater’ or leaving this page.

2.2.2 Server Info This page shows information about current state of the server.

Figure 2-3




2.2.3 Velkomsttekst This page is used for text editing, which will be shown at the welcome page.

Figure 2-4

Any desirable text can be added in the text area. There is one text area for each language, which can be used in the system. New text will be stored in the system after pressing button ‘Oppdater’ or leaving this page.

2.3 Søknader This section shows an overview of all applications in the system and information on each of them when chosen in the table.

2.3.1 Application list The page shows the list of applications. The list can be filtered by application name or by user name. Administrator can specify a full or part of filter value, after the filter has been chosen. The wildcard symbols ‘*’ or ‘%’ can be used for allowing any symbols for the specified value. After entering a value the list will be updated when pressing button ‘Enter’ or clicking button ‘Søk’. Any application can be chosen from the list. After making a choice, next page will be opened

Figure 2-5




2.3.2 Application This page contains some information about the chosen application or empty fields, in case when no application has been chosen.

Figure 2-6


Name The name of the application

Date created The date, when application has been created

State A current state of application (indicates ‘Sent’ status after sending of the application )

Table 2-3

All fields on this page are read only.

The chosen application can be deleted by clicking the ‘DELETE’ link.

2.4 Brukere This section shows an overview of all user accounts in the system and properties on each of them when chosen in the table. There is a possibility to send an email to the users as well.

2.4.1 Liste brukere The list of user accounts is shown on this page. The list can be filtered by login, name, email address, number of the company or commune, name of company, user role. Administrator can specify a full or part of filter value, after the filter has been chosen. The wildcard symbols ‘*’ or ‘%’ can be used for allowing any symbols for the specified value. The list will be updated when pressing button ‘Enter’ or clicking button ‘Søk’ after entering a value. Any user account from the list can be chosen. After making a choice, next page will be opened

ByggSøk plan Administration Guide of 20 Document Date/Version 30.03.2012/1.0 Document status Released


Figure 2-7

2.4.2 Bruker This page contains properties of the chosen user account or empty fields, in case when no user account has been chosen.



Figure 2-8


Login The login for current user account

Navne The user name for the current user account

Rolle The role for the current user account. Can be chosen: Applicant (fagkyndig), Approved company (foretak med elektronisk signatur), Local authority (kommune), External system, Administrator

Passord The password for the current user account

e-postadresse The email address for the current user account. Used for sending any messages for this user.




Foretak The name of the company for the current user account

Telefonnummer The telephone number for the current user account

Org.nr./Kommunenr. The company number or commune number for the current user account

Postadresse The postal address for the current user account

Postnummer The zip code for the current user account

Poststed The city for the current user account

IS HelpID The ID of the help document for the municipality for the current user account (if kommune specific help texts are to be used).

For role ‘Local autotity’ (kommune) only.

XML versjon Eksternt system

The version of the XML documents for data exchange by SOAP services for the current user account.

For role ‘External system’ only.

URL for karttjener An URL for access to resource with a map of the municipality for the current user account.


Kommune Outlook url An URL for access to resource with a calendar of the commune for the current user account.


e-postadresse for søknadsmottak

An email address for sending applications to the municipality for the current user account.


FTP addresse An URL for access to the FTP server for the current user account.


Kommune hjemmeside An URL for access to the internet site of the municipality for the current user account.


Tillatte vedleggsformater The allowed types of attachment files for the current user account. There is a possibility to choose the following types: PDF, DOC, XLS, PPT, TIFF, JPEG, PNG, DWG.


Andre tillatte vedleggsformater

The additional allowed types of the attachment files for the current user account.





Tillatt filstørrelse på vedlegg

The allowed size of the attachment file for the current user account.


Tillatt filstørrelse på alle vedlegg samlet

The allowed total size of the all attachment files for a one application for the current user account.


XML versjon kommune The version of the XML documents for sending to municipality for the current user account.


Allow only 'initiativ fase' Indicates whether the themes should be disabled or not for the current user account.


Aktiver/deaktiver planfaglig tema

A list of the available themes with possibility to choose the active elements for the current user account.


Table 2-4

Administrator can add a new user account with specified properties by clicking button ‘Legg til’, can update all properties for the chosen user account by clicking button ‘Oppdater’ or can delete a chosen user account by clicking button ‘Slett’. All changed properties for the chosen user account will be updated when leaving this page as well.

2.4.3 Send e-post Administrator can create and send an email to users from this page.

Figure 2-9




Mottagerens rolle The user role. Can be chosen Applicant (fagkynidg), Approved company (foretak med elektronisk signature), Local authority (kommune), External system, Administrator.

Vedrørende The subject of the email

Tekst The text of the email message

Table 2-5

An email with specified subject and text will be sent to all users with specified role after clicking the button ‘Send’.

2.5 Oversettelser This section contains many functions for manipulation with translation resources and for updating system cache of the resources.

2.5.1 Liste oversettelser The list of translations is shown on this page. The list can be filtered by language, resource ID or translation. Administrator can specify a full or part of filter value, after the filter has been chosen. The wildcard symbols ‘*’ or ‘%’ can be used for allowing any symbols for the specified value. The list will be updated when pressing button ‘Enter’ or clicking button ‘Søk’ after entering a value. Any translation from the list can be chosen. After making a choice, next page will be opened

Figure 2-10



2.5.2 Oversettelse This page contains information about the chosen translation resource or empty fields, in case when a translation resource has not been chosen.

Figure 2-11


Språk The language of the translation resource

Ressurs The ID of the translation resource

Oversettelse The value of the translation resource

Table 2-6

Administrator can add new translation resource with specified parameters by clicking the link ‘INSERT’, can update all parameters for the chosen translation resource by clicking the link ‘UPDATE’ or can delete a chosen translation resource by clicking the link ‘DELETE’. The changed properties of the chosen translation resource will be updated after leaving this page too. If the language or ID of the chosen translation resource has been changed then a new translation resource with specified parameters will be created instead of updating the chosen translation resource.

2.5.3 Oversettelsesfiler Administrator can operate with all translation resources on this page at ones.



Figure 2-12

Administrator can specify a text file, which contains many translation resources and upload it to the server by clicking a button ‘Last opp oversettelse’. All translation resources, currently loaded to the system, can be saved as a text file by clicking a button ‘All oversettelse som texstfil’. All images, currently loaded to the system, can be saved as a zip file by clicking a button ‘All grafikk som zip-fil’.

2.5.4 Kontroll oversettelse Administrator can initiates reloading of all translation resources on this page.

Figure 2-13

After clicking the button ‘Restart oversetter’, current user translations will be dropped and completely reloaded, so that all changes made to translations will be visible.

2.6 Log This section shows an overview of all system events and information on each of them when chosen in the table.



2.6.1 Logg The list of events is shown on this page. The list can be filtered by type1, type2 or level. The possible values for type1 (event source): Timer Service, SOAP Service, WWW Service, WWW Page, Other. The possible values for type1 (event reason): Security, State Change, Data Change, Incoming Call, Outgoing Call, Other. Administrator can specify a full or part of filter value, after the filter has been chosen. The wildcard symbols ‘*’ or ‘%’ can be used for allowing any symbols for the specified value. After entering a value the list will be updated when pressing the button ‘Enter’ or clicking the button ‘Søk’ After making a choice, next page will be opened.

Figure 2-14

2.6.2 Hendelse This page contains information about chosen event resource or empty fields, in case when an event has not been chosen.

Figure 2-15


Dato The date of the chosen event.

Hendelse The name of the chosen event

Nivå The logging level of the chosen event

All fields on this page are read only.



2.7 Statistikk This page contains statistic information about system working.

Figure 2-16

Administrator can specify a start date of the time period, end date of the time period and date units. One of the following date units can be chosen: year, month, week, day, hour. Additionally, visibility for the following types of the counters can be chosen: new users, new applications, sent applications. A representation of the statistics data (counter values per date unit) in the table and graphic will be updated after clicking button ‘Søk’.

3 Using of the translation resources Any translation resource can be edited on the page ‘Oversettelse’ (described in section 2.5.2). At the same time simple text editor (e.g. Notepad) can be used for editing translations. Administrator has to use the page ‘Oversettelsesfiler’ (described in section 2.5.3), to work with translations in this way. All currently used translations



should be saved as a text file, edited and uploaded back to server. Text file must have ‘ISO 8859-1’ encoding.

Each translation resource represented in file in following format:

NO:Formal1List@kollektivterminal = kollektivterminal

The first part is a language code followed by sign ‘:’ (colon). The next part is a resource ID followed by ‘ = ’. And the last part is a translation text. Resource ID is a full path to the field. The node names for the path can be found in the file /WEB-INF/config/TreeMenu.xls. There is possibility to add translation for each value from enumeration for the fields, which have value enumeration. In this case value from enumeration must be added to the end of the resource ID. Additionally there is a resource ID ends with ‘@isTr’. This resource indicates whether translations should be used for enumeration values or not. In case when ‘yes’ is the translation text for this resource – translations for enumeration values will be used.

Administrator can add new translation resources to the file and edit existing translation resources. After uploading file to the server all new translations will be added to the system and all existing translations will be updated.

For deleting translation resource, administrator has to delete resource on the page ‘Oversettelse’ and uploaded file has to exclude this resource.

When any changes have been made for the translation resources administrator has to initiate a reload of all translations to the system cache on the page ‘Kontroll oversettelse’ (described in section 2.5.4).

Even adding a single resource with a new language code will entail adding this language code to the list of available languages.

At the start, system checks the file /WEB-INF/config/AllResourses.txt. All new translation resources from this file will be added to the system.

4 Using of the image resources Administrator can download all currently used images and upload new images on the page ‘Oversettelsesfiler’ (described in section 2.5.3). Zip archive is used for transmitting many images in a single operation. Administrator should make changes to the downloaded zip file – add new image files and change existing image files and must keep the structure of the directories unchanged. The language independent images there are in the directory ‘/i/’. The language dependent images there are in the subdirectories ‘/I’/XX/’, where XX is code of the language (NO, EN, ..). After uploading zip file, all image files will be extracted and ready for reload to the system cache.

5 Help text documents The help texts being shown in the right hand side pane, is located in a separate InfoServer (usually http://hjelpetekst.byggsok.no/) holding specially formatted help text documents for the ByggSøk web applications.



A special editor (ISeditor) for the help text documents is included in the InfoServer, and is accessible after logging in (on InfoServer) with the administrator account.

To edit a help text document, a new editable version of the published help text document must be created. This is done by using the InfoServer QAclient (which can be downloaded from the InfoServer). By selecting the newest published version of the help text document, a new editable version is to be created. Once created, the document is available for editing in ISeditor.

The editable help text document is accessible from within the InfoServer, after logging in as administrator. In ISeditor, download the document, edit it, and upload it to the server again. By using the QAclient, the document can then be published. As soon as a new version is published, it’s contents will be reflected in ByggSøk plan GUI.

A separate InfoServer clients user guide exist.

ByggSøk plan Administration Guide - Dibk · Document Date/Version 30.03.2012/1.0 Document status...

Documents

Transcript of ByggSøk plan Administration Guide - Dibk · Document Date/Version 30.03.2012/1.0 Document status...