///////////////////////////////////////////////////////////////////////////
// Scripting Tutorial #3 - Excel and HTML output
///////////////////////////////////////////////////////////////////////////
// Title 
//   Report to list all attributes from the current selected object(s)
//   Supports now Excel and HTML; PDF is also handled
// 
// Main new features
//   - Additional Format Templates (Styles)
//   - New Functions used, like BeginTable, TableRow, TableCell, TableCellF ...
//   - Different output handling in case Excel, HTML or PDF 
//   - Support for multiple sheets in one Excel file
//   - Custom Arrays
//   - Variable naming and comments closer to ARIS Wizard standard
//   - optional: Fixed output file name possible
//
// Author
//   Volker Eckardt, Oracle Corporation, April 2010
///////////////////////////////////////////////////////////////////////////

var nLocale=Context.getSelectedLanguage();
// Attribute Header Values and Width
var headerList = ["Attribute", "Value", "ID", "API Name"]
var hWidthList = [30,30,10,40]
// To show only maintained attributes set to false
var bShowNotMaintainedAttr = false
// To force a fixed Excel file name, set to true
var bUseFixedOutPutFileName = true
 
/** Main Function
*/
function main(){
    
    // if you like to define the excel name explicitely, you can use the following instead:
    if (bUseFixedOutPutFileName == true && Context.getSelectedFormat()==Constants.OUTEXCEL) {
      var outFileName = Context.getScriptInfo(Constants.SCRIPT_NAME) + ".xls"; 
      var oOutput = Context.createOutputObject(Context.getSelectedFormat(), outFileName);
    }  
    else {
      // Create an output Object
      var oOutput = Context.createOutputObject();
    }  
    
    // define the styles (here Arial, 9)
    defineStyles(oOutput);
    // set the html page name
    oOutput.SetTitle(Context.getScriptInfo(Constants.SCRIPT_NAME))
    
    // read the current selected objects
    var objoccs = ArisData.getSelectedObjOccs();
    
    // if at least one object selected
    if (objoccs.length > 0) {

       // loop through all objects in the list
       for (o=0;o<objoccs.length;o++) {

        // get the object occurrence
        var currObj = objoccs[o];
        
        // get some values from the object
        var objName = currObj.ObjDef().Name(nLocale);
        var modelName = currObj.Model().Name(nLocale);
        var modelGroup = currObj.Model().Group().Name(nLocale);
        var modelGroupPath = currObj.Model().Group().Path(nLocale);

        // get some values form the current database
        var modelDatabase = currObj.Model().Database();
        var nameOfDatabase = modelDatabase.Name(nLocale);
        var langOfDatabase = modelDatabase.getDbLanguage().Name(nLocale);
        var currFilter = modelDatabase.ActiveFilter();
        var currFilterName = modelDatabase.ActiveFilter().Name(nLocale);
        
        // get the object type number
        var typeNumber = currObj.ObjDef().KindNum();
        
        // print a warning in case someone starts it in PDF
        if(Context.getSelectedFormat()==Constants.OUTPDF) {
          oOutput.OutputLn("This report is not yet prepared for PDF, sorry!", "Arial", 11, Constants.C_BLACK, Constants.C_TRANSPARENT,  Constants.FMT_LEFT, 0.71)  
        }
        
        // initialize the table output
        oOutput.BeginTable(100, Constants.C_BLACK, Constants.C_WHITE,  Constants.FMT_LEFT | Constants.FMT_REPEAT_HEADER, 0)
        
        // Write Header Line (Script Name), not supported in pdf
        if(Context.getSelectedFormat()!=Constants.OUTPDF) {
          oOutput.TableRow();
          oOutput.TableCell ( Context.getScriptInfo(Constants.SCRIPT_NAME), 1, 2, "Arial", 12, Constants.C_OLIVE, Constants.C_WHITE,  0,Constants.FMT_BOLD  | Constants.FMT_CENTER | Constants.FMT_VCENTER,0)
        } 
       
        if (false) {
        // write database details
        // possible, but covering repeating steps in a single function is better
        oOutput.TableRow();
        oOutput.TableCellF("Database", 30, "TABLE_HEAD");        
        oOutput.TableCellF(nameOfDatabase, 70, "TABLE_DATA");
        oOutput.TableRow();
        oOutput.TableCellF("Language Id", 30, "TABLE_HEAD");        
        oOutput.TableCellF(nLocale, 70, "TABLE_DATA");
        oOutput.TableRow();
        oOutput.TableCellF("Curr Filter Name", 30, "TABLE_HEAD");        
        oOutput.TableCellF(currFilterName, 70, "TABLE_DATA");
        }
        
        // write database details
        WriteMetaData (oOutput, "Database", nameOfDatabase)
        WriteMetaData (oOutput, "Language", langOfDatabase)
        WriteMetaData (oOutput, "Curr Filter Name", currFilterName)
        
        // write model details
        WriteMetaData (oOutput, "Model Name", modelName)
        WriteMetaData (oOutput, "Model Group", modelGroup)
        WriteMetaData (oOutput, "Model Group Path", modelGroupPath)

        // write object and symbol details
        WriteMetaData (oOutput, "Object Name", objName)
        WriteMetaData (oOutput, "Object Type", currObj.ObjDef().Type()) 
        WriteMetaData (oOutput, "Symbol Number", currObj.getSymbol())
        WriteMetaData (oOutput, "Symbol Name", currObj.SymbolName())
        WriteMetaData (oOutput, "Symbol API Name", currFilter.getAPIName(Constants.CID_OBJOCC, currObj.getSymbol()))
        
        // empty line
        oOutput.TableRow();
        oOutput.TableCellF(" ", 30, "TEXT");      
        
        // Part 1: Maintained Attributes
        // write subtable header 
        oOutput.TableRow();
        for (var i=0;i<headerList.length;i++) 
           oOutput.TableCellF(headerList[i], hWidthList[i], "TABLE_HEAD");  

        // write subtable attributes
        var attrs=currFilter.AttrTypes(typeNumber);
        var counter=0;
        for(var i=0;i<attrs.length;i++){
          if(isAttrMaintained(currObj.ObjDef(), attrs[i], nLocale)){
              oOutput.TableRow();
              oOutput.TableCellF(currFilter.getOriginalAttrTypeName(attrs[i]), hWidthList[0], "TABLE_DATA");
              oOutput.TableCellF(currObj.ObjDef().Attribute(attrs[i], nLocale).getValue(), hWidthList[1], "TABLE_DATA");
              oOutput.TableCellF(attrs[i], hWidthList[2], "TABLE_DATA");
              oOutput.TableCellF(currFilter.getAPIName(Constants.CID_ATTRDEF, attrs[i]), hWidthList[3], "TABLE_DATA");
              counter++;
            }
        }
        // write subtable summary
        oOutput.TableRow();
        oOutput.TableCellF("Total: " + counter, 30, "TABLE_HEAD");
    
        // only in case it is not PDF
        if(Context.getSelectedFormat()!=Constants.OUTPDF)
           oOutput.EndTable("Maintained Attr - Obj "+(o+1), 100, "", 0, Constants.C_BLACK, Constants.C_TRANSPARENT, 0, Constants.FMT_LEFT, 0);

        if (bShowNotMaintainedAttr==true) {
            // Part 2: Not maintained Attributes
            if(Context.getSelectedFormat()!=Constants.OUTPDF)
               oOutput.BeginTable(100, Constants.C_BLACK, Constants.C_WHITE,  Constants.FMT_LEFT | Constants.FMT_REPEAT_HEADER, 0)
        
            // write subtable header 
            oOutput.TableRow();
            for (var i=0;i<headerList.length;i++) 
                if (i!=1) oOutput.TableCellF(headerList[i], hWidthList[i], "TABLE_HEAD");  

            // write subtable attributes
            var attrs=currFilter.AttrTypes(typeNumber);
            var counter=0;
            for(var i=0;i<attrs.length;i++){
              if(!isAttrMaintained(currObj.ObjDef(), attrs[i], nLocale)){
                  oOutput.TableRow();
                  oOutput.TableCellF(currFilter.getOriginalAttrTypeName(attrs[i]), hWidthList[0], "TABLE_DATA");
                  oOutput.TableCellF(attrs[i], hWidthList[2], "TABLE_DATA");
                  oOutput.TableCellF(currFilter.getAPIName(Constants.CID_ATTRDEF, attrs[i]), hWidthList[3], "TABLE_DATA");
                  counter++;
                }
            }
    
            // write subtable summary
            oOutput.TableRow();
            oOutput.TableCellF("Total: " + counter, 30, "TABLE_HEAD");

            oOutput.EndTable("Not maintained Attr - Obj "+(o+1), 100, "", 0, Constants.C_BLACK, Constants.C_TRANSPARENT, 0, Constants.FMT_LEFT, 0);
        }
      }  
      
    } else {
        // Write Hint
        oOutput.BeginTable(100, Constants.C_BLACK, Constants.C_WHITE,  Constants.FMT_LEFT | Constants.FMT_REPEAT_HEADER, 0)
        oOutput.TableRow();
        oOutput.TableCellF("Please select (a) valid object occurence(s)!", 100, "ERROR");
        oOutput.EndTable("Hint", 100, "", 0, Constants.C_BLACK, Constants.C_TRANSPARENT, 0, Constants.FMT_LEFT, 0);
    }    
    
    oOutput.WriteReport();
}
    
