Skip to content

VNCdirectory Admin Manual

Welcome to VNCdirectory

VNCdirectory is the professional directory service that enables the full VNC software stack to be used with Single-Sign-On (SSO) and one set of credentials. VNCdirectory can be integrated with other directory services as required.

VNCdirectory includes the following features:

  • Single-Sign-On: single sign-on to all VNClagoon products;

  • Single-Log-Out: if you log out from 1 specific application, you are automatically logged out from any other application;

  • 2-Factor Authentication: flexible methodologies for 2FA, e.g. SMS, Authenticators;

  • integration with directory services: integration with, for example, LDAP, OpenLDAP, Active Directory;

  • user management: manage all users' information and contact details, accounts, group memberships, permissions and access in VNCdirectory;

  • exchange authentication: exchange authentication data between VNClagoon products;

  • user provisioning: provides user provisioning procedures for VNClagoon products, also integrated with external directories;

  • syncing clients: syncing clients for example VNCsafe;

  • syncing passwords: syncing passwords for classical password-driven authentication;

  • directory schemas: object classes, attributes, name bindings and knowledge.

To see more information - refer to "Product Description" on our website.

Description of VNcdirectory interface and operations

VNCdirectory home page

VNCdirectory home page looks as follows:

Number Description
1 navigation with 3 tabs and "SIGN OUT" button. The tabs allow to go to:
- administration settings - "Admin" tab;
- organizations settings - "ORGANIZATIONS" tab;
- section where you can create a new issue - "HELP" tab.
2 icon with your avatar. It allows to go to the profile dialog
3 VNC products navigation. It allows to go to VNC products
4 "NC - Virtual Network Consult AG" link. It redirects you to VNClagoon website
5

Operations on VNCdirectory home page

Go to any VNC product

To go to any VNC product - just click it, but you should be subscribed to it.

Edit the profile information
  1. Click the avatar icon:

  2. Click the pencil icon and edit the profile information.

  3. Click Save.
Customize/change the avatar
  1. Click the avatar icon:

  2. Click the pencil icon and click Change avatar:

  3. Click Choose File and select required photo/picture.

  4. Click Save.
Delete the avatar

You can delete the avatar in case you have already customized it.

  1. Click the avatar icon:

  2. Click the pencil icon and click Change avatar:

  3. Click Delete and confirm that you want to delete the avatar - click OK in the pop-up window.

Change the password
  1. Click the avatar icon:

  2. Click the pencil icon and click Change password:

  3. Fill in the following fields:

    • Password* - enter your current password;
    • New password* - enter a new password;
    • Confirmation* - enter a new password again.
  4. Click Apply.

Enable 2 Factor Authentication
  1. Click the avatar icon:

  2. Click the pencil icon and click Enable 2 Factor Authentication:

  3. Follow the instructions and click Enable.

Sign out

Just click SIGN OUT:

Reset Atom access key
  1. Click the avatar icon:

  2. Click the pencil icon and click Reset:

Reset API access key
  1. Click the avatar icon:

  2. Click the pencil icon and click Reset:

Get API access key
  1. Click the avatar icon:

  2. Click the pencil icon and click Show:

"ADMIN" tab

"ADMIN" tab looks as follows:

Number Description
1 navigation with the following tabs:
- "Home" - for going to VNCdirectory main page;
- "Organizations" - for going to organizations settings;
- "Teams" - for
- "RFC" - for going to RFC settings;
- "Administration" - for going to the administration settings.
2 navigation with 2 tabs and "Sign out" button. The tabs allow to go to:
- general account settings - "My account" tab;
- section where you can create a new issue - "HELP" tab.
3 administration menu. It allows to select an item for performing some specific operations

Operations on "ADMIN" tab

Add a new project

  1. Click Projects and click + New project.
  2. Fill in the fields. The fields with the asterisk are required.
  3. Tick required modules and click Create. The crated project is visible in the projects list:

Delete a project

  1. Click Projects and click Delete next to required project.
  2. Confirm that you want to delete a project - tick Yes:

