PinManager

PinManager is a utility designed to be used for bulk actions on Space Pins (Passcodes). Longer term, the functionality contained within PinManager will migrate into the user interface.

The PinManager tool generates a CSV file (Users.csv) containing a list of all Users whose password was updated. This CSV file can be used as an input file with BulkEmailer.

Note: This utility executes on a Windows system and connects to VQ Conference Manager via its REST API. VQ Conference Manager is the Windows version.

Contacting Support

CAUTION: We strongly recommend that the first time you use this tool, you do so under guidance from support@vqcomms.com

Before you start

The tool requires the credentials for an Admin user from VQ Conference Manager. The tool, itself, needs to be run with Administrator permissions.

Back up your VQ Conference Manager server and Call Bridge before making any changes.

Running PinManager

Installing PinManager

Download PinManager (VQCM 3.12.x) from vqcomms.com.

The tool can be downloaded and executed from a Windows system. The PinManager connects to your VQ Conference Manager instance via VQ Conference Manager's REST API. You will need authentification details for Administrator user on VQ Conference Manager.

Usage

PinManager picks up its settings from a configuration file "Config", located in the same folder as PinManager.

{
  "VQCM": {
    "Fqdn": "vqcm.mydomain.com",
    "Authorization": {
      "LoginFqdn": "login. vqcm.mydomain.com ",
      "Client": {
        "ClientId": "MyClientId",
        "Secret": "squirrel"
      }
    }
  },
  "Settings": {
    "Action": "",
    "LdapConfig": ""
  }
}

Parameter	Description	Note
Fqdn	The FQDN for VQ Conference Manager.
LoginFqdn	The FQDN for VQ's Identity Server
ClientID	The ClientId configured in VQCM-Admin
Secret	The Secret configured in VQCM-Admin
LdapConfig	The LDAP Configuration name for the User group to be checked. All users within the group will be checked. Only one LDAP Configuration can be processed per run.	Example: “BigCo Users” Please note: Functionality change from VQCM 3.1; earlier versions required the LDAP Config Identifier. From VQCM 3.1, the tool users the LDAP Configuration name.

Action values

Action	Description	Note
ReportOnly	Analyze the Pins on all Roles for each Space in the selected group and check they conform to the complexity rules defined on the Space Template Role.	No action is taken on the Space. The Space and Pins remain unchanged.
ReportAndFix	In addition to producing a report, fix any issues found. 'Fixing' means that the tool will replace a non-conforming Pin with one conforming to the validation rules defined by the Space Template.
Remove	Use this mode to remove Pins from Space in the selected group.	PinManager will check the validation rules for each Pin (using the Space and the Role). It will prevent Pins being deleted if the Space Template requires a Pin length of greater than zero or if there is more than one Role on the Space.
Regenerate	A new Pin will be generated for each Role on each Space within the selected group.	The new Pins are generated in the same way as performed by VQ Conference Manager. Note : The Pin generated will have the length of the 'maximum length' defined on the Space Template Role. For example, if you have defined Min/Max values of 4 and 12, each new Pin will have a length of 12 digits. The next Maintenace Release, MR6, removes this limitation and will generate Random Pins between 4 and 12 digits.
Read	This mode will output the Pins for each role of each Space in the selected group.	No action is taken on the Space. The Space and Pins remain unchanged.

In each mode, the tool generates a list of users whose Pin has been created, updated or deleted. This list can be copied from the PinManager log file and pasted into the configuration file of the 'BulkEmailer' tool which can then be run to email users the details of their updated Pins. The Email template sent by BulkEmailer can be customized as appropriate. For example, if you have regenerated all Pins, it could be used to mail users a "Your Pin has changed" message.

Example output

Note: The user names in the following output examples are examples from a randomly generated test data set.

Remove Mode

Mode: Remove

LdapConfig: Blue Mountain Mining Co

WARNING This tool will Modify pins for Blue Mountain Mining Co cospaces created by acano manager.

WARNING This tool will impact the performance of your acano manager. Please ensure you run it out of hours or when acano manager is idl Do you want to continue (Y/N)?

