Client Portal

A Lockbox client portal can be easily added to any website with just a single line of HTML code.

Client users can access their boxes through a web page containing a client box gateway. A client portal has the following advantages:

• It is simpler for clients, as they do not need to register with Lockbox
• It is more controllable for businesses, as the business is in complete control of client's access and password management.

Client Portal URL

Every standard box is associated with a unique URL – the client box gateway URL. Incorporate it in an existing Web portal and point your clients to it. The best way to embed the client box gateway into your Web portal is via the iframe HTML tag.

You find the URL of the client box gateway for your box here:

1. In the box navigation pane, select the box for which you would like to obtain the client box gateway URL.
2. Right-mouse click the box icon to open the box’s context menu and select the ‘Manage Box’ item.
3. Select the 'Portal' tab and the ‘Portal URL’ section.
4. Press the 'Copy to Clipboard' button to copy the currently valid URL to the clipboard.

Only box owners have access to the 'Portal' tab of the selected box.

Lockbox strongly recommends to copy and paste the client box gateway URL in order to avoid any omissions or misspellings that may prevent your clients from accessing their client boxes.

Reset to Default Portal URL

if you would like to clear your Client Portal URL from all customised settings, follow these steps:

1. In the box navigation pane, select the box for which you would like to obtain the client box gateway URL.
2. Right-mouse click the box icon to open the box’s context menu and select the ‘Manage Box’ item.
3. Select the 'Portal' tab and the ‘Portal URL’ section.
4. Press the 'Reset to Default Portal URL' button to reset the Client Portal URL of the selected box.

Customised URLs are still valid after resetting to default. This means that any previous URLS that are incorporated into your web site still work as expected.

Generate New Portal URL

The Client Portal URL can be customised by setting a number of URL parameters. Follow these steps to customise the Client Portal URL:

1. In the box navigation pane, select the box for which you would like to obtain the client box gateway URL.
2. Right-mouse click the box icon to open the box’s context menu and select the ‘Manage Box’ item.
3. Select the 'Portal' tab and the ‘Portal URL’ section.
4. Tick either one of the checkboxes to enable the corresponding feature
   • Disable client passphrase change - to disallow clients to change their passphrases.
   • Disable client email settings - to stop clients from changing their email notification settings.
   • Disable client uploads - to prevent clients from uploading files.
5. If you have logo image files uploaded earlier, you can set these images now to occupy the top-left and top-right corner of the Client Portal. To do so, click the respective combo box and select the file name of your choice. 
6. After completing your inputs, click the 'Generate New Portal URL' button.

A new Client Portal URL is generated and displayed at the top of the 'Portal URL' section where you can copy it easily to the clipboard by selecting the 'Copy to Clipboard' button.

you can generate multiple Client Portal URLs. Every single one is valid as long as you do not change the Secret Portal URL key.

For details on how to upload logo image files, please refer to the Set Logos section.

The input form contains an additional field labelled 'Secret Portal URL Key'. If a secret key is set, it is displayed there, 'not set' otherwise. See the Set Secret Key section for details.

The 'Portal Link' field of the input form indicates whether this box is linked to another box. See the Linking Boxes to a Single Portal section for details.

Set Logos

The login screen of the Client Portal can be customised with up to two logos that are displayed in the top-left and top-right corners respectively.

To set a logo, follow these steps:

1. In the box navigation pane, select the box for which you would like to obtain the client box gateway URL.
2. Right-mouse click the box icon to open the box’s context menu and select the ‘Manage Box’ item.
3. Select the 'Portal' tab and the ‘Set Logos’ section.
4. Select the tab of 'Logo 1' or 'Logo 2'. If no logo is set, the image panel displays 'no image data available'.
5. Click the browse button to open a file browser window. Navigate to the image file of your choice and select it subsequently.
6. After the image file is loaded, the view of the selected tab updates. You can now see the logo together with its name and dimensions.
7. Select the 'Set Logo' button to upload the image file to the Lockbox Server.
8. Afterwards the upload finished successfully, the view of the selected tab changes, in particular the buttons at the bottom.

It is not possible to upload two image files with the same name. The names of the image files must differ.

Make sure that the image files are not too large for the space available in the login screen of your Client Portal.

You can delete an uploaded logo from the Lockbox Server similarly. Follow steps 1-4 from above, then click the 'Delete Logo' button. The image file is deleted from the Lockbox Server. Upon completion, the view of the selected tab changes back to its initial state and displays: 'no image data available'.

Set Secret Key

You can set a secret portal URL key if you would like to increase the protection the customised parameters in a generated Client Portal URL. This key makes it harder for attackers to tamper with the various URL parameters of a Client Portal URL. To set the secret key, do the following:

1. In the box navigation pane, select the box for which you would like to obtain the client box gateway URL.
2. Right-mouse click the box icon to open the box’s context menu and select the ‘Manage Box’ item.
3. Select the 'Portal' tab and the ‘Set Secret Key’ section.
4. Enter a secret manually in the textfield or press the 'Generate' button to auto-generate a 20-character strong secret key.
5. Select the 'Save' button to save the secret key.

Lockbox recommends that the secret key should have at least 20 characters.

All existing Client Portal URLs become invalid after changing (save/clear) the secret key. Hence all URLs incorporated into your web site need to be replaced.

The secret portal key can be cleared. To do so, follw the steps 1-3 from above and then click the 'Clear' button.

Linking Boxes to a Single Portal

Two or more parent boxes can be linked in order to allow all clients to access their client boxes through a single Portal. This feature allows organising clients under different parent boxes, whilst still maintaining a single Client Portal.

Link two boxes

To link two boxes:

1. In the box navigation pane, select the box you would like to link up.
2. Right-mouse click the box icon to open the box’s context menu and select the ‘Manage Box’ item.
3. Select the 'Portal' tab and the 'Manage Box Links' section.
4. Click the combobox and select the box (master) to which you would like to connect the current box to.
5. Press the ‘Link’ button.

After linking the two boxes, the Client Portal URL of the linked box changes to the URL of the master box. All Client Portal URLs that were previously incorporated into your web site are still valid but they continue to reference the linked box directly.

It is essential for this feature that all client boxes have unique client and user names across the two boxes to be linked up. An error message will inform you about any conflicts.

You can only link boxes you own. This means that this functionality only works if you own at least two boxes.

Linking multiple parent boxes

Boxes are linked pair-wise. So to link multiple boxes, choose one to be the master box and link the other boxes to it.

For example, if you have three boxes A, B, C you can link them together as follows:

1. Choose A as the master box
2. Link B to A
3. Link C to A.

Unlink boxes

To unlink a linked box:

1. In the box navigation pane, select the box you would like to unlink.
2. Right-mouse click the box icon to open the box’s context menu and select the ‘Manage Box’ item.
3. Select the 'Portal' tab and the 'Manage Box Links' section.
4. Click the 'Unlink' button. The boxes are unlinked instantaneously.

To unlink a linked box from the master box:

1. In the box navigation pane, select the box you would like to unlink.
2. Right-mouse click the box icon to open the box’s context menu and select the ‘Manage Box’ item.
3. Select the 'Portal' tab and the 'Manage Box Links' section.
4. Click the combobox and select the box you would like to unlink.
5. Click the 'Unlink' button. The boxes are unlinked instantaneously.