Module

This class provides properties and methods related to the data module processing function of OZ Server.

---

Constructor Detail

Module

public Module(string url, string id, string pw, bool autoLogin, bool useUSL)

Performs OZ Data Module related functions.

Parameters:

url - URL of OZ Server

id - User ID

pw - User Password

autoLogin - Whether to use the AutoLogin

useUSL - Whether to use the USL

---

Property Detail

MemoAllowed

public bool MemoAllowed

Allow memo or not.

Password

public string Password

Password for saving as OZD.

---

Method Detail

AddODIParameter

public void AddODIParameter(string odiName, string key, string value) throws OZAPIException

Configures the ODI parameter values to create SDM files. Default ODI parameter values will be used if not configured.

Parameters:

odiName - ODI name

key - ODI parameter name

value - ODI parameter value

AddODIParameter

public void AddODIParameter(string odiName, string item, string category, IDictionary parameters) throws OZAPIException

Configures the ODI parameter values to create SDM files. Default ODI parameter values will be used if not configured. Used when creating SDM generation units for each parameter and when each different SDM file is needed depending on the ODI parameter values.

Parameters:

odiName - ODI name set in the Designer

item - ODI file name

category - ODI file path

parameters - Dictionary where the parameter keys and values are set.

AddParameter

public void AddParameter(string key, string value) throws OZAPIException

Configures form parameter values to create SDM files. Default form parameter values will be used if not configured.

Parameters:

key - Form Parameter Name

value - Form Parameter Value

AddReport

public IReportInfo AddReport(string itemName, string categoryName)

Adds reports in the process of making multiple reports into one OZD file.

Parameters:

itemName - Item name where reports will be added

categoryName - Category name of the item where reports will be added

AddReport

public IReportInfo AddReport(string itemName, string categoryName, string displayName)

Adds reports in the process of making multiple reports into one OZD file.

Parameters:

itemName - Item name where reports will be added

categoryName - Category name of the item where reports will be added

displayName - Report name to appear in the report tree of the OZ Viewer

GetODIParameter

public OZParameter[] GetODIParameter(string category, string odiName)

Gets ODI parameter from ODI

Parameters:

category - Category name

odiName - ODI name

GetOZD

public Stream GetOZD()

Creates an OZD with multiple reports and gets its Input Stream.

GetOZD

public Stream GetOZD(string item, string category, string[] urls)  throws OZAPIException

Creates an OZD with multiple reports and gets its Input Stream.

Parameters:

item - Item name(OZR file name)

category - Category name

urls - The URL of the image file to save together with the OZD

GetOZD

public Stream GetOZD(string itemName, string categoryName)

Creates an OZD with multiple reports and gets its Input Stream.

Parameters:

itemName - Item name(OZR file name)

categoryName - Category name

GetOZQReportParameter

public OZODIItem[] GetOZQReportParameter(string category, string ozqItemName)

Gets ODI parameter from OZ Query Designer.

Parameters:

category - Category name

ozqItemName - ODI name

GetOZReportParameter

public OZReportParameter GetOZReportParameter(string category, string reportName)

Gets ODI parameter and form parameter from report.

Parameters:

category - Category name

reportName - Report name

GetOZReportDataSetInfo

public OZDataSetInfo[] GetOZReportDataSetInfo(string category, string reportName) throws OZCPException

Gets the dataset information in the report. Returns in the order they are added to the data tree.

Parameters:

category - Category name

reportName - Report name

RedirectODIPath

public void RedirectODIPath(string odiName, string path)

Registers an ODI file to dynamically change when creating an OZD.

Parameters:

odiName - ODI name

path - ODI file path

SaveOZD

public void saveOZD(String fileName) throws OZCPException

Creates an OZD with multiple reports and saves it in a specific path.

Parameters:

fileName - Category path where the file will be saved and file name

SaveOZD

public void saveOZD(String fileName, String item, String category) throws OZCPException

Saves a report file as OZD file.

Parameters:

fileName - OZD file name including the save path

item - Report file(.ozr) name

category - Category name of the report file(.ozr)

SaveOZD

public void saveOZD(String fileName, String item, String category, String[] urls) throws OZCPException

Saves a report file as OZD file.

Parameters:

fileName - OZD file name including the save path

item - Report file(.ozr) name

category - Category name of the report file(.ozr)

urls - URL of the image file to save together with the OZD file