Fluid Topics Configuration and Administration Guide - Fluid Topics - 4.0

Version: 4.0
Category: Reference Guides
Audience: public

Before you begin
Product
Browser recommendations
Audience
Visual cues
Support
Configure a Fluid Topics tenant
Knowledge Hub
Types of content
Publishing
Publish an archive
Track an ongoing job in the queue
Browse job history
View a job report
Delete a document
Metadata journal
View a topic's metadata
View a structured document's metadata
View an unstructured document's metadata
Sources
Default sources
View information about a source
Create a source
Modify a source
Clean a source
Delete a source
Enrich and Clean
Create an Enrich and Clean rule
Delete an Enrich and Clean rule
Modify an Enrich and Clean rule
Vocabularies
Prepare a file
Prepare a file to add synonyms
Prepare a file to add a taxonomy
Prepare a file to add a monolingual taxonomy
Prepare a file to add a multilingual taxonomy
Add a vocabulary
Modify a vocabulary
Index metadata
Define a metadata key to index
Create a metadata key manually
Edit a manually-added metadata key
Delete a manually-added metadata key
Stop indexing a metadata key
Configure FTML resources for indexation
Indexation use cases
Pretty URL
Define templates
Use metadata prefixes
Add a metadata requirement
Normalize URLs
Access rules
Create a rule
Define a default group
Access rule use cases
Rules governing content access rights
Content packager
Users
Manage users
View information about a user's account
View a user's search preferences
Create an internal user account
Assign groups to users
Remove a user from a group
Assign roles to users
Assign user roles manually
Assign default user roles
Delete users
Lock a user account
Copy or merge user accounts
Download user information
Manage users In the Command Line Interface
Get user roles in the Command Line Interface
Define user roles in the Command Line Interface
Legal terms
Enable legal terms
Configure a message to display
Set a legal terms URL
Add a message for another interface language
Update legal terms
Notify users of updated legal terms
Authentication
Configure general authentication parameters
Mandatory authentication
SSO login page
Credentials form
Logout redirect URL
Native logout
Authentication timeout
Configure realms
Configure an internal realm
Registration type
Password policy
Email restrictions
Configure an LDAP realm
Realm identifier
Server URL
System user
Search base
Authentication mechanism
Configure SSO realms
Configure an OpenID Connect realm
Realm identifier
Login button
Relying Party Metadata
OAuth 2.0 credentials
Endpoints
Scopes
Microsoft Azure AD B2C troubleshooting
Configure a SAML 2.0 realm
Service Providers and Identity Providers
Declare Fluid Topics as the Service Provider
Realm identifier
Login button
Service Provider metadata
Identity Provider metadata
SAML protocol settings
SAML troubleshooting
ADFS troubleshooting
Session refused
Signature is not trusted
Error decoding SAML message
Error during trust engine evaluation of the token
Error decrypting the encrypted data element
No valid subject assertion found in response
SAML message intended destination endpoint did not match recipient endpoint
Response issue instant is too old or in the future
Authentication response is not success ; actual urn:oasis:names:tc:SAML:2.0:status:Responder
Unknown authentication plugin type saml12
Validation of received messages enabled, but no signature found on message
General SSLEngine problem
Subject NameID, BaseID and EncryptedID cannot be all null at the same time if there are no Subject Confirmations
SAML user id must not be empty
Configure profile mappers
Configure search preferences
View search preferences
Request additional user information from an external domain
Verifying results and troubleshooting
Migrate user accounts to a different realm
Define an order of precedence
Design
Pages
Component templates
Portal
General
Splash screen
Favicon
Header logo
Footer
Security
HTML documents
SVG documents
Custom components
Asset library
Create an asset
Edit an asset
Search for an asset
Sort assets
Theme
Fonts
Colors
Accessibility contrasts
Description of variables
Page Title Color (@pageTitleColor)
Facet Title Color (@facetTitleColor)
Text Color (@textColor)
Focus Color (@focusColor)
Active Elements Color (@activeColor)
Sidebar Background Color (@sidebarBackground)
Content Background Color (@contentBackground)
Content Background Highlight (@contentBackgroundHighlight)
Area Border (@areaBorder)
Fields Border Color (@fieldsBorderColor)
Sidebar Tab Color (@asideTabColor)
Sidebar Tab Hover Color (@asideTabHoverColor)
Sidebar Tab Active Color (@asideTabActiveColor)
Sidebar Tab Background (@asideTabBackground)
Sidebar Tab Hover Background (@asideTabHoverBackground)
Sidebar Tab Active Background (@asideTabActiveBackground)
Sidebar Tab Border (@asideTabBorder)
Sidebar Title Color (@asideTitleColor)
Sidebar Description Color (@asideDescriptionColor)
Sidebar Title Separator (@asideTitleSeparator)
Sidebar Footer Border (@asideFooterSeparator)
Sidebar Separator with Main Content (@asidePanelSeparator)
Sidebar Tabs Separator (@asideTabsSeparator)
Pop-up Title Color (@popupTitleColor)
Pop-up Background Color (@popupBackground)
Drawer Header Background (@drawerHeaderBackground)
Drawer Header Border (@drawerHeaderBorder)
Drawer Title Color (@drawerTitleColor)
Link Color (@linkColor)
Hovered Link Color (@hoverLinkColor)
Visited Link Color (@visitedLinkColor)
Collapsible Title Color (@collapsibleTitleColor)
Collapsible Background Color (@collapsibleBackground)
Collapsible Border Color @collapsibleBorderColor
Card Text Color (@cardTextColor)
Card Title Color (@cardTitleColor)
Card Information Color (@cardInfoColor)
Card Background Color (@cardBackgroundColor)
Card Background Hover Color (@cardHoverBackgroundColor)
Card Border Color (@cardBorderColor)
Notification Badge Background Color (@badgeBackgroundColor)
Header Background Color (@headerBackground)
Header Border Color (@headerBorder)
Header Button Foreground Color (@headerButtonColor)
Header Button Border (@headerButtonBorder)
Header Button Background Color (@headerButtonBackground)
Hovered Header Button Foreground Color (@headerButtonHoverColor)
Header Button Hover Border Color (@headerButtonHoverBorderColor)
Hovered Header Button Background Color (@headerButtonHoverBackground)
Header Button Active Color (@headerButtonActiveColor)
Header Button Active Border Color (@headerButtonActiveBorderColor)
Header Button Active Background (@headerButtonActiveBackground)
Header Menu Item Color (@headerMenuItemColor)
Header Menu Item Hover Color (@headerMenuItemHoverColor)
Header Menu Item Active Color (@headerMenuItemActiveColor)
Button Color (@buttonColor)
Button Border Color (@buttonBorderColor)
Button Background Color (@buttonBackground)
Button Hover Color (@buttonHoverColor)
Button Hover Background (@buttonHoverBackground)
Button Hover Border Color (@buttonHoverBorderColor)
Button Active Color (@buttonActiveColor)
Button Active Background (@buttonActiveBackground)
Button Active Border Color (@buttonActiveBorderColor)
Feature Button Color (@buttonFeatureColor)
Button Feature Border Color (@buttonFeatureBorderColor)
Feature Button Background Color (@buttonFeatureBackground)
Button Feature Hover Color (@buttonFeatureHoverColor)
Button Feature Hover Border Color (@buttonFeatureHoverBorderColor)
Button Feature Hover Background (@buttonFeatureHoverBackground)
Button Feature Active Color (@buttonFeatureActiveColor)
Button Feature Active Border Color (@buttonFeatureActiveBorderColor)
Button Feature Active Background (@buttonFeatureActiveBackground)
Without Background Button Color (@buttonNoBackgroundColor)
Button No Background Hover Color (@buttonNoBackgroundHoverColor)
Button No Background Active Color (@buttonNoBackgroundActiveColor)
Cancel Button Color (@buttonCancelColor)
Button Cancel Border Color (@buttonCancelBorderColor)
Cancel Button Background Color (@buttonCancelBackground)
Button Cancel Hover Color (@buttonCancelHoverColor)
Button Cancel Hover Border Color (@buttonCancelHoverBorderColor)
Button Cancel Hover Background (@buttonCancelHoverBackground)
Button Cancel Active Color (@buttonCancelActiveColor)
Button Cancel Active Border Color (@buttonCancelActiveBorderColor)
Button Cancel Active Background (@buttonCancelActiveBackground)
Cancel Button without Background Color (@buttonCancelNoBackgroundColor)
Cancel Button without Background Border Color (@buttonCancelNoBackgroundBorderColor)
Cancel Button without Background Hover Color (@buttonCancelNoBackgroundHoverColor)
Cancel Button without Background Hover Border Color (@buttonCancelNoBackgroundHoverBorderColor)
Cancel Button without Background Active Color (@buttonCancelNoBackgroundActiveColor)
Cancel Button without Background Active Border Color (@buttonCancelNoBackgroundActiveBorderColor)
Delete Button Color (@buttonDeleteColor)
Button Delete Border Color (@buttonDeleteBorderColor)
Delete Button Background Color (@buttonDeleteBackground)
Button Delete Hover Color (@buttonDeleteHoverColor)
Button Delete Hover Border Color (@buttonDeleteHoverBorderColor)
Button Delete Hover Background (@buttonDeleteHoverBackground)
Button Delete Active Color (@buttonDeleteActiveColor)
Button Delete Active Border Color (@buttonDeleteActiveBorderColor)
Button Delete Active Background (@buttonDeleteActiveBackground)
Portal Title Color (@portalTitleColor)
Portal Subtitle Color (@portalSubtitleColor)
Homepage Search Context Background Color (@homeSearchContextBackground)
Homepage Invitation Text Color (@homepageInvitationsColor)
Homepage Facet Title Color (@homepageFacetTitleColor)
Homepage Carousel Title Color (@homeCarouselTitle)
Homepage Carousel Title Color visited (@homeCarouselTitleVisited)
Homepage Carousel Description Color (@homeCarouselDescription)
Homepage Carousel Description Color visited (@homeCarouselDescriptionVisited)
Tile Border Color (@tileBorderColor)
Tile Background Color (@tileBackgroundColor)
Home Footer Border Color (@homeFooterBorderColor)
Home Footer Background Color (@homeFooterBackgroundColor)
Search Result Border Color (@searchResultBorderColor)
Search Result Title Color (@searchResultTitleColor)
Hovered Search Result Title Color (@hoverSearchResultTitleColor)
Visited Search Result Title Color (@visitedSearchResultTitleColor)
Search Result Breadcrumb Color (@searchResultBreadcrumbColor)
Search Result Excerpt Color (@searchResultExcerptColor)
Tag Text Color (@searchMetadataTagColor)
Tag Background Color (@searchMetadataTagBackgroundColor)
Tag Border Color (@searchMetadataTagBorderColor)
Multivalued Tag Border Color (@searchMultivalueMetadataTagBorderColor)
Promote Title Color (@searchPromoteTitle)
Promote Title Color visited (@visitedSearchPromoteTitle)
Promote Excerpt Color (@searchPromoteExcerpt)
Shortcut Menu Button Color (@buttonShortcutMenuColor)
Shortcut Menu Button Background (@buttonShortcutMenuBackground)
Shortcut Menu Button Color Hover (@buttonShortcutMenuColorHover)
Shortcut Menu Button Background Hover (@buttonShortcutMenuBackgroundHover)
Shortcut Menu Entries Color (@shortcutMenuEntriesColor)
Cover Bar Background Color (@coverBarBackgroundColor)
Cover Bar Font Color (@coverBarFontColor)
Cover Bar Button Hover Background (@coverBarButtonHoverBackground)
Cover Bar Button Hover Color (@coverBarButtonHoverColor)
Cover Bar Metadata Background Color (@coverBarMetadataBackgroundColor)
Override default stylesheet
Content styles
Homepage
Select a homepage layout
Simple layout
Guided layout
Pages
Homepage introduction
Logo
Background image
Select and order homepage filters
Configure Homepage tiles
Set tiles according to language
Create a tile
Add an image to a tile
Add a video to a tile
Modify a tile
Organize homepage tiles
Modify the number of columns
Move a tile
Add a line
Delete a tile
Delete a line of tiles
Download or upload Homepage configuration
Search page
Filters tab
Displayed facet values
Last update facet
Search page facets
Configure the labels of search page facets
Configure the behavior of search page results tags
Advanced settings
Relevance sort
Configure custom sort criteria
Custom sort criteria example
Results tab
Search page results tags
Configure the labels of search page results tags
Advanced settings
External links
Reader page
Interface tab
Document metadata
Display document metadata in the Cover page
Display document metadata as a static tag in the title bar
Display document metadata as a switch to relatives menu
Configure labels for metadata keys in the Reader page
Quick actions
Reader Page interface advanced settings
Cross-document link behavior
Access level
HTML download for Shared Personal Books
Switch to relatives
Content tab
Cover page
Pagination
Display the table of contents in split view
Reader page content advanced settings
Topic preloading
Search tab
Search bars
Filters
Use filters for contextual search
Languages
Related links
Prerequisites
Content formats
Metadata
Language
Enable related links
Select an audience for related links
Select metadata for dynamic suggestions
Define sort criteria for related links
Exclude sources from related links
Feature toggles
Print templates
View default PDF template
Upload custom PDF templates
PDF template placeholders
Configure date formats
Configure PDF templates with different languages
Add a custom header
Configuration example
Variables
Styling
Header size
Configure headers according to interface language
Offline
Notifications
Email
Reply-to address
Logo
From address
Configure a From address with SPF and DKIM
Configure a From address with an SMTP provider
Feedback
Recipients
Enrich email subject
Email service
Forbidden attachment file extensions
Maximum total attachment size
Rating
Create a rule
Integrations
Web Search Engines
Introduction to crawling
Define crawl settings
Robots.txt
Sitemap.xml
List of supported crawlers
Test crawl settings
Configure HTML for crawlers
Title tags
Configure a description tag
Set a description for Author-It content
Set a description for FTML content
Set a description for DITA content
Set a description for unstructured documents
Default robots meta tags
Custom robots rules
OpenSearch
Enable the OpenSearch integration for a tenant
Define the search engine name
Set the description document for a tenant
Security
Configure trusted origins
API keys
Configure analytics
Configure the analytics displayed in Fluid Topics
Implement Tracking
Configuration files
Fluid Topics configuration validator
List of configuration files
conf.json
khub
mode
boProjectName
target
pafs
connector
DITA-related Options
ditamaps
related_links
ditaot_max_memory
privateDitavals
dita-ot
generate_tasks_heading
transtype
conf.xml
custom.js
Fluid Topics PDF server configuration file
header.vm
pdf-template.vm
mongo.conf.json
vhost.conf.json
ws.conf.json
Configuration Guide Glossary
Abbreviations
Definitions
ACP
Alert
Analytics
API key
Article
Asset
Audit trail
Autocomplete
Book
Bookmark
Built-in groups
Built-in metadata
Classic homepage
Client-generated metadata
Clustered search
Collection
Color variables
Connector
Consume mode
Content styles editor
Contextual search
Custom metadata
Document
Customer metadata
Editorial homepage
Enrich & Clean
Facet
Favicon
Feedback
Filter
Instance
KHUB
Knowledge Hub
Manage mode
Map
Map attachment
Metadata element
Metadata label
Metadata journal
Multi-portal
OpenSearch
PaF
PBK
Personal book
Personal topic
Pipes and Filters
Pretty URL
Processing pipeline
Reader page
Realm
Reindexing
Related links
Reprocessing
Resource
Saved search
Search Engine Optimization
Search page
Semantic metadata
Service ID
Service status
Session
Shared personal book
Sidebar
Simple homepage
Single Sign-On
SSO
Source
Spellcheck
Stemming dictionaries
Structured document
Suggest
Synonyms
Tag
Taxonomy
Tenant
Theme
Tile
Topic
UD
Uniform Resource Identifier
Unstructured document
URI
User authentication
User authorizations
User-generated content
User roles
User origin
Viewer page
Vocabulary

Back to home page