xbrlware-ce 1.0.4 → 1.1.0

data/example/case_study/buy_strategy.rb

@@ -21,7 +21,7 @@ end
 
 curr_asset, prev_asset=0, 0
 
-if Date.parse(assets[0].context.period) > Date.parse(assets[1].context.period)
+if assets[0].context.period.value > assets[1].context.period.value
   curr_asset=assets[0].value.to_f
   prev_asset=assets[1].value.to_f
 else

data/example/case_study/c_sell_strategy.rb

@@ -14,7 +14,7 @@ end
 
 curr_netincome, prev_netincome=0, 0
 
-if Date.parse(net_incomes[0].context.period["end_date"]) > Date.parse(net_incomes[1].context.period["end_date"])
+if net_incomes[0].context.period.value["end_date"] > net_incomes[1].context.period.value["end_date"]
   curr_netincome=net_incomes[0].value.to_f
   prev_netincome=net_incomes[1].value.to_f
 else

data/lib/xbrlware/context.rb

@@ -21,29 +21,66 @@ module Xbrlware
   # This class represents each context in the XBRL instance file.
   # Look at {delaing with instance page on xbrlware wiki}[http://code.google.com/p/xbrlware/wiki/InstanceTaxonomy] for more details.
   class Context
-    attr_reader :id,:entity,:period, :scenario
+    attr_reader :id, :entity, :period, :scenario
     PERIOD_FOREVER = -1
-    def initialize(id,entity,period, scenario=nil)
+
+    class Period
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def to_s
+        @value.to_s
+      end
+
+      def eql?(o)
+        o.is_a?(Period) && @value == o.value
+      end
+
+      def hash
+        @value.hash
+      end
+
+      def is_instant?
+        @value.is_a?(Date)
+      end
+
+      def is_duration?
+        @value.is_a?(Hash)
+      end
+
+      def is_forever?
+        @value.is_a?(Fixnum)
+      end
+    end
+
+    def initialize(id, entity, period, scenario=nil)
       @id = id
       @entity = entity
-      @period = period
+      @period = Period.new(period)
       @scenario=scenario
     end
-    
+
+    def has_scenario?
+      (not @scenario.nil?)
+    end
+
     def to_s
-      "Id [" + id + "], Entity { " + @entity.to_s + " },  period ["+period.to_s+"]"+ (",  scenario ["+scenario+"]" unless scenario.nil?).to_s      
+      "Id [" + id + "], Entity { " + @entity.to_s + " },  period ["+period.to_s+"]"+ (",  scenario ["+scenario+"]" unless scenario.nil?).to_s
     end
-    
+
     def eql?(o)
       o.is_a?(Context) && @id == o.id
     end
-    
+
     def hash
       @id.hash
     end
-    
+
     def has_explicit_dimensions?(dimensions=[])
-      return @entity.has_explicit_dimensions?(dimensions) unless @entity.nil?  
+      return @entity.has_explicit_dimensions?(dimensions) unless @entity.nil?
       false
     end
 
@@ -54,10 +91,10 @@ module Xbrlware
     end
 
     alias_method :dimensions, :explicit_dimensions
-    
+
     def explicit_domains(dimensions=[])
       return @entity.explicit_domains(dimensions)
-    end  
+    end
 
     alias_method :domains, :explicit_domains
 
@@ -66,37 +103,42 @@ module Xbrlware
     end
 
     alias_method :dimensions_domains, :explicit_dimensions_domains
-    
+
   end
-  
+
   class Entity
-    attr_reader :identifier,:segment
-    def initialize(identifier,segment=nil)
+    attr_reader :identifier, :segment
+
+    def initialize(identifier, segment=nil)
       @identifier = identifier
       @segment = segment
     end
-    
+
+    def has_segment?
+      (not @segment.nil?)
+    end
+
     def to_s
       "Identifier { " + @identifier.to_s + " } " + (", segment [" + segment.to_s + "]" unless segment.nil?).to_s
     end
-    
+
     def has_explicit_dimensions?(dimensions=[])
       dimensions_set=Set.new
       dimensions_set.merge(dimensions)
       unless @segment.nil? || @segment["explicitMember"].nil?
-        
-        return true if dimensions.size==0 
-        
+
+        return true if dimensions.size==0
+
         dim = Set.new
         @segment["explicitMember"].each do |member|
           dim << member["dimension"]
         end
-        return dim.superset?(dimensions_set) 
+        return dim.superset?(dimensions_set)
       end
-      
+
       return false
     end
-    
+
     def explicit_dimensions
       dim = Set.new
       unless @segment.nil? || @segment["explicitMember"].nil?
@@ -106,7 +148,7 @@ module Xbrlware
       end
       return dim.to_a
     end
-    
+
     def explicit_domains(dimensions=[])
       dom = Set.new
       if has_explicit_dimensions?(dimensions)
@@ -116,33 +158,34 @@ module Xbrlware
             next unless dim==member["dimension"]
             dom << member["content"]
           end
-        end        
+        end
       end
       return dom.to_a
     end
-    
+
     def explicit_dimensions_domains
       dim_dom={}
       if has_explicit_dimensions?
         @segment["explicitMember"].each do |member|
           dim_dom[member["dimension"]]=[] if dim_dom[member["dimension"]].nil?
           dim_dom[member["dimension"]] << member["content"]
-        end   
+        end
       end
       return dim_dom
     end
-    
+
   end
-  
-  class Identifier 
-    attr_reader :value,:scheme
-    def initialize(scheme,value)
+
+  class Identifier
+    attr_reader :value, :scheme
+
+    def initialize(scheme, value)
       @scheme = scheme
       @value = value
     end
-    
+
     def to_s
-      "schema [" + @scheme.to_s + "], value [" + @value.to_s + "]" 
+      "schema [" + @scheme.to_s + "], value [" + @value.to_s + "]"
     end
   end
 end

data/lib/xbrlware/date_util.rb

@@ -21,15 +21,25 @@ module Xbrlware
   module DateUtil # :nodoc:
     def self.stringify_date (date)
       return "" if date.nil?
-      _date=Date.parse(date) if date.is_a?(String)
-      _date=date if date.is_a?(Date)
-      m=Date::ABBR_MONTHNAMES[_date.month]
-      m + " " + _date.day.to_s + ", " + _date.year.to_s
+      begin
+        _date=Date.parse(date) if date.is_a?(String)
+        _date=date if date.is_a?(Date)
+        m=Date::ABBR_MONTHNAMES[_date.month]
+        m + " " + _date.day.to_s + ", " + _date.year.to_s
+      rescue Exception => e
+        ""
+      end
     end
 
     def self.months_between(date1=Date.today, date2=Date.today)
-      (date1 > date2) ? (recent_date, past_date = date1, date2) : (recent_date, past_date = date2, date1)
-      (recent_date.year - past_date.year) * 12 + (recent_date.month - past_date.month)
+      begin
+        date1=Date.parse(date1) if date1.is_a?(String)
+        date2=Date.parse(date2) if date2.is_a?(String)
+        (date1 > date2) ? (recent_date, past_date = date1, date2) : (recent_date, past_date = date2, date1)
+        (recent_date.year - past_date.year) * 12 + (recent_date.month - past_date.month) + 1
+      rescue Exception => e
+        0
+      end
     end
   end
 end

data/lib/xbrlware/instance.rb

@@ -58,6 +58,7 @@ module Xbrlware
       end
 
       @taxonomy=Xbrlware::Taxonomy.new(taxonomy_filepath, self)
+      @entity_details=Hash.new("UNKNOWN")
     end
 
     # Returns raw content of instance file in the form of Hash
@@ -190,9 +191,9 @@ module Xbrlware
     # Returns -1 if period is forever 
     def period(period_content)
       if period_content["startDate"] && period_content["endDate"]
-        return {"start_date" => period_content["startDate"][0]["content"], "end_date" => period_content["endDate"][0]["content"]}
+        return {"start_date" => Date.parse(period_content["startDate"][0]["content"]), "end_date" => Date.parse(period_content["endDate"][0]["content"])}
       elsif period_content["instant"]
-        return period_content["instant"][0]["content"]
+        return Date.parse(period_content["instant"][0]["content"])
       elsif period_content["forever"]
         return Context::PERIOD_FOREVER
       end
@@ -279,7 +280,7 @@ module Xbrlware
       all_items.each do |name, item_content|
         _name=name.upcase
         next if _name=="CONTEXT" || _name=="UNIT"
-        items_hash[name.upcase] = item(name)   
+        items_hash[name.upcase] = item(name)
       end
       items_hash
     end
@@ -348,34 +349,40 @@ module Xbrlware
       @item_footnote_map
     end
 
+    def entity_details=(value)
+      @entity_details.merge!(value) if value.is_a?(Hash)
+    end
 
     def entity_details
-      @entity_details={}
       if @entity_details.size==0
-        e_name=item("EntityRegistrantName")[0]
-        e_ci_key=item("EntityCentralIndexKey")[0]
-        e_doc_type=item("DocumentType")[0]
-        e_doc_end_type=item("DocumentPeriodEndDate")[0]
-
-        fedate=item("CurrentFiscalYearEndDate")
-        e_fiscal_end_date=fedate[0] unless fedate.nil?
-
-        shares_outstanding = item("EntityCommonStockSharesOutstanding")
-        e_common_shares_outstanding=shares_outstanding[0] unless shares_outstanding.nil?
-
-        @entity_details["name"]=e_name.value unless e_name.nil?
-        @entity_details["ci_key"]=e_ci_key.value unless e_ci_key.nil?
-        @entity_details["doc_type"]=e_doc_type.value unless e_doc_type.nil?
-        @entity_details["doc_end_date"]=e_doc_end_type.value unless e_doc_end_type.nil?
-        @entity_details["fiscal_end_date"]=e_fiscal_end_date.value unless e_fiscal_end_date.nil?
-        @entity_details["common_shares_outstanding"]=e_common_shares_outstanding.value unless e_common_shares_outstanding.nil?
-
-        file_name=File.basename(@file_name)
-        symbol=file_name.split("-")[0]
-        symbol.upcase!
-
-        @entity_details["symbol"]=symbol unless symbol.nil?
-
+        begin
+          # Specific to US filing 
+          e_name=item("EntityRegistrantName")[0]
+          e_ci_key=item("EntityCentralIndexKey")[0]
+          e_doc_type=item("DocumentType")[0]
+          e_doc_end_type=item("DocumentPeriodEndDate")[0]
+
+          fedate=item("CurrentFiscalYearEndDate")
+          e_fiscal_end_date=fedate[0] unless fedate.nil?
+
+          shares_outstanding = item("EntityCommonStockSharesOutstanding")
+          e_common_shares_outstanding=shares_outstanding[0] unless shares_outstanding.nil?
+
+          @entity_details["name"]=e_name.value unless e_name.nil?
+          @entity_details["ci_key"]=e_ci_key.value unless e_ci_key.nil?
+          @entity_details["doc_type"]=e_doc_type.value unless e_doc_type.nil?
+          @entity_details["doc_end_date"]=e_doc_end_type.value unless e_doc_end_type.nil?
+          @entity_details["fiscal_end_date"]=e_fiscal_end_date.value unless e_fiscal_end_date.nil?
+          @entity_details["common_shares_outstanding"]=e_common_shares_outstanding.value unless e_common_shares_outstanding.nil?
+
+          file_name=File.basename(@file_name)
+          symbol=file_name.split("-")[0]
+          symbol.upcase!
+
+          @entity_details["symbol"]=symbol unless symbol.nil?
+        rescue Exception => e
+          @entity_details
+        end
       end
       @entity_details
     end

data/lib/xbrlware/linkbase/calculation_linkbase.rb

@@ -116,7 +116,7 @@ module Xbrlware
         attr_reader :contexts, :entity_details
 
         def initialize(entity_details, title, role, href=nil, arcs=nil, contexts=nil)
-          super(title, role, href, arcs)
+          super("Calculation", title, role, href, arcs)
           @contexts=contexts
           @entity_details=entity_details
         end

data/lib/xbrlware/linkbase/definition_linkbase.rb

@@ -151,7 +151,7 @@ module Xbrlware
         attr_reader :primary_items
 
         def initialize(title, role, href=nil, primary_items=nil)
-          super(title, role, href, primary_items)
+          super("Definition", title, role, href, primary_items)
           @primary_items=primary_items
         end
 
@@ -164,7 +164,7 @@ module Xbrlware
                 dimension.domains.each do |domain|
                   domains << domain.href.sub("_", ":")
                 end
-                dim_dom_map[dimension.href.sub("_", ":")]=domains
+                dim_dom_map[dimension.href.sub("_", ":")]=domains if domains.size > 0
               end
             end
           end unless @primary_items.nil?

data/lib/xbrlware/linkbase/linkbase.rb

@@ -95,9 +95,10 @@ module Xbrlware
 
       class Link
 
-        attr_reader :title, :role, :href, :arcs
+        attr_reader :link_type, :title, :role, :href, :arcs
 
-        def initialize(title, role, href, arcs=nil)
+        def initialize(link_type, title, role, href, arcs=nil)
+          @link_type=link_type
           @role = role
           @href = href
 

data/lib/xbrlware/linkbase/presentation_linkbase.rb

@@ -133,7 +133,7 @@ module Xbrlware
         attr_reader :contexts, :definition, :instance, :timelines, :dimensions, :entity_details
 
         def initialize(entity_details, title, role, href=nil, contexts=nil, arcs=nil, definition=nil, instance=nil, dimensions=[])
-          super(title, role, href, arcs)
+          super("Presentation", title, role, href, arcs)
           @entity_details=entity_details
           @contexts=contexts
           @definition=definition

data/lib/xbrlware/meta_util.rb

@@ -41,5 +41,10 @@ module Xbrlware
             alias :#{alias_name} :#{actual_name}
       }
     end
+
+    def self.eval_on_instance(o, method_block)
+      p "#{o.class}"
+      o.instance_eval method_block
+    end
   end
 end

data/lib/xbrlware/report.rb

@@ -0,0 +1,277 @@
+module Xbrlware
+
+  #This class defines methods to generate HTML reports from XBRL documents.
+  class Report
+
+    PREF={}
+
+    def initialize(entity_details={}, pref={})
+      PREF.merge!(pref)
+      PREF["ITEM_FORMAT"]=lambda{|val| (BigDecimal(val)/1000000).round(4).to_s("F")} if PREF["ITEM_FORMAT"].nil?
+      PREF["ITEM_FORMAT_DESC"]=" in millions " if PREF["ITEM_FORMAT_DESC"].nil?
+      PREF["ITEM_FORMAT_EXCLUDE"] = ["EntityRegistrantName", "EntityCentralIndexKey", "DocumentType", "DocumentPeriodEndDate", "CurrentFiscalYearEndDate", "EntityCommonStockSharesOutstanding"] if PREF["ITEM_EXCLUDE"].nil? 
+      @entity_details=entity_details
+    end
+
+    @@html_template = %{
+    <html>
+      <head>
+        <% if defined? reports_map && (not reports_map.nil?) %>
+        <title>
+          <%=reports_map["entity_details"]["symbol"].to_s + " :: " +  reports_map["entity_details"]["doc_type"].to_s + " :: " + DateUtil.stringify_date(reports_map["entity_details"]["doc_end_date"]) + " :: Presentation & Calculation Reports"%>
+        </title>
+        <meta name="title" content="<%=reports_map["entity_details"]["symbol"].to_s + " :: " +  reports_map["entity_details"]["doc_type"].to_s + " :: " + DateUtil.stringify_date(reports_map["entity_details"]["doc_end_date"]) + " :: Presentation & Calculation Reports"%>" />
+        <meta name="description" content="<%=reports_map["entity_details"]["name"].to_s + " ( " + reports_map["entity_details"]["symbol"].to_s + " ) :: " +  reports_map["entity_details"]["doc_type"].to_s + " :: " + DateUtil.stringify_date(reports_map["entity_details"]["doc_end_date"]) + " :: Presentation & Calculation Reports" %>" />
+        <link rel="image_src" href="/static/<%=reports_map["entity_details"]["ci_key"].to_s  + ".png"%>" / >
+        <% end %>
+        <meta name="Author" content="xbrlware (bitstat technologies)"/>
+        <style>
+          table, td {
+              border-color: #000000;
+              border-style: solid;
+          }
+
+          table {
+              border-width: 0 0 1px 1px;
+              border-spacing: 0;
+              border-collapse: collapse;
+          }
+
+          tr {
+            background-color: #FFC;
+          }
+
+          .tr_white_bg {
+            background-color: #FFFFFF;
+          }
+
+          td {
+              margin: 0;
+              padding: 4px;
+              border-width: 1px 1px 0 0;
+
+              font-family: 'Times New Roman','Times serif';
+              font-size: 10pt;
+          }
+        </style>
+      </head>
+      <body>
+        <table border="1">
+          <tr class="tr_white_bg">
+            <td><b>Entity</b></td>
+            <td><b>Presentation Reports</b></td>
+            <td><b>Calculation Reports</b></td>
+          </tr>
+          <% count=0 %>
+          <% @ins_report_map.each do |ins, reports_map| %>
+            <% if count % 2 == 0%>
+              <tr>              
+            <% else %>
+              <tr class="tr_white_bg">
+            <% end %>
+            <% count=count+1 %>
+            <td>
+              <%=reports_map["entity_details"]["name"]%>&nbsp;(<%=reports_map["entity_details"]["symbol"]%>) &nbsp;
+              <br><%=reports_map["entity_details"]["doc_type"] + " : " +  DateUtil.stringify_date(reports_map["entity_details"]["doc_end_date"])%>
+            </td>
+            <td valign="top">
+              <%=create_report_html(reports_map["pre"])%>  
+            </td>
+            <td valign="top">
+              <%=create_report_html(reports_map["cal"])%>
+            </td>
+           </tr>
+          <% end %>
+        </table>
+      </body>
+    </html>
+    } # :nodoc:
+
+    private
+    def create_report_html(reports) # :nodoc:
+      return "" if reports.nil?
+      html_snipet=StringIO.new
+      reports.each do |title, report_files|
+        next if report_files.size==0
+        html_snipet << title << " &nbsp; &nbsp;"
+        report_files.each do |report_file|
+          html_snipet << "<a href='" << report_file << "'>"
+          html_snipet << File.extname(report_file).sub(".", "") << "</a>&nbsp;|&nbsp;"
+        end
+        html_snipet << "</br>"
+      end
+      html_snipet.string
+    end
+
+    public
+    # Takes path to folder that contains xbrl documents of entities. If the folder contains xbrl documents of single entity
+    # then HTML reports are generated for that entity. If there is need to generate reports for multiple entities then
+    #  1. Create root folder
+    #  2. Create subfolder for each entity inside root folder
+    #  3. The sub folders contains xbrl documents of the entity
+    #  4. File names of xbrl documents has to be in the following convention (if files are not in the convention mentioned below, you have to use gen_for method to generate reports)
+    #    calculation linkbase document must end with _cal.xml
+    #    definition linkbase document must end with _def.xml
+    #    presentation linkbase document must end with _pre.xml
+    #    label linkbase document must end with _lab.xml
+    #    taxonomy file must end with .xsd
+    #    instance document must end with .xml
+    # calling "gen" with root folder, will create reports for all entities under root folder
+    # detailed reports are stored under "reports" folder of the entity. If the "reports" doesn't exist, it
+    # will be created. Consolidated report of all generated reports is stored under root folder with name "edgar_report_index.html"
+    def gen(path_to_data_folder=".", report_for="pre|cal", report_type="html|xls|xml|json", verbose_flag="q")
+      @ins_report_map={}
+      files=xbrl_files(path_to_data_folder)
+      $LOG.info " Filtering xbrl files from folder [" + path_to_data_folder + "] done"
+      files.each do |file_map|
+        begin
+          @ins_report_map[file_map["ins"]]=gen_for(file_map, report_for, report_type, verbose_flag)
+          $LOG.info "Report generation for ["+file_map["ins"]+"] completed."
+        rescue Exception => e:
+          $LOG.fatal e.to_s
+        end
+      end
+
+      erb = ERB.new(@@html_template)
+      index_content=erb.result(get_binding)
+      File.open("master_report_index.html", 'w') {|f| f.write(index_content) }
+
+    rescue Exception => e:
+      $LOG.fatal e.to_s
+    end
+
+    private
+    def get_binding
+      binding
+    end
+
+    private
+    def xbrl_files(folder_path)
+      files=[]
+      presentation_files=Dir[folder_path+File::Separator+"**"+File::Separator+"*pre.xml"]
+      presentation_files.each do |pre_file|
+        files << Xbrlware::file_grep(File.dirname(pre_file))
+      end
+      files
+    end
+
+    private
+    def reports_content (link, report_type, verbose_flag)
+      reports_content={}
+
+      reports_content["html"]=link.to_html(verbose_flag) if report_type =~ /html|HTML/
+      reports_content["xls"]=link.to_xls if report_type =~ /xls|XLS/
+      reports_content["xml"]=link.to_xml if report_type =~ /xml|XML/
+      reports_content["json"]=link.to_json if report_type =~ /json|JSON/
+      reports_content["hash"]=link.to_hash if report_type =~ /hash|HASH/
+
+      return reports_content
+    end
+
+    private
+    def write_reports (links, report_dir, report_type, verbose_flag)
+      reports=HashUtil::OHash.new
+      links.each do |link|
+        reports_content=reports_content(link, report_type, verbose_flag)
+        report_name=link.title.gsub(/[^a-zA-Z0-9]/, "_")
+        report_files=[]
+        reports_content.each do |rtype, rcontent|
+          next if rcontent.nil?
+          extension = "." + rtype
+          report_dir = report_dir +File::Separator unless report_dir.end_with?(File::Separator)
+          report_file = report_dir+report_name+extension
+          File.open(report_file, 'w') {|f| f.write(rcontent) }
+          report_files << report_file
+        end
+        reports[link.title] = report_files
+      end
+      return reports
+    end
+
+    public
+    # Generates HTML reports from given Hash that contains files for instance, taxonomy, calculation, presentation, label, definition.
+    # Example of populating hash,
+    #   files={}
+    #   files["ins"] = "<instnace_file_path>"
+    #   files["tax"] = "<taxonomy_file_path>"
+    #   files["cal"] = "<calculation_linkbase_file_path>"
+    #   files["pre"] = "<presentation_linkbase_file_path>"
+    #   files["lab"] = "<label_linkbase_file_path>"
+    #   files["def"] = "<definition_linkbase_file_path>"
+    # Generated HTML reports will be stored under "reports" folder of current dir. If the "reports" doesn't exist, it
+    # will be created. If "cal" is passed as null, calculation linkbase path from taxonomy will be used. Same for other
+    # linkbases too (ie, "pre", "lab" and "def".)
+    def gen_for (file_map, report_for="pre|cal", report_type="html|xls|xml|json", verbose_flag="q", report_dir=nil, meta_gen=true)
+      ins_file=file_map["ins"]
+      tax_file=file_map["tax"]
+      cal_file=file_map["cal"]
+      pre_file=file_map["pre"]
+      lab_file=file_map["lab"]
+      def_file=file_map["def"]
+
+      reports_map={}
+
+      instance=nil
+      m=Benchmark.measure do
+        instance = Instance.new(ins_file, tax_file)
+        taxonomy=instance.taxonomy
+        taxonomy.init_all_lb(cal_file, pre_file, lab_file, def_file)
+      end
+      bm(" Initializing xbrl took", m)
+
+      instance.entity_details=@entity_details
+      reports_map["entity_details"]=instance.entity_details
+      reports_map["instance"]=instance
+
+      report_dir = (File.expand_path(File.dirname(ins_file)) + File::Separator + "report" + File::Separator) if report_dir.nil?
+      File.makedirs(report_dir) unless File.directory?(report_dir)
+
+      if report_for =~ /pre/ && (not instance.taxonomy.prelb.nil?)
+        links=instance.taxonomy.prelb.presentation
+        pre_dir = report_dir + "pre"
+        File.makedirs(pre_dir) unless File.directory?(pre_dir)
+        reports_map["pre"]=write_reports(links, pre_dir, report_type, verbose_flag)
+      end
+
+      if report_for =~ /cal/ && (not instance.taxonomy.callb.nil?)
+        links=instance.taxonomy.callb.calculation
+        cal_dir = report_dir + "cal"
+        File.makedirs(cal_dir) unless File.directory?(cal_dir)
+        reports_map["cal"]=write_reports(links, cal_dir, report_type, verbose_flag)
+      end
+
+      _tmp = @ins_report_map
+
+      erb = ERB.new(@@html_template)
+      index_content=erb.result(lambda do
+        @ins_report_map={}
+        @ins_report_map[file_map["ins"]]=reports_map
+        lambda {}
+      end.call)
+
+      @ins_report_map = _tmp
+
+#      str_ci_key=reports_map["entity_details"]["ci_key"]
+#      str_doc_end_date=reports_map["entity_details"]["doc_end_date"]
+#      str_doc_end_date="" if str_doc_end_date.nil?
+#      str_doc_end_date.gsub!("-", "")
+#      report_index_file = report_dir + str_ci_key+"_"+str_doc_end_date+"_report.html"
+
+      report_index_file = report_dir + "report_index.html"
+      File.open( report_index_file, 'w') {|f| f.write(index_content) }
+
+      reports_map["report_index_file"]=report_index_file
+
+      if meta_gen
+        meta_file_name = report_dir + "meta.json"
+        meta_gen_content = reports_map.reject {|k, v| k=="instance"}.to_json.to_s
+        File.open( meta_file_name, 'w') {|f| f.write(meta_gen_content) }
+        reports_map["report_meta_file"]=meta_file_name
+      end
+
+      reports_map
+    rescue Exception => e
+      raise " Report generation failed for instance " + ins_file + "\n #{e.to_s + "\n" + e.backtrace.join("\n ")}"
+    end
+  end
+end