Manage Site Settings
These settings are used to configure each XMPro Product. To open the settings page, click on the gears icon in the grey bar at the top of the screen.
Please note that the settings that you will see on this page depend on the role and access rights that have been assigned to you.
App Designer Settings
Security
Enable Audit Trail
Enabling this setting would cause logs to be created whenever changes are made to Recommendations, Connectors, and components of Applications. The logs will contain details about who made the change and when it was applied.
Integration
Integration Key
This key is used to verify Agents that integrate with the App Designer. The Integration Key will need to be copied into the Agent's configuration settings.
Metablocks
Added v4.4.0
Metablocks Enabled
Enabling this setting results in Metablocks appearing in the Blocks blade.
Reports
Added v4.3.7
Standard reports give the administrator a view into where (which Applications) and how (which version) Connectors have been used. The information is presented in a grid that can be sorted, filtered, reorganized, and grouped. It can also be exported as an XLSX file.
Connector Usage Report
This report shows all loaded Connectors, their versions, and how many times each version is used in an Application, if any.
This master list shows the administrator which Connectors are installed and their utilization. This assists in identifying new Connectors or versions not yet added.
Connector Usage Details Report
This report shows the Applications in which a Connector version has been used. Additional information includes the Application's owner and category.
This detailed report assists in gauging the impact of upgrading one or more Connector versions.
Data Stream Designer Settings
Security
Encryption Key
The encryption key is used to encrypt and decrypt sensitive data configured in the user settings of an Agent when they are stored or retrieved from the database, for example, passwords.
Enable Audit Trail
Enabling this setting would cause logs to be created whenever changes are made to Agents, Collections, and components of Data Streams. The records will contain details about who made the change and when it was applied.
UI
Enable InputMap Highlights
Enables the Canvas arrow highlight which is shown if the arrow's configuration doesn't have mappings. This is useful for demos where the complete configuration has intentionally not been provided.
Enable Stream Metrics
Enables the logging and display of stream metrics in Data Streams. Refresh the page for the setting to be applied to the Data Stream Canvas.
Behavior
Default Polling Interval (seconds)
Added v4.3.7
The default value that is used for the polling interval when a Polling Agent is added to a Streaming type Data Stream.
If there is no value provided for this setting, the polling interval defaults to 3600 seconds (1 hour).
The default is applied when the Agent is added to the canvas. A change to this site setting will only take effect for Agents added afterward.
Live View Usage
Added v4.3.6
Over time, if users did not close the Live View, these open connections placed an additional load on the Data Stream Designer (DS) as the Stream Hosts continued to send live data back to DS. This reduced overall performance and reliability, and increased infrastructure costs.
We recommend that users always close the Live View of a published Data Stream before navigating away. When in doubt, an administrator can force a reset to close all open Live View connections.
The Live View Usage includes the following:
The number of Stream Objects (Agents) with Live View enabled and the number of Data Streams affected.
A button to reset the Live View usage.
Resetting the Live View will close any connections that may have been left open if a user closes the Data Stream canvas without first closing the Live View.
It will also stop any open Live View blades from receiving data. To start receiving data again, re-open the Live View and reselect the Stream Objects.
Refer to the Live View Usage Report for a list of Stream Objects and Data Streams that are preselected for Live View.
A Stream Object with Live View enabled is an indicator that a user has viewed the data - it is not confirmation whether the user closed the connection.
The Live View issue is addressed in the v4.3.7 release:
Open connections are closed regardless of how the Live View is closed (e.g. navigating away or closing the tab).
All connections are closed when the Data Stream Designer app service is restarted.
If you've upgraded to v4.3.7, use the Reset Live View button once to ensure all connections are closed.
Reports
Added v4.3.7
Standard reports give the administrator a view into where (which Data Stream) and how (which version) Agents have been used. The information is presented in a grid that can be sorted, filtered, reorganized, and grouped. It can also be exported as an XLSX file.
Live View Usage Report
This report shows all Agents that have Live View enabled. Additional information includes the Data Stream name, Data Stream version, Data Stream owner, the Collection name, the Stream Object name, and whether the Data Stream is published.
This report along with the Reset option was useful prior to v4.3.7, to determine where connections may have been left open.
Agent Usage Report
This report shows all loaded Agents, their versions, their categories, and how many times a version is used in a Data Stream, if any.
This master list shows the administrator which Agents are installed and their utilization. This assists in identifying new Agents or versions not yet added.
Agent Usage Details Report
This report shows Data Streams in which an Agent version has been used. Additional information includes the Data Stream version, its owner, the Collection, and the Stream Object name.
This detailed report assists in gauging the impact of upgrading one or more Agent versions.
Agent Polling Interval Report
This report shows the polling intervals configured on all Agents that have the Polling Interval option. Additional information includes the Agent Name, Agent Category, Data Stream name, Data Stream version, Data Stream owner, the Collection name, the Stream Object name, and whether the Data Stream is published.
This master list empowers the administrator to locate those set too short (1s) that may be causing performance issues. 10 seconds may be appropriate during initial testing, but ill-advised in a QA or Production environment.
Subscriptions Manager Settings
Global Notification
Added v4.4.0
Global Administrators can display a global notification across the top of all products in the XMPro suite for a specific period. This aids in communicating important information to users, such as a notice advising of planned maintenance downtime and a hyperlink to release notes.
Choose a type of hint, warning, or error to set the notification icon and banner color. The banner can be dismissed for a session.
Discard "Global Notification" Settings
Clears all Global Notification settings and hides the current message, if any.
Type
This determines the icon and color of the notification banner. The options are a hint, warning, or error.
Message
A message of up to 500 characters is displayed in the notification banner. Basic text formatting, lists, and links are supported.
Show Now
Enabling this setting results in the notification banner being immediately shown across all products, and disables the Show On property.
Show On (your local time)
The date and time when the notification will be shown to users. It is stored as UTC, but displayed in the administrator's local time zone.
This setting is not available when Show Now is enabled.
Hide On (your local time)
An optional date and time when the notification should no longer be shown to users. It is stored as UTC, but displayed in the administrator's local time zone.
Leave blank if you want the message to be shown until it is manually cleared - either by clicking Discard "Global Notifications" Settings, clearing the Message or Show option.
Support
Email
The email to which notifications will be sent if a user signs up to XMPro or makes a request, for instance, a request for a Subscription to a Product, or a request for a License.
Disable Email Notifications
Disables emails sent to the email address above for any reason. If email notifications are disabled then the Global Administrator will need to log in to Subscription Manager to check whether there are any pending requests.
Security
Encryption Key
The encryption key is used to encrypt and decrypt sensitive data configured in the user settings of an Agent when they are stored or retrieved from the database, for example, passwords.
Hide Users Outside Business Role Branch
When enabled, users can see the information of users in their business role and any of its parent business roles up to the root. They cannot see any child or sibling business roles and their users.
For example, a user cannot tag/search users outside of their business role tree path in a comment on a recommendation alert.
This defaults to true on new installations. Toggle it off to make all user information visible to all users in the company.
The exception for this setting is a user with an Administrator role for the Subscription Manager product. They can assign access to XMPro objects to any user or business role in the company.
Last updated