Copy a project

  1. Click Projects and click Copy next to required project.
  2. Fill in the fields. The fields with the asterisk are required.
  3. Tick required modules and tick required options in Copy section.
  4. Send email notifications during the project copy
  5. Click Copy. The copied project is visible in the projects list:

Archive a project

  1. Click Projects and click Archive next to required project.
  2. Confirm that you want to archive a project - click OK in the pop-up window. Where you can find the archived project

Edit a project information

  1. Click Projects and click required project.
  2. Edit required fields and click Save.

Add a new member to a project

  1. Click Projects and click required project.
  2. Click Members tab:

  3. Click + New member and tick required user or use the search field to find he/she.

  4. Tick required role for a user in Roles section and click Add.

Delete a project member

  1. Click Projects and click required project.
  2. Click Members tab:

  3. Click Delete next to required user.

Edit a project member's role

  1. Click Projects and click required project.
  2. Click Members tab:

  3. Click Edit next to required user and tick required role.

  4. Click Save:

Add a new version to a project

  1. Click Projects and click required project.
  2. Click Versions tab:

  3. Click + New version and fill in the fields. Name field is required.

  4. Click Create. The added version is visible in the versions list:

Delete a project version

  1. Click Projects and click required project.
  2. Click Versions tab:

  3. Click Delete next to required version.

  4. Confirm that you want to delete a project version - click OK in the pop-up window.

Edit a project version

  1. Click Projects and click required project.
  2. Click Versions tab:

  3. Click Edit next to required version.

  4. Edit the fields and click Save.

Add a new user to VNCdirectory

  1. Click Users and click + New user.
  2. Fill in the fields. The fields with the asterisk are required.
  3. Click Create.

Delete a user from VNCdirectory

  1. Click Users and click Delete next to required user.
  2. Confirm that you want to delete a user - click OK in the pop-up window.

Lock a user in VNCdirectory

Click Users and click Lock next to required user.

Unblock a user in VNCdirectory

  1. Click Users and select locked from Status drop-down menu in Filters, and click Apply.
  2. Click Unblock next to required user.

Delete a user's avatar in VNCdirectory

  1. Click Users and select required option from Status drop-down menu in Filters, and click Apply.
  2. Click Delete image next to required user.

Edit a user's profile information in VNCdirectory

  1. Click Users and select required option from Status drop-down menu in Filters, and click Apply.
  2. Click required user and edit the fields.
  3. Click Save.

Switch an organization for a user in VNCdirectory

Switch organization option is available only for active and registered users.

  1. Click Users and select active or registered option from Status drop-down menu in Filters, and click Apply.
  2. Click required user and click Switch organization:

  3. Search for required organization and select a role from Department drop-down menu.

  4. Click Switch.

Edit a group for a user in VNCdirectory

There are 2 groups in VNCdirectory:

  • Premium subscribers;
  • Public subscribers.

  • Click Users and select required option from Status drop-down menu in Filters, and click Apply.

  • Click required user and click Groups tab:

  • Tick required option or if you want to tick both options, click Check all.

  • Click Save.

Edit a project role in

  1. Click Users and select required option from Status drop-down menu in Filters, and click Apply.
  2. Click required user and click Projects tab:

  3. Click Edit next to required project.

  4. Tick required role and click Save.

Delete a user's project

  1. Click Users and select required option from Status drop-down menu in Filters, and click Apply.
  2. Click required user and click Projects tab:

  3. Click Delete next to required project.

  4. Confirm that you want to delete a project - click OK in the pop-up window.

Add a user's avatar

  1. Click Users and select required option from Status drop-down menu in Filters, and click Apply.
  2. Click required user and click Avatar tab:

  3. Click Choose File and select a picture/photo.

  4. Click Save.

Edit a user's organization

  1. Click Users and select required option from Status drop-down menu in Filters, and click Apply.
  2. Click required organization and click Edit.
  3. Edit the fields. The fields with the asterisk are required.
  4. Click Save.

