Documentation Updates
Our documentation is continually updated with new topics, and corrections or clarifications made to existing content. Check back every now and then, to see what is new!
Since November 2021, the developer portal is not divided in release versions any more and it contains latest information on a single environment. The change logs are gathered as subpages of each impacted product so that developers still have access to its history and know which features are introduced in their new version of any Symphony product impacting the developer journey.
Please note that our REST API reference documentation is still divided into release versions, and you can navigate through these to have the adhoc endpoints request/payload rules to your deployed Agent/SBE version.
In this page, you will find the main updates/announcements of the developers portal documentation changes, as well as the historical changes corresponding to each version from our old documentation system.
- Create Message endpoint: removed a mistake in the documentation mentioning that bots were able to send a message in streams it is not part of with adhoc permissions, although it has never been supported.
- Extension Apps: removed documentation of addMenuItem() method in modules service after deprecation of client 1.5, as this method is not anymore supported in the client 2.0.
- New design of the REST API reference. From now on,
- APIs are grouped as subsections of various different topics like Messages, Streams, Datafeed, etc.
- Each API reference will be presented on a single and separated page from the other APIs,
- You will be able to dynamically generate code in real time and in your preferred language thanks to the parameters presented at the bottom of each API reference page,
- Please note that some links you have saved might be broken, due to the apis being referenced as pages instead of sections from the restapi doc (i.e.: https://developers.symphony.com/restapi/reference#messages-v4 becomes https://developers.symphony.com/restapi/reference/messages-v4).
- Please note that this new design is mainly supported on 20.13 and later versions.
- Rework of the Messages documentation for it to be clearer for developers. It is now divided in MessageML and PresentationML; MessageML contains the following sections: MessageML Basics, Interactive Elements Forms, Extensibility UI Actions, and Entities; each of these subsections contains the corresponding specifications and examples helping our developer community to construct messages.
- The developer portal has been updated to a single environment: it is not divided in release versions any more and the change logs are now divided by products.
- The form is reset when the page is refreshed and the enduser is able to send a new reply.
- New Elements features are generally not supported by pods running an older client version than the one where they have been introduced (i.e. for XPod use cases)
- Added a section "Versions and Compatibility" on each Available Element documentation, which gathers the versions in which main features of the considered Element were introduced, and which outcome can be expected from it in previous Client version, for the purpose of using it in XPod use-cases for example.
- Added a description of Datafeed 2.0 (versus its previous version Datafeed 1.0) and its support in the agent. See Introduction to datafeed
- API Reference updates:
- SBE x Agent compatibility matrix is now mentioned and linked for all agent endpoints from the API reference for more clarity
- Updated the User Attributes Object and therefore its impacts on the endpoints Create User v2 / Update User v2 / Search Users
- The endpoint Subscribers documentation has been updated to highlight both default and maximum values for the parameter "limit"
This section contains the main changes that occurred in the v20.12 version of the documentation.
No tutorial pages, overviews, nor guides have been added to the Symphony Platform documentation for v20.12.
The following list shows the endpoints that have been updated or added to the API Reference documentation to include the changes according to the Change Log:
- Updated:
- Deprecated:
- Firehose v2 endpoints were removed.
- Updated Extension App Documentation to add the specification of adding default value to the share service
This section contains the main changes that occurred in the v20.10 version of the documentation.
No tutorial pages, overviews, nor guides have been added to the Symphony Platform documentation for v20.10.
The following list shows the endpoints that have been updated or added to the API Reference documentation.
This section contains the main changes that occurred in the v20.9 version of the documentation.
No tutorial pages, overviews, nor guides have been added to the Symphony Platform documentation for v20.9.
The following list shows the endpoints that have been updated or added to the API Reference documentation.
- User Attributes Object - some attributes were added (impacts on the endpoints Create User v2 / Update User v2 / Search Users)
- Updated Overview of Symphony Elements documentation for the examples to use Client 2.0 rendering instead of Client 1.5.
- Updated Text Field, Masked Text Field, Text Area, Person Selector, and Dropdown Menu documentation in order to guide on how to use
label
andtitle
attributes.
This section contains the main changes that occurred in the v20.7 version of the documentation.
No tutorial pages, overviews, nor guides have been added to the Symphony Platform documentation for v20.7.
The following list shows the endpoints that have been updated or added to the API Reference documentation.
- Users Lookup and Search Users documentation have been updated to add a note regarding information not returned in case of cross-pod search.
There was no other page update for v20.7.
The following list shows the pages that have been updated:
- Symphony Elements:
- Elements: added information about using Elements with cards.
- Text Field, Text Area and Masked Text Field: added the new
pattern
andpattern-error-message
attributes. Also, the gif images have been updated in order to show the new design of the error messages. - Buttons: added the new
class
attribute which allows bot developers to use the new palette of colorsprimary
,secondary
,tertiary
anddestructive
. The classesprimary-destructive
andsecondary-destructive
are however deprecated. - Regular Expressions - Regex: new page added in order to help bot developers to securely validate input data. This page describes what a regular expression is (shortened as regex) and how to add the validation to Symphony Elements.
- Update User Avatar: added a note stating that this API allows the current user also to update its own avatar.
- Datafeed 2.0: added documentation regarding Datafeed 2.0 including a small introduction and the endpoints added in the agent to support it.
This section contains the main changes that occurred in the v20.5 version of the documentation.
The following list shows the pages that have been updated:
- The Documentation Updates page has been moved from the REST API Guide to the Developer Guide.
- The RSA Bot Authentication Workflow page has been moved from the REST API Guide to the Developer Guide.
- PresentationML Live Renderer Tool: fixed an issue that when clearing the rendering of the live preview was returning the chosen theme (dark) to the default status (light).
This section contains the main changes that occurred in the v20.4 version of the documentation.
The following list shows the endpoints that have been updated or added to the API Reference documentation.
- Share v3: the description of the
publishDate
field now states that the article publish date in unix timestamp is in seconds. - Users Lookup v3: added a note saying that the
department
andlocation
fields are returned only if the user is an internal user of the current pod. - List IB Groups: added a note showing that the API returns only IB Groups that have at least one policy associated with it.
The following list shows the pages that have been updated:
- Symphony Elements - Buttons: the description of the
type
attribute has changed. Now, it says that the reset button resets the form-data to its initial values. - PresentationML Live Renderer Tool: corrections performed on the rendering of cards and in the live preview.
This section contains the main changes that occurred in the v20.3.x (1.57) version of the documentation.
The following list shows tutorial pages, overviews, and guides that have been added to the Symphony Platform documentation:
- SBE x Agent Compatibilities: page created in order to show the compatibility between the Agent and SBE versions.
The following list shows the endpoints that have been updated or added to the API Reference documentation.
- Create Room v3: The following note has been added: "
viewHistory
,discoverable
andmembersCanInvite
attributes cannot be false ifpublic=true
. - Message Search - POST: Added a note stating that search terms cannot contain the following reserved characters: colon :, parentheses ( ), and whitespaces.
- Message Search - GET: The following information has been added to the
text
argument: Multi-word search is allowed. Syntax: text:"Hello world". - Create Application, Create Application with an RSA Public Key, Update Application and Update Application with an RSA Public Key: The
notification
object has been added to the APIs. - Create Connection: The following information has been added to the API page: "Only one connection request is allowed between two users. When this limit is exceeded, no more connections requests are allowed. A new connection request will be allowed only if the user that received the connection request declines it."
- Add Member: The following recommendation has been added: "For rooms with more than 500 users, members should be added/deleted 1 member every "3 seconds" to allow key management functions time to process."
- The description of the
active
andprivate
body parameters has changed. - The
multilateralRoom
parameter has been added to the response sample.
The following list shows the pages that have been updated:
- The Enforce TLS 1.2 option has been added to the Modify Startup Script Configuration.
- Added a table containing flags showing the available actuator endpoints for the Agent application.
- Symphony Elements Action: the event payload returned by the Datafeed has changed. The attribute
actionStream
has been removed and theformStream
attribute has been renamed tostream
. - The ACCESS_ADMIN_API and the VIEW_PRIVILEGED_USER_AUDIT_TRAIL privileges have been added to the Audit Trail Management role.
- The Cep Visibility Group Management role with the MANAGE_CEP_VISIBILITY_GROUPS permission has been added to the page.
- The VIEW_USER_DETAIL privilege has been added to the following roles:
- Administrator
- Compliance Officer
- Content Management
- EF Policy Management
- Key Manager
- L1 Support
- L2 Support
- Scope Management
- Super Administrator
- Super Compliance Officer
- Symphony Admin
- User Provisioning
- Symphony Elements
- Text Fields: the following information has been added: "The text field cannot have children tags but it can have a default text (initial value) between the tags".
- Overview of Symphony Elements: new information related to Symphony Elements GA has been added to the Availability & known limitations section. We also added more information about the limitation with read-only rooms.
Last modified 9mo ago