Recommended Reading

The following articles provide background on Exago's Storage Management system. It is highly recommended to review them before writing a custom implementation of Storage Management.

• Storage Management: Introduction
• Storage Management: Database Schema

Introduction

Clients may write their own implementation of the Storage Management assembly to replace Exago's out-of-the-box implementation.

Clients looking to write their own Storage Management assembly may download Exago's Storage Management implementation code as a Visual Studio project from the Downloads page on Support Site. Clients are also encouraged to open a Services Ticket in our Support Center for assistance if desired.

SessionInfo

The SessionInfo object is not available in the Storage Management system. However, there is a dictionary of options passed around the Storage Management system that stores pertinent information for the database, but additional key-value pairs can be added as needed. This dictionary may be accessed with the .NET API, REST Web Service API and within the Storage Management assembly itself.

Example

This example modifies the constructor of Exago's Storage Management example.

public StorageMgmtDatabase(StorageMgmtConfig config) {
 
 //set the value of the companyId identity key to Exago, Inc.
 config.SetIdentity("companyId", "Exago, Inc.");
 
 //set a Custom Option named userProfile
 config.SetOption("userProfile", "support_Administrator");
}
...

Implementation

Note

This article references <WebApp>/, <WebSvc>/ and <Sched>/as a placeholder for the Web Application, Web Service API and Scheduler Service's install location respectively. The default install location is C:\Program Files\Exago\ExagoWeb\ (/opt/Exago/ on Linux), C:\Program Files\Exago\ExagoWebApi\ ( /opt/Exago/WebServiceApi/ on Linux) or C:\Program Files\Exago\ExagoScheduler\ (/opt/Exago/Scheduler/ on Linux); however, these directories can be changed during installation.

Once developed, move the finished library into a directory accessible to the Exago Web Application e.g. <WebApp>/bin, Scheduler Services e.g. <Sched>/bin (if applicable) and REST Web Service API e.g. <WebSvc>/bin (if applicable). Then set the Admin Console > Storage Management > Assembly Location and Class Name settings accordingly.

Tip

Name the DLL file something other than WebReports.ContentDatabase.dll as not to overwrite the Exago provided library. This way, if troubleshooting is ever needed in the future, it is easy to change back to the factory provided implementation.

ContentMetadata Class

The ContentMetadata class contains metadata about reports and other content. This data is saved to the Storage Management database, and is serializable as JSON.

Namespace: WebReports.Api.Common

Properties

A ContentMetaData object has the following properties. Properties that appear as hyperlinks below require constants or enums which are documented in the Constants and Enumerators article.

Constructors

public ContentMetadata()

public ContentMetadata(ContentMetadata other)

Methods

string GetUdfJson()

static ContentMetadata GetMetadataFromJson(string jsonStr)

void SetFullNamesFromFullName(string fullName)

string ToString()

ReportMetadata Id: {contentId} Name: {name} Folder: {folder} Type: {report or content type}

ReportMetadata Id: 34952c9c-9b0c-869a-c850-3b623ba4005b Name: Current Product Listing Folder: General Reports Type: ExpressView

ReportMetadata Id: 141f017a-e8c2-4a9a-baec-90826bab4d77 Name: SA Timesheet (blank).pdf Folder: NULL Type: Template

IStorageManagement Interface

The IStorageManagement interface defines all of the necessary methods that will be called from Exago BI to read and write content to the Storage Mechanism. All of the permissions logic, if applicable, can be built into the methods of this class.

WebReports.Api.Report.ReportProperties objects can be used for reading information about reports directly from their XML definition, without having to first load the report with ReportObjectFactory.LoadFromRepository(string name).

Namespace: WebReports.Api.ReportMgmt

public interface IStorageManagement
 {
  wrContentType? GetContentType(Guid contentId)
  
  IEnumerable<ContentMetadata> GetContentList(wrContentType contentType, bool includeContent = false);
  
  ContentMetadata GetContent(ContentMetadata metadata);

  string GetCacheKey();

  void RenameContent(ContentMetadata metadata, string newName, ContentMetadata parentMetadata);

  void DeleteContent(ContentMetadata metadata);

  void SaveContent(ContentMetadata metadata);
  
  StorageMgmtResult ValidateContentName(string reportName, string udfData);

  void AddFolder(ContentMetadata metadata);
  
  void MoveFolder(ContentMetadata folder, ContentMetadata target, bool updatePermissions);

  IEnumerable<string> GetTemplateList();

  byte[] GetTemplate(string templateName);

  void SaveTemplate(string templateName, byte[] templateData)

  IEnumerable<ContentMetadata> GetThemeList(string themeType);

  bool ExistTheme(string themeType, string themeName);

  string GetTheme(string themeType, string themeName);

  void SaveTheme(string themeType, string themeName, string themeData);

  void ClearReportListCache();
  
  string TestConnection();

  string InitDb(string jsonSchemaFilePath, bool showSQL);
 }

Methods

wrContentType? GetContentType(Guid contentId);

IEnumerable<ContentMetadata> GetContentList(wrContentType contentType, bool includeContent)

ContentMetadata GetContent(ContentMetadata metadata)

string GetCacheKey()

void RenameContent(ContentMetadata metadata, string newName, ContentMetadata parentMetadata)

void DeleteContent(ContentMetadata metadata)

void SaveContent(ContentMetadata metadata)

StorageMgmtResult ValidateContentName(string reportName, string udfData)

void AddFolder(ContentMetadata metadata)

void MoveFolder(ContentMetadata folder, ContentMetadata target, bool updatePermissions)

IEnumerable<string> GetTemplateList()

byte[] GetTemplate(string templateName)

void SaveTemplate(string templateName, byte[] templateData)

IEnumerable<ContentMetadata> GetThemeList(string themeType)

bool ExistTheme(string themeType, string themeName)

string GetTheme(string themeType, string themeName)

void SaveTheme(string themeType, string themeName, string themeData)

this.SaveTheme("Chart", "Crimson Mountain", "#F0433A,#C9283E,#820333,#540032,#2E112D")

void ClearReportListCache()

string TestConnection()

string InitDb(string jsonSchemaFilePath, bool showSQL)

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WebReports.Api.Common;
using WebReports.Api.ReportMgmt;
using WebReports.ContentDatabase;

namespace V_versions
{
 public class V_storage : StorageMgmtDatabase
 {
  private static readonly Logger logger = Log.GetLogger();

  /**
   * Provide a constructor
   */ 
  public V_storage(StorageMgmtConfig config) : base(config)
  {
  }

  /** 
   * Override the SaveContent method
   * <param name="metadata">the ContentMetadata object to be saved</param>
  */ 
  public override void SaveContent(ContentMetadata metadata)
  {
   //Custom implementation of the method goes here
  }

  /**
   * Override the AddFolder method
   * <param name="metadata">a ContentMetadata object representing the folder to be added</param>
  */ 
  public override void AddFolder(ContentMetadata metadata)
  {
   //Custom implementation of the method does here
  }
 }
}