Fotoware Veloz User Toolkit

Fotoware Veloz User Toolkit is a Windows desktop application for Fotoware Veloz and Fotoware On-premises that allows you to bulk update users and groups based on information from a CSV file. The toolkit can be used when migrating from one single sign-on (SSO) identity provider (IdP) to another. It changes the external authentication provider identities for Fotoware users and groups so they can log in with the new authentication provider and access their existing user accounts, with their Albums, Pins, and Comments. It can also be used to make other bulk changes, such as updating usernames and licenses.

Requirements

• .NET Framework 4.6.2 or newer
  • Systems running newer versions, such as .NET Framework 4.8, are fully backward-compatible and already support earlier versions. If .NET Framework 4.8 (or newer) is installed, no further action is required.
     
• API mode
  • Fotoware Veloz and FotoWeb non-interactive/script application registration (Client ID & Secret)
  • A user account that belongs to a group with the Manage users permission (required to register an application)
     
• Non-API (MongoDB) mode
  • Access to the FotoWeb MongoDB TCP port 7200 or 27017
     

Overview

Toolkit tab: Tab containing the tools

(select site): Select the site settings to use from the dropdown list.

Logs: The right-hand panel displays logs when using the tools. Log files are stored as text files under the name of the site settings description.

C:\ProgramData\VelozUserToolkit\Logs\Example.log

 Settings tab: Tab containing the site settings

[+]: Add site settings.

[Save Settings]: Save site settings to: C:\ProgramData\VelozUserToolkit\VelozUserToolkit.xml. 

[ - ]: Remove site settings using the [ - ] button in the top-right.
 

Veloz User Toolkit using Fotoware API

Use the Fotoware API to remotely change users and groups. Fotoware Veloz sites can only be updated via API.

Restrictions

In API mode, Veloz User Toolkit uses the User Management API (Beta), which currently cannot change between FotoWeb non-SSO users with passwords to SSO users without passwords. The API does not allow changing external authentication provider information for user accounts with a password, nor can it remove passwords. We cannot migrate FotoWeb user accounts with passwords from internal FotoWeb authentication to an external authentication provider such as Microsoft Entra ID, or vice versa. This means we can only migrate existing SSO users to another authentication provider.

Registering the Fotoware application for Veloz User Toolkit

https://example.fotoware.cloud/login

1. Log in and go to Tools > Site Configuration > Integrations > Applications > Add application.
2. Enter the following information:

• Type: Non-interactive / script
• Name: VelozUserToolkit

3. Select Save.

4. Copy the Client ID and Client secret values to the Veloz User Toolkit settings.

Veloz User Toolkit settings

• Description: example. A description of the site settings used in the dropdown list when selecting a site.
• Site URL: https://example.fotoware.cloud.The base URL for the Fotoware site. Do not include /fotoweb or a trailing /.
• Method: Select Use Fotoware API to select whether to use the Fotoware API or, for Fotoware On-premises, directly update the FotoWeb MongoDB.
• Client ID: ********-****-****-****-************
  Site Configuration > Integrations > Applications > Type: Non-interactive / script > Client ID
• Client secret: *****************
  Site Configuration > Integrations > Type: Non-interactive / script > Client Secret

Veloz User Toolkit using MongoDB

 If the Fotoware API is not available, you can use the Veloz User Toolkit to update the FotoWeb MongoDB directly.

Restrictions

Only available for Fotoware On-premises systems, when you can access the FotoWeb MongoDB via the IP address and TCP Port.

Veloz User Toolkit settings

• Description: example. A description of the site settings used in the dropdown list when selecting a site.
• Site URL: https://example.com. The base URL for the Fotoware site. Do not include /fotoweb or a trailing /.
• Method: clear Use Fotoware API. Checkbox to select whether to use the Fotoware API or, for Fotoware On-premises, directly update the FotoWeb MongoDB.
• Site name: EXAMPLE. This is the Fotoware site name that can be found in FotoWeb Settings in Fotoware On-premises.
• MongoDB:
  • mongodb://127.0.0.1:7200 (FotoWeb 8.0 - 8.1)
  • mongodb://127.0.0.1:27017 (FotoWeb 9.0 and newer)
     

