Embed Redwood Server Overviews into Extension Points with the Embed API

The embed API allows you to embed Redwood Server overviews, diagrams, and process output into iframes, this functionality is limited to extension points.

Prerequisites

  • License key Module.ExtensionPoint set to true

Syntax

Copy 
api-embed/(diagram|list|output|show)?link-objecttype=<objecttype>&(link-path=<name>|link-uniqueid=<n>|link-jobid=<jobid>)

api-embed/list?link-objecttype=<objecttype>&(link-search=<search>)

api-embed/diagram?link-objecttype=Job&(link-jobid=<jobid>|link-path=<name>|link-uniqueid=<n>)
  • <objecttype> - The object type; not all object types are supported. For example, JobDefinition and JobChain are supported.
  • <name> - The full name of the object in the form of <partition>.<objectName>, for example GLOBAL.System_Info, or jobId for processes.
  • <n> - The unique ID of the object.
  • <search> - The IntelliSearch query.
  • <jobid> - The ID of the process or Chain Process.

Note: link-jobid and diagram can only be used with processes and chains.

Showing Filters

Process filters can be embedded by using the link-path keyword and specifying the technical name of the filter. The following table lists the built-in filters that can be embedded. You can also embed your custom filters, provided you know the name of the filter.

Note: Filters are displayed by their Description and not their Name; this is due to the fact that filter-names, unlike descriptions, cannot contain spaces or special reserved prefixes.

Technical Name English Name
Job.state.Completed With Status "Completed"
Job.state.Error With Status "Error"
Job.state.Never With Status "Never"
Job.state.Overdue With Status "Overdue"
Job.state.Running With Status "Running"
Job.stategroup.Active In an Active State
Job.stategroup.Console In a Console State
Job.stategroup.Final In a Final State
Job.stategroup.Initial In an Initial State
Job.stategroup.Pending In a Pending State
Job.time.last24h For the Last 24 Hours
Job.time.last7d For the Last 7 Days
Job.time.next24h For the Next 24 Hours
Job.time.next7d For the Next 7 Days
Job.time.window24h For a Window of 24 Hours
Job.time.window7d For a Window of 7 Days
JobChain.all All Chains
Job.all All (Non-Maintenance) Processes
Job.maintenance Standard Maintenance (Background) Processes
Job.customMaintenance Custom Maintenance (Background) Processes
Job.stategroup.Manual In a Manual Intervention State

diagram

Embed a Chain in a Chain diagram.

Example

Copy 
  http://pr1.example.com:50200/redwood/api-embed/diagram?link-objecttype=Job&link-path=65

list

Embed the overview page for a certain object type, also used to link to IntelliSearch queries.

Example

Embed the Process Definition overview.

Copy 
  http://pr1.example.com:50200/redwood/api-embed/list?link-objecttype=JobDefinition

List all processes matching IntelliSearch query a:MSLN.

Copy 
  http://pr1.example.com:50200/redwood/api-embed/list?link-objecttype=JobDefinition&link-search=a:MSLN

output

Embed the file contents.

Example

Copy 
  http://pr1.example.com:50200/redwood/api-embed/output?link-objecttype=JobFile&link-jobid=2147&link-jobfilename=stdout.log

show

Embed a show page for the given object.

Objects

When you embed objects, such as Process Definitions, you can choose to use either the link-path, which is [<partition>.]<object> or the unique ID of the object.

Copy 
Embed process definition System_Sleep show page by businesskey.  http://pr1.example.com:50200/redwood/api-embed/show?link-objecttype=JobDefinition&link-path=GLOBAL.System_Info

Embed process definition System_Sleep show page by uniqueid.  http://pr1.example.com:50200/redwood/api-embed/show?link-objecttype=JobDefinition&link-uniqueid=79036

Files

For embedding JobFile content, there are extra convenience attributes, which allow to access the JobFile contents by: jobid and (filename or file order).

Note: The attributes: link-jobid, link-jobfileorder and link-jobfilename only work for JobFiles!

Copy 
Embed JobFile contents by uniqueid.  http://pr1.example.com:50200/redwood/api-embed/show?link-objecttype=JobFile&link-uniqueid=340644

Embed JobFile contents by jobid and filename.  http://pr1.example.com:50200/redwood/api-embed/show?link-objecttype=JobFile&link-jobid=22727&link-jobfilename=stdout.log

Embed JobFile contents by jobid and fileorder.  http://pr1.example.com:50200/redwood/api-embed/show?link-objecttype=JobFile&link-jobid=22727&link-jobfileorder=1

See Also

Integrating Redwood Server into Third-Party Applications with PermaLink