Wyn Enterprise: Using Integration URLs

Integration URLs or the access URLs for integration can be used directly in th e Web browser to access the respective portals or used within iframe of customer's application.

A URL enables you to access a specific document, resource, and other items available on the server database. A URL access also lets you customize the viewing experience for your users.

Please see Configuring an Integration Security Token and Using DirectURL.

The format of URLs for integration is as follows:

server/module/command/{documentid}&token={token}

• server is the customer installed URL of the Wyn Enterprise portal
• module takes the following values:
      reports
      dashboards
      datasources
      datasets
      models
      images
      themes
• command takes following values:
      create - opens document designer for design a new document
      view - opens document content in viewer. It needs the documentID
      edit - modify document in designer, need the document in url
• documentID is the document identity; it is unique even if the document name is same.

Examples

Module	Command	Access URL
reports	create	http://localhost:51980/reports/create?token={token}
	view	http://localhost:51980/reports/view/{reportID}?token={token}
	edit	http://localhost:51980/reports/edit/{reportID}?token={token}
dashboards	create	http://localhost:51980/dashboards/create?token={token}
	view	http://localhost:51980/dashboards/view/{dashboardID}?token={token}
	edit	http://localhost:51980/dashboards/edit/{dashboardID}?token={token}
datasources	create	http://localhost:51980/datasources/create?token={token}
	view	http://localhost:51980/datasources/view/{datasourceID}?token={token}
	edit	http://localhost:51980/datasources/edit/{datasourceID}?token={token}
datasets	create	http://localhost:51980/datasets/create?token={token}
	view	http://localhost:51980/datasets/view/{datasetID}?token={token}
	edit	http://localhost:51980/datasets/edit/{datasetID}?token={token}
models	create	http://localhost:51980/models/create?token={token}
	edit	http://localhost:51980/models/edit/{semanticmodelID}?token={token}
theme	view	http://localhost:51980/theme/view/{themeID}?token={token}
images	view	http://localhost:51980/images/view/{imageID}?token={token}

Customization using Action Queries

The integration urls can be used to customize the Document Portal interface using hide action queries.

Hide Actions

Use hideActions queries in Document Portal integration URL to hide interface options from the end users:

The supported hide actions are:

favorite
category
rename
openInNewWindow
refresh
preview
filter
delete
download
copyUrl
copyReport
copyDashboard
reporting:exportReport
reporting:editReport
dashboards:editDashboard

Examples of 'hideActions'

• Hide 'Filter' option:

  http://localhost:51980/integration/favorites/{documentID}?token={token}&hideActions=filter
  

• Hide 'Preview' option:

  http://localhost:51980/categories/{categoryID}/documents/{documentID}?token={token}&hideActions=preview
  

• Hide Report 'Editing' and 'Export' options:

  http://localhost:51980/categories/{categoryID}/documents/{documentID}?token={token}&hideActions=reporting:exportReport,reporting:editReport
  

Show or Hide Navigation menu

The Navigation menu, Avatar menu, and Welcome Screen can be hidden for the end users using the hidenav action query. The only valid value for hidenav is 'true'.

Example of 'hidenav'

http://localhost:51980/reports/view/{reportID}?token={token}&hidenav=true

http://localhost:51980/categories/{categoryID}/documents/{documentID}?token={token}&hideActions=preview&hidenav=true