Share via

State Management Service

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

State management is a simple but essential feature of dashboard applications. The state of a Web Part or dashboard is the combination of standard Web Part and dashboard schema properties and any user- or system-defined extensions.

For example, a Web Part that displays a stock ticker must be able to save and retrieve customization information between sessions. In this case, the stock symbols the user selects are private data that, with the values from the Web Part schema that you specify, constitute the state of the Web Part.

The Digital Dashboard Services Component (DDSC) makes it possible for setting and retrieving of content and individual property elements. Stored state information is location transparent; an object does not require information about the location in which its state is stored. Additionally, while the DDSC makes it possible for maintaining personalized or global state for an object, all access to the dashboard and Web Parts through the PartCollection retrieves personalized state.

**Note   **State is stored with the Web Part. If you delete a Web Part, its state information is lost.

In This Section

  • Part Object (State Management Service)
    The Part object provides access to all of the properties that are defined for the Web Part. It also provides the capability to save property changes to the store.
  • Dashboard Object (State Management Service)
    Similar to the Part object, the Dashboard object provides access to all of the properties that are defined on the currently loaded dashboard. It also provides the capability to save property changes to the store.
  • Property Object (State Management Service)
    The Property object provides access to an individual property value. The Digital Dashboard Services Component (DDSC) tracks whether a property has been changed since the dashboard was loaded.
  • PropertyCollection Object (State Management Service)
    The PropertyCollection object makes it possible for properties to be retrieved, set, added, or deleted. Only properties that are set for the object appear.
  • State Management Service Example
    In this example, the Web Part, Get More Information,**tracks the requester's name and address, so it can be retrieved the next time the user accesses the dashboard.
  • Digital Dashboard Services Component
    The Digital Dashboard Services Component (DDSC) is a client-side component that is included in every dashboard page as a hidden object.
  • Part Discovery Service
    The Part Discovery service makes it possible for Web Parts to discover other Web Parts on a dashboard.
  • Notification Service
    Through the Notification service, Web Parts can indicate interest in an event, providing a handle to a function that will be called when the event runs.
  • Session State Management Service
    Through the Session State Management service, Web Parts can share data with other parts (even if the Web Parts are located on other dashboards) through name-value pairs associated with the browser session.
  • Item Retrieval Service
    The Item Retrieval service makes it possible for Web Parts to retrieve items, such as Web Parts and dashboards from the store, even if they do not reside on the current dashboard.