Product Documentation

Install

Best Practices

The UMT will allow you to connect into a selected domain but for best speed and results the tool should be installed on a domain joined server. It is recommended to install this tool on a server or box that is rarely taken offline.

The windows scheduler integration allows the User Management Tool rules to be run recurrently, keeping ShareFile up to date with changes in Active directory. These tasks cannot run if the machine is offline or shut down as often happens with personal machines. Tasks will be run using the windows user context that created the scheduled task and will require the correct permissions (listed above) to complete.

Additionally, an admin or service account in ShareFile may be used with the UMT and all user and group creation will be logged in ShareFile as an action of the admin or service account user. If segregating the logging of user creation by the UMT for tracking purposes is needed then it is recommended to create a service account to use with this tool. Use of a service account will allow for detailed reporting on the users and groups creating on the accounts name.

First Steps

Once the requirements are in place and all appropriate user accounts have been acquired, you can install the application.

Before installation, make sure that any prior UMT instance that is version 1.8 or older has been uninstalled and the Scheduled Tasks have been disabled or deleted. This is important because the UMT rules on a Policy Based Administration account are vastly different and you cannot upgrade an old-style UMT rule to a new PBA-style rule.

Once you have made sure all previous versions of the UMT have been removed, navigate to www.citrix.com/downloads and log in. If you do not have a user account you can easily register for one on the page. Once logged in, hover over the downloads link at the top of the page and then select ShareFile from the product drop down. On this page,you should see a link to download the latest ShareFile User Management Tool installer. Run the installer and follow the prompts to complete the installation. When finished a shortcut for the application will be placed on your desktop and in the start menu.

First-time setup

Upon first starting the tool you will be brought to a ShareFile login page. You will need to fill in which account you want to connect to as well as the ShareFile administrative or service account credentials listed in the requirements to run the application. This tool is designed to be run by an administrator and therefore does not support SAML authentication even if it is configured on the connected ShareFile account.

After logging into the correct ShareFile account with administrative credentials you will proceed to a domain log in. Here you will need to enter the domain and the credentials of a user with full read permissions to allow the UMT to read necessary properties from AD. If you are running this tool on a domain joined machine and logged in with a user account with the necessary permissions you can leave the form blank and click connect to use the local domain and user.

For best load times and speed, it is recommended to run this tool on a domain joined machine. Once authenticated you can choose to always use this domain in the future. Additionally, the tool should only be kept open when updating and managing rules. The log in token will expire if the tool is kept open and cause error messages upon next load.

Proxy Setup

If you need to configure a proxy server, click the Settings icon and then select Configure Proxy.

If you are unable to log in to configure these settings you can open this page manually by navigating to

Program Files>Citrix>ShareFile>User Management Tool

and opening the “ShareFileProxyConfig.exe”

Dashboard

Once logged in you will be navigated to the Dashboard page. This page displays quick links to see your existing rules, to create user rules or great group rules. Midway on the dashboard you will see a description of which ShareFile account and user as well as the domain and user you are logged in as for this session. Finally, you will see a history section, which displays status updates and logs for recently run rules and tasks.

Rule Creation

Information on Rule Creation and scheduling can be found under provision accounts and distritbution groups.

Install