Lock a user's organization

  1. Click Users and select required option from Status drop-down menu in Filters, and click Apply.
  2. Click required organization and click lock.

Unblock a user's organization

  1. Click Users and select required option from Status drop-down menu in Filters, and click Apply.
  2. Click required organization and click Unblock.

Edit a user's department

  1. Click Users and select required option from Status drop-down menu in Filters, and click Apply.
  2. Click required department and click Edit.
  3. Edit the fields. Name field is required.
  4. Click Save.

Add a new group

  1. Click Groups and click + New group.
  2. Fill in Name field and click Create. The created group is visible in the groups list:

Delete a group

  1. Click Groups and click Delete next to required group.
  2. Confirm that you want to delete a group - click OK in the pop-up window.

Rename a group

  1. Click Groups and click required group.
  2. Edit Name field and click Save.

Add a new user to a group

  1. Click Groups and click required group.
  2. Click Users tab:

  3. Click + New user and search for required user.

  4. Click Add.

Delete a user from a group

  1. Click Groups and click required group.
  2. Click Users tab:

  3. Click Delete next to required user.

  4. Confirm that you want to delete a user from a group - click OK in the pop-up window.

Edit a profile information of a group user

  1. Click Groups and click required group.
  2. Click Users tab:

  3. Click required user and click Edit.

  4. Edit the fields. The fields with the asterisk are required.
  5. Click Save.

Add a project to a group

  1. Click Groups and click required group.
  2. Click Projects tab:

  3. Click + Add projects.

  4. Tick required project and a role.
  5. Click *Add.

Add a new role

  1. Click Roles and permissions and click + New role.
  2. Fill in the fields and tick required permissions. Name field is required.
  3. Click Create.

Delete a role

  1. Click Roles and permissions and click Delete next to required role.
  2. Confirm that you want to delete a role - click OK in the pop-up window.

Copy a role

  1. Click Roles and permissions and click Copy next to required role.
  2. Fill in the fields and tick required permissions. Name field is required.
  3. Click Create. The copied role is visible in the roles list:

Edit the permissions report of all roles

  1. Click Roles and permissions and click Permissions report.
  2. Edit the report and click Save.

Edit a role information

  1. Click Roles and permissions and click required role.
  2. Edit the fields and tick required permissions. Name field is required.
  3. Click Save.

Add a new tracker

  1. Click Trackers and click + New tracker.
  2. Fill in Name field, select required status from Default status drop-down menu, and tick required checkboxes.
  3. Click Create. The created tracker is visible in the trackers list:

Delete a tracker

  1. Click Trackers and click Delete next to required tracker.
  2. Confirm that you want to delete a tracker - click OK in the pop-up window.

Edit a tracker

  1. Click Trackers and click required tracker.
  2. Edit Name field, select required status from Default status drop-down menu, and tick required checkboxes.
  3. Click Save.

Edit the summary of all trackers

  1. Click Trackers and click Summary.
  2. Tick or untick required checkboxes and click Save.

Add a new issue status

  1. Click Issue statuses and click + New status.
  2. Fill in Name field and:

    • if an issue is closed - tick Issue closed;
    • if an issue is not closed - leave Issue closed by default.
  3. Click Create. The created status is visible in the issue statuses list:

Delete an issue status

  1. Click Issue statuses and click Delete next to required status.
  2. Confirm that you want to delete an issue status - click OK in the pop-up window.

Edit an issue status

  1. Click Issue statuses and click required status.
  2. Edit Name field and:

    • if an issue is closed - tick Issue closed;
    • if an issue is not closed - leave Issue closed by default.
  3. Click Create.

Edit a workflow

  1. Click Workflow.
  2. Select required options from Role and Tracker drop-down menus.
  3. If you want statuses to be displayed that are used by the tracker that you have selected - tick Only display statuses that are used by this tracker.
  4. Click Edit and tick or untick required checkboxes.
  5. Click Save.

