Configuration
Namespace
urn:se.viamap.useradmin#1.0
Tags
config
This is the base configuration for the User Administration extension that other components may be depending on.
Properties
Name | Type | Required | Description |
datasource | string | yes | Reference the JDBC data source connected to the User Administration database |
schema | string | no | Specify a custom schema. If not specified, the default schema of the database will be used |
includePublishedClients | boolean | no | If true, published Weave clients will be displayed in the User Dashboard. Defaults to true. |
enableLdap | boolean | no | If true, LDAP tools will be enabled for administrators. The LDAP tools include managing LDAP connections (only system administrators) and adding users from defined LDAP directories. |
admin | List<string> | no | A list of usernames who should be treated as system administrators. |
client
The client configuration is used to create custom urls to clients or other resources.
Properties
Name | Type | Required | Description |
title | string | yes | The title of the client |
description | string | no | Description of the client |
url | string | yes | The url to the client |
iconCls | string | no | Optional icon class |
acl | string | no | Optional ACL reference to limit user access |
<useradmin:config id="ikartan.context">
<datasource>ds.weave</datasource>
<schema>useradmin</schema>
<includePublishedClients>true</includePublishedClients>
<enableLdap>false</enableLdap>
<admin>
<user>admin</user>
</admin>
</useradmin:config>
Namespace
urn:se.viamap.useradmin.userattributes#1.0
The User Attribute configuration integrates the User Attributes setup in User Admin and apply the appropriate Attributes on Users.
Tags
config
Properties
Name | Type | Required | Description |
cache | boolean | no | If true, User Attributes will be cached. Defaults to true. |
expire | number | no | Cache expiration in seconds (assumes cache is true), defaults to 300 |
prefix | string | no | Set a prefix for user attributes, i.e. myprefix will result in user.myprefix.theParameterName |
This User Attribute provider will generate a few convenient attributes automatically related to the current user in addition to the ones defined in User Admin.
Note that these keys cannot be overridden in User Admin and will be ignored
Key | Description |
---|---|
userUuid | The User’s database UUID |
firstName | The User’s first name |
lastName | The User’s last name |
emailAddress | The User’s email address |
title | The User’s title |
department | The User’s department |
phone1 | The User’s Phone number |
phone2 | The User’s Mobile phone number |
userGroupUuid | The database UUID of the User Group the User belong to |
userGroupName | The name of the User Group the User belong to |
tenantUuid | The database UUID of the Tenant the User belong to |
tenantName | The name of the Tenant the User belong to |
tenantRecid | The numeric ID of the Tenant the User belong to |
tenantAddressLine1 | Tenant address row |
tenantAddressLine2 | Tenant address row |
tenantAddressLine3 | Tenant address row |
tenantPostalCode | Tenant postal code |
tenantPostalArea | Tenant postal area |
tenantCountry | Tenant country |
tenantPhone1 | Tenant main phone number |
tenantPhone2 | Tenant mobile phone number |
tenantOrgId | Tenant organizational number |
tenantVatId | Tenant VAT number |
Example
<config xmlns:ikartan= "urn:se.viamap.ikartan.admin#1.0"
xmlns:userattr= "urn:se.viamap.useradmin.userattributes#1.0">
<ikartan:config id="ikartan.context">
<datasource>ds.weave</datasource>
<schema>useradmin</schema>
<includePublishedClients>true</includePublishedClients>
<enableLdap>true</enableLdap>
<admin>
<user>admin</user>
</admin>
</ikartan:config>
<ikartan:client acl="acl.admin">
<iconCls>x-fa fa-wrench</iconCls>
<title>Weave Admin</title>
<description>Administer and monitor Weave</description>
<url>admin.html</url>
</ikartan:client>
<userattr:config>
<cache>false</cache> <!-- enable/disable cache, defaults to true -->
<expire>300</expire> <!-- Cache expiration in seconds (assumes cache is true), defaults to 300 -->
<!--<prefix>myprefix</prefix>--> <!-- Set a prefix for user attributes, i.e. myprefix will result in user.myprefix.theParameterName -->
</userattr:config>
</config>