| Excerpt |
|---|
Each object of interworks.cloud BSS (Accounts / Offers / Orders etc..) references a variety of out-of-the-box fields. Apart from those system fields, you are also allowed to add as many custom fields as you need in order to capture additional information in interworks.cloud BSS. As an interworks.cloud BSS administrator, you are able to proceed with the customization of all interworks.cloud BSS entities as you have been granted full access to the interworks.cloud BSS setup mode. |
Note that system fields cannot be removed and their label cannot be modified by any interworks.cloud BSS user. As an interworks.cloud BSS administrator user, you can only proceed with customizing their values according to your business needs. In contrast with system fields, custom fields are created by an administrator from scratch and can be added or removed at any time as they are fully editable. |
Edit or Add a Value to a System Field
Follow the instructions below to edit the system fields:
Login into interworks.cloud BSS and access the Set-up mode
Select the module you need (e.g. accounts contacts, invoices, subscriptions, etc.) and under the section "Customization of default fields" you will view the available customizations for the system fields. Select the system field whose values will be modified.
On the new page, a list of values is displayed. You can edit the values of the existing entries, or proceed to insert a new entry. To insert a new entry select a number, fill in the 'Description', choose a 'Default' field optional), and click the '+' icon.
Click 'Save'
| Rw ui textbox macro | ||
|---|---|---|
| ||
Keep in Mind! |
Create and Manage Custom Fields
Create a Custom Field
For each entity, you can create new fields (custom fields), in order to capture data that are needed to support specific business requirements.
Here is how to do that:
Login into interworks.cloud BSS and access the Set-up mode
On the 'Custom Fields' screen click on the "Add" button. A new pop up window appears. 
Complete the necessary information and click on the "Save and Close" option in order to display the field on the object's page. Below you will find the most basic details for the new field:
Name: The name of the filed that will be displayed at BSS
Type: the type of the value
Group: the group the field will belong.
Ordering: If there are more than one fields at the group, this signifies the ordering rank
Compulsory field: if this field is compulsory, it will have to be filled
Set Custom field as search criterion: This enables the use of the field at the search facility of the system
Value Type: Based on the 'Type' of the field, you can select more options here
| Rw ui textbox macro | ||
|---|---|---|
| ||
Please keep in mind that if you are planning to push or pull any kind of custom fields with an API call, you will have to populate the field 'Code for Provisioning System' with any numeric code (ex. 1245), of your preference. |
Define display rules for Custom Fields
You can modify the way a custom field will be displayed at the interworks.cloud BSS. You can create a rule that will define the display of the field according to a rule being valid:
At the 'Display Rules' section, click on the drop-down list and select a customer attribute
Select as many as you want, click 'Insert to Selected' and then Add'
That's it. The field will be displayed if the above attributes are valid for the entity
| Rw ui textbox macro | ||
|---|---|---|
| ||
Some entities (accounts, Support cases, orders) support the display of a custom field to the Storefront! You can achieve this, by navigating to the 'Advanced Options' tab of the new custom field and mark the 'Show in Storefront'. |
Custom Fields Advanced Options
In the Edit Custom Field dialog, the Advanced Options tab features options to expand the possibilities of the custom field with regards to the storefront and the ways in which its value can be set.
Custom Fields updated from a Third-Party System
The Use this field for displaying data of other system checkbox allows the field to retrieve its value from the response to an API call. Specify the code in the Code for Systems Integration in the Field Details tab, which becomes mandatory when the aforementioned checkbox is enabled. Enabling this feature also makes the custom field read-only, and the value of the field cannot be modified by the BSS user when editing the details of the account.
Custom Fields in Storefront
Certain custom fields can be displayed in the Storefront, based on the Advanced Options tab.
Check Show in Storefront to display the field in the Storefront, where it appears on the My Profile page, in the Additional Information section. Check Editable from Storefront User to allow the storefront user to edit the field, otherwise it will retain the value set in the BSS. Refer toDisplaying Extra Fields in "My Profile" Form for more information.Check Show in Storefront to display any of the four systemic custom fields in the Storefront, where it appears on the Subscription viewpage of Microsoft NCE Subscriptions, in the Details section. Refer to Displaying Extra Fields in Microsoft NCE "Subscription" View Page for more information.Check Show in End Customer’s form to enable the field in the first step of the checkout process. When selecting to purchase an item(s) for a new customer, the field will appear in the Additional Information section, after the customer’s details. Refer to Adding Extra Fields in Checkout Forms for more information.
Inheriting Values from Custom Fields
Custom fields can inherit values from one another, provided the two fields are of the same type. For example, any custom field created for Contacts can contain the value of a custom field specified in Accounts. To create the association between the two fields, go to the Advanced Options tab and:
Create a custom field in Accounts
Create a custom field of the same type (e.g. Text) in Contacts
In the Contacts custom field Advanced Options tab, select the custom field from Accounts
When a new contact is created under this account, it will now contain the value of the custom field from the Account.
Such associations can be created for most Custom Fields, however, not all custom fields can be associated with each-other due to their hierarchy. The figure below shows the associations that can be created from a custom field in Offers.
Group Custom Fields
If you need to create a new 'Group', follow the next steps:
At the 'Custom Fields' page, hover your mouse over the 'Groups' option. From the drop-down list select 'New Group'
At the pop-up screen fill in the group details and click 'Save'
Set security level to control access to Custom Fields
You can set the access rights to this group (and the underlying fields) in the following manner:
At the 'Custom Fields' page, click on an existing group (orange highlight)
Then, hover your mouse over the 'Groups' option. From the drop-down list select 'Add/Edit Group'
Click the magnifying glass to access the available application users/user groups
Click on the desired user or user group. Exit the screen and click 'Save'
Table of Contents
tocTable of Contents
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|