Loading CoSpaces for LdapConfig Blue Mountain Mining Co

Loaded 10 CoSpaces for LdapConfig Blue Mountain Mining Co

Updated anastasia.mccleary.cospace - anastasia.mccleary.cospace - Huddle Room - 1 of 10 cospaces processed

Updated andre.brewer.cospace - andre.brewer.cospace - Huddle Room - 2 of 10 cospaces processed

Updated anton.o'brien.cospace - anton.o'brien.cospace - Huddle Room - 3 of 10 cospaces processed

Updated caiden.price.cospace - caiden.price.cospace - Huddle Room - 4 of 10 cospaces processed

Updated diamond.conley.cospace - diamond.conley.cospace - Huddle Room - 5 of 10 cospaces processed

Updated jazlyn.roach.cospace - jazlyn.roach.cospace - Huddle Room - 6 of 10 cospaces processed

Updated jazmin.bryant.cospace - jazmin.bryant.cospace - Huddle Room - 7 of 10 cospaces processed

Updated jesse.lewis.cospace - jesse.lewis.cospace - Huddle Room - 8 of 10 cospaces processed

Updated keira.lowe.cospace - keira.lowe.cospace - Huddle Room - 9 of 10 cospaces processed

Updated taniya.welsh.cospace - taniya.welsh.cospace - Huddle Room - 10 of 10 cospaces processed

All cospaces have now been processed. Total:10 Success:10 Fail:0

---ERRORS---

No Errors

Users with modified Pins. You can copy and paste Users.csv into the bulk emailer config file to email users this information

/Users/thomas/Utilities/PinManager/Users.csv

Regenerate Mode

Mode: Regenerate

LdapConfig: Blue Mountain Mining Co

WARNING This tool will Modify pins for Blue Mountain Mining Co cospaces created by acano manager.

WARNING This tool will impact the performance of your acano manager. Please ensure you run it out of hours or when acano manager is idle Do you want to continue (Y/N)?

Loading CoSpaces for LdapConfig Blue Mountain Mining Co

Loaded 10 CoSpaces for LdapConfig Blue Mountain Mining Co

Updated anastasia.mccleary.cospace - anastasia.mccleary.cospace - PinManagerTest - 1 of 10 cospaces processed - New Pins - Role A:359514

Updated andre.brewer.cospace - andre.brewer.cospace - PinManagerTest - 2 of 10 cospaces processed - New Pins - Role A:715737 Role B:3636

Updated anton.o'brien.cospace - anton.o'brien.cospace - PinManagerTest - 3 of 10 cospaces processed - New Pins - Role A:025927 Role B:40

Updated caiden.price.cospace - caiden.price.cospace - PinManagerTest - 4 of 10 cospaces processed - New Pins - Role A:604827 Role B:9170

Updated diamond.conley.cospace - diamond.conley.cospace - PinManagerTest - 5 of 10 cospaces processed - New Pins - Role A:159627 Role B:

Updated jazlyn.roach.cospace - jazlyn.roach.cospace - PinManagerTest - 6 of 10 cospaces processed - New Pins - Role A:802683 Role B:618

Updated jazmin.bryant.cospace - jazmin.bryant.cospace - PinManagerTest - 7 of 10 cospaces processed - New Pins - Role A:492416 Role B:63

Updated jesse.lewis.cospace - jesse.lewis.cospace - PinManagerTest - 8 of 10 cospaces processed - New Pins - Role A:079692 Role B:496815

Updated keira.lowe.cospace - keira.lowe.cospace - PinManagerTest - 9 of 10 cospaces processed - New Pins - Role A:727380 Role B:703839

Updated taniya.welsh.cospace - taniya.welsh.cospace - PinManagerTest - 10 of 10 cospaces processed - New Pins - Role A:683604 Role B:848 2All cospaces have now been processed. Total:10 Success:10 Fail:0

---ERRORS---

No Errors

Users with modified Pins. You can copy and paste Users.csv into the bulk emailer config file to email users this information

/Users/thomas/Utilities/PinManager/Users.csv

ReportOnly Mode

Mode: ReportOnly

LdapConfig: Blue Mountain Mining Co

