Kupp Deployment / Reference / Steps /

BlockUserAccessStep

Applies to KDTooling Deployment Manager 1.2

Content

Overview
Parameters
Dependencies
Examples
Build Provider
Troubleshooting
Additional Information

Overview

Block access to the system for certain users or business units.

Caution! If no UnblockUserAccessStep is contained in the same Deployment Definition as the BlockUserAccessStep, the blocked users or business units can not be set active again, with the KDTooling Deployment Manager!

Name	BlockUserAccessStep
Type	Deployment Definition
IsPostBuild	True

Parameters

Name	Type	Description
Title	String	Title
TargetEnvironment	Dropdown	Target Environment
Error Behaviour	Enum	Specifies the behaviour of the step if an error occurs in a following step (e.g. Unblock the blocked users).
Filter by User	Boolean	If set, users will be directly blocked, otherwise a user can only be blocked if it’s business unit gets blocked
Include System Administrators	Boolean	By default, system administrators do not get blocked. If you set this control, system administrator will get blocked too
Use User Filter	Boolean	If Filter By User is set, all found users, will get blocked by default. Set this control to apply a custom fetch XML filter to specify the users which shall be blocked.
User Filter Fetch XML	String	The custom fetch XML filter for users
Filter By Business Unit	Boolean	If set, business units will be directly blocked. Filter By User and Filter By Business Unit can be set at the same time (see Additional Information for the behaviour table)
Use Business Unit Filter	Boolean	If Filter By Business Unit is set, all found business units (except the root business unit), will get blocked by default. Set this control to apply a custom fetch XML filter to specify the business units, which shall be blocked.
Business Unit Filter Fetch XML	String	The custom fetch XML filter for business units

Dependencies

UnblockUserAccessStep

Examples

Business Unit Filter Fetch XML Example:

<fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
  <entity name="businessunit">
    <attribute name="name" />
    <attribute name="address1_telephone1" />
    <attribute name="websiteurl" />
    <attribute name="parentbusinessunitid" />
    <attribute name="businessunitid" />
    <order attribute="name" descending="false" />
    <filter type="and">
      <condition attribute="name" operator="eq" value="test bu lv 3" />
    </filter>
  </entity>
</fetch>

User Fetch XML Example:

<fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
  <entity name="systemuser">
    <attribute name="fullname" />
    <attribute name="businessunitid" />
    <attribute name="title" />
    <attribute name="address1_telephone1" />
    <attribute name="positionid" />
    <attribute name="systemuserid" />
    <order attribute="fullname" descending="false" />
    <filter type="and">
      <condition attribute="fullname" operator="eq" value="Alan Steiner" />
    </filter>
  </entity>
</fetch>

Build Provider

Local Visual Studio: Supported
Team Foundation Server: Supported

Troubleshooting

Additional Information

Recommended default configuration:

This configuration works perfectly for you if you just want to deny user access to your system during the deployment time. In this case all business units except the root business unit get blocked. The deploying user will not get blocked either. After your deployment the UnblockUserAccessStep will activate all blocked business units again. If an error occurs during your deployment, the Error Behaviour “PerformRollbackOnError” ensures, that even if the UnblockUserAccessStep doesn’T get executed anymore all users regain their access to the system. For more information about configuring the BlockUserAccessStep see section “Parameters” and the “Behaviour Table”.

Behaviour Table:

Filter By User	Filter By Business Unit	Use User Filter	Use Business Unit Filter	Include System Administrators	Behaviour
False	False	-	-	-	All business units except the root business unit and the business unit of the deploying user get blocked.
False	True	-	False	-	All business units except the root business unit and the business unit of the deploying user get blocked.
False	True	-	True	-	All business units specified by the fetch XML filter get blocked (except the business unit of the deploying user)
True	False	False	-	False	All users except the deploying user and system administrators get blocked
True	False	False	-	True	All users except the deploying user get blocked
True	False	True	-	False	All users specified by the filter except the deploying user and system administrators get blocked
True	False	True	-	True	All users specified by the filter except the deploying user get blocked
True	True	False	False	False	All business units except the root business unit and the business unit of the deploying get blocked. All users except the deploying user and system administrators get blocked.
True	True	False	False	True	All business units except the root business unit and the business unit of the deploying get blocked. All users except the deploying user get blocked.
True	True	False	True	False	All business units specified by the custom filter get blocked (except the business unit of the deploying user). Additionally all users except the deploying user and system administrators get blocked
True	True	False	True	True	All business units specified by the custom filter get blocked (except the business unit of the deploying user). Additionally all users except the deploying user get blocked too.
True	True	True	False	False	All business units except the root business unit and the business unit of the deploying user get blocked. Additionally all users except the deploying user and system administrators get blocked too.
True	True	True	False	True	All business units except the root business unit and the business unit of the deploying user get blocked. Additionally all users except the deploying user get blocked too.
True	True	True	True	False	All business units specified by the custom filter except the root business unit and the business unit of the deploying user get blocked. Additionally all users specified by the custom filter except the deploying user and system administrators get blocked too
True	True	True	True	True	All business units specified by the custom filter except the root business unit and the business unit of the deploying user get blocked. Additionally all users specified by the custom filter except the deploying user get blocked too.

Need help? Contact support