EasyManage Platform : Administrator Guide |
Administrator Guide 5.0
For EasyManage Platform
(EM WebPlus Suite 5.0 | EM 5.0)
On Windows & Unix
Platforms
(Updated: 10-Jan-20, Build 5.82 P25.25)
Contents
System
Requirements for Database
Install/Set-Up
Java JDK J2EE, Application Server / Jsp Container
Tomcat
: Specify configurations:
Using
Apache Web Server with Tomcat
Configure
Application Server CLASSPATH
Sun
Java System Application Server:
Configure
and Set-up the Database for EM
Verify
Database parameters in EM Configuration file:
Set-Up
and Run EM 5.0 Java Batch Utilities
Availability
of Jsp Configuration/Customization in License
Jsp
Configuration Parameters - Cosmetic
Jsp
Configuration Parameters - Advanced
Changing
webapp context name from default “em”
Configuring
multiple EM instances on a server
Multiple
EM instances on a server: Sign-In restricted to instance
Configuring
Secure (https) Mode For Sign-In and Sign-Up
Configuring
Sign-Up Checks: Invitation Codes, Private Beta
Configuring
– Character Encoding (Charsets)
Default
Character Encoding (Charset) : Unicode UTF-8
Changing
Default Character Encoding (Charset) : e.g. ISO-8859-1
Installation
and Set-Up of SDK (WsGen)
Setting-up
SDK (WsGen) for use
Configuration
settings in Sun Application Server
Compiling
the WsGen generated source files
Using
Command Prompt For WsGen generated Source Files
Using
Eclipse For WsGen generated Source Files
Chapter
2: EM Configuration Parameters
How
to use EM Configuration Parameters?
em.param.file_download_size_kb
em.param.em_tg_tagp_<AppId|ALL>
em.param.em_tg_ext_<AppId|ALL>
Parameter
Usage, Defaults, Optimum Values
How
to use Plan or User specific EM Configuration Parameters?
Which
Parameters can be override via Plan / User files?
Chapter
3: Java Utility Programs, Batch Jobs
Using
Java Utility Programs, Examples
Chapter
4: Administering EM 5.0
Monitoring
em.param.file_dest_dir for Disk Space Usage
Monitoring
Database (DBA’s Role)
Chapter
5: Migrating From EM AFE Rel 4.0 to EM 5.0
Appendix
A – New Features for Administrators
Collaboration
: EM Mail (Application-Data Exchange)
Search
Server: Portal, Content, Collaboration Search
Introduction
|
This guide describes the Administration features of “EasyManage Platform”, also
referred as “EM 5.0”, for System Administrators and
DBAs.
Note: Reference to previous release is made as EM AFE or EM AFE Release 4.0 or EM ApplicationFrame Work Engine 4.0.
Chapter 1: Installation
|
This section describes how to install EM Release 5.0 on Microsoft Windows and
Unix operating platforms.
If you are installing EM 5.0 for the first time, follow the sections
below in this chapter.
If you are upgrading or migrating from previous versions
of EM AFE then please refer to chapter “Migrating from
EM AFE Release 4.0 to EM 5.0”.
This section lists the system
requirements for machine, Software, OS, Database and Browser.
Software Requirements
EM products require following software.
Java and J2EE |
Following JDK are
supported:
Following combinations are supported:
Following JDK is
supported from initial validation:
Following
combinations are supported:
|
Application
Server/ Jsp Container |
Any Of:
|
Web Services Runtime
for WsGen |
Out of box support
for:
Other runtimes can
be used with some changes to build.xml files. |
Browser |
Latest Browsers
are supported: |
Database |
MySQL, Oracle, MS
SQL Server, MS Access |
|
Following are
supported in limited preview edition only: DB2, Sybase |
EM products support Using eclipse IDE as an option to work with generated web services source files :
Eclipse |
Following are
supported:
|
As you are aware, there are different implementations of Java on various operating systems. We focus EM products testing and validation on a core widely used combinations which are our reference platforms. EM products will run fine in operating environments beyond the reference platforms.
EM products are tested and validated on the following reference platforms:
Primary
Reference Platforms |
|
Operating Environment |
Software / Database |
Windows XP SP3 |
With
|
CentOS 5.1 Linux (Kernel 2.6.x glibc 2.5.x) |
With
|
Secondary
Reference Platforms |
|
Windows XP SP3 |
With:
|
Windows XP SP3 |
With:
|
EM products will run fine on the following platforms:
Platforms |
|
Operating Environment |
Software / Database |
Windows Windows 7 Windows Server
2003 Windows Server
2008 |
With any of:
|
One Of: Red Hat Enterprise
Linux 4.0 , 5.0 SUSE Linux Enterprise Server 10 Sun Solaris 9, 10 (SPARC) Sun Solaris 10 on
x86 HP HP-UX 11i on PA-RISC HP HP-UX 11i on
Itanium Other operating
platforms Supporting JDK 5.0 and J2EE SDK 5.0 |
With any of
database below supported by given OS:
|
(Note: As they are not tested by us, we can not vouch for them and supporting any issues arising on these platforms which can not be re-created on reference platforms will have lower priority.)
Note: Microsoft Windows 98 / NT / 2000 / Me (Millennium Edition) is not
supported from EM products Ver 5.0 Build 5.80 onwards.
EM products are available on the following platforms/databases in limited preview edition only:
Platforms For
Preview Edition |
|
Operating Environment |
Software / Database |
Windows XP Windows Server
2003 |
With any of:
|
System
Requirements for Database
Please refer to the database vendor
supplied system requirement documentation.
The following section gives guidelines on minimum system
configuration required on Intel along with memory and disk
requirements for product running with MySQL database.
OS |
Windows XP SP3 |
Processor (Windows/Linux) |
Minimum: Intel Celeron 2.6 GHz Recommended: Pentium IV+, Pentium Dual Core |
|
Minimum: 512 MB Recommended: 1 GB |
Hard disk space |
Total 1GB+ |
· Please refer to documentation at Sun site: http://java.sun.com
· Please refer to documentation at Apache site site
export
JAVA_HOME=/ProgFiles/jdk1.5.0_14
export
JAVAEE_HOME=/ProgFiles/java_ee_sdk5_03
export
· To use BodyEncodingForURI and
· To get correct hostname for forwarded Web Url links when Using Apache Web Server with Tomcat
For Tomcat specify to use BodyEncodingForURI in server.xml file to handle URLs with UTF-8 contents properly.
Specify proxyName and proxyPort to get correct hostname for forwarded Web Url links. Replace easymanage.com with the hostname for your environment.
Please edit file $CATALINA_HOME/conf/server.xml:
Edit Following:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443"
/>
To:
<Connector port="8080"
protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" useBodyEncodingForURI="true"
proxyName="easymanage.com"
proxyPort="80"
/>
yum
-y install compat-libstdc++-296 compat-libstdc++-33
yum
-y update
http://tomcat.apache.org/tomcat-6.0-doc/proxy-howto.html
[mysqld]
lower_case_table_names=1
default-character-set=utf8
default-storage-engine=INNODB
sql-mode="STRICT_TRANS_TABLES,NO_
#
max_connections=100
· On Windows: e.g. at E:\ProgFiles\ jdbc_drivers\mysql5\mysql-connector-java-5.0.7-bin.jar
· On Unix: e.g. at /MySQL/mysql-connector-java-5.0.7
· set CLASSPATH= %CLASSPATH%;E:\ProgFiles\ jdbc_drivers\mysql5\mysql-connector-java-5.0.7-bin.jar;
1. Enable protocol TCP/IP
2. Stop and Start services:
3. "SQL Server (SQLEXPRESS)"
4. "SQL Server Browser"
· On Windows: e.g. at E:\ProgFiles\ \jdbc_drivers\mssqlj20\jdk5_jdbcspec30\sqljdbc.jar
· set CLASSPATH= %CLASSPATH%;E:\ProgFiles\ \jdbc_drivers\mssqlj20\jdk5_jdbcspec30\sqljdbc.jar;
----------------------------------------------------------
E:\>sqlplus
system/<password>
SQL*Plus: Release
10.2.0.1.0 - Production on Mon May 9 19:16:35 2011
Copyright (c) 1982,
2005, Oracle. All rights reserved.
Connected to:
Oracle Database 10g
Express Edition Release 10.2.0.1.0 - Production
SQL> Exec DBMS_XDB.SETHTTPPORT(10070);
PL/SQL procedure
successfully completed.
SQL> quit
Disconnected from
Oracle Database 10g Express Edition Release 10.2.0.1.0 - Production
----------------------------------------------------------
----------------------------------------------------------
E:\>sqlplus
system/<password>@XE
SQL*Plus: Release
10.2.0.1.0 - Production on Mon May 9 20:08:14 2011
Copyright (c) 1982,
2005, Oracle. All rights reserved.
Connected to:
Oracle Database 10g
Express Edition Release 10.2.0.1.0 - Production
SQL> SELECT
value$ FROM sys.props$ WHERE name = 'NLS_CHARACTERSET' ;
VALUE$
------------------------------------------------------
AL32UTF8
SQL> SELECT *
FROM NLS_DATABASE_PARAMETERS;
----------------------------------------------------------
· On Windows: e.g. at E:\ProgFiles\jdbc_drivers\oracle10\ojdbc14.zip
· set CLASSPATH= %CLASSPATH%;E:\ProgFiles\jdbc_drivers\oracle10\ojdbc14.zip;
EM Product is supplied in WAR archive format:
em.war
EM Product Documentation is supplied in WAR archive format:
emdoc.war
Deploy the above war files to your Web server / container:
Copy the war file to appropriate deployment directory of container. Restart the container.
The CLASSPATH variable for your application server needs to include following locations:
On Win Settings:
· E.g. MySQL
·
set
CLASSPATH= %CLASSPATH%;E:\ProgFiles\jdbc_drivers\mysql5\mysql-connector-java-5.0.7-bin.jar;
· E.g. MSSQL
·
set
CLASSPATH=%CLASSPATH%;E:\ProgFiles\jdbc_drivers\mssqlj20\jdk5_jdbcspec30\sqljdbc.jar;
· E.g. Oracle
·
set
CLASSPATH=%CLASSPATH%;E:\ProgFiles\jdbc_drivers\oracle10\classes12.zip;
·
set
CLASSPATH=%CLASSPATH%;E:\ProgFiles\java_ee_sdk-5\lib\mail.jar;
On Unix Settings:
·
on Linux with Tomcat 6.0 , edit catalina.sh and
add bold text, e.g.: edit file /ProgFiles/apache-tomcat-6.0.14/bin/catalina.sh
#
Add on extra jar files to CLASSPATH
if
[ -n "$JSSE_HOME" ]; then
CLASSPATH="$CLASSPATH":"$JSSE_HOME"/lib/jcert.jar:"$JSSE_HOME"/lib/jnet.jar:"$JSSE_HOME"/lib/jsse.jar
fi
CLASSPATH="$CLASSPATH":"$CATALINA_HOME"/bin/bootstrap.jar:"$CATALINA_HOME"/bin/commons-logging-api.jar
CLASSPATH="$CLASSPATH":/ProgFiles/MySQL/mysql-connector-java-5.0.7/mysql-connector-java-5.0.7-bin.jar:
CLASSPATH="$CLASSPATH":$JAVAEE_HOME/lib/mail.jar:
CLASSPATH="$CLASSPATH":$JAVAEE_HOME/lib/activation.jar:
CLASSPATH="$CLASSPATH":$JAVAEE_HOME/lib/javaee.jar:
echo "Using
CLASSPATH: $CLASSPATH"
· Login to Sun Java System Application Server Admin Console at e.g. http://localhost:4848/
· Go to Application Server -> JVM Settings -> Path Settings. Add following to field “Classpath Suffix”:
<database
selected JDBC driver classes path>;E:/ProgFiles/java_ee_sdk-5-u2/domains/domain1/applications/j2ee-modules/em/
· Save, Re-start Application Server
Product electronic online documentation supplied can be accessed from link:
Help->Documentation
Look for
em_param_en_US.properties file in deployed application dir em\
Oracle: Verify and set following database parameter values :
em.db.oracle.url=jdbc:oracle:thin:@127.0.0.1:1521:XE
em.db.oracle.user=<db user>
em.db.oracle.password=<db password>
MySQL: Verify and set following database parameter values :
em.db.mysql.url=
jdbc:mysql://localhost:3306/EMDB
em.db.mysql.user=<db
user>
em.db.mysql.password=<db
password>
MS SQL Server: Verify and set following database parameter values :
em.db.mssql.url=jdbc:sqlserver://localhost;databaseName=EMDB;serverName=localhost\\SQLEXPRESS;
em.db.mssql.user=<db
user>
em.db.mssql.password=<db
password>
MS Access (ODBC): Verify and set following database parameter values :
em.db.access.url=jdbc:odbc:EMAJSP
em.db.access.user=<db user>
em.db.access.password=<db
password>
To run emutil java utility programs and batch programs:
Add CLASSPATH to Java Util classes (in addition to J2EE JDK classpaths):
set
TOMDIR=E:\Work_em_local\ProgFiles\apache-tomcat-6.0.14
set
CLASSPATH=%TOMDIR%\webapps\em\WEB-INF\classes;%TOMDIR%\webapps\em\WEB-INF\lib\emlib.jar;E:\ProgFiles\jdbc_drivers\oracle10\classes12.zip;E:\
ProgFiles\jdbc_drivers\mysql5\mysql-connector-java-5.0.7-bin.jar;E:\
ProgFiles\jdbc_drivers\mssqlj20\for_jdk5_jdbcspec30\sqljdbc.jar;%JAVAEE_HOME%\lib\javaee.jar;
Run the em util program, e.g.:
java emutil.EjUser_stat %
Then Sign-Up first after which you can start using product.
The registration IDs that are licensed and will work for Sign-Up/In are supplied separately.
Open the client browser window.
Enter following URL Address:
http://<machine_name>:8080/em
Select Sign Up link and register yourself. Then Sign-In with newly created User ID and Password.
NOTE: The jsp configuration parameter customization is available to only those who have license for the same. Please consult with sales/support if you are not sure about this. All the sections under Additional Installation Tasks apply to those customers having license for same.
There are jsp configuration parameters which can be set as below in file /em/jsp/BaseEmPrtl.jsp.
Parameter: TitleInb
The title displayed on Home Sign-In screen.
Parameter: TitlePrtl
If set, displays title of network / site along with EM Inbox Name.
Parameter: CopyRt
To set Copyright information for sites having hosting license.
There are other jsp configuration parameters which can be set to achieve advanced functionality, please exercise caution while changing them. They are in these files:
/em/jsp/BaseEmPrtl.jsp
/em/jsp/BaseEm.jsp
/em/custom/jsp/JspConfParam.jsp
They are highlighted in respective sections as per functionality.
To achieve this please change the jsp parameter usrproj in /em/jsp/BaseEmPrtl.jsp.
This can be changed to have new webapp context name. Please also change the value of em.param.em_usrproj to new value in em_param_en_US.properties file.
You can configure the EM instances in different ports of server or as different webapp context in a port. The instance id assigned can be used to restrict sign-in to that instance.
EM Instance |
Instance Id |
Port 8080: |
|
10 |
|
20 |
30 |
|
|
Port 9080: |
|
40 |
|
50 |
For changing the default webapp (context) name of “em” please refer to section before this. The webapp (context) must be unique within a port (but we recommend keeping it unique across server).
Upon Sign-In EM WebPlus will put user information in a cookie. The settings for cookie can be influenced by following parameters in em_param_en_US.properties file.
Section of em_param_en_US.properties file:
# Define settings / values for cookies maintaining sign-in info
# If domain and path are blank, domain is not set and Path is set to
"/".
# If you are running multiple EM instances on same server, then you
must set these
# to maintain sign-in
restricted to given instance.
# em.param.em_ck_domain: Define domain value, begin with a dot (.), as
per RFC 2109
# e.g.
em.param.em_ck_domain=.developer.easymanage.com
# or IP address (not
preferred) em.param.em_ck_domain=127.0.0.1
# em.param.em_ck_path: Define path value, as per RFC 2109
# em.param.em_ck_inst_id: Define unique id for this EM instance (incl.
port.) on server
# e.g.
em.param.em_ck_inst_id=127.0.0.1:8080/em/
# or em.param.em_ck_inst_id=10
em.param.em_ck_domain=
em.param.em_ck_path=
em.param.em_ck_inst_id=10
NOTE: Please assign a unique instance id (to parameter em.param.em_ck_inst_id) for each webapp (context) of EM on a server to have sign-in restricted to that instance.
To set secure https mode for Sign-In and Sign-Up, please change jsp configuration parameters (first 2 parameters shown below) in above file. The session can be left as secure or switched back to http mode by setting up next 2 parameters.
Section of /em/jsp/BaseEmPrtl.jsp:
Original Code:
// **************** Begin: Configure
Secure Mode Options ****************
//Https Sign-In/Sign-Up options
int secSignInUp = 0; //0=No, 1=Yes
String secURLPrefix = ""; //e.g.
https://<domain>:port (without trailing "/" )
//e.g. https://127.0.0.1:8443
//From https switch to http after sign-in
or sign-up
int switchToHttp = 0; //0=No, 1=Yes
String switchToHttpURLPrefix =
""; //e.g. http://<domain>:port (without trailing "/"
)
//e.g. http://127.0.0.1:8080
// **************** End : Configure Secure Mode Options
****************
Change Code To:
// **************** Begin: Configure
Secure Mode Options ****************
int secSignInUp = 1; //0=No, 1=Yes
String secURLPrefix =
"https://127.0.0.1:8443"; //e.g. https://<domain>:port (without
trailing "/" )
//e.g. https://127.0.0.1:8443
//From https switch to http after sign-in
or sign-up
int switchToHttp = 1; //0=No, 1=Yes
String switchToHttpURLPrefix =
"http://127.0.0.1:8080"; //e.g. http://<domain>:port (without
trailing "/" )
//e.g.
http://127.0.0.1:8080
// **************** End : Configure Secure Mode Options
****************
In order to restrict Sign-Up by general people to limited ones, invitation code checking can be enabled. To configure the checking of valid invitation codes for Sign-Up, please change jsp configuration parameters (as shown below) in above file.
The invitation codes can be configured for Group level, User level or combined Group + User. The user entered Group and User codes are checked against siCodeList string array: siCodeList[n][0] is Group code and siCodeList[n][1] is User code.
Setting of siCodeCheck parameter:
Section of /em/jsp/BaseEmPrtl.jsp:
Original Code:
// **************** Begin: Sign-Up
Invitation Code checking ****************
int siCodeCheck = 0; //Check Invitation code on Sign-Up?
//0=No, >0=Yes:
1=User Or Group, 2=User && Group
//Message for Invitation
code on Sign-Up screen
String siCodeMsg = "Please request
codes to <a
href=\"mailto:support@easymanage.com\">support@easymanage.com</a>.";
String[][] siCodeList = {
// GroupCode, UserCode
{ "Group 1", "User 1" }
, { "Group 1", "User 2" }
, { "Group 2", "User 1" }
};
// **************** End: Sign-Up
Invitation Code checking ****************
Change Code To:
// **************** Begin: Sign-Up
Invitation Code checking ****************
int siCodeCheck = 1; //Check Invitation code on Sign-Up?
//0=No, >0=Yes:
1=User Or Group, 2=User && Group
//Message for Invitation
code on Sign-Up screen
String siCodeMsg = "Please request
codes to <a href=\"mailto:your_email@your_domain.com\">
your_email@ your_domain.com</a>.";
String[][] siCodeList = {
// GroupCode, UserCode
{ "Group 1", "User 1" }
, { "Group 1", "User 2" }
, { "Group 2", "User 1" }
};
// **************** End: Sign-Up
Invitation Code checking ****************
EM Products are configured to support UTF-8 character encoding (charset or character set). The database to be used should be created and configured to support UTF-8, and the JDBC connection url should include extension to support Unicode UTF-8.
e.g. MySQL JDBC URL:
em.db.mysql.url=jdbc:mysql://localhost:3306/EMDB?useUnicode=true&characterEncoding=utf8
Note: Changing
the default encoding is not recommended but if you need
to change it for some reason, try following these steps. The new encoding must
be java supported Character Encoding e.g. ISO-8859-1, UTF-16, US-ASCII, etc.
Please refer to JDK
To change default encoding to other java supported encoding e.g. to ISO-8859-1, Following configuration parameters and locations need to be updated:
e.g. Changing one of the location
Existing:
<init-param>
<param-name>requestEncoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
Change To:
<init-param>
<param-name>requestEncoding</param-name>
<param-value>ISO-8859-1</param-value>
</init-param>
· To use default encodings for your platform and application server / container, please remove string UTF-8, leaving the parameter value null at all places.
Change To:
<init-param>
<param-name>requestEncoding</param-name>
<param-value></param-value>
</init-param>
EM License (EmLicense.class): Using, Applying, Upgrading:
EM License is supplied in a java class file named ‘EmLicense.class’. The License is pre-marked for a particular product build and with a unique License Id. Interchanging License file with other environments and releases, than those it has been marked for, is not allowed and is not compatible.
To upgrade or to apply the new License received, please follow these steps:
Supported Runtime:
Sun Application Server 9.0 (J2EE SDK 5.0 with JDK 5 Update 12)
Additional tools/jars needed:
Update following in build.properties :
jaxm.home=E:/ProgFiles/jaxm1.1.2
sh.exe, cp.exe, ls.exe, echo.exe
The SDK Product is supplied in directory:
sdk
The WsGen tool is supplied in directory:
sdk\wsgen
Copy this dir to desired directory of your hard-disk. E.g. c:\emv50\sdk\wsgen
The wsgen directory has mostly static files and has following configuration file which needs to be updated for your environment, please review README.txt in this dir for further instructions (also detailed somewhere below for reference):
build.properties
NOTE: The WsGen tool is for implementing SOA (Service-Oriented Architecture) for enterprises. The actual Web Services Java source generated by WsGen are created under folder specified in configuration parameter: “em.file_dest_dir”. And when you need to compile those, the files in wsgen dir above are needed.
Make sure CLASSPATH for EM classes is set as described in “Configure Application Server CLASSPATH” section before.
The WsGen generates the java and xml source files for jaxb, jaxws, jaxm and clients (jaxws, jaxm).
Depending upon the selection the source is generated, following illustrates sample generated source tree.
Examples:
em.file_dest_dir= E:\tmp\em_files\
The WsGen generated source is under:
WSGEN
So, Java web services source generated by user “DEMO” would be in folder (with Id 10127) :
E:\tmp\em_files\WSGEN\DEMO\WS_10127
The sub-dirs under this folder are like:
.
./common
./TableServices
./TableServices/common
./TableServices/common/jaxb
./TableServices/CUSTOMER
./TableServices/CUSTOMER/jaxb
./TableServices/CUSTOMER/jaxb/src
./TableServices/CUSTOMER/jaxm
./TableServices/CUSTOMER/jaxm/etc
./TableServices/CUSTOMER/jaxm/src
./TableServices/CUSTOMER/jaxws
./TableServices/CUSTOMER/jaxws/etc
./TableServices/CUSTOMER/jaxws/src
./TableServices/CUSTOMER/jaxwsClient
./TableServices/CUSTOMER/jaxwsClient/src
./TableServices/CUSTOMER/schema
./WPServices
./WPServices/common
./WPServices/common/jaxb
./WPServices/Wp2
./WPServices/Wp2/jaxb
./WPServices/Wp2/jaxb/src
./WPServices/Wp2/jaxm
./WPServices/Wp2/jaxm/etc
./WPServices/Wp2/jaxm/src
./WPServices/Wp2/jaxws
./WPServices/Wp2/jaxws/etc
./WPServices/Wp2/jaxws/src
./WPServices/Wp2/jaxwsClient
./WPServices/Wp2/jaxwsClient/src
./WPServices/Wp2/schema
To compile the jaxb, web services, deploy them and clients use following:
cd E:\tmp\em_files\WSGEN\DEMO\WS_10127
sh.exe c:\emv50\sdk\wsgen\cpbldfl.sh
This will copy the static files from “sdk\wsgen” to the directory structure under Ws_10127 and this will also create ant build file build.xml (which can make ant calls for all sub-dirs).
To run ant for all sub-dirs type:
ant
To run ant for specific sub-directories, cd to that directory and then run ant e.g.:
cd .\WPServices\Wp2\jaxb
ant all
For more information
please refer to “sdk\wsgen\README.txt “. It is also pasted below for reference.
README
- EM WsGen (Using EM Web Service Generation Tools)
---------------------------------------------------------------------------------
Please update the file build.properties with:
- Correct values for Sun Application Server
variable settings.
- Please change the values for following
variables:
javaee.home=E:/ProgFiles/java_ee_sdk-5
jaxm.home=E:/ProgFiles/jaxm1.1.2
javaee.server.passwordfile=c:/admin-password.txt
em.classes.dir=E:/ProgFiles/java_ee_sdk-5/domains/domain1/applications/j2ee-modules/em/
Set following variables on command prompt
before running ant commands:
e.g. on Windows platform -
----------------------------------------------------------------------
set JAVA_HOME=E:\ProgFiles\java_ee_sdk-5\jdk
set JAVAEE_HOME=E:\ProgFiles\java_ee_sdk-5
set path=%JAVA_HOME%\bin;%JAVAEE_HOME%\bin;%JAVAEE_HOME%\lib\ant\bin;%path%;
----------------------------------------------------------------------
In the web service main-dir, you can execute
(to run ant all for jaxb/jaxws/clients/...):
ant
In the web service sub-dir, you can execute:
ant all
ant
ant create-war
ant deploy
ant undeploy
In the web service client sub-dir, you can
execute:
ant all
ant
ant run
ant run-soap-client
Development of applications using eclipse is supported. Java web services source generated by WsGen can be imported in eclipse under Java Project.
For example user “DEMO” created web service source would be in folder :
E:\tmp\em_files\WSGEN\DEMO\WS_10127
Summary:
Create a new Java Project. Using Option Create Project from existing source. Then you can use eclipse to compile / modify and work on these web services using the ant build files under respective sub-directories.
Detailed Steps:
Select Following wizard
FileàNewàOtheràJava/Java Project
On Create Java Project Screen Select:
Project Name: WsProj10127
Select: Create New
Project from existing source.
Directory: E:\tmp\em_files\WSGEN\DEMO\WS_10127
Click Next.
Java Settings Screen displayed.
Click Finish.
To run Ant Builds for all the web services:
In Package Explorer Right Click on WsProj10127/build.xml.
Select: Run Asà2 Ant Build
To run ant for specific sub-directories:
In Package Explorer Right Click on WsProj10127/WPServices/WSWP1/jaxb/build.xml.
Select: Run Asà2 Ant Build
Output of the command:
Buildfile:
E:\tmp\em_files\WSGEN\DEMO\WS_10127\
Trying
to override old definition of task apt
compile:
[echo]
Compiling the schema...
[xjc]
E:\tmp\em_files\WSGEN\DEMO\WS_10127\
[xjc]
Compiling
file:/E:/tmp/em_files/WSGEN/DEMO/WS_10127/WPServices/WSWP1/jaxb/WSWP1.xsd
[xjc]
Writing output to
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src
[echo]
Compiling the java source files...
[javac]
Compiling 20 source files to
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\build\classes
javadoc:
[echo] Generating
javadoc...
[javadoc]
Generating Javadoc
[javadoc]
Javadoc execution
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\FileObj.java...
[javadoc]
Loading source file E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\ObjectFactory.java...
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\QueryInfo.java...
[javadoc]
Loading source file E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\QueryLine.java...
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\QueryParam.java...
[javadoc]
Loading source file E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\RecInfo.java...
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\SchemaInfo.java...
[javadoc]
Loading source file E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\Tblall.java...
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\TblallFlds.java...
[javadoc]
Loading source file E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\TblallRecords.java...
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\WSWP1.java...
[javadoc]
Loading source file E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\WSWPScrFive.java...
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\WSWPScrFour.java...
[javadoc]
Loading source file E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\WSWPScrOne.java...
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\WSWPScrSix.java...
[javadoc] Loading
source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\WSWPScrThree.java...
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\WSWPScrTwo.java...
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\WpInfo.java...
[javadoc]
Loading source file
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\gen-src\WSWP1\jaxb\package-info.java...
[javadoc] Loading
source files for package WSWP1.jaxb...
[javadoc]
Constructing Javadoc information...
[javadoc] Standard
Doclet version 1.6.0
[javadoc]
Building tree for all the packages and classes...
[javadoc] Building
index for all the packages and classes...
[javadoc]
Building index for all classes...
[javadoc]
Generating
E:\tmp\em_files\WSGEN\DEMO\WS_10127\WPServices\WSWP1\jaxb\docs\api\stylesheet.css...
[javadoc] 1
warning
run:
[echo]
Running the sample application...
[java]
JAXBElement Name / Declared Type : {http://emws50.WSWP1/jaxb/WSWP1}WSWP1 /
class WSWP1.jaxb.WSWP1
[java] WSWPScrOne : Tblall : Records :
[java] Name : ABCD_string
[java] Num : 1234
[java] Flt : 1234.56
[java] Dt : 2006-06-01-05:30
[java] Dttm :
2006-06-01T14:10:00-05:30
[java] Tm : 14:10:00-05:30
[java] Bln : false
[java] HyLn : HyperLink_string
[java] TxtS : ABCD_string
[java] Txt : ABCD_string
[java] File :
[B@9446e4
[java] RecInfo : 1 , 10010
[java] WpInfo : 1 , 1
[java] END : WSWPScrOne : Tblall : Records
:
BUILD
SUCCESSFUL
Total
time: 9 seconds
Chapter 2: EM Configuration Parameters
|
This section describes configuration parameters for EM 5.0 Server.
Database
JDBC drivers supported are (not changeable):
em.param.em_dur_def_si_timeout
em.param.em_easy_qry_form
em.param.max_records_sql_limits
em.param.em_app_mail
em.param.em_enable_cust_html
em.param.em_disp_htmlObj
em.param.em_check_si_dur_days
em.param.em_tp_sharing_enable
em.param.em_tp_sharing_code
em.param.em_sem_tags_enable
em.db.<database>.<param>:
Database
Details:
em.db.oracle.url=jdbc:oracle:thin:@127.0.0.1:1521:ORA10G
em.db.oracle.user=jspuser
em.db.oracle.password=jsppass
em.db.mssql.url=jdbc:sqlserver://localhost:1433;databaseName=EMDB;
#em.db.mssql.url=jdbc:odbc:EMDB
em.db.mssql.user=jspuser
em.db.mssql.password=jsppass
em.db.access.url=jdbc:odbc:EMADB
em.db.access.user=jspuser
em.db.access.password=jsppass
em.db.mysql.url=jdbc:mysql://localhost:3306/EMDB
em.db.mysql.user=emdb
em.db.mysql.password=emdb
em.db.db2.url=jdbc:db2:EMDB
em.db.db2.user=emdb
em.db.db2.password=emdb
em.db.sybase.url=jdbc:sybase:Tds:localhost:5000/EMDB
em.db.sybase.user=emdb
em.db.sybase.password=emdb
em.param.em_db_type:
em.param.em_db_type=default
em.param.em_mail_out:
em.param.em_mail_out=<smtp<127.0.0.1<<
em.param.em_mail_in:
em.param.em_mail_in=<pop3<127.0.0.1<<
em.param.records_per_form:
em.param.records_per_form=10
em.param.da_records_per_form:
em.param.da_records_per_form=100
em.param.max_records_per_form:
em.param.max_records_per_form=20
em.param.file_upload_size_kb:
em.param.file_upload_size_kb=2048
em.param.file_download_size_kb:
em.param.file_download_size_kb=2048
em.param.file_dest:
em.param.file_dest=1
em.param.file_dest_dir:
em.param.file_dest_dir=D:\\tmp\\em_files
em.param.max_table_fields:
em.param.max_table_fields=40
em.param.max_table_keys:
em.param.max_table_keys=5
em.param.max_query_lines:
em.param.max_query_lines=5
em.param.style_class_ids:
em.param.style_class_ids=1
em.param.data_owner_change:
em.param.data_owner_change=2
em.param.em_user_lkup:
em.param.em_user_lkup=<Student:10043:C<Student:0:C<
em.param.em_user_da:
em.param.em_user_da=<DEMO<John<
em.param.em_user_<User
Type>:
em.param.em_user_developer=
em.param.em_user_application=
em.param.em_user_selfapp=
em.param.em_user_apponly=<DEMO1<DEMO2<
em.param.em_user_advanced=<DEMO<CONSUMER<
em.param.em_user_portal=
em.param.em_user_content=
em.param.em_user_su:
em.param.em_user_su=<DEMO<PortalSecurity<
Reserved For Future
Use:
em.param.em_user_appsu:
em.param.em_tg_<AppId>:
em.param.em_tg_DEMO=>1>0><1<1<1<><[:CONSUMER:YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY:[:John:YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY:[<[:TEST:YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY:[:Student:YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY:[<[:CONSUMER:YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY:[:DEMO:YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY:[<>
em.param.em_tg_tagp_DEMO=<[(LR(|1|Agreement|1|1|||||(|3^Agree||4^DisAgree||5^Neutral||([(L1(|7|Approvals|1|1|S||||(|8^Approve||9^Reject||([(LM(|30|Action|1|1|M|3|||(|32^Accepted||33^In
Process||34^Forwarded||35^Need Info||36^Need
Enhancement||37^Invalid||([(L1(|50|Preference|1|1|B||||(|52^Like It||53^Do Not
Like||([(L1(|55|Rating|1|1|||||(|56^Excellent||57^Good||58^Average||59^Needs
Improvement||60^Unsatisfactory||([(LF(|80|Provide Feedback|1|1|100|15|||(|82^Price
Wish||83^Preferred Color||([(LV(|90|Vote For This Rec|1|1|C|92|||(|92^Vote
Yes||93^Vote No||([(LV(|100|Vote My Preferred
Color|1|1|R||||(|102^Red||103^Blue||104^Metallic||([<<[(IC(|200|Icon
Group|1|1|||||(|202^I1001||203^I1002||([<
em.param.em_block_users_apps:
em.param.em_block_users_apps=<DEMO<CONSUMER<PortalSecurity<
Optional Parameters:
#
--------------------------------------------------------------------------------------
#
em.param.em_dur_def_si_timeout [30]: In minutes -
# Default SignIn timeout duration from
last activity
em.param.em_dur_def_si_timeout=120
# em.param.em_easy_qry_form
[0]: 0=No, 1=enable easy keywords in table qry form.
em.param.em_easy_qry_form=1
#
em.param.max_records_sql_limits [0]: Max no of records fetched in sql qry
# 0=No Max Limit,
Optimum value = 1000, -1=Disable : <enable_hvy_qry[1|0]<TblQry<PwrSrhDv<UsrSrh<PwrSrhOther<MultAppSrh<PSrh<CSrh<ColSrh<Othr<
em.param.max_records_sql_limits=<1<1000<1000<100<0<0<0<0<0<0<
#
em.param.em_app_mail :
<DisableFILE_MailComp<DisableFILE_MailImp<NotImpl:DisableFILE_Collab<fill1<fill2<
# 0=No, 1=disable
em.param.em_app_mail=<0<0<0<0<0<
#
em.param.em_seq_id_grp : For Odbc Sequence Id Table Group Suffix
em.param.em_seq_id_grp=
#
em.param.em_enable_cust_html [0]:
<FormProp<WP_Exec<My_Menu<Uploaded App Help
Files<ProfilePublic<fill1<
# 0=No, (1+)=yes : 1=yes Safe Html + HREFs,
2= +images, 3= +iframe tags, 4= +videos/audio, xml data / OBJECT / embed tags,
5= +script tag
em.param.em_enable_cust_html=<2<2<2<1<1<0<
#
em.param.em_disp_htmlObj :
<DispHtmlObjForFileStream<DispHtmlObjForHyLnk<DispHtmlObjForText<DispTextHtmlEditor<DispDatePicker<filler<
# For DispHtmlObjForFileStream ,
DispHtmlObjForHyLnk :
# 0=No, (1+)=yes : 1=yes images/code/text
win, 2= videos/audio, 3= enable iframe tag, 4= enable OBJECT / embed tag as
well
# For DispHtmlObjForText :
# 0=No, (1+)=yes : 1=yes Safe Html + HREFs,
2= +images, 3= +iframe tags, 4= +videos/audio, xml data / OBJECT / embed tags,
5= +script tag
# For DispTextHtmlEditor , DispDatePicker
:
# 0=No, 1=yes
em.param.em_disp_htmlObj=<2<2<2<1<1<0<
# em.param.em_check_si_dur_days
[0] : If enabled, Permitt User Si as per setting
# 0=No Check, >=1
: allow Si if user's CL_
# OR if user's create date is
> (Today - em_check_si_dur_days)
em.param.em_check_si_dur_days=0
#
em.param.em_tp_sharing_enable [0]: 0=No, 1=enable sharing / publishing to third
party sites like facebook
em.param.em_tp_sharing_enable=1
em.param.em_tp_sharing_code=
\
<!-- AddThis
Button BEGIN --> \n \
<div
class="addthis_toolbox addthis_default_style " style="float:
right;" \n \
EMURL \n \
EMTITLE \n \
EMDESC \n \
> \n \
<a
class="addthis_button_preferred_1"></a> \n \
<a
class="addthis_button_preferred_2"></a> \n \
<a
class="addthis_button_preferred_3"></a> \n \
<a
class="addthis_button_preferred_4"></a> \n \
<a
class="addthis_button_compact"></a> \n \
<a
class="addthis_counter addthis_bubble_style"></a> \n \
</div> \n \
<script
type="text/javascript">var addthis_config =
{"data_track_clickback":true};</script> \n \
<script
type="text/javascript"
src="http://s7.addthis.com/js/250/addthis_widget.js#pubid=YourPubIdOnAddThis"></script>
\n \
<!-- AddThis
Button END -->
# optinal custom
values
# <div
class="addthis_toolbox addthis_default_style " \n \
#
addthis:url="EMURL" \n \
#
addthis:title="EMTITLE"
\n \
#
addthis:description="EMDESC" \n \
# > \n \
#
em.param.em_sem_tags_enable [0]: 0=No, 1=enable semantic tags in display
em.param.em_sem_tags_enable=1
#
--------------------------------------------------------------------------------------
Note: After making any changes re-start the JSP Container for new values to
take effect.
Order of
reading file is as below (Keep looking in next file till parameter is found):
The user
property is specified as a string with parts mentioned below:
<CL_PARAM_FLG<CL_PARAM_VAL<CL_PARAM_CONF_FLG<CL_PARAM_CONF_VAL<
Where:
CL_PARAM_FLG =
Values "" : Default, |
"UserPlan" : UserFile then Plan File | "Plan" |
"User"
e.g. "Plan" will look for:
em_param_<PlanName>_en_US.properties
CL_PARAM_VAL = ‘PlanName|User Id’
CL_PARAM_CONF_FLG = same as
CL_PARAM_FLG
CL_PARAM_CONF_VAL = ‘PlanName|User Id’
e.g. "Plan" will look for:
em_param_conf_<PlanName>_en_US.properties
Usage
scenarios:
e.g.
"<New Prop>" = <UserPlan<|Plan25|DEMO|<<<
e.g.
"<New Prop>" = <Plan<|Plan10||<<<
e.g.
"<New Prop>" = <User<||CONSUMER|<<<
Example
usage scenario: Assign “Plan10” to user ‘DEMO’, and user file ‘DEMO10’ as well.
E:\>java emutil.EjUser_prop
Needs User
parameters eg. ...
java <program>
"User Id"
java <program>
"User Id" "User Sec Id" "UpdateProp"
"<New Prop>"
Where "<New Prop>" =
"<em_param flag<em_param value<em_param_conf flag<em_par
am_conf
value<"
e.g.
"<New Prop>" = <UserPlan<|Plan25|DEMO|<<<
e.g.
"<New Prop>" = <Plan<|Plan10||<<<
e.g.
"<New Prop>" = <User<||CONSUMER|<<<
E:\>java emutil.EjUser_prop DEMO
//localhost:3306/EMDB?useUnicode=true&characterEncoding=utf8]
----------------------------------------------------------------
Parameters Received:
DEMO, , , ,
----------------------------------------------------------------
User -Status -User Sec Id -[E-Mail, Updated]
----------------------------------------------------------------
DEMO VALID 10002
[<UserPlan<|Plan10|DEMO10|<<<]
-----------------Over-------------------------------------------
03/07/2011
03:33:24.166 PM IST Mon :
>>clse db conn
E:\>java emutil.EjUser_prop DEMO 10002
UpdateProp "<UserPlan<|Plan10|DEMO10|<<<"
//localhost:3306/EMDB?useUnicode=true&characterEncoding=utf8]
----------------------------------------------------------------
Parameters Received:
DEMO, 10002, UpdateProp, <UserPlan<|Plan10|DEMO10|<<<,
----------------------------------------------------------------
User -Status -User Sec Id -[E-Mail, Updated]
----------------------------------------------------------------
DEMO VALID 10002
[<UserPlan<|Plan10|DEMO10|<<<]
----------------------------------------------------------------
Database Updated:
User = DEMO
User Sec Id = 10002
New Prop = <UserPlan<|Plan10|DEMO10|<<<
Table: EM_USER Updated Records: 1
----------------------------------------------------------------
Table: EM_USER *** Updated WHERE PARENT USER Records: 3
-----------------Over-------------------------------------------
03/07/2011
03:33:41.166 PM IST Mon :
>>clse db conn
Note: All the EM Mail and Collaboration
Ids (EMMAIL9999 / EMAPP 9999) created by user also get the User property
assigned.
em.param.em_mail_out
em.param.em_mail_in
em.param.em_mail_param
em.param.records_per_form
em.param.da_records_per_form
em.param.em_user_da
em.param.max_records_per_form
em.param.file_upload_size_kb
em.param.file_download_size_kb
em.param.em_block_users_apps
(Default set to ALL)
em.param.em_easy_qry_form
em.param.em_app_mail
em.param.em_tg_<AppId|ALL>
em.param.em_tg_tagp_<AppId|ALL>
em.param.em_tg_ext_<AppId|ALL>
em.param.em_enable_cust_html
(Excluding WP_Exec parts)
em.param.em_disp_htmlObj
em.param.em_check_si_dur_days
Chapter 3: Java Utility Programs, Batch Jobs
|
This section describes EM supplied java utility programs and batch jobs that
can be run from Windows Command or MS-DOS prompt.
Following is the
list of java utility classes present in emclasses.jar, their names begin with
“Ej”. They are in package “emutil” :
The utility programs are in package “emutil”, Please run them as
below:
java emutil.EjCateg_tot_rep
Following section
describes usage, shows examples of using these utility programs and parameters required:
EjCateg_tot_rep.class:
Reports total number
of categories by category type for every EM User ID in database.
D:\emv50>java
emutil.EjCateg_tot_rep
Needs
User parameters eg. ...
java
<program> "User Id"
D:\emv50>java
emutil.EjCateg_tot_rep %
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
User
Id Category Type Total
-------------------------------------------------------------
DEMO tbl [ 4 ]
DEMO txt [ 4 ]
DEMO wpj [ 3 ]
DEMOUSR
txt [ 3 ]
------------Over------------
>>clse db conn
EjCtgTree.class:
Displays or
Populates Category Tree structure for ODBC database types, used by Inbox to
display Tree.
D:\emv50>java
emutil.EjCtgTree
Needs
User parameters eg. ...
java
<program> "User Id" "Categ Id"
java
<program> "User Id" "Categ Id" "ReGenerate"
D:\emv50>java
EjCtgTree DEMO 200
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
CL_USER
- CL_CATEG_ID - CL_PARENT_CATEG_ID - CL_CATEG_TYPE - CL_
-----------------------------------------------------------------------
DEMO
10072 200 wpj 200:1:
DEMO
10070 200 tbl 200:2:
DEMO
10069 200 tbl 200:3:
DEMO
10066 200 tbl 200:4:
DEMO
205 200 txt 200:5:
DEMO
10077 205 tbl 200:5:1:
>>clse db conn
EjSeq_id.class:
Displays Sequence
Ids used for generating unique numbers for categories, tables, fields, etc.
D:\emv50>java
emutil.EjSeq_id
Needs
User parameters eg. ...
java
<program>
java
<program> "<Sequence>"
java
<program> "<Sequence>" "Reset" "<New
Value>"
Where: "<Sequence>"=[
D:\emv50>java
EjSeq_id
----------------------------------------------------------------
Parameters
Received:
----------------------------------------------------------------
Sequence -[ Current Db Value ]
----------------------------------------------------------------
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
USER [ 1026 ]
FIELD [ 10148 ]
CATEG [ 10077 ]
QRY [ 10017 ]
WP [ 10006 ]
SCREEN [ 10011 ]
-----------------Over-------------------------------------------
>>clse db conn
D:\emv50>java
EjSeq_id USER Reset 1030
----------------------------------------------------------------
Parameters
Received: USER, Reset, 1030,
----------------------------------------------------------------
Sequence -[ Current Db Value ]
----------------------------------------------------------------
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
USER [ 1026 ]
----------------------------------------------------------------
Database
Updated:
Seq = USER
New Val = 1030
Updated
Records: 1
-----------------Over-------------------------------------------
>>clse db conn
EjSql.class:
Utility class to
check database type and connection status, connects and displays only 1 User ID
record from database, evenif there are more.
D:\emv50>java
emutil.EjSql
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
DEMO
>>clse db conn
EjTable_ad_rep.class:
Reports for each
user, table id, table name: number of archived and deleted records.
D:\emv50>java
emutil.EjTable_ad_rep
Needs
User parameters eg. ...
java
<program> "User Id"
D:\emv50>java
emutil.EjTable_ad_rep %
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
User
Id Table Id Table Name Total
-------------------------------------------------------------
DEMO 10066
"Address Book"
[Archived = 1 ]
DEMO 10066
"Address Book"
[Deleted = 1 ]
DEMO 10070
"employee"
[Deleted = 1 ]
------------Over------------
>>clse db conn
EjTable_ln_data_rep.class:
Linked table data
records report. Reports for each user, linked table id, table name: number of
total, archived, deleted, valid, in accessible total and in accessible detail
records.
NOTE: In accessible
detail records may/will appear for more than one table Id for the given User
Id.
D:\emv50>java
emutil.EjTable_ln_data_rep
Usage:
java <program> <User Id> <Table Name>
Reporting:
<User Id=
<<
make db conn [access 20100 jdbc:odbc:EMADB]
EM Table Linked : Actual Physical Table Data
Report:
---------------------------------------------------------------
Table
Name Tbl Id User [Db Prop / Db Ops]
---------------------------------------------------------------
<<
make db conn [access 20100 jdbc:odbc:EMADB]
---------------------------------------------------------------
tblall_upd 10039
DEMO [ / ]
[ Total Records = 384 ]
[ Deleted = 382 ]
[ Archived = 0 ]
[ Valid = 2 ]
[ In Accessible Total = 0 ]
---------------------------------------------------------------
tblall_upd_New 10040 DEMO [ / ]
[ Total Records = 10 ]
[ Deleted = 0 ]
[ Archived = 0 ]
[ Valid = 9 ]
[ In Accessible Total = 1 ]
In Accessible Rec # 10761 [ (Detail)
0 ]
>>clse db conn
------------Over------------
>>clse db conn
e.g. showing running
report for a specific User and table name wild card search:
D:\emv50>java
emutil.EjTable_ln_data_rep DEMO tblall_upd_N
<<
make db conn [access 20100 jdbc:odbc:EMADB]
Reporting
user ids like: [DEMO%]
Reporting
table names like: [tblall_upd_N%]
EM Table Linked : Actual Physical Table Data
Report:
---------------------------------------------------------------
Table
Name Tbl Id User [Db Prop / Db Ops]
---------------------------------------------------------------
<<
make db conn [access 20100 jdbc:odbc:EMADB]
---------------------------------------------------------------
tblall_upd_New 10040 DEMO [ / ]
[ Total Records = 10 ]
[ Deleted = 0 ]
[ Archived = 0 ]
[ Valid = 9 ]
[ In Accessible Total = 1 ]
In Accessible Rec # 10761 [
(Detail) 0 ]
>>clse db conn
------------Over------------
>>clse db conn
EjTable_data_cln.class:
Header class used by
EjTable_data_arccln.class and
EjTable_data_delcln.class. WILL
NOT
D:\emv50>java
emutil.EjTable_data_cln
Exception
in thread "main" java.lang.NoSuchMethodError: main
EjTable_data_arccln.class:
Batch job program to
Clean-Up Archived data records for all users.
CAUTION: Will actually completely remove (i.e. physically deletes) data records from EM Tables My Table and physical tables.
CAUTION: This program does not take back-up of
archived data records. Make sure Archived data is extracted and backed-up from
database before running this job.
D:\emv50>java
emutil.EjTable_data_arccln
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
Em
Job Data Clean-Up: Deleted/Archived Flag = 1
-------------------------------------------------------------
Table:
Table:
NUM Records: 0
Table:
FLT Records: 0
Table:
BOOL Records: 0
Table:
TEXT Records: 0
Table:
TEXTS Records: 1
Table:
DATE Records: 1
Table:
BLOB Records: 1
Table:
CLOB Records: 0
[Info
about physical table deletes here…]
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
Physical
Table: tblall_upd (User:DEMO, Tbl Id:10039)
Records: 2
>>clse db conn
Table:
EM_USER_
>>clse db conn
EjTable_data_delcln.class:
Batch job program to
permanently Clean-Up Deleted data records for all users. CAUTION: Will
actually completely remove (i.e. physically deletes) data records from EM
Tables My Table and physical tables.
Recommended to run
at least twice a week.
D:\emv50>java
emutil.EjTable_data_delcln
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
Em
Job Data Clean-Up: Deleted/Archived Flag = 0
-------------------------------------------------------------
Table:
Table:
NUM Records: 1
Table:
FLT Records: 2
Table:
BOOL Records: 0
Table:
TEXT Records: 0
Table:
TEXTS Records: 1
Table:
DATE Records: 2
Table:
BLOB Records: 1
Table:
CLOB Records: 0
[Info
about physical table deletes here…]
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
Physical
Table: tblall_upd (User:DEMO, Tbl Id:10039)
Records: 382
>>clse db conn
Table:
EM_USER_
>>clse db conn
EjTable_tot_rep.class:
Reports for each
user, table id, table name: number of total data records (excluding archived
and deleted).
D:\emv50>java
emutil.EjTable_tot_rep
Needs
User parameters eg. ...
java
<program> "User Id"
D:\emv50>java
emutil.EjTable_tot_rep %
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
User
Id Table Id Table Name Total
-------------------------------------------------------------
DEMO 10077
"Address Book" [ 1 ]
DEMO 10066
"Address Book" [ 3 ]
DEMO 10070
"employee" [ 8 ]
DEMO 10069
"tt" [ 5 ]
------------Over------------
>>clse db conn
EjUser_remove.class:
Utility program to
remove an EM User and all associated data from database. The User ID to be
removed MUST be marked for removal by program EjUser_Stat first.
D:\emv50>java
emutil.EjUser_remove
Needs
User parameters eg. ...
java
<program> "User Id" "User Sec Id"
"RemoveGoAhead"
Warning: This program deletes all data
associated with given User Id
EjUser_set_pref.class:
Utility program to
define User’s EM table to use particular list of group of EM System tables.
Although prefixed the program implementation will be available in next release.
D:\emv50>java
emutil.EjUser_set_pref
Needs
User parameters eg. ...
java
<program> "User Id"
java
<program> "User Id" "User Sec Id" "Prefix
List"
Where: "Prefix List"=[One or more
prefix separated by comma, "NULL"=Reset to blank] e.g. "EM_
EjUser_stat.class:
Utility program to
query on and display status of EM User Id.
D:\emv50>java emutil.EjUser_stat
Needs
User parameters eg. ...
java
<program> "User Id"
java
<program> "User Id" "Sorting Option" "User Sec
Id" "New Status"
Where: "Sorting
Option"= [Def/IdUp/IdDown/ CreatedDown/ UpdatedDown]
Where: "New
Status"=[Disable/Enable/UnRegister/Remove]
D:\emv50>java emutil.EjUser_stat DEMO
<< make db conn [odbc 20100 jdbc:odbc:EMAJSP]
----------------------------------------------------------------
Parameters
Received: DEMO, , ,
----------------------------------------------------------------
User -Status -User Sec Id -[E-Mail, Updated]
----------------------------------------------------------------
DEMO
VALID 1021 [demo@demo.demo, 2002-08-12
DEMOUSR
VALID 1024 [demousr@d.d, 2002-08-12
-----------------Over-------------------------------------------
>>clse db conn
D:\emv50>java
emutil.EjUser_stat DEMOUSR Def 1024 Disable
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
----------------------------------------------------------------
Parameters
Received: DEMOUSR, 1024, Disable,
----------------------------------------------------------------
User -Status -User Sec Id -[E-Mail, Updated]
----------------------------------------------------------------
DEMOUSR
VALID 1024 [demousr@d.d, 2002-08-12
----------------------------------------------------------------
Database
Updated:
User = DEMOUSR
User Sec Id = 1024
New Status = DISABLED
Table:
EM_USER Updated Records: 1
-----------------Over-------------------------------------------
>>clse db conn
D:\emv50>java
emutil.EjUser_stat DEMOUSR
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
----------------------------------------------------------------
Parameters
Received: DEMOUSR, , ,
----------------------------------------------------------------
User -Status -User Sec Id -[E-Mail, Updated]
----------------------------------------------------------------
DEMOUSR
DISABLED 1024 [demousr@d.d, 2002-09-06
-----------------Over-------------------------------------------
>>clse db conn
EjUser_IdChg.class:
Utility program to
change a User Id to new one.
D:\emv50>java emutil.EjUser_IdChg
Needs
User parameters eg. ...
java
<program> "User Id"
java
<program> "User Id" "User Sec Id" "New Id"
D:\emv50>java
EjUser_IdChg DEMO 1004
EjUser_tbl_set_pref.class:
Utility program to
define EM table to use particular group of EM System tables. Although prefixed
the program implementation will be available in next release.
D:\emv50>java
emutil.EjUser_tbl_set_pref
Needs
User parameters eg. ...
java
<program> "User Id"
java
<program> "User Id" "User Sec Id" "Table
Id"
java
<program> "User Id" "User Sec Id" "Table
Id" "Prefix"
Where: "Table Id"=[Valid Id of the
Table, "0"=All Tables]
"Prefix"=[One prefix to be
assigned, "NULL"=Reset to blank] e.g. "EM_
EjUser_tsh_cln.class:
Batch job program to
permanently Clean-Up Trash Folder objects, categories, table, data records for
all users. Recommended to run at least twice a week.
D:\emv50>java
emutil.EjUser_tsh_cln
<<
make db conn [odbc 20100 jdbc:odbc:EMAJSP]
Em
Job Trash COMPLETE Clean-Up :
-------------------------------------------------------------
Table:
EM_USER_CATEG_DET Records: 0
Table:
EM_USER_CATEG_
Table:
EM_USER_WEBPROJ Records: 0
Table:
EM_USER_FORMS Records: 0
Table:
EM_USER_TBLFK Records: 0
Table:
EM_USER_
Table:
EM_USER_FORMS_
Table:
EM_USER_QRY Records: 0
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_FIELDS Records: 0
-------------------------------------------------------------
Em
Job Deleted Field COMPLETE Clean-Up :
-------------------------------------------------------------
Table:
EM_USER_FORMS_
Table:
EM_USER_QRY Records: 0
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_
Table:
EM_USER_CATEG_DET Records:
2
Table:
EM_FIELDS Records: 2
>>clse db conn
D:\emv50>
EjSql_AccCrTbl.class:
Batch job program to
create SQL schema (tables, views, indexes) for MS Access database. To be run
only once during installation. Uses the supplied special file emtbl_acc.sql
(with commands delimited with “go”) for dropping and re-creating database
tables.
WARNING: This
program drops tables and re-creates them! PLEASE
D:\emv50>java
emutil.EjSql_AccCrTbl
Needs
parameters eg. ...
java
<program> "CREATE" "<path>emtbl_acc.sql"
EjUser_passwd.class:
Utility program to
reset password of EM User Id.
D:\emv50>java emutil.EjUser_passwd
Needs
User parameters eg. ...
java
<program> "User Id"
java
<program> "User Id" "User Sec Id"
"ResetPassword" "<New Password>"
D:\emv50>java EjUser_passwd DEMO
<< make db conn [access 20100 jdbc:odbc:EMADB]
----------------------------------------------------------------
Parameters
Received: DEMO, , , ,
----------------------------------------------------------------
User -Status -User Sec Id -[E-Mail, Updated]
----------------------------------------------------------------
DEMO
VALID 1002 [s@s.c, 2003-02-26
-----------------Over-------------------------------------------
>>clse db conn
D:\emv50>
java emutil.EjUser_passwd DEMO 1002 ResetPassword guesswhat
<<
make db conn [access 20100 jdbc:odbc:EMADB]
----------------------------------------------------------------
Parameters
Received: DEMO, 1002, ResetPassword, guesswhat,
----------------------------------------------------------------
User -Status -User Sec Id -[E-Mail, Updated]
----------------------------------------------------------------
DEMO
VALID 1002 [s@s.c, 2003-04-08
----------------------------------------------------------------
Database
Updated:
User = DEMO
User Sec Id = 1002
New Password = guesswhat
Table:
EM_USER Updated Records: 1
-----------------Over-------------------------------------------
>>clse db conn
EjLicInfo.class:
Utility program to
display License Information Details. It will display products licensed,
edition, build information, database supported. The Licensee details and User
ID’s licensed (as supplied in license and/or specified in configuration
parameter file) are also displayed.
D:\emv50>java emutil.EjLicInfo
===== LICENSE INFORMATION =========================================
** Product : EMSTE50 - EM
WebPlus Suite 5.0
With
: EMSVR50 - EM WebPlus
Server 5.0
: EMSTD50 - EM WebPlus
Studio 5.0
: EMCNT50 - EM WebPlus
Content Mgmt 5.0
: EMPRT50 - EM WebPlus
Portal 5.0
Edition : Standard Edition
** Build : EM-A0520-200-020-500-P00-D103103
Database : access, Db No:20100
** Licensed To : Organization/Company/Individual Name
Location Id : 1111111111
License Desc : Trial License - Only for
Evaluation or Demo purposes
Lic. # Desc : 2 Developers, 2 Apps, 5 AppOnly, 1 Portal, 1 Content
** Lic Expiry Dt:
** Allow Setting (Table Fields, Keys, Query
Lines) param values in Conf. file ? : Yes
**
Allowed Database Connections: oracle mssql access (access is default)
** Db
=====
LICENSED USER ID
-----
[developer] User Ids: -----------------------------
Check
User Id Licensed or Not ? : Yes
User
Ids are : Supplied in
License
Licensed
Number Of User Ids : 2
Valid
User Ids detected are :
<DEMO<CONSUMER<
-----
[application] User Ids: -----------------------------
Check
User Id Licensed or Not ? : Yes
User
Ids are : Supplied in
License
Licensed
Number Of User Ids : 2
Valid
User Ids detected are :
<DEMO<CONSUMER<
-----
[selfapp] User Ids: -----------------------------
Check
User Id Licensed or Not ? : Yes
User
Ids are : Supplied in
License
Licensed
Number Of User Ids : 2
Valid
User Ids detected are :
<DEMO<CONSUMER<
-----
[apponly] User Ids: -----------------------------
Check
User Id Licensed or Not ? : Yes
User
Ids are : Supplied in
License (+) Can be defined in Conf param file.
Licensed
Number Of User Ids : 5
Valid
User Ids detected are :
<DEMOAPPUSR<<DEMO1<DEMO2<
-----
[advanced] User Ids: -----------------------------
Check
User Id Licensed or Not ? : Yes
User
Ids are : Supplied in
License (+) Can be defined in Conf param file.
Licensed
Number Of User Ids : 2
Valid
User Ids detected are :
<DEMO<CONSUMER<
-----
[portal] User Ids: -----------------------------
Check
User Id Licensed or Not ? : Yes
User
Ids are : Supplied in
License
Licensed
Number Of User Ids : 1
Valid
User Ids detected are :
<DEMO<
-----
[content] User Ids: -----------------------------
Check
User Id Licensed or Not ? : Yes
User
Ids are : Supplied in
License
Licensed
Number Of User Ids : 1
Valid
User Ids detected are :
<DEMO<
=====================================================================
Chapter 4: Administering EM 5.0
|
This chapter discusses various issues relating to administering EM 5.0.
When running EM 5.0, a runtime Log is displayed on the Command or MS-DOS window. Change buffer size of this window to hold 200-400 lines. Any user problems can be tracked on this window for any EM system error messages and warnings. Also monitor user access activities including sign-in, sign-out, failure on sign-in checks, etc.
Tomcat: environment allows options to keep log and it’s location specifications. Set-up the logging as per your needs and monitor the log file for above mentioned checks.
Monitor the EM Files location (em.param.file_dest_dir) supplied
in EM Parameters file for disk space. It keeps the
files for
The DBA or EM 5.0 Administrator needs to monitor database for normal maintenance reasons. However when the EM Users are using advanced features like:
the monitoring should be more vigilant as
these powerful features, if used erroneously, can seriously affect database
consistency or performance.
Please make sure that database permissions
granted to the user id specified as “em.db.<dbtype>.user” in configuration file (em_param_en_US) are
appropriate for your installation.
The EM 5.0 Administrator needs to run periodically the maintenance batch jobs (java util classes discussed earlier), e.g.:
Twice a week:
Data Record
Deleted Clean-Up
Trash complete
Clean-up
Once a week:
As needed:
Extract, Back-Up
Archived data records and Data Record Archives Clean-Up
For internationalization of OS, database, desktops, Web Server, Please follow the relevant OS, database documentation for configuring language, character sets, etc. Use EM 5.0 Profile screen to choose appropriate formats. The Java programs and browser will support the international character sets as per the international configurations of OS or desktops they are running from.
You can customize
Looks and feel and other functions as supplied in Options (User Profiles, etc),
EM Configuration Parameters.
Advanced SQL (Post Process, Modifiers): If using these you need access to
DBA. We do not support the actual usage issues except when they relate to
underlying problems in provisions of our software product. Customizing EM 5.0
for one database type will restrict you to that database environment, unless
migrated manually.
JSP customization:
Changes to JSP files supplied, made by customers themselves, are not supported
and can lead to: data in-consistency, security loopholes and or other problems.
The EM software
product can be implemented in different Models. It can use:
Multiple Web Servers
Multiple Databases with User segregation
We advise you to
seek consulting help from us for any advanced sizing and scaling issues.
Software support
provided depends upon the type of License and Support purchased by customer.
When provisioned, for any software installation,
use or other issues please contact the re-seller or if purchased from
EasyManage.com, then via email at:
support@easymanage.com.
Please supply your
contact information, description of the issue with log details, screen
captures, etc as relevant.
Chapter 5: Migrating From EM AFE Rel 4.0 to EM 5.0
|
CAUTION: EM AFE Release 4.0 database schema will not work
with EM 5.0 Release, it needs to be upgraded first!
When Migrating from EM AFE Release 4.0 to EM 5.0 Release,
specific tasks need to be performed. Following consideration is desired:
·
Always
fully back-up the previously installed versions, databases, work and user
stored files, etc before installing new versions.
·
Perform
the migration in off-line mode i.e. after shutting down application servers,
databases completely.
·
Since EM
5.0 Release uses database schema enhancements, the Release 4.0 database schema
will not work with EM 5.0 Release, it needs to be upgraded to work with new
release.
·
For
further assistance please email to support@easymanage.com.
Appendix A – New Features for Administrators
|
This section describes New Features in EM 5.0 for System Administrators
and DBAs.
Java components listed under System Requirements will be required to use enhanced functions in this release.
Allows EM Users to compose and send application as well as table data as xml files to other users who can receive/upload the files and import the App-Data Mail. Monitor the EM Files location (em.param.file_dest_dir) supplied in EM Parameters file for disk space as Mail Compose/Uploaded Files can take lot of space based on User activity.
Allows anonymous users to search for Portlets, Content and collaborations and execute them. Monitoring performance is desirable for this. Also educate EM Users on setting Portal Search parameters on User Registration and WebProject Screen Forms.
EasyManage Platform
Copyright © 2021 EasyManage.com
All Rights Reserved.