Organizational Type Properties

[This is preliminary documentation and is subject to change.]

Required introduction

Basic Properties

These properties/ fields are displayed in tab "Properties". "Type", "Name(singular)" and "Name (plural)" are required for all arganizational types.. "Employer" is important - must be set in order to create employees (and hence users) on the actual type. The rest of the properties are used to set up validation rules etc.

Name

Type

User interface

Description

Icon

(image)

The folder Organization/Images inside the configuration folder may contain image files in GIF-format. The filename must match the name of the organizational type. If Organization/Images contains a file hospital.gif, and the organization structure contains a type hospital, the hospital.gif is displayed next to each hospital in the organization hierarchy.

This image cannot be edited using the property form (but it may be uploaded using TOPICA Explorer).

Type

String

Text field

The name of the organizational type. This name is part of the key of the org.units - org.unit keys áre (type, code).

The name may not contain spaces or any special characters.

Name (singular)

String

Text field

The full name displayed in the user interface - singular form.

Name (plural)

String

Text field

The full name displayed in the user interface - plural form.

Display (ancestor) type

(relation)

Dropdown

In some cases displaying the name of an org.unit may not be enough to identifiy it. For example, many hospitals may have departments named "Emergency ward" or "Medical department". To identify such units, some prefix is needed. The name of the parent org.unit is not sufficient, because department is typically a "recurvsive" type - the parent unit may be a hospital or some other department.

When one of the "ancestor" types are selected as the "display ancestor", the system will locate the ancestor with the given type, and display the name of the ancestor as a prefix.

Example: hosp ("Hospital") has child type = hospdep ("Hospital department") Hierarchical structure:

Copy

First hospital
    Emergency ward
    Medical department
        Medical ward 1
        Medical ward 2
Second hospital
    Emergency ward
    Medical department

When type hospdep ("Hospital department") has no display ancestor type, departments will be displayed like this:

Copy

Emergency ward
Medical department
Medical ward 1
Medical ward 2
Emergency ward
Medical department

When type hospdep ("Hospital department") has display ancestor type = hosp ("Hospital"), departments will be displayed like this:

Copy

First hospital, Emergency ward
First hospital, Medical department
First hospital, Medical ward 1
First hospital, Medical ward 2
Second hospital, Emergency ward
Second hospital, Medical department

Hidden

Boolean

CheckBox

Set checkmark here to make the type hidden in the organization hierarchy.

Institution

Boolean

CheckBox

Set checkmark here to make the type as an institution type. Institution types have some extra features in the user interface. For example, when working with a unit of institution type, user interface typically displays data for all the sub-orgunits, too.

Employer

Boolean

CheckBox

Set checkmark here to enable creation of employees (users) on org.units of this type.

Note
There is currently an error in the user interface that (in some situations) makes it possible to create employees on org.units of types, that do not have this property set. Do not rely on this - this error will be fixed in a future version.

Weekly capacity planning

Boolean

CheckBox

Set checkmark here to enable weekly capacity planning.

Use parent code as prefix

Boolean

CheckBox

When a checkmark is set here, the prefix of the code of a new / edited org.unit must match the coe of the "parent" org.unit. Example:

Parent type = hosp ("Hospital").
Child type = hospdep ("Hospital Department"). This type is"recursive". "Use parent code as prefix" is set.

Legal scenario:

Copy

hosp 1234
    hospdep 123401
    hospdep 123402
        hospdep 1234021
    hospdep 123403

Illegal scenario:

Copy

hosp 1234
    hospdep 1235                (error: prefix is not 1234)
    hospdep 123602              (error: prefix is not 1234)
    hospdep 123402              (OK)
        hospdep 123403          (error: prefix is not 123402)

Code numeric

Boolean

CheckBox

When a checkmark is set here, only digists (0-9) are allowed in code.

Code length minimum

Integer

Integer field

Minumum length of code.

Code length maximum

Integer

Integer field

Maximum length of code.

Regular expression for code

String

Text field

When a regular expression is entered here, it is used to validate codes when org.units are create or edited. Examples:

Type	Description	Regular expression
Country code	2 lower case letters (between 'a' and 'z')	[a-z]{2}

Error message

String

Text field

This text is displayed, when an end user enters a code, that violates the regular expression specified (see above).

Recursive

Boolean

CheckBox

Set checkmark here to enable, that units of this type may be parent of units of the same type.

For example, it is customary, that hospital departments may be organized as sub-departments.

When "Recursive" is enabled, the type is displayed in the organization structure. with a special legend.

Number of org. units

(computed)

Displays number of org.units of the actual type currently created in the database - current(active), deleted and total.

Example: If 3 org.units have been created, and 1 (logically) deleted, the display will be "Current: 2, Deleted: 1, Total: 3".

It is impossible to delete a type, when org.units of that type exist in the database (even logically deleted). E.g. only when the Total count displayed is 0, the type can be deleted.

Document References Properties

The fields in the tab "Document references module" should ONLY be filled in for those org.types, that should have document references enabled.

Name	Type	User interface	Description
Menu tekst	String	Text field	The tekst displayed in the org.unit submenu (the tab), that activates the pages, that hande creating and editing document references per org.unit.
Menu access key	String	Text field	If specified, the first character in the text will become the "access key".
Caption (singular)
Caption (plural)
Type	Enumeration	DropDown	Field status. Values Hidden / Optional / Mandatory.
Status	Enumeration	DropDown	Field status. Values Hidden / Optional / Mandatory.
Title	Enumeration	DropDown	Field status. Values Hidden / Optional / Mandatory.
Description	Enumeration	DropDown	Field status. Values Hidden / Optional / Mandatory.
Approved	Boolean	CheckBox	Whether field "Approved" should be displayed.
Reference (= location) to physical documents	Boolean	CheckBox	Enable creating references to physical documents
Reference (= URL) to digital documents	Boolean	CheckBox	Enable creating references to external, digital documents
Upload digital documents	Boolean	CheckBox	Enable uploadin documents (to be stored in BLOB fields in the database).
File types that can be uploaded	String	Text field	Blank => all types of documents may be uploaded. Not blank => only documents of the specified file typs may uploaded. Example: "doc, docx" => only Microsoft Word documents may be uploaded.
File type description	String	Text field	The file type text displayed in the user interface. Example: "Microsoft Word documents"
File type error message	String	Text field	The error message is displayed, when an end user selects wrong type of document. Example: "Only Microsoft Word documents may be selected".
Path to report	String	Text field	If specified, the report specified is displayed (run) in the document references page.
IFrame attributes	String	Text field	If "Path to report" is specified, this report is displayed in an iframe. This property may define attributes on the iframe tag - e.g. to specify size of this iframe (if the iframe is smaller than the rendered report, scrollbars will appear). Example: width=800 height=600.