/** Helper function to write a 2 column meta format
 * @param {Output} oOutput The output object
 * @param {String} dataName The data field name
 * @param {String} dataValue The field value
*/
function WriteMetaData (oOutput, dataName, dataValue) {
  oOutput.TableRow();
  oOutput.TableCellF(dataName + ": ", 30, "TABLE_HEAD_RIGHT");        
  oOutput.TableCellF(dataValue, 70, "TABLE_DATA");
}

/** Checks, if the current attribute is maintained
 * @param {Item} item The item
 * @param {Number} attrNum The Attribute Number
 * @param {Number} nLocale The Language code
*/
function isAttrMaintained(item, attrNum, nLocale) {
    var attr = item.Attribute(attrNum, nLocale);
    return ((attr.getValue() != null) && (attr.getValue().trim().length() > 0));
}

/** Defines a format template - style
 * @param {Output} oOutput The output object
*/
function defineStyles(oOutput) {
    oOutput.DefineF("TEXT", "Arial", 9, Constants.C_DARK_BLUE, Constants.C_TRANSPARENT, Constants.FMT_LEFT, 0, 0, 0, 0, 0, 0);
    oOutput.DefineF("TABLE_HEAD","Arial", 10, Constants.C_BLACK, Constants.C_SKY_BLUE, Constants.FMT_BOLD  | Constants.FMT_CENTER | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
    oOutput.DefineF("TABLE_HEAD_RIGHT","Arial", 10, Constants.C_BLACK, Constants.C_SKY_BLUE, Constants.FMT_BOLD  | Constants.FMT_RIGHT | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
    oOutput.DefineF("TABLE_DATA","Arial", 10, Constants.C_BLACK, Constants.C_WHITE, Constants.FMT_LEFT | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
    oOutput.DefineF("ERROR","Arial", 12, Constants.C_RED, Constants.C_WHITE, Constants.FMT_LEFT | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
}

// call the main function
main()