Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Next revision Both sides next revision
devel:documentation:application_configuration:dev:backend [2021/05/05 08:54]
tomiskar [Bulk actions] 		devel:documentation:application_configuration:dev:backend [2021/10/19 19:04]
tomiskar [Authentication]
Line 63: Line 63:
 idm.pub.app.stage= idm.pub.app.stage=
 # Application instance / server id - is used for scheduler etc. # Application instance / server id - is used for scheduler etc.
-# Should be defined in property file only+# Can be defined in property file only! Overidding via ConfigurationService is not possible for application instance (~ more instanceos on the same database)
 idm.pub.app.instanceId=idm-primary idm.pub.app.instanceId=idm-primary
 # global date format on BE. Used in notification templates, logs, etc. FE uses localization key 'core:format.date'. # global date format on BE. Used in notification templates, logs, etc. FE uses localization key 'core:format.date'.
Line 77: Line 77:
 # Show role baseCode in frontend application for roles (table, role detail, niceLabel, info components, role select). # Show role baseCode in frontend application for roles (table, role detail, niceLabel, info components, role select).
 idm.pub.app.show.role.baseCode=true idm.pub.app.show.role.baseCode=true
 +# Rendered column in role table agenda. Comma is used as separator. Order of rendered columns is preserved as configured.
 +# Available columns:
 +# - name - role name info card with link to detail
 +# - baseCode - role base code (without environment)
 +# - environment - role environment
 +# - disabled
 +# - description
 +idm.pub.app.show.role.table.columns=name, baseCode, environment, disabled, description
 +# Show role catalogue item code in role catalogue tree
 +idm.pub.app.show.roleCatalogue.tree.code=false
 # Number of items (pagination) in role catalogue tree in root level. Used on role select and agenda. # Number of items (pagination) in role catalogue tree in root level. Used on role select and agenda.
 idm.pub.app.show.roleCatalogue.tree.pagination.root.size=25 idm.pub.app.show.roleCatalogue.tree.pagination.root.size=25
Line 113: Line 123:
 # you can use FE configuration https://wiki.czechidm.com/devel/documentation/application_configuration/dev/frontend # you can use FE configuration https://wiki.czechidm.com/devel/documentation/application_configuration/dev/frontend
 idm.pub.app.show.identity.table.columns=username, lastName, firstName, externalCode, email, state, description idm.pub.app.show.identity.table.columns=username, lastName, firstName, externalCode, email, state, description
 +idm.pub.app.show.identityRole.table.columns=role, roleAttributes, environment, identityContract, contractPosition, validFrom, validTill, directRole, automaticRole, incompatibleRoles
 # If is true, then role-request description will be show on the detail. # If is true, then role-request description will be show on the detail.
 # Description will hidden if this property will be false and role request # Description will hidden if this property will be false and role request
Line 128: Line 139:
 idm.sec.core.init.data.enabled=true idm.sec.core.init.data.enabled=true
 </code> </code>
 +
 +=== Change server for asynchronous processing (switch application instance) ==
 +
 +@since 11.1.0
 +
 +Application instance (server) is used for asynchronus processing - for scheduled tasks, asynchronous long running tasks and events.
 +Instance identifier can be defined in the application profile (application.properties) by property ''idm.pub.app.instanceId''.
 +When we want to schedule and process asynchronous tasks and event on other instace (or when one instance shutdown), then we can switch processing by provided bulk action ''Change server for asynchronous processing'' in configuration agenda:
 +
 +{{ :devel:documentation:application_configuration:dev:switch-instance-bulk-action.png |}}
 +
 +Previous and new instance identifier is required as input parameters. All scheduled tasks and all created (~ not processed) asynchronous long running tasks and events will be moved from previous to new instance and will be processed on new instance (server).
 +
 +Bulk action is available for logged user with required authorities and permissions:
 +  * ''CONFIGURATION\_UPDATE'' - configuration property contains instance for asynchronous processing will be changed => authority and ''UPDATE'' base permission for property ''idm.sec.core.event.asynchronous.instanceId'' is required.
 +  * ''SCHEDULER\_UPDATE'' - scheduled tasks and created (~ not processed) asynchronous long running tasks will be changed.
 +  * ''ENTITYEVENT\_UPDATE'' - created (~ not processed) asynchronous events will be changed.
 +
  
 ==== Jpa === ==== Jpa ===
