Product Documentation

Create links to remediation report views

Jun 15, 2016

This topic explains how to configure your Forward Path reports so that the name of each application included in the report is a link to the application's remediation report view. You can create the link to the remediation report view of a single report or to a combination of any of the standard reports (this links to the merged remediation report view).

Here is a snippet from a Forward Path report that shows the application name appearing as a link:

You specify the link in the Forward Path scenario using the RemediationModules property on the Output object (also known as the ForwardPathReportOutput object). You can create the link to the remediation report view for a single report or to a merged remediation report view. For example, you can create a link to the Windows 7 remediation report view like this:

Dim myForwardpathresult As New Output() 
' ... 
myForwardpathresult.RemediationModules.Add("Win7Module")

To create a link to the merged Windows 7 and App-V remediation report views, add another line like this:

myForwardpathresult.RemediationModules.Add("VirtualisationRuleModule")

By default, the link takes you to the remediation issues view. If you want it to go to the remediation actions view, add the following line:

myForwardpathresult.RemediationView = RemediationView.Actions
Note: The RemediationModules property is an object of the standard .NET List class (see the MSDN Library for documentation).

The following table lists the IDs that define the various AppDNA reports. For the link to work correctly, the report must be licensed and the application analyzed for that report.

To specify this report: Use this ID:
Windows 7 Win7Module
Windows 8/8.1 Win8Module
Windows Server 2012/2012 R2 Win2012Module
Windows Server 2008 R2 Win2008R2Module
XenApp Hosted XenAppRuleModule
App-V VirtualisationRuleModule
Internet Explorer (IE) IEModule
Firefox FFModule
WorxWeb WorxWebModule

Link to custom report remediation views

You can link to a single custom report's remediation report view. To do this, you need to know the custom report's identifier. Typically this is the same as the custom report's name (with any spaces removed). For example, if you create a custom report using the default name of "My New Custom Report", its identifier is typically MyNewCustomReport. However, there are exceptions. For example:

  • If you rename the custom report, the identifier remains unchanged.
  • If you create another custom report with the same name as a previous one whose name has been changed, the identifier is the same as the previous one, but with_1 appended.
Note: Linking to merged custom report remediation report views is not supported.

The complete scenario

Here is the example scenario we created in the Forward Path example, that has been expanded to create links to the remediation report views:

Public Function ForwardPath(ByVal currentApplication _ 
  As Application) As Output 
 
  Dim myForwardpathresult As New Output()	 
 
  If (currentApplication.Modules.Windows7.RAG = RAG.Green) Then 
    myForwardpathresult.Outcome = "OK for Windows 7"     
  Else         
    If (currentApplication.Modules.Windows7.RAG = RAG.Amber) Then 
        myForwardpathresult.Outcome = "Remediation required"         
    Else 
        myForwardpathresult.Outcome = "Redevelopment required"         
    End If     
  End If	 
 
  myForwardpathresult.Cost = 100	 
  myForwardpathresult.RAG = _ 
    currentApplication.Modules.Windows7.RAG     
 
  ' Create links to the merged Windows 7 and App-V 
  ' remediation report views. 
  myForwardpathresult.RemediationModules.Add("Win7Module") 
  myForwardpathresult.RemediationModules.Add("VirtualisationRuleModule") 
 
  ' Specify that the link goes to the action view. 
  myForwardpathresult.RemediationView = _ 
    RemediationView.Actions	 
 
  ForwardPath = myForwardpathresult 
End Function