Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Include Page
Header Image
Header Image
Localtabs
designIdentifier9c533e7d-e96a-42b0-84e1-3b4fdee6c8d2
verticalfalse
[{"id":"4bcfd3b8-df96-95b6-72d4-de7753988243","label":"Summary","body":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"With a simple interface to manage buttons, you can streamline your support staff or even enable end users to manage their own buttons."}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Consistent "},{"type":"text","text":"user experience","marks":[{"type":"strong"}]},{"type":"text","text":" across models and brands of phones"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Saves time in training & support"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Auto-expose correct amount of buttons based on the device model"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Application has detailed knowledge about each model"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Expansion module support"}]}]}]}]}},{"id":"702e279e-b03a-cbbf-8e4d-b751d3788cb8","label":"Configuration","body":{"version":1,"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"type":"text","text":"Visual Button Manager (VBM) Customization"}]},{"type":"paragraph","content":[{"type":"text","text":"Customize the Visual Button Manager for you and your customers!"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Customizations can only be set at the Root Company within your Hierarchy and will apply to all Companies within your Hierarchy."}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"For Hierarchy Users, this is the Account-level Company"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Non-Hierarchy Users, this is available when Managing All Tenants"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"text","text":"Key Types"}]},{"type":"paragraph","content":[{"type":"text","text":"Each line key is configured for a specific function. Typically customers configure their keys as either a Line Key, BLF, or Speed Dial."}]},{"type":"paragraph","content":[{"type":"text","text":"A key type is defined with three parameters:"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Label: The label you want to present to the User"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Configuration Method: How you want to configure the key"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Data Source: Asset to present to the User in a dropdown menu. The User's selection will be used to configure the key."}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"text","text":"Configuration Options"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"label: Must be a string"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"configuration_method: Valid options ['Unassigned', 'Line', 'BLF', 'SpeedDial', 'PagingGroup', 'SharedLine', 'CallPark']"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"data_source: Valid options [null, 'contacts', 'voip_credentials', 'paginggroup', 'parkinglot', 'intercom']Note: If an empty value is submitted for the data source, the configuration fields will appear for manual entryNote: Paging Groups, Parking Lots, and Intercom entries can be configured via the API."}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"text","text":"Visual Button Manager (VBM) Phone Configuration"}]},{"type":"paragraph","content":[{"type":"text","text":"When the phone is edited, VBM will be seen on Buttons menu. "}]},{"type":"mediaSingle","attrs":{"width":50,"layout":"center"},"content":[{"type":"media","attrs":{"id":"att1469743232","type":"external","width":1223,"height":807,"url":"https://phonism.atlassian.net/wiki/download/attachments/1469808744/d88796ef-4acf-4f59-8787-4285537e0ad0.png?version=1&modificationDate=1655207194330&cacheVersion=1&api=v2"}}]},{"type":"paragraph","content":[{"type":"text","text":"When any of the buttons is clicked, “Button Configuration“ screen will be displayed, allowing to provision the button. Drop-down displays the account-level pre-defined key types. "}]},{"type":"mediaSingle","attrs":{"width":33.33333333333333,"layout":"center"},"content":[{"type":"media","attrs":{"id":"att1470824510","type":"external","width":941,"height":444,"url":"https://phonism.atlassian.net/wiki/download/attachments/1469808744/ed923947-f470-4d9b-991c-e1604ece34e9.png?version=1&modificationDate=1655207221128&cacheVersion=1&api=v2"}}]},{"type":"paragraph","content":[{"type":"text","text":"Keys can be configured and re-located easily on Visual Button Manager and the provisioning here will be uploaded to the phone after saved."}]},{"type":"mediaSingle","attrs":{"width":50,"layout":"center"},"content":[{"type":"media","attrs":{"id":"att1470562430","type":"external","width":878,"height":325,"url":"https://phonism.atlassian.net/wiki/download/attachments/1469808744/a892c3cc-c943-48c2-836c-f05d1356554d.png?version=1&modificationDate=1655207246912&cacheVersion=1&api=v2"}}]}]}},{"id":"962bf744-9439-e9f0-29ff-9f2fc22b52b0","label":"Examples","body":{"version":1,"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"type":"text","text":"VBM Customization Examples:"}]},{"type":"heading","attrs":{"level":4},"content":[{"type":"text","text":"Configuring a BLF"}]},{"type":"paragraph","content":[{"type":"text","text":"In this configuration, the key type labelled \"Busy Monitor\" will configure the key as a BLF and require manual input from the User to configure the key with the extension to be monitored."}]},{"type":"codeBlock","attrs":{},"content":[{"type":"text","text":"{\n    \"label\": \"Busy Monitor\",\n    \"configuration_method\": \"blf\",\n    \"data_source\": \"\"\n}\n\n"}]},{"type":"heading","attrs":{"level":4},"content":[{"type":"text","text":"Configuring a Paging Group as a Speed Dial"}]},{"type":"paragraph","content":[{"type":"text","text":"In this configuration, the key type labelled \"Paging Group\" will present a list of Contacts to the User. Upon selection, the VBM will configure the key as a Speed Dial using the selected Contact."}]},{"type":"codeBlock","attrs":{},"content":[{"type":"text","text":"{\n    \"label\": \"Paging Group\",\n    \"configuration_method\": \"speeddial\",\n    \"data_source\": \"contacts\"\n}\n\n"}]},{"type":"heading","attrs":{"level":4},"content":[{"type":"text","text":"Example Configuration Body Submitted"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Refer to the "},{"type":"text","text":"APIv3 documentation","marks":[{"type":"link","attrs":{"href":"https://documenter.getpostman.com/view/6160997/S1EWNuYj?version=latest"}},{"type":"underline"}]},{"type":"text","text":" to learn how to use the API"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"\"customization\" is an additional parameter to Hierarchy PUT requests."}]}]}]},{"type":"codeBlock","attrs":{},"content":[{"type":"text","text":"{\n    \"customization\": {\n        \"vbm\": {\n            \"key_types\": [\n                {\n                    \"label\": \"Unassigned\",\n                    \"configuration_method\": \"unassinged\",\n                    \"data_source\": \"\"\n                },\n                {\n                    \"label\": \"Line\",\n                    \"configuration_method\": \"line\",\n                    \"data_source\": \"\"\n                },\n                {\n                    \"label\": \"Shared Line\",\n                    \"configuration_method\": \"sharedline\",\n                    \"data_source\": \"\"\n                },\n                {\n                    \"label\": \"BLF\",\n                    \"configuration_method\": \"blf\",\n                    \"data_source\": \"\"\n                },\n                {\n                    \"label\": \"Speed Dial\",\n                    \"configuration_method\": \"speeddial\",\n                    \"data_source\": \"contacts\"\n                },\n                {\n                    \"label\": \"Call Park\",\n                    \"configuration_method\": \"callpark\",\n                    \"data_source\": \"contacts\"\n                },\n                {\n                    \"label\": \"Paging Group\",\n                    \"configuration_method\": \"paginggroup\",\n                    \"data_source\": \"contacts\"\n                }\n            ]\n        }\n    }\n}"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"text","text":"VBM Phone Configuration Example:"}]},{"type":"paragraph","content":[]},{"type":"mediaSingle","attrs":{"width":66.66666666666666,"layout":"center"},"content":[{"type":"media","attrs":{"id":"att1469808754","type":"external","width":1386,"height":628,"url":"https://phonism.atlassian.net/wiki/download/attachments/1469808744/508a2ee8-7886-4e1f-87e6-073a228b1e85.gif?version=1&modificationDate=1655207308272&cacheVersion=1&api=v2"}}]}]}},{"id":"ee276dd4-0963-c61d-7a31-f808e2f84acf","label":"Assumptions & Limitations","body":{"version":1,"type":"doc","content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"Customization of the Visual Button Manager can only be done through the API at this time."}]}]}]},{"type":"paragraph","content":[]}]}}]

...