Copy a workflow

  1. Click Workflow and click Copy.
  2. Select required options from the drop-down menus and click Copy.

Edit the workflow summary

  1. Click Workflow and click Summary.
  2. Click required option and tick or untick required checkboxes.
  3. Click Save.

Add a new custom field

  1. Click Custom fields and click + New custom field.
  2. Select the type of object to which a custom field should be attached and click Next.
  3. Fill in the fields. Name field is required.
  4. Click Save. The created field is visible in the custom fields list:

Delete a custom field

  1. Click Custom fields and click Delete next to required custom field.
  2. Confirm that you want to delete a custom field - click OK in the pop-up window.

Edit a custom field

  1. Click Custom fields and click required custom field.
  2. Edit the fields. Name field is required.
  3. Click Save.

Add a new value to a category

  1. Click Enumerations and click + New value in required category.
  2. Fill in Name field and tick the checkboxes if it is required.
  3. Click Create.

Delete a value from a category

  1. Click Enumerations and click Delete next to required value in required category.
  2. Confirm that you want to delete a value from a category - click OK in the pop-up window.

Edit a value in a category

  1. Click Enumerations and click required value in required category.
  2. Edit the information and click Save.

Add a new global contact

  1. Click Global contacts and click + New contact.
  2. Fill in the fields and click Create. The created contact is visible in the global contacts list:

Edit a global contact

  1. Click Global contacts and click Edit next to required global contact.
  2. Edit the fields and click Save.

Delete a global contact

  1. Click Global contacts and click Delete next to required global contact.
  2. Confirm that you want to delete a global contact - click OK in the pop-up window.

Import global contacts

  1. Click Global contacts and click + Import contact.
  2. Click Choose file and select required file.
  3. Click Next and fill in the fields.
  4. Click Next.

Configure VNCdirectory general settings

  1. Click Settings and fill in the fields.
  2. Click Save.

Configure the settings for VNCdirectory page display

  1. Click Settings and click Display tab:

  2. Fill in the fields and click Save.

Configure Authentication settings of VNCdirectory

  1. Click Settings and click Authentication tab:

  2. Fill in the fields and click Save.

Configure API settings of VNCdirectory

  1. Click Settings and click API tab:

  2. Fill in the fields and click Save.

Configure projects settings of VNCdirectory

  1. Click Settings and click Projects tab:

  2. Tick required options and click Save.

Configure users settings of VNCdirectory

  1. Click Settings and click Users tab:

  2. Tick required options, select required options from the drop-down menus, and click Save.

Configure the settings for VNCdirectory issue tracking

  1. Click Settings and click Issue tracking tab:

  2. Tick required options, select required options from the drop-down menus, and click Save.

Configure the settings for VNCdirectory time tracking

  1. Click Settings and click Time tracking tab:

  2. Tick required options and click Save.

Configure the settings for VNCdirectory files

  1. Click Settings and click Files tab:

  2. Fill in the fields and click Save.

Configure the settings for email notifications

  1. Click Settings and click Email notifications tab:

  2. Tick required options, fill in the fields, and click Save.

Configure the settings for incoming emails

  1. Click Settings and click Incoming emails tab:

  2. Tick required options, fill in the fields, and click Save.

Configure the repositories settings

  1. Click Settings and click Repositories tab:

  2. Tick required options, fill in the fields, and click Save.

Configure registration notifications

  1. Click Settings and click Registration notifications tab:

  2. If you want administrators to be notified on registrations - tick the checkbox and click Save.

Add a new authentication mode

  1. Click LDAP authentication and click + New authentication mode.
  2. Fill in the fields. The fields with the asterisk are required.
  3. Click Create. The created authentication mode is visible in the list of authentication modes:

Delete an authentication mode

  1. Click LDAP authentication and click Delete next to required authentication mode.
  2. Confirm that you want to delete an authentication mode - click OK in the pop-up window.

Test an authentication mode

  1. Click LDAP authentication and click Test next to required authentication mode.

