(v23) Get Started with the Symphony Application Framework

Get Started with the Symphony Application Framework

This applies to: Visual Data Discovery

Symphony's application framework provides you with the tools you need to query data or embed visuals from Symphony in your own application. If you want to use Symphony visuals or data in your own custom application, then read on. You might be looking for information about creating your own custom charts, see Maintain Custom Charts Using the Custom Chart CLI.

Note: insightsoftware recommends using Trusted Access for all embed-related workflows.

Uses of the Application Framework

	You can use a query to get data from Symphony and use it in your own applications. You might want to go this route if: You just need the data. You already have a visual built into your application and you want to keep it, but need data for it.
	You can embed a Symphony visual in your application and use your query to supply it with data. You might want to go this route if: You already have a data query set up. You need to use the same query for more than one visual or for visuals and other purposes.
	You can embed a Symphony visual and give it the information it needs to create its own query. You might want to go this route if you really just need one visual based on its own query.

Dependencies

The application framework depends upon jQuery. Symphony recommends that you link jQuery v1.8 or later.

Accessing the Application Framework

Symphony's application framework is provided by linking the zoomdata-client.js file in your web application. You can find zoomdata-client.js on your installation at

https://<yourserver>/composer/sdk/zoomdata-client.js

replacing <yourserver> with the URL for your server.

Best practice: Use the zoomdata-client.js file found on the Symphony installation that will be supplying your data and visuals. There is not usually a problem using different versions, but following this guidance avoids such issues and may help Symphony support your work.

Linking the zoomdata-client.js file into your web application gives you access to the ZoomdataSDK object. The main purpose of the ZoomdataSDK object is to create a Symphony client for your application. Typically, one Symphony client is enough, but if you need to access multiple Symphony servers, you'll need one client for each one.

Typical Workflows

There is a lot of flexibility with the Symphony application framework, but some steps must precede others. When steps must be kept in a particular order, the Symphony application framework uses promises to do so. Below is an example of the most common workflow.

Typical Workflow to Query Data

This workflow creates a query and then queries data from it. This workflow is useful if you already have visuals in your application and you need to supply them with data from Symphony. It's also useful if you just want the data.

1. Create a Symphony client. Steps to create a client are found in Use a Data Query.
2. Create a Symphony query.
3. Run the Symphony query.
4. Gather and use the queried data.

To help you get going, you might want to fiddle with an example or download it from GitHub.

Next Steps

It might be that you only need to embed a visual or use data from Symphony in your own application. Consider the information at the following links:

• Use a Data Query
• Symphony Data Discovery REST API Overview
• Maintain Custom Charts Using the Custom Chart CLI
• Trusted Access