WARNING This tool will impact the performance of your acano manager. Please ensure you run it out of hours or when acano manager is idle Do you want to continue (Y/N)?

Loading CoSpaces for LdapConfig Blue Mountain Mining Co

Loaded 10 CoSpaces for LdapConfig Blue Mountain Mining Co

anastasia.mccleary.cospace - anastasia.mccleary.cospace - PinManagerTest has Pin issues - 1 of 10 cospaces processed

The PIN 19236898 for role 'Role A' must be at least 4 digits and at most 6 digits

andre.brewer.cospace - andre.brewer.cospace - PinManagerTest has Pin issues - 2 of 10 cospaces processed The PIN 19236898 for role 'Role A' must be at least 4 digits and at most 6 digits

The PIN 193 for role 'Role B' must be at least 4 digits and at most 6 digits

anton.o'brien.cospace - anton.o'brien.cospace - PinManagerTest has Pin issues - 3 of 10 cospaces processed The PIN 19236898 for role 'Role A' must be at least 4 digits and at most 6 digits

The PIN 222222 for role 'Role B' contains a digit that is repeated more than twice, which is not allowed

caiden.price.cospace - caiden.price.cospace - PinManagerTest has Pin issues - 4 of 10 cospaces processed The PIN 222222 for role 'Role A' contains a digit that is repeated more than twice, which is not allowed

diamond.conley.cospace - diamond.conley.cospace - PinManagerTest has NO Pin issues - 5 of 10 cospaces processed jazlyn.roach.cospace - jazlyn.roach.cospace - PinManagerTest has NO Pin issues - 6 of 10 cospaces processed jazmin.bryant.cospace - jazmin.bryant.cospace - PinManagerTest has NO Pin issues - 7 of 10 cospaces processed

jesse.lewis.cospace - jesse.lewis.cospace - PinManagerTest has NO Pin issues - 8 of 10 cospaces processed keira.lowe.cospace - keira.lowe.cospace - PinManagerTest has NO Pin issues - 9 of 10 cospaces processed

taniya.welsh.cospace - taniya.welsh.cospace - PinManagerTest has NO Pin issues - 10 of 10 cospaces processed

All cospaces have now been processed. Total:10 Success:6 Fail:4

---ERRORS---

anastasia.mccleary.cospace - anastasia.mccleary.cospace - PinManagerTest has Pin issues

The PIN 19236898 for role 'Role A' must be at least 4 digits and at most 6 digits

andre.brewer.cospace - andre.brewer.cospace - PinManagerTest has Pin issues

The PIN 19236898 for role 'Role A' must be at least 4 digits and at most 6 digits

The PIN 193 for role 'Role B' must be at least 4 digits and at most 6 digits

anton.o'brien.cospace - anton.o'brien.cospace - PinManagerTest has Pin issues

The PIN 19236898 for role 'Role A' must be at least 4 digits and at most 6 digits

The PIN 222222 for role 'Role B' contains a digit that is repeated more than twice, which is not allowed

caiden.price.cospace - caiden.price.cospace - PinManagerTest has Pin issues

The PIN 222222 for role 'Role A' contains a digit that is repeated more than twice, which is not allowed Users with pin errors.

Users with Pin errors. You can copy and paste Users.csv into the bulk emailer config file to email users this information

/Users/thomas/Utilities/PinManager/Users.csv

ReportAndFix Mode

Mode: ReportAndFix

LdapConfig: Blue Mountain Mining Co

WARNING This tool will Modify pins for Blue Mountain Mining Co cospaces created by acano manager.

WARNING This tool will impact the performance of your acano manager. Please ensure you run it out of hours or when acano manager is idle Do you want to continue (Y/N)?

Loading CoSpaces for LdapConfig Blue Mountain Mining Co

Loaded 10 CoSpaces for LdapConfig Blue Mountain Mining Co

anastasia.mccleary.cospace - anastasia.mccleary.cospace - PinManagerTest has Pin issues - 1 of 10 cospaces processed Pin for Role Role A has been updated - OldPin: 19236898 - NewPin: 484707

andre.brewer.cospace - andre.brewer.cospace - PinManagerTest has Pin issues - 2 of 10 cospaces processed Pin for Role Role A has been updated - OldPin: 19236898 - NewPin: 828524

Pin for Role Role B has been updated - OldPin: 193 - NewPin: 929418

anton.o'brien.cospace - anton.o'brien.cospace - PinManagerTest has Pin issues - 3 of 10 cospaces processed Pin for Role Role A has been updated - OldPin: 19236898 - NewPin: 513528

Pin for Role Role B has been updated - OldPin: 222222 - NewPin: 471405

caiden.price.cospace - caiden.price.cospace - PinManagerTest has Pin issues - 4 of 10 cospaces processed Pin for Role Role A has been updated - OldPin: 222222 - NewPin: 794929

taniya.welsh.cospace - taniya.welsh.cospace - PinManagerTest has NO Pin issues - 10 of 10 cospaces processed

All cospaces have now been processed. Total:10 Success:6 Fail:4

---ERRORS---

anastasia.mccleary.cospace - anastasia.mccleary.cospace - PinManagerTest has Pin issues

Pin for Role Role A has been updated - OldPin: 19236898 - NewPin: 484707

andre.brewer.cospace - andre.brewer.cospace - PinManagerTest has Pin issues

Pin for Role Role A has been updated - OldPin: 19236898 - NewPin: 828524

Pin for Role Role B has been updated - OldPin: 193 - NewPin: 929418

anton.o'brien.cospace - anton.o'brien.cospace - PinManagerTest has Pin issues

Pin for Role Role A has been updated - OldPin: 19236898 - NewPin: 513528

Pin for Role Role B has been updated - OldPin: 222222 - NewPin: 471405

caiden.price.cospace - caiden.price.cospace - PinManagerTest has Pin issues

Pin for Role Role A has been updated - OldPin: 222222 - NewPin: 794929 Users with modified pins.

Users with modified Pins. You can copy and paste Users.csv into the bulk emailer config file to email users this information

/Users/thomas/Utilities/PinManager/Users.csv

Read Mode

Mode: Read

LdapConfig: Blue Mountain Mining Co

WARNING This tool will impact the performance of your Conference Manager. Please ensure you run it out of hours or when Conference Manager is idle.

Do you want to continue (Y/N)?

Loading coSpaces for LdapConfig Blue Mountain Mining Co

Loaded 10 coSpaces for LdapConfig Blue Mountain Mining Co

anastasia.mccleary.cospace - anastasia.mccleary.cospace - PinManagerTest - Pins - <Role A:79306> - 1 of 10 coSpaces processed

andre.brewer.cospace - andre.brewer.cospace - PinManagerTest - Pins - <Role A:2470> - 2 of 10 coSpaces processed

anton.o'brien.cospace - anton.o'brien.cospace - PinManagerTest - Pins - <Role A:27291> - 3 of 10 coSpaces processed

caiden.price.cospace - caiden.price.cospace - PinManagerTest - Pins - <Role A:796352> - 4 of 10 coSpaces processed

diamond.conley.cospace - diamond.conley.cospace - PinManagerTest - Pins - <Role A:947957> - 5 of 10 coSpaces processed

jazlyn.roach.cospace - jazlyn.roach.cospace - PinManagerTest - Pins - <Role A:369251> - 6 of 10 coSpaces processed

jazmin.bryant.cospace - jazmin.bryant.cospace - PinManagerTest - Pins - <Role A:2704> - 7 of 10 coSpaces processed

jesse.lewis.cospace - jesse.lewis.cospace - PinManagerTest - Pins - <Role A:1703> - 8 of 10 coSpaces processed

keira.lowe.cospace - keira.lowe.cospace - PinManagerTest - Pins - <Role A:713581> - 9 of 10 coSpaces processed

taniya.welsh.cospace - taniya.welsh.cospace - PinManagerTest - Pins - <Role A:462739> - 10 of 10 coSpaces processed

All coSpaces have now been processed. Total:10 Success:10 Fail:0

---ERRORS---

No Errors

Getting help running this tool

Please do not hesitate to contact our support team at support@vqcomms.com for help running this tool.