API Themes

Portal Management -> Setup -> API Themes

Unique Presentation themes can be designed to customize the appearance, functionality, and level of access on your Portal website at the customer level.
 Default themes are provided if customization is not required.
 There are two types of themes that can be utilized:

1.The Presentation theme refers to the Portal screen appearance, and is controlled by the parameters and settings in Presentation Themes, including such properties as colors, logo, messages, fonts, screen proportions, etc.

2.An API theme (Application Program Interface) controls the functions and utilities and the levels of access made available to the customer on the Portal and can be designed and customized by your firm's web administrator as outlined in Customize the Portal Website.
 The API themes are named here in the API Themes setup utility, and designed partially in the Presentation Themes, and partially by your firm's web administrator on the Portal website.

Both Presentation and API theme types can be assigned to the specific customers in the expanded record in Portal Customers.
 If no theme is specified, then the default themes supplied by SRM software are applied.

The prompts to setup themes are:

SEQ

The sequence number tracks the number of API themes listed in this table.

THEME

Enter the code for the theme using up to a 6 character alpha-numeric maximum.

DESCRIPTION

Enter the description for the theme code using up to 30 characters.

ASSOCIATED CUSTOMERS

A window is provided to view and maintain a list of customers that see this API theme when they access the Portal website.
 Customer records can be added and deleted from the list.
 The prompts in the window include:

SEQ

The sequence number tracks the number of customers in this table.

CUSTOMER#

Enter the customer that uses this API theme, or select one from the Portal Customer Search window.
 The customers must have access to the Portal as assigned in Portal Customers.

Note: The themes can also be assigned and updated for individual customers in the expanded record in Portal Customers.

Change in Customer Theme Warning:
 If this customer has already been assigned a theme, a warning message is triggered that includes the current Theme name previously assigned to this customer.
 Click OK to acknowledge the warning.

•If this change to the theme is correct click ACCEPT at the bottom to remove the "old" theme and apply the new theme for use by this customer.

•If this change to the theme is not correct, click CANCEL to abort the theme change and to maintain use of the original theme for this customer.

NAME

The customer's name is displayed.

PHONE

The customer's telephone number is displayed.
 A window is provided to view the customer's additional phone numbers as outlined in Alternate Customer Phone Numbers.

Finished?

Click ACCEPT to accept the customer list for this theme and exit, or click CANCEL to remove the last record if it has not yet been saved.

Finished?

After the API Theme codes have been setup click ACCEPT, or CANCEL to abort.

Customize the separate API Themes as outlined in Customize the Portal Website using the API Documentation as a guide.

ACTIONS:
 Additional actions provided by buttons on the API Themes screen include:

•Delete an Unused API Theme:
 Click on the sequence number of the record to be deleted to highlight it in focus, and click the DELETE button to permanently remove an API theme from this table.
 Only themes that have not been assigned to a customer can be deleted.
 Confirmation is required.

•Create a Duplicate of a Theme:
 Click COPY to create a copy of a theme as outlined in Theme Copy Utility to facilitate easy customization on versions of existing themes.

•Reset Default API Information:
 Click RESET INDEX to recreate the parameters and fields used by the API's when new features or fields are added to the Portal.
 Confirmation is required.

This program is also executed when SRM Global Update is run.

Topic Keyword: TXTM01