Add a new birthday information

  1. Click Birthdays and click + New birthday.
  2. Fill in the fields. The fields with the asterisk are required.
  3. Click Create. The created birthday date is visible in the birthdays list:

Import birthdays information

  1. Click Birthdays and click Import birthdays.
  2. Click Choose File and select required CSV file.
  3. Click Next

Edit a birthday information

  1. Click Birthdays and click Edit next to required birthday.
  2. Edit the fields. The fields with the asterisk are required.
  3. Click Save.

Delete a birthday information

  1. Click Birthdays and click Delete next to required birthday.
  2. Confirm that you want to delete a birthday information - click OK in the pop-up window.

Add a new email template

  1. Click Email templates and click + New email template.
  2. Fill in the fields. The fields with the asterisk are required.
  3. Click Create. The created email template is visible in the list of email templates:

Edit an email template

  1. Click Email templates and click Edit next to required email template.
  2. Edit the fields and click Save.

Delete an email template

  1. Click Email templates and click Delete next to required email template.
  2. Confirm that you want to delete an email template - click OK in the pop-up window.

Footer link is the link that is visible at the bottom of VNCdirectory home page:

You can configure any footer link on both English and German:

  1. Click Footer links and click + New footer link.
  2. Fill in the fields and tick required checkboxes. The fields with the asterisk are required.
  3. Click Create. The created footer link is visible in the list of footer links:

  1. Click Footer links and click Edit next to required footer link.
  2. Edit the fields and tick/untick required checkboxes.
  3. Click Save.
  1. Click Footer links and click Delete next to required footer link.
  2. Confirm that you want to delete a footer link - click OK in the pop-up window.

Edit a group chat

  1. Click Group chats and click required group chat.
  2. Click Edit in the upper right corner.
  3. Edit the fields. The fields with the asterisk are required.
  4. Click Save.

Change a type of a user’s affiliation

  1. Click Group chats and click the meatballs menu next to required group chat:

  2. Click Edit and click Affiliations tab:

  3. Click Edit next to required user.

  4. Select required role from the drop-down menu and click Save:

Add the avatar for a group chat

  1. Click Group chats and click the meatballs menu next to required group chat:

  2. Click Edit and click Avatar tab:

  3. Click Choose File and select required photo/picture.

  4. Click Save.

Delete the avatar of a group chat

  1. Click Group chats and click the meatballs menu next to required group chat:

  2. Click Edit and click Avatar tab:

  3. Click Delete and confirm that you want to delete the avatar - click OK in the pop-up window.

Add a new industry code

  1. Click Industry codes and click + New industry codes.
  2. Fill in the fields and click Create. The added industry code is visible in the list of industry codes:

Edit an industry code

  1. Click Industry codes and click required code or click Edit next to required code.
  2. Edit the fields and click Save.

Delete an industry code

  1. Click Industry codes and click Delete next to required code.
  2. Confirm that you want to delete an industry code - click OK in the pop-up window.

Rename a tag

  1. Click Tags and click required tag.
  2. Rename a tag and click Save.

Check for updates

There are many different plugins which you can configure for VNCdirectory. To check for available plugins, click Plugins and click Check for updates at the bottom of the page. You should see that the plugins list has been updated and new plugins have appeared.

Configure a plugin

  1. Click Plugins and click Configure next to required plugin.
  2. Fill in required fields and click Apply.

Send a new RFC

  1. Click RFC:

  2. Fill in the following fields:

    • Email - enter an email address where RFC will be sent;
    • Message - enter a short description.
  3. Click Send RFC.

Delete a sent RFC

  1. Click RFC:

  2. Click Sent:

  3. Click Delete next to required email address.

"ORGANIZATIONS" tab

"ORGANIZATIONS" tab looks as follows:

Number Description
1 navigation with the following tabs:
- "Home" - for going to VNCdirectory main page;
- "Organizations" - for going to organizations settings;
- "Teams" - for
- "RFC" - for going to RFC settings;
- "Administration" - for going to the administration settings.
2 navigation with 2 tabs and "Sign out" button. The tabs allow to go to:
- general account settings - "My account" tab;
- section where you can create a new issue - "HELP" tab.
3 "Filters" and "Options" accordeons. They allow to configure filters and options
4 "Apply" and "Clear" buttons. They are used with "Filters" and "Options"
5 "New organization" tab. It allows to go to the section where you can add a new organization
6 Organizations list. It contains the list of all existing organizations

Operations on "ORGANIZATIONS" page

Add a new organization
  1. Click + New organization and fill in the fields. The fields with the asterisk are required.
  2. Click Create. The added organization is visible in the list of organizations.
Edit an organization
  1. Click Edit next to required organization and edit the fields. The fields with the asterisk are required.
  2. Click Save.
Delete an organization
  1. Click Delete next to required organization.
  2. Confirm that you want to delete an organization - click OK in the pop-up window.
Lock an organization
  1. Click Lock next to required organization.

"HELP" tab

"HELP" tab looks as follows:

Number Description
1 navigation with the following tabs:
- "Home" - for going to VNCdirectory main page;
- "Organizations" - for going to organizations settings;
- "Teams" - for
- "RFC" - for going to RFC settings;
- "Administration" - for going to the administration settings.
2 navigation with 2 tabs and "Sign out" button. The tabs allow to go to:
- general account settings - "My account" tab;
- section where you can create a new issue - "HELP" tab.
3 "Filters" and "Options" accordeons. They allow to configure filters and options
4 "Apply" and "Clear" buttons. They are used with "Filters" and "Options"
5 "New issue" link. It allows to go to the section where you can create a new issue
6 "Issues" tabs. They allow to go to the sections where you can perform specific operations
7 export and import options.

Operations on "HELP" page

Add a new issue
  1. Click + New issue and fill in the fields. The fields with the asterisk are required.
  2. Click Create. The created issue is visible in the list of incidents:

Edit an issue
  1. If it is required. apply the filters. For this click Filters and tick Status checkbox. Then select required status from Status drop-down menu.
  2. If it is required, apply the options. For this click Options and select required option from Columns menu. Then select required option from Group results by drop-down menu.
  3. If it is required, tick the options in Shows and Totals menus.
  4. Click Apply.
  5. Click More button next to required issue and click Edit:

  6. Edit the fields. The fields with the asterisk are required.

  7. Click Submit.
Delete an issue
  1. If it is required, apply the filters. For this click Filters and tick Status checkbox. Then select required status from Status drop-down menu.
  2. If it is required, apply the options. For this click Options and select required option from Columns menu. Then select required option from Group results by drop-down menu.
  3. If it is required, tick the options in Shows and Totals menus.
  4. Click Apply.
  5. Click More button next to required issue and click Delete:

  6. Confirm that you want to delete an issue - click OK in the pop-up window.

Copy an issue
  1. If it is required, apply the filters. For this click Filters and tick Status checkbox. Then select required status from Status drop-down menu.
  2. If it is required, apply the options. For this click Options and select required option from Columns menu. Then select required option from Group results by drop-down menu.
  3. If it is required, tick the options in Shows and Totals menus.
  4. Click Apply.
  5. Click More button next to required issue and click Copy:

  6. Edit the fields. The fields with the asterisk are required.

  7. Click Create. The copied issue is visible in the list of issues:

Import issues

You can import issues. It should be CSV file.

  1. Click Import:

  2. Click Choose File and select required file.

  3. Click Next >> and click Next >> again.
  4. Select required options from the drop-down menus and click Import.
Export issues

You can export issues in PDF pr CSV files.

  1. If it is required, apply the filters. For this click Filters and tick Status checkbox. Then select required status from Status drop-down menu.
  2. If it is required, apply the options. For this click Options and select required option from Columns menu. Then select required option from Group results by drop-down menu.
  3. If it is required, tick the options in Shows and Totals menus.
  4. Click Apply.
  5. Click CSV or PDF at the bottom of the page.