Exporting users to a CSV file

Select Export Users to CSV, then select a destination folder and filename for the CSV file. The users' CSV file will contain the columns listed in the following table.

Updating users

Select Update Users, then open the CSV file containing the new authentication provider's identities for the users. This will update existing users using the information in the CSV file.
 

Exporting groups to a CSV file

Select Export Groups to CSV, then select a destination folder and filename for the CSV file.

Updating groups

Select Update Groups, then open the required groups' CSV file containing the new authentication provider identities for the groups. This will update existing groups using the information in the CSV file. 

Exporting memberships

Select Export Memberships CSV, then choose a destination folder and filename for the CSV file (API mode only).

This will export the memberships of the groups and users. It includes all the memberships by recursively processing groups within groups. The memberships CSV can be used in Power BI with Activity Exports to provide group membership information for users.

The memberships CSV file will contain the columns listed in the following table. 

Copying users to a CSV file

Select Copy Users to CSV and select a destination folder and filename for the CSV file.

This will copy the complete user account records to a CSV, which can then be used to transfer the users to a different site.

The copy users CSV file will contain the columns listed in the following table. 

Creating users

Select Create Users, then open the required users' CSV file containing the copied users. This will create new FotoWeb user accounts in the destination site.

Migrating a Fotoware site to a new authentication identity provider (IdP)

Updating the Fotoware users to use the new authentication identity provider (IdP)

1. Ask the new authentication identity provider (IdP) administrator to export their list of users to a text file containing each user's email address and new identity provider ID.
2. Run Veloz User Toolkit and select the settings for the Fotoware site from the dropdown list.
3. In Veloz User Toolkit, select Export users to CSV, then choose a destination filename to create the CSV file.
4. Open the exported Fotoware users CSV file in Microsoft Excel or Notepad and add the new authentication provider identity IDs to the list of users in the CSV file in the column matching the new identity provider:

• Column saml20 for SAML 2.0 external identity value
• Column msazuread for Microsoft Entra ID user object ID external identity 
• Column msad for Microsoft Active Directory (Legacy) LDAP external identity 

5. Save the updated user list as a CSV UTF-8 (Comma-delimited) (*.csv) file.
6. In Veloz User Toolkit, select Update Users, then choose the CSV file containing the users with the new authentication provider identities. Veloz User Toolkit will update the Fotoware user accounts, allowing users to log in with the new IdP after changing the Fotoware single sign-on provider.
    

Linking the Fotoware groups to the new authentication identity provider (IdP)

1. Ask the new authentication identity provider (IdP) administrator to export their list of groups to a text file containing the group name and new identity provider ID.
2. Run Veloz User Toolkit and select the settings for the Fotoware site from the dropdown list.
3. Select Export groups to CSV, then choose a destination filename to create the CSV file.
4. Open the exported Fotoware groups CSV file in Microsoft Excel or Notepad and add the new authentication provider identity IDs to the list of groups in the CSV file in the column matching the new identity provider:

• Column saml20 for SAML 2.0 external identity value
• Column msazuread for Microsoft Entra ID user object ID external identity 
• Column msad for Microsoft Active Directory (Legacy) LDAP external identity 

5. Save the updated groups list as a CSV UTF-8 (Comma-delimited) (*.csv) file.
6. In Veloz User Toolkit, select Update Groups, then choose the CSV file containing the groups with the new authentication provider identities. Veloz User Toolkit will update the Fotoware groups and link them to the new authentication provider.

Copying users from one Fotoware site to another

Veloz User Toolkit can copy users between sites, provided the destination Fotoware site does not already have users with the same usernames or email addresses.

1. Run Veloz User Toolkit and select the settings for the source Fotoware site from the dropdown list.
2. Select Copy users to CSV on the source Fotoware site and choose a destination file name to create the CSV file.
3. Select the settings for the destination Fotoware site from the dropdown list.
4. Select Create Users, and choose the CSV file with the users copied from the source site.
5. Veloz User Toolkit will create the users on the destination site using the JSON data from the user column in the CSV file.
6. Remember to manually add the new users to the required groups using Manage Users/Groups or Site Configuration in the Fotoware site.