Configure Tenant

Tenant configuration is a REST service available to manage business configuration for the care application.

To view existing configuration:
1. Request URL: <fabric-host>/admin/tenantConfigurations
2. Operation: GET
3. Authorization: OAUTH2.0
  
  Use bearer token generated from <FA-Host>/fscmRestApi/tokenrelay?scope=<Fabric-Host>
To edit the configuration, get the response using GET call and update the required configuration and do a PUT operation to the same endpoint with the whole object as payload.
Here are the business configurations available by default:

Area	Comments	Object	Configuration Key	Configuration Value	Default Value	Comments
`unspecifiedDashboardTiles`	Controls how tiles are rendered on the unspecified dashboard for an agent	`assets`	`visible`	`true/false`	`"true"`	Controls if asset tiles are rendered on the dashboard
`unspecifiedDashboardTiles`	Controls how tiles are rendered on the unspecified dashboard for an agent	`assets`	`inActiveTimePeriodInMonths`	`No of months`	`"3"`
`unspecifiedDashboardTiles`	Controls how tiles are rendered on the unspecified dashboard for an agent	`billUnitBalances`	`visible`	`true/false`	`"true"`	Controls if bill unit tiles are rendered on the dashboard
`unspecifiedDashboardTiles`	Controls how tiles are rendered on the unspecified dashboard for an agent	`billUnitBalances`	`count`	`a valid positive number`	`"6"`	Controls number of bill unit tiles that are rendered on the dashboard
`unspecifiedDashboardTiles`	Controls how tiles are rendered on the unspecified dashboard for an agent	`serviceRequests`	`visible`	`true/false`	`"true"`	Controls if service request tiles are rendered on the dashboard inside the filmstrip
`unspecifiedDashboardTiles`	Controls how tiles are rendered on the unspecified dashboard for an agent	`serviceRequests`	`count`	`a valid positive number`	`"6"`	Controls number of service request tiles that are rendered on the dashboard inside the filmstrip
`unspecifiedDashboardTiles`	Controls how tiles are rendered on the unspecified dashboard for an agent	`orders`	`visible`	`true/false`	`"true"`	Controls if order tiles are rendered on the dashboard inside the filmstrip
`unspecifiedDashboardTiles`	Controls how tiles are rendered on the unspecified dashboard for an agent	`orders`	`count`	`a valid positive number`	`"6"`	Controls number of order tiles that are rendered on the dashboard inside the filmstrip
`billingDashboardTiles`	Controls how tiles are rendered on the customer billing dashboard for an agent	`billHistory`	`limit`	`a valid positive number`	`"6"`	Controls number of months considered for displaying bill history on billing dashboard
`billingDashboardTiles`	Controls how tiles are rendered on the customer billing dashboard for an agent	`paymentHistory`	`limit`	`a valid positive number`	`"6"`	Controls number of months considered for displaying payment history on billing dashboard
`billingDashboardTiles`	Controls how tiles are rendered on the customer billing dashboard for an agent	`bills`	`visible`	`true/false`	`"true"`	Controls if bill tiles are rendered on the billing dashboard
`billingDashboardTiles`	Controls how tiles are rendered on the customer billing dashboard for an agent	`serviceRequests`	`visible`	`true/false`	`"true"`	Controls if service request tiles are rendered on the billing dashboard
`billingDashboardTiles`	Controls how tiles are rendered on the customer billing dashboard for an agent	`serviceRequests`	`count`	`a valid positive number`	`"6"`	Controls number of service request tiles that are rendered on the billing dashboard inside the filmstrip
`billingDashboardTiles`	Controls how tiles are rendered on the customer billing dashboard for an agent	`accountReceivables`	`visible`	`true/false`	`"true"`	Controls if `A/R` tiles are rendered on the billing dashboard
`billingDashboardTiles`	Controls how tiles are rendered on the customer billing dashboard for an agent	`accountReceivables`	`count`	`a valid positive number`	`"6"`	Controls number of adjustment tiles that are rendered on the billing dashboard inside the filmstrip
`dashboardSpotlight`	To enable/disable churn propensity	`churnPropensityIndicator`	`visible`	`false/true`	`false`
`dashboardSpotlight`	To enable/disable offer recommendations	`offerRecommendations`	`visible`	`false/true`	`false`
`dashboardSpotlight`	To enable/disable offer recommendations	`offerRecommendations`	`limit`	`a valid positive number`	`3`
`targetUrls`	Controls navigation targets for link clicks on UI	`serviceRequestListPage`	`target`	`A valid Service Request List page URL with host value or placeholder`	`"https://{{host}}/fscmUI/faces/deeplink?objType=SVC_SERVICE_REQUEST"`	Controls Service Request List page navigation
`targetUrls`	Controls navigation targets for link clicks on UI	`contactDetailPage`	`target`	`A valid Contact detail page URL with host value and id value or placeholders`	`"https://{{host}}/crmUI/faces/FuseOverview?fndGlobalItemNodeId=HZ_FOUNDATIONPARTIES_CONTACTS_CRM_CARD& fndTaskItemNodeId=HZ_FOUNDATIONPARTIES_CONTACTS_CRM& fnd=;subTabName=Overview%253BContactPartyId={{contactId}};;;;false;256;;"`	Controls Contact Detail page navigation
`targetUrls`	Controls navigation targets for link clicks on UI	`serviceRequestEditPage`	`target`	`A valid Service Request edit page URL with host value and id value or placeholders`	`"https://{{host}}/fscmUI/faces/deeplink?objType=SVC_SERVICE_REQUEST&objKey=srNumber={{srNumber}}&action=EDIT_IN_TAB"`	Controls Service Request Edit page navigation
`adjustmentThresholds`	Controls agent thresholds for adjustments made in application. This property is a business configuration	`currencyThreshold`	`positiveThreshold`	`A valid positive amount`	`1`	Adjustment requires manager approval if positive adjustment exceeds this amount
`adjustmentThresholds`	Controls agent thresholds for adjustments made in application. This property is a business configuration	`currencyThreshold`	`negativeThreshold`	`A valid negative number`	`-1`
`adjustmentThresholds`	Controls agent thresholds for adjustments made in application. This property is a business configuration	`Data`	`positiveThreshold`	`A valid positive number`	`1`
`adjustmentThresholds`	Controls agent thresholds for adjustments made in application. This property is a business configuration	`Data`	`negativeThreshold`	`A valid negative number`	`-1`
`adjustmentThresholds`	Controls agent thresholds for adjustments made in application. This property is a business configuration	`SMS`	`positiveThreshold`	`A valid positive number`	`1`
`adjustmentThresholds`	Controls agent thresholds for adjustments made in application. This property is a business configuration	`SMS`	`negativeThreshold`	`A valid negative number`	`-1`
`adjustmentThresholds`	Controls agent thresholds for adjustments made in application. This property is a business configuration	`Talk`	`positiveThreshold`	`A valid positive number`	`1`
`adjustmentThresholds`	Controls agent thresholds for adjustments made in application. This property is a business configuration	`Talk`	`negativeThreshold`	`A valid negative number`	`-1`
`brmConfigurations`	Mapping between adjustment reason lookup value in oracle sales cloud and billing system	`adjustmentReasons`	`ORA_ATC_NOT_SATISFIED_SERVICE`	`A valid lookup value in billing system`	`1`
`brmConfigurations`	Mapping between adjustment reason lookup value in oracle sales cloud and billing system	`adjustmentReasons`	`ORA_ATC_CHARGE_UNAWARE`	`A valid lookup value in billing system`	`2`
`brmConfigurations`	Mapping between adjustment reason lookup value in oracle sales cloud and billing system	`adjustmentReasons`	`ORA_ATC_DEBIT_MISTAKE`	`A valid lookup value in billing system`	`3`
`brmConfigurations`	Mapping between adjustment reason lookup value in oracle sales cloud and billing system	`adjustmentReasons`	`ORA_ATC_SUPPORT_CHARGES`	`A valid lookup value in billing system`	`4`
`brmConfigurations`	Mapping between adjustment reason lookup value in oracle sales cloud and billing system	`adjustmentReasons`	`ORA_ATC_SERVICE_CHARGES`	`A valid lookup value in billing system`
`brmConfigurations`	Mapping between adjustment reason lookup value in oracle sales cloud and billing system	`disputeReasons`	`ORA_ATC_NOT_SATISFIED_SERVICE`	`A valid lookup value in billing system`
`brmConfigurations`	Mapping between adjustment reason lookup value in oracle sales cloud and billing system	`disputeReasons`	`ORA_ATC_CHARGE_UNAWARE`	`A valid lookup value in billing system`
`brmConfigurations`	Mapping between adjustment reason lookup value in oracle sales cloud and billing system	`disputeReasons`	`ORA_ATC_DEBIT_MISTAKE`	`A valid lookup value in billing system`
`brmConfigurations`	Mapping between adjustment reason lookup value in oracle sales cloud and billing system	`disputeReasons`	`ORA_ATC_SUPPORT_CHARGES`	`A valid lookup value in billing system`
`brmConfigurations`	Mapping between adjustment reason lookup value in oracle sales cloud and billing system	`disputeReasons`	`ORA_ATC_SERVICE_CHARGES`	`A valid lookup value in billing system`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`cancelSubscription`	`effectivity`	`immediate/ endOfBillingCycle`	`immediate`	`Controls the effectivity for cancel/suspend/resume subscriptions.`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`cancelSubscription`	`numberOfMonths`	`4`		`Controls the effectivity for cancel/suspend/resume subscriptions.`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`suspendSubscription`	`startType`	`ORA_ATC_IMMEDIATE_EFFECTIVITY /ORA_ATC_DATE_EFFECTIVITY /ORA_ATC_NEXTCYCLE_EFFECTIVITY`	`ORA_ATC_IMMEDIATE_EFFECTIVITY`	`Controls the effectivity for cancel/suspend/resume subscriptions.`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`suspendSubscription`	`endType`	`ORA_ATC_END_FIXED_PERIOD /ORA_ATC_END_SPECIFIC_DATE`	`ORA_ATC_END_FIXED_PERIOD`	`Controls the effectivity for cancel/suspend/resume subscriptions.`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`suspendSubscription`	`reason`	`ORA_ATC_SERVICE_ON_HOLD /ORA_ATC_NOT_USING_SERVICE /ORA_ATC_ON_VACATION /ORA_ATC_OTHER_REASON`	`ORA_ATC_SERVICE_ON_HOLD`	`Controls the effectivity for cancel/suspend/resume subscriptions.`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`suspendSubscription`	`defaultPeriod`	`a valid positive number`	`1`	`Controls the effectivity for cancel/suspend/resume subscriptions.`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`suspendSubscription`	`minPeriod`	`a valid positive number`	`1`	`Controls the effectivity for cancel/suspend/resume subscriptions.`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`suspendSubscription`	`maxPeriod`	`a valid positive number`	`6`	`Controls the effectivity for cancel/suspend/resume subscriptions.`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`suspendSubscription`	`defaultUnits`	`ORA_ATC_END_UOM_MONTHS /ORA_ATC_END_UOM_DAYS`	`ORA_ATC_END_UOM_MONTHS`	`Controls the effectivity for cancel/suspend/resume subscriptions.`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`resumeSubscription`	`startType`	`ORA_ATC_IMMEDIATE_EFFECTIVITY /ORA_ATC_DATE_EFFECTIVITY /ORA_ATC_NEXTCYCLE_EFFECTIVITY`	`ORA_ATC_IMMEDIATE_EFFECTIVITY`	`Controls the effectivity for cancel/suspend/resume subscriptions.`
`subscriptionCare`	`Controls the effectivity for cancel/suspend/resume subscriptions.`	`resumeSubscription`	`reason`	`ORA_ATC_BACK_FROM_VACATION /ORA_ATC_CHANGED_MIND /ORA_ATC_OTHER_REASON`	`ORA_ATC_CHANGED_MIND`	`Controls the effectivity for cancel/suspend/resume subscriptions.`
`orderCareDashboardTiles`	`Controls the visibility, Billing and order function for orderActivity , Recent orders.`	`orderActivity`	`visible`	`true/false`	`true`
`orderCareDashboardTiles`	`Controls the visibility, Billing and order function for orderActivity , Recent orders.`	`orderActivity`	`limit`	`a valid positive number`	`"30"`
`orderCareDashboardTiles`	`Controls the visibility, Billing and order function for orderActivity , Recent orders.`	`recentOrders`	`visible`	`true/false`	`true`
`orderCareDashboardTiles`	`Controls the visibility, Billing and order function for orderActivity , Recent orders.`	`recentOrders`	`count`	`a valid positive number`	`"6"`
`orderCareSpotlight`	`Controls the days limit for which orders to be shown.`	`orders`	`limit`	`a valid positive number`	`"30"`
`contactManagementSections`	`Controls how many records are displayed in each section in contact management page. If more records are present, user need to click View All link to see full set of records.`	`phones`	`rowLimit`	`a valid positive number`	`5`
`contactManagementSections`	`Controls how many records are displayed in each section in contact management page. If more records are present, user need to click View All link to see full set of records.`	`emails`	`rowLimit`	`a valid positive number`	`5`
`contactManagementSections`	`Controls how many records are displayed in each section in contact management page. If more records are present, user need to click View All link to see full set of records.`	`addresses`	`rowLimit`	`a valid positive number`	`5`
`contactManagementSections`	`Controls how many records are displayed in each section in contact management page. If more records are present, user need to click View All link to see full set of records.`	`connectedAccounts`	`rowLimit`	`a valid positive number`	`5`
`contactManagementSections`	`Controls what phone type lov's are supported in Account and contact management and its mapping`	`phoneType`	`MOBILE`	`mobilePhoneNumber`	`mobilePhoneNumber`
`contactManagementSections`	`Controls what phone type lov's are supported in Account and contact management and its mapping`	`phoneType`	`WORK`	`workPhoneNumber`	`workPhoneNumber`
`contactManagementSections`	`Controls what phone type lov's are supported in Account and contact management and its mapping`	`phoneType`	`HOME`	`homePhoneNumber`	`homePhoneNumber`
`generalSettings`		`billingPeriod`	`numberOfYears`	`a valid positive number`	`"4"`
`generalSettings`		`currencySymbol`	`placement`	`before/after`	`before`	Controls if currency symbol need to be placed before or after the number for currency amounts.
`generalSettings`		`serviceSpec`	`Mobile`	`TextPS,VoicePS`
`generalSettings`		`serviceSpec`	`TV`	`DigitalTVPS`
`generalSettings`		`serviceSpec`	`TVExtension`	`HDBoxPS`
`generalSettings`		`useFusionAppsUserPreference`	`dateTimeFormat`	`true/false`	`"true"`	Controls if date fields to be displayed as formatted in user preference date format set in oracle sales cloud.
`generalSettings`		`useFusionAppsUserPreference`	`numberFormat`	`true/false`	`"false"`	Controls if number fields to be displayed as formatted in user preference number format set in oracle sales cloud.
`buyingConfigurations`	Gets the phone category based on the customerType	`phoneCategory`	`Residential`	`Smart%20Phone`
`buyingConfigurations`	Gets the phone category based on the customerType	`phoneCategory`	`SMB`	`Smart%20Phone`
`buyingConfigurations`	Gets the phone category based on the customerType	`phoneCategory`	`Business`	`Smart%20Phone`
`buyingConfigurations`	Gets the phone category based on the customerType	`phoneCategory`	`MDU`	`Smart%20Phone`
`buyingConfigurations`	Gets the tv category based on the customerType	`tvCategory`	`Residential`	`TV%20Packages`
`buyingConfigurations`	Gets the tv category based on the customerType	`tvCategory`	`SMB`	`TV%20Packages`
`buyingConfigurations`	Gets the tv category based on the customerType	`tvCategory`	`Business`	`TV%20Packages`
`buyingConfigurations`	Gets the tv category based on the customerType	`tvCategory`	`MDU`	`TV%20Packages`
`buyingConfigurations`	Gets the product offerings having this priceList	`priceList`	`Residential`	`DX4C%20NA%20Pricelist`
`buyingConfigurations`	Gets the product offerings having this priceList	`priceList`	`SMB`	`DX4C%20NA%20Pricelist`
`buyingConfigurations`	Gets the product offerings having this priceList	`priceList`	`Enterprise`	`DX4C%20EURO%20Pricelist`
`buyingConfigurations`	Gets the product offerings having this priceList	`priceList`	`MDU`	`DX4C%20NA%20Pricelist`
`buyingConfigurations`	Gets the product offerings having this priceList	`priceList`	`priceListName`	`DX4C%20NA%20Pricelist`	`DX4C%20NA%20Pricelist`
`buyingConfigurations`		`maxMobileLines`	`Residential`		`5`
`buyingConfigurations`		`maxMobileLines`	`MDU`		`1000`
`buyingConfigurations`		`maxMobileLines`	`SMB`		`100`
`buyingConfigurations`		`maxMobileLines`	`Business`		`5000`
`buyingConfigurations`	Category name to identify service of the package	mobileCategory	Residential	Mobile	Mobile
`buyingConfigurations`	Category name to identify service of the package	mobileCategory	Business	Mobile	Mobile
`buyingConfigurations`	Category name to identify service of the package	mobileCategory	MDU	Mobile	Mobile
`buyingConfigurations`	Category name to identify service of the package	mobileCategory	SMB	Mobile	Mobile
`unspecifiedDashboardSpotlight`		`orders`	`limit`	`30`
`orderCareDashboardSpotLight`		`orders`	`limit`	`30`
`AddressVerificationCloudService`	`To enable verification of address entered in ui.`	`verify`	`enable`		`false`
`salesCatalog`		`CustomerType`	`RES`		`Residential`
`salesCatalog`		`CustomerType`	`SMB`		`SMB`
`salesCatalog`		`CustomerType`	`ENT`		`Enterprise`
`salesCatalog`		`CustomerType`	`MDU`		`MDU`
`salesCatalog`		`OffersList`	`limit`		`20`
`salesCatalog`		`Channel`	`CC`		`CH-10010`
`salesCatalog`		`Channel`	`Online`		`CH-10001`
`salesCatalog`		`Channel`	`Retail`		`CH-10001`
`salesCatalog`	`To give business unit.`	`salesCatalog`	`BU`		`202`
`salesCatalog`	`To give paypal agency code.`	`salesCatalog`	`PaypalAgencyId`		`1`
`salesCatalog`	`To enable/disable in-store pickup.`	`inStorePickup`	`enable`	`false/true`	`false`
`salesCatalog`	`Check for stores within this mile range.`	`inStorePickup`	`mileRangeList`	`list of valid positive numbers`	`5,10,20,200`
`salesCatalog`	`Range unit symbol in Order Broker system (api).`	`inStorePickup`	`mileRangeUnit`	`KM/M`	`M`
`salesCatalog`	`Range unit`	`inStorePickup`	`M/Km`	`Miles/Km`	`Miles/Km`
`salesCatalog`	`Requesting Location in Order Broker.`	`inStorePickup`	`requestingLocation`	`DX4CCare`	`DX4CCare`
`salesCatalog`	`Query parameters (type=service,package,device and limit )can be defined as a tenant configuration.`	`productOfferingQueryParameters`	`type`	`comma separated Offer types like package, device, service and so on.`	`"service,package,device,accessory"`
`salesCatalog`		`productOfferingQueryParameters`	`limit`	`Valid positive number`	`50`
`aggregate`	`To enable/disable caching of dashboard data.`	`caching`	`enable`	`false/true`	`false`
`serviceRequest`	`status code meaning mapping`	`statusCodeMeaningMapping`	`acknowledged`	`New`
`serviceRequest`	`status code meaning mapping`	`statusCodeMeaningMapping`	`inProgress`	`In%20Progress`
`serviceRequest`	`status code meaning mapping`	`statusCodeMeaningMapping`	`pending`	`Waiting`
`serviceRequest`	`status code meaning mapping`	`statusCodeMeaningMapping`	`resolved`	`Resolved`
`serviceRequest`	`status code meaning mapping`	`statusCodeMeaningMapping`	`closed`	`Closed`
`InputAddressComponent`	`Gets the usability mode for Input Address Component.`	`usabilityMode`	`type`	`auto, manual`	`auto`