*********************************
** O C D **
** Eve Online Corp Database **
** **
*********************************
Summary:
Eve OCD is an onlne shared data warehouse for Eve Online Corporation management. Data for a corporation is pulled using CCP's
API Interface and stored in MySQL Tables. A web interface allows for reporting of the stored data and exporting to Excel on any
registerd users local machine.
Installation Guide ...
Prerequisites:
A Web server with ...
PHP 5.3+
MySQL 5.1
Apache 2.2.4 / 2.2.25 or IIS7
The software has been tested to work on Windows based hosts with PHP 5.3, MySQL 5.1 and IIS 7 and on Unix hosts with
PHP5.3. MySQL 5.5 and Apache 2.2.24 and 2.2.25. Other versions of these components probably work but have not been tested. Note that
versions less than PhP5.3 are definitely not supported and may break.
Whats In the Box:
Everything else you need is in the ZIP file.
The tool comes with the following components included ...
- Yii Framework 1.1.14 Note that the Yii Framework Gii tool has been tweaked to allow GIIX to generate CRUD code that supports composite keys.
- Pheal. The API interface uses the Pheal interface developed by Peter Petermann (c) 2010
- A bunch of ~really usefull~ Yii Extensions and modules that make life so much easier for PhP development. The most important modules are ...
- RIGHTS This module controls access to all of the displays. Several pre-configured "roles" make defining access much easier
- "Admin" role gives full access to all displays
- "Director" role give access to all Eve Related info, but not Admin functions
- "Accountant" role give access to the corp wallet data
- "Quartermaster" role gives access to Hangar and Order information
- "Fleet Commander" role gets access to POS data and Notifications
- "Authenticated" role gives basic access
- "Guest" role denies access to everything
- USER This module controls log in rights.
- Modifying access for other users requires a "superuser" privilege. Note: This is separate from the rights module described above.
- A Complete Eve Static Database Dump for Rubicon, courtesy of Steve Ronuken -> https://www.fuzzwork.co.uk/dump/
Installing:
1. Create a suitable domain / sub-domain to host the tool.
2. Upload the ZIP file to your web host and expand it.
3. You need 2 databases - one for the Eve OCD Data and One for the Eve Online Static Dump files. These CAN be combined into the same database.
You can also use an existing database. However BACK IT UP FIRST. If there is a table name conflict your database could get trashed !!!
The tool will try to create empty databases. However, your ISP will probably not allow this. You will need to create the empty MySQL Database
manually and assign a user with privileges to it.
The installer tool does not support Table Name prefixes at the moment. However, if you install the database tables manually, you may
configure a table name prefix later. See the notes on shared hosts later in this readme.
The Eve Static Data Export is large. (about 512 MB) If your Database size is limited you may be able to remove some unused tables. However,
the largest tables in the SDE are the items database and this data is required. Consider using a Hosting Plan that doesnt limit the number of databases
or the database size. Eve OCD is developed and hosted on Hostgator (www.hostgator.com)
4. Ensure that the settings file does NOT exist. <path to web files>/protected/config/settings.ini
The settings file is created automatically. If you want to re-install the site again than you need to delete this file.
5. Navigate to ...
<your web site>/index.php/installer/install
Fill in the form and submit it.
The Eve OCD Database tables will be created and filled with some starter data for users, security and wallet names.
You will be re-directed to the login screen
6. Login as username: admin, password: admin to continue the installation
7. The Eve Static Data Export (SDE) will now be loaded. The tool comes with a copy of the Rubicon static data. Alternative versions of the
SDE can be uploaded and installed using this page. This will take a few minutes.
8. When the SDE installation is complete, continue the installation. You will be redirected to a page to install your Corp API Information.
A page link to the CCP web site is included to allow you to find and create your API key details.
<your web site>/index.php/corpApi/index
- You need to use a character with "Director" roles in the corporation
- Create a "Corporation" Key
- Give the Key access to Everything
- Set the key to "No Expiry"
9. Once your API Data is installed, you should be redirected to the Eve Online API Console page. This will allow you to test your API and upload
basic data about your corporation
<your web site>/index.php/site/console
Note ... the folowing sequence is IMPORTANT
1. Update your Corporation Details - "Corp Details". If this fails go back to step 8 and check your API key
2. Update the current list of Null Sec Conquerable Station Names - "Stations"
3. Update the Corporation Member List "Members"
10. Log Out
11. Register a User for your Director Character
<your web site>/index.php/user/registration
- The User Name must be a Corp Member. The name must match an ingame name EXACTLY and is case sensitive.
So "Captain SeNsIbLe" is NOT "Captain Sensible"
- There must be at least one Full Director API key entered so that In Game Notifications can be pulled from the API
- Use a "Character" API Key
- Allow access to everything
- Set "No Expiry"
- The API key you enter is checked against the character name and the current list of Corp members.
The registration process sends an e-mail to the user to check the address is valid. The email should arrive quite quickly.
If it doesnt, check your spam box. Confirm the registration.
12. Log in as "admin/admin" again
13. Assign "Admin" priviledges to the new user. This user will then have full access to all site pages and admin functions.
- Go to "Home" -> "User Access Rights", <your web site>/index.php/rights
- Click on the User Name you want to modify
- From the drop down list select "Admin" and Apply.
14. Log Out, Log In as the registered user.
Confirm that you can see the complete Home Menu including "Site Settings" on the far lower right.
Go to "Home"->"Site Settings"
- Select the "Must Be A Corp Member To Log In" checkbox to limit access to registered corp members only
- "Save"
Go to "Home"->"User Management"
- In the table, Select user name "Admin" and click the "Modify" icon (pencil).
- Go to the "Status" field and change it to "Banned",save
- In the table, Select user name "Demo" and click the "Modify" icon (pencil).
- Go to the "Status" field and change it to "Banned"
- In the table, Select your new username and click the "Modify" icon (pencil).
- Go to the "Superuser" field and change it to "Yes"
15. Update the rest of the Corporation Database.
Go to "Home"->"API Interface Console" or select the "Admin" tab
- Update all of the Corp Data files using each of the link buttons in turn
- If an error occurs, check the "Updater Log"
16. Configure the Scheduled Updates
The OCD Scheduler runs a single CRON job. This job then checks all of the entries in the Schedule table, and runs each
command as a CRON job at the specified interval. See your specific host documents for help on how to set up
CRON jobs.
Go to "Admin"->"Scheduled Updates" (link in the right hand menu)
For each job in the schedule, you must update the "Command" field to match your specific web host. Select each row in
the table and click the "update" (pencil) icon. Update the command field as required by your web host.The format for the command is ...
<path to>php <path to web root>/protected/yiic.php <command name>
for Hostgator accounts, the command is ...
/opt/php54/bin/php www/<your site root>/protected/yiic.php <command name>
Check with your web host for the correct syntax to use. Update all of the commands in the schedule. The possible commands are ..
updateCorpDetails
updateStations
updateCorpMembers
updateCorpAssets
updateCorpContracts
updateCorpIndustry
updateCorpKills
updateCorpNotifications
updateCorpOrders
updateCorpPOS
updateCorpTransactions
updateCorpWallets
updatePrices
updateWalletHistory
The Update "updateWalletHistory" is used to calculate the total corp valuation. It should normally be run every 24 hours.
17. Configure the master Schedule Task
The scheduler task executes all of the tasks configured in the previous steps on the scheduled interval. It must be configured using your web host
CRON job scheduler. The format for the scheduler command is
<path to>php <path to site root>/protected/yiic.php Scheduler run
For a hostgator account, the command is ...
/opt/php54/bin/php www/<your site>/protected/yiic.php Scheduler run
You can direct the output of this cron job to a log file to check on the output ...
/opt/php54/bin/php www/demo/protected/yiic.php updateCorpDetails > cronfile.log where "cronfile.log" is any path/name you wish.
Set this Scheduler task to run every few minutes.
===================
Help .. Something went wrong during the installation !
-------------------------------------------------------
To re-run the installation
1. Delete the settings file in <your web file root>/protected/config/settings.ini
2. Drop the database tables in your Database. Note, this destroys your complete database. Only do this if you know what youre doing.
- "corpWallet100x" are views and will not drop when dropping tables. Drop them individually with phpMyAdmin or SQL Drop View
- "auth" tables have key relations. Use the SQL command "SET FOREIGN_KEY_CHECKS=0;" to dispable key checking and allow you to drop the tables
3. go back to <your web site>/index.php/installer/install and try again.
You have a shared host and only one Database.
---------------------------------------------
The easiest and safest way to ensure that Eve OCD does not conflict with any tables in your existing database is to add a "prefix" to the table names.
You will need to edit the .SQL files to add the prefix to all table names
1. The OCD Database file is held in <your web file root>/protected/modules/installer/data/ocd_template.sql
2. The Eve SDE tables are held in <your web file root>/protected/modules/installer/data/sde/sde_rubicon_1.3_95173.sql
3. Edit the SQL files and replace all "INSERT INTO " with "INSERT INTO ocd_" (or any other prefix you want) using a text editor .
You already have a copy of the Eve SDE Installed
------------------------------------------------
Yes, you can use it. The table structure must be identical to the SQL files down loaded from https://www.fuzzwork.co.uk/dump/
There is a new version of the SDE
---------------------------------
Get it here -> https://www.fuzzwork.co.uk/dump/
1. Back up your existing installation
2. Go to <your web site>/index.php/installer/install/bigdump
3. Upload and install the new Database files
The Scheduled Jobs are not running as expected
----------------------------------------------
1. Check the scheduled tasks Updater Log file to see if the tasks are running
"Admin"->"Updater Log"
You should see "info" messages indicating that jobs are startign and ending
If you see "error" for missing API keys etc, check your corp and directors API keys
If you see errors you cannot solve, note the error message and raise a support ticket on the source forge Wiki
2. Check the master Scheduler cron job is running correctly.
Redirect the output of the Scheduler cron job to a file, and check for errors. You should see something like
running app...
nothing to do...
This indicates the main Scheduler task has run and found that none of the tasks need to be run at this time. (The master Scheduler runs every few minutes,
so most times there is nothing to do )
If you see an error indicating that your Tasks are not configured correctly then check with your web hosts documentation for the correct format.
3. Check the "Scheduled" time for each task. This time is EVE Time ( Also known as UTC ), not your local server or client time. Carefully check the date
and time settings and the scheduled Frequency.
Setting the Scheduled time to a date in the past will ensure the task is updated immediately the next time the master Scheduler task runs.
Download Latest Version
Eve Online Corp Database - Version 3.0.2 Release 2014-04-18.zip (91.4 MB)
