2022 April Release

Class FSCFOLIOCLOUD@1.1001:SelfServiceBranding Permanent link for this heading

Class Hierarchy

Object > ComponentObject > SelfServiceBranding

E-mails and links that are used in self-service use cases of the Fabasoft Cloud may be customized by a Cloud App. This can be done by creating an SelfServiceBranding object.
The SelfServiceBraning object provides a string mapping list that allows to change the strings used within active reports to generate the e-mails.

A SelfServiceBranding object may be used
- during registration of new users from a Web Site of yours,
- when sending an invitation to a team room programmatically in a Cloud App,
- when as user purchases a Cloud App in the Cloud App Store.

instance SelfServiceBranding MyAppSelfServiceBranding { ssbbranding = "My Fabasoft Cloud App"; ssbstringmappings<smkey, smvalue, component> = { { StrRegistration, StrMyRegistration, MYCLOUDAPP@111.100 }, { StrActivation, StrMyActivation, MYCLOUDAPP@111.100 }, ... } } Registration: Using the JavaScript API for a registration page, it is possible to customize the strings in the e-mails or in the registration form. To activate the branding on a Web page using the JavaScript API for registration, set the fsc.account.options.context parameter to the COO address of the proper SelfServiceBranding object. Invitation: Use the SelfServiceBranding object as input parameter of action Invite. Cloud App Store: It is possible to customize the e-mail which is sent for confirmation of purchase and the button link (FSCFOLIOCLOUDPAYMENT@1.1001:StrEnterUrl) on the confirmation page.
ssbstringmappings<smkey, smvalue, component> = { { StrEnterUrl, StrMyEnterUrl, MYCLOUDAPP@111.100 }, ... } Define a "Context Expression" in a customization point, so that the shop can find the appropriate SelfServiceBranding object for the Cloud App, like: customize CPContextExpressions<App, MyApp, MyApp> { cfgexpression = expression { #MYCLOUDAPP@111.100:MyAppSelfServiceBranding; } }

Additional Information

Properties Permanent link for this heading

Type

Property

Name

ActiveReportMapping[]

ssbactivereportmappings

Mapping Table for Active Reports

string

ssbbranding

Product Name

LanguageStringList[]

ssbinvitationsubject

Mail Subject

LanguageContentList[]

ssbinvitationtext

Notification Text

StringMapping[]

ssbstringmappings

Mapping Table for Strings

Actions Permanent link for this heading

Return Type

Signature

ActiveReport

GetSelfServiceActiveReport(
  ActiveReport key,
  out retval ActiveReport value)

string

GetSelfServiceString(
  String key,
  Language lang,
  out retval string value)

String

GetSelfServiceStringObject(
  String key,
  out retval String value)