Line 515: Line 544:
 # Needed on FE (=> public)  # Needed on FE (=> public) 
 idm.pub.core.identity.passwordChange.public.idm.enabled=true idm.pub.core.identity.passwordChange.public.idm.enabled=true
-# 
-# create default identity's contract, when identity is created. 
-# skipped in synchronizations - contract synchronization should be provided. 
-idm.pub.core.identity.create.defaultContract.enabled=true 
 # #
 # Skip identity dashboard content - show full detail directly (link from table or from info component) # Skip identity dashboard content - show full detail directly (link from table or from info component)
 # Needed on FE (=> public)  # Needed on FE (=> public) 
 idm.pub.core.identity.dashboard.skip= idm.pub.core.identity.dashboard.skip=
 +#
 +# Create default identity's contract, when identity is created.
 +# Skipped in synchronizations - contract synchronization should be provided.
 +idm.sec.core.identity.create.defaultContract.enabled=true
 +# Creates default identity's contract with configured position name.
 +idm.sec.core.identity.create.defaultContract.position=Default
 +# Creates default identity's contract with configured state. Valid contract will be crated by default, other possible values:
 +# EXCLUDED - Excluded from evidence - remains valid, but roles assigned for this contract are not added for logged identity.
 +# DISABLED - Invalid by user - not changed by dates.
 +idm.sec.core.identity.create.defaultContract.state=
 +# Number of days related to current date - will be used for set contract valid till date (current date + expiration in days = valid till).
 +# Contact valid till will not be set by default (~ contract expiration is not configured by default).
 +idm.sec.core.identity.create.defaultContract.expiration=
 +#
 +# Profile image max file size in readable string format (e.g. 200KB).
 +idm.sec.core.identity.profile.image.max-file-size=512KB
  
 </code> </code>
Line 610: Line 651:
 # disable / enable asynchronous event processing. Events will be executed synchronously, if it's disabled. Enabled by default. # disable / enable asynchronous event processing. Events will be executed synchronously, if it's disabled. Enabled by default.
 idm.sec.core.event.asynchronous.enabled=true idm.sec.core.event.asynchronous.enabled=true
 +# Asynchronous event processing is stopped.
 +# Event processing is stopped, when instance for processing is switched => prevent to process instances in the meantime.
 +# Asynchronous event processing can be disabled for testing or debugging purposes.
 +# Events are still created in queue, but they are not processed.
 +idm.sec.core.event.asynchronous.stopProcessing=false
 # Asynchronous events will be executed on server instance with id. Default is the same as {@link ConfigurationService#getInstanceId()} (current server instance). # Asynchronous events will be executed on server instance with id. Default is the same as {@link ConfigurationService#getInstanceId()} (current server instance).
 idm.sec.core.event.asynchronous.instanceId= idm.sec.core.event.asynchronous.instanceId=
Line 846: Line 892:
  
 === CAS authentication filter === === CAS authentication filter ===
-@since 10.9.0+@since 12.0.0
 [[..:..:security:dev:security#cas_authentication|CAS authentication]] can be configured with following properties: [[..:..:security:dev:security#cas_authentication|CAS authentication]] can be configured with following properties:
 <code properties> <code properties>
-# Enable authentication via CAS. If enabled, all properties below "Other properties" become mandatory and must be set for SSO authentication via CAS to work. Default: false +# Enable authentication via CAS. If enabled, "idm.sec.core.cas.url" become mandatory and must be set for SSO authentication via CAS to work. Default: false 
-idm.pub.core.cas.sso.enabled=true+idm.pub.core.cas.enabled=true
 # Other properties # Other properties
 # Base URL where CAS is accessible. Syntax of this field is https://hostname-of-CAS/URI. # Base URL where CAS is accessible. Syntax of this field is https://hostname-of-CAS/URI.
-idm.pub.core.cas.url= +idm.sec.core.cas.url= 
-# Suffix which is, in effect, appended to idm.pub.core.cas.url. Resulting URL is used for login operation in CAS. It must start with slash (eg. /login). +# IdM service name configured as service on CAS server.  
-idm.pub.core.cas.login-suffix=/login?service= +# When service is configured, then login and logout redirect urls, should be defined directly in CAS service configuration. 
-# Suffix which is appended to idm.pub.core.cas.url. Resulting URL is used for single sign-out operation. It must start with slash (eg. /logout). +# Default: service name for login / logout is created dynamically by BE server url (recommended). 
-idm.pub.core.cas.logout-suffix=/logout?service= +idm.sec.core.cas.service= 
-# URL of CzechIdM. This URL is used for redirect back after logout and also for ticket validation. Syntax of this field is https://hostname-of-CzechIdM/URI. +# Suffix which is, in effect, appended to idm.sec.core.cas.url. Resulting URL is used for login operation in CAS. It must start with slash (eg. /login). 
-idm.pub.core.cas.idm-url= +idm.sec.core.cas.login-path=/login 
-# Header name in which CAS sends the ticket value.+# Suffix which is appended to idm.sec.core.cas.url. Resulting URL is used for single sign-out operation. It must start with slash (eg. /logout). 
 +idm.sec.core.cas.logout-path=/logout 
 +# Ticket can be given as request parameter (recommended, configured by default). 
 +idm.sec.core.cas.parameter-name=ticket 
 +# Header name in which CAS sends the ticket value. Ticket can be given as request header. Not configured by default.
 idm.sec.core.cas.header-name=referer idm.sec.core.cas.header-name=referer
-# Path to CzechIdM for the HTTP Referer header used by CAS while redirecting back to application. This value is concatenated with CAS ticket to form Referer header. Syntax of this field is https://hostname-of-CzechIdM/URI/?ticket=.+# Path to CzechIdM for the HTTP Referer header used by CAS while redirecting back to application. This value is concatenated with CAS ticket to form Referer header. Syntax of this field is https://hostname-of-CzechIdM/URI/?ticket=. Not configured by default.
 idm.sec.core.cas.header-prefix= idm.sec.core.cas.header-prefix=
 </code> </code>
Line 938: Line 988:
  
 ==== Provisioning global break ==== ==== Provisioning global break ====
-<note tip>For enable global provisioning break you must set configurations properties defined below, otherwise global provisioning break will not be active.</note>+<note tip>For enable global provisioning break you must set configurations properties defined below, otherwise global provisioning break will not be activated.</note>
  
 <code properties> <code properties>
Line 1031: Line 1081:
 # Show thread name configured by thread pools (task, event) in logs (generated name is shown otherwise) # Show thread name configured by thread pools (task, event) in logs (generated name is shown otherwise)
 # Two appenders 'console' and 'file' are provided by product. Same configuration is needed for your custom appenders (added in logback.xml). # Two appenders 'console' and 'file' are provided by product. Same configuration is needed for your custom appenders (added in logback.xml).
-logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} %5level %relative --- [%thread] %logger{36}.%M : %msg%n +logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} %5level %relative --- [%thread] %logger{60}.%M : %msg%n 
-logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} %5level %relative --- [%thread] %logger{36}.%M : %msg%n+logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} %5level %relative --- [%thread] %logger{60}.%M : %msg%n
 </code> </code>
  
Line 1049: Line 1099:
 idm.sec.core.logger.eu.bcvsolutions=DEBUG idm.sec.core.logger.eu.bcvsolutions=DEBUG
 </code> </code>
 +
 +==== Monitoring ====
 +
 +=== Monitoring evaluator ===
 +
 +In the application profile (''application.properties'') - overloadable via ''ConfigurationService''.
 +
 +<code properties>
 +# disable / enable monitoring evaluator
 +idm.sec.<module>.monitoring-evaluator.<name>.enabled=true
 +</code>
 +Where ''<module>'' is monitoring's module a ''<name>'' is monitoring's name.
 +
 +Common configuration properties for all monitorings:
 +  * ''enabled'' - true / false
  • by chalupat