Page tree

Versions Compared

Key

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

...

Each new install of the ucp/userman module will by default create a "<brand>-template" with tabs showing CDR and Voicemail widgets. The PBX administrator is free to use this default template as-is, they can modify the default template to better suit their needs, or can ignore it and create their own templates.

This default template is for reference. If it's not required it can be deleted safely.

To see the UCP templates, browse to Admin → User management → UCP Templates tab



Image RemovedImage Added

How to Add a UCP Template

To create a new template, browse to User management→ UCP Templates tab and click the Add button.

When adding a new template, there two ways:

...

" Add Template → Import from a User "  → dropdown list will display the list of available users to choose from. 

Image RemovedImage Added

Using Template Creator account

There is a Default user called 'FreePBXUCPTemplateCreator' which is auto generated on module install that is associated with a Virtual extension (FreePBXUCPTemplateCreator).
We can import the template from 
FreePBXUCPTemplateCreator FreePBXUCPTemplateCreator user as well.

Once you have added the template the new/update template will be highlighted.


Image RemovedImage Added

How to modify UCP template 

...

Here you can add additional dashboards (tabs) and widgets for this template.
Once you are finished editing, note the Button  at the bottom left Connorcorner. Click this button to save this template.

Info

Please note that , this the "save" option is only available for UCP template login, not for normal UCP users.


Please do not forget to Logout , once you are done with your UCP template configuration.

Image RemovedImage Added


Once you update/save the template settings , the UCP template list will highlight those templates which are in need of being rebuilt.

FreePBXUCPTemplateCreator  FreePBXUCPTemplateCreator User 

To view/edit the UCP Template we need  need FreePBXUCPTemplateCreator.

Create Generic Template User 

On the GUI we have the option to create the FreePBXUCPTemplateCreator user, which comes under Userman → UCP Templates.

Image RemovedImage Added

When you click on this Create Generic Template Button  button, it will create Userman user and a Virtual Extension to associate with this created user user.

Deleting Generic Template User 

When you click Clicking on the Delete Generic Template Button  button, it will delete the FreePBXUCPTemplateCreator User and its associated virtual extension extension.

Image RemovedImage Added

There is also a fwconsle command to delete the FreePBXUCPTemplateCreator 

...

There are two ways you can associate the template to a user user:

  1. Group Level    :   Group → UCP→ General 
    Assign UCP Template → Whether the group users can use the templates (yes /no)
    Template List  →  If the Assign UCP Template option is Yes  then the List of template will be listed here, you can assign One of them
    Image Removedone template list

    Image Added


  2. User Level  : User → UCP→ General
    Assign UCP Template → Whether the user can use the templates (yes /no/inherit), if you select Inherit then template will be used from group
    Template List  →  If the Assign UCP Template option is Yes  then the List of template will be listed here, you can assign One of them, 
     
    Image Removed
    assign one template list


    Image Added

How to associate template to a new user

...

You can associate a UCP Template either at the group or the user level. If you wish to apply a template to an already existing user, you will may use the Force rebuild widgets button  shown in the action column on the UCP Templates listing page.

When you click on any template  Force Rebuild option, you will be taken to a new page where it will list all the associated users of the template on left side. You can choose Choose which users user(s) (one or more) you wish to rebuild by dragging each user to the area on the right and clicking the desired button at the bottom right to rebuild.

Image RemovedImage Added


The "Rebuild Widgets" button option

The Rebuild Widgets option will clear all of the user's existing UCP dashboard dashboards, widgets and sidebar and replace it with the layout from the UCP template.

...

When a user is logged into User Control Panel, they will see a Reset button at the lower left. This Option allows user to permanently reset their panel widgets and tabs to their assigned template settings, . Once they you click on the reset button, the UCP will ask the user to confirm for confirmation by entering the word "reset".

Image RemovedZImage Added

Template and users permissions

...

While Rebuild/Merging the template for a user, only the widgets for which the user has permission permissions will be added to the UCP panel. Any other widgets will be ignored. In order for all widgets from a template to show for a user, it is necessary for the user to have permission for all widgets. You can review the group and user permissions but by editing the appropriate group/user in User Management.   Changes in user permissions for UCP widgets will not immediately show up in the user's UCP layout, it is necessary to rebuild their UCP layout from the template.

...

UCP supports importing and exporting templates using the Bulk Handler module. The exported csv data contains all settings for a single UCP template in JSON format.

UCP Template Export

Image RemovedImage Added

 The exported csv data contains template name , description, template_1_key, template_1_value, template_1_type, etc.

Image RemovedImage Added

The CSV file direct edit is not recommended as the file contains lengthy json strings. Ensure the UCP template is set up as desired before exporting.

UCP

...

Template Import

Image RemovedImage Added

It is expected that the admin will import an unmodified csv file which has been exported using the Bulk Handler module:

Image RemovedImage Added

Replace existing is done based on the template name, if you have same template name already defined in your list of UCP Templates, then it will be replaced with newly imported data.


Image RemovedImage Added