# DCjive.ctl:326:Collects Jive Information
# $Id: DCjive.ctl,v 1.4 2015/05/28 18:52:06 RDA Exp $
# ARCS: $Header: /home/cvs/cvs/RDA_8/src/scripting/lib/collect/OFM/DCjive.ctl,v 1.4 2015/05/28 18:52:06 RDA Exp $
#
# Change History
# 20150527  KRA  Improve the documentation.

=head1 NAME

OFM:DCjive - Collects Jive Information

=head1 DESCRIPTION

This module collects the Jive-related diagnostic information.

The following report can be generated and are regrouped under C<Jive>:

=cut

echo tput('bold'),'Processing OFM.JIVE module ...',tput('off')

# Initialization
var $JIVE_HOME = ${D_HOME:''}
var $TAIL      = ${DFT.N_TAIL:1000}

var $TOC = '%TOC%'
var $TOP = '[[#Top][Back to top]]'
pretoc '1:Jive'

# Load common macros
run RDA:library()

=head2 prop - jive.properties

Gathers F<jive.properties> file.

=cut

report prop
debug ' Inside JIVE module, getting jive.properties file'
prefix
 write '---+ JIVE_HOME/database/jive.properties'
call writeFile(catFile($JIVE_HOME,'database','jive.properties'))
if isCreated(true)
 toc '2:[[',getFile(),'][rda_report][jive.properties]]'

=for stopwords startup

=head2 start - jive_startup.xml

Gathers F<jive_startup.xml> file.

=cut

report start
debug ' Inside JIVE module, getting jive_startup.xml file'
prefix
 write '---+ JIVE_HOME/jive_startup.xml'
call writeFile(catFile($JIVE_HOME,'jive_startup.xml'))
if isCreated(true)
 toc '2:[[',getFile(),'][rda_report][jive_startup.xml]]'

=for stopwords usersearch

=head2 user - jive_usersearch.xml

Gathers F<jive_usersearch.xml> file.

=cut

report user
debug ' Inside JIVE module, getting jive_usersearch.xml file'
prefix
 write '---+ JIVE_HOME/search/user/jive_usersearch.xml'
call writeFile(catFile($JIVE_HOME,'search','user','jive_usersearch.xml'))
if isCreated(true)
 toc '2:[[',getFile(),'][rda_report][jive_usersearch.xml]]'

=head2 Log Files

Finds all files in the F<$JIVE_HOME/log> directory.

=cut

debug ' Inside JIVE module, listing log files'
pretoc '2:Log files'
call sort_files(3,$TAIL,grepDir(catDir($JIVE_HOME,'logs'),'.*','p'))
unpretoc 2

=head1 SEE ALSO

L<RDA:library|collect::RDA:library>

=begin credits

=over 10

=item RDA 4.14: Pramod Vasista.

=back

=end credits

=head1 COPYRIGHT NOTICE

Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.

=head1 TRADEMARK NOTICE

Oracle and Java are registered trademarks of Oracle and/or its
affiliates. Other names may be trademarks of their respective owners.

=cut