How to configure Portal

One of the elements of the portal installation is to configure the system so that the portal is ready for use. The tutorial shows how to properly configure your system.

1. Profiles

Create a new profile that will specify what permissions are granted to the portal users. Profile management can be found in Software configuration → Permissions → Profiles


2. Roles

The profile must be assigned a new role. To do that, go to Software configuration → Permissions → Roles and create a new role using the profile you created earlier.


3. Users

Create a new user with the role you created in the previous step. In order to do that go to  Software configuration → Permissions → Users. The user will be needed to define permissions and will be the default owner for newly created records.


4. Web service - Applications

The next step is adding an application for API in Software configuration → Integration → Web service - Applications. The application type should be set to "Webservice Premium". It will allow you to use an API container called Webservice Premium. A complete documentation can be found at

"Webservice Premium API" is a paid feature, it requires purchasing YetiForce Webservice Premium



5. Menu

Another element cricial for the portal to work properly is the menu.  You can find the configuration panel for the menu in Software configuration → Integration → Web service - Applications

Thanks to creating a separate menu accessible exclusively to portal you can limit the number of modules available to portal users. 

For the modules to be visible, you have to grant permissions in profiles, otherwise the modules won't show up in the menu.


6. Record access fields

This step is only required for webservice users whose type is different than "permissions based on user".

When API users are assigned to contacts, it's required to add a field that will allow you to control access to records.  Records won't be available in the portal unless this field is configured. 

This solution allows you to have several portals/webservice apps and control record availability for them separately. 

Each module that should be available in the portal must contain this field.

Field configuration can be found in Software configuration → Standard modules 

→ Edit fieldsaddfield

Manage record access in portal

To share a record in the portal, find the record you wish to share and in the list view click the wrench icon to open additional options. Then click on the share button  and confirm.


7. Visibility and enforcing default values only for portal/api

Enabling this option will cause all records created from portal/API to have the same value set by default. 

Portal field management can be found in Software configuration → Standard modules → Edit fields



8. Permissions for picklist values

Available values should also be specified for picklists based on roles. Without this setting, the user won't see the selection list for picklists based on roles when creating or editing records. 

The panel can be found in Software configuration → Standard modules → Fields – Picklists


9. Web service - Users

For webservice users whose type is different than "permissions based on user" an Account and Contact should be created in advance.

The last step is to add portal users, which can be done in Software configuration → Integration → Web service - Users

The password can only be set from the CRM while creating a user, the portal only offers an option to change or reset the password.


  • Thursday, 18 November 2021