Smart Company App

Documentation

 

Basic informations

Thanks you for your purchase!

Installation

Requirements:

  • PHP: PHP 5.2 and higher
  • MySQL: MySQL 5.0 and higher
  • Yii Framework: v 1.1.12 and higher
  • Ensure that you have write permissions set (CHMOD 6xx or 7xx) for the following folders:
    • protected/vendors/mpdf/ttfontdata/ - used to cache font data; improves performance a lot
    • protected/vendors/mpdf/tmp/

Database Setup

  • Create a database in mysql (You can do it with phpMyAdmin or any other tool). The rest of the steps will be described for phpMyAdmin.
  • In phpMyAdmin, type your database name in the Create new database field, and then click on Create button.
  • After database creation, click on the Import menu, browse main directory, select setup.sql It will create database with predefined data used in Smart Company App (abbreviation - SCA)
  • Click Go to import the sql file.
  • Your database should be installed now.

Upload Files

Extract the main zip file, and then upload the sca and yii folder to your webserver.

Yii Framework Path

Open WEBROOT/sca/index.php
Change variable - $yii to yours specific path, if you have coppied yiiframework folder in other location

                    
    // change the following paths if necessary
    $yii=dirname(__FILE__).'/../yii/framework/yii.php';
                    
                

Configuration File

Open WEBROOT/sca/protected/config/main.php
Set values for:

  • 'db' array
    • host - your host name
    • dbdbname - your database name
    • username - username of your database
    • password - password to database
                    
                'db'=>array(
			'connectionString' => 'mysql:host=localhost;dbname=sca',
			'emulatePrepare' => true,
			'username' => 'root',
			'password' => '',
			'charset' => 'utf8',
		),
                    
                

User login

If you are not logged in then system will automatically redirect to login page.
Use following creditionals for first login. Then it`s advised to change these default values.

Administrator = Employer account

  • Login: admin@admin.com
  • Password: admin

Basic user = Employee account

  • Login: employee@employee.com
  • Password: employee

STARTUP GUIDE

This is a complete application. Only thing you have to do is to install it on your webserver.

It provides functionality for:

  • Timesheets management
  • Vacations management
  • Meetings management (with invitations for invited users)
  • Users management
  • Application Language Management - you can define new languages for this application.

Two kind of accounts:
  • Administrator = Employer
  • Employee
Employee functions:
  • Can create timesheet entries. How much time he spent on some task on specific day
  • Can create Vacation requests. Which have to be approved by Employer
  • Can create Meetings where he can choose which user from system will be invited
  • Can confirm or reject invitation for Meeting where he was invited
  • Can manage Meetings which he had created
  • Can choose language in which the application will be shown to him
  • Can edit his account information
  • Can change password
Employer (Administrator) functions (can do everything what employee + other functions):
  • Can create timesheet entries. How much time he spent on some task on specific day
  • Can manage employee timesheets (approve, reject or sent it back for employee`s correction)
  • Can create workspaces (projects on which employees can create timeentries, projects on which users have worked)
  • Can create Vacation requests. Which have to be approved by Employer
  • Can manage Vacation requests (approve or reject)
  • Can create Meetings where he can choose which user from system will be invited
  • Can confirm or reject invitation for Meeting where he was invited
  • Can manage Meetings which he had created
  • Can choose language in which the application will be shown to him
  • Can edit his account information
  • Can change password
  • Can manage user accounts (update, delete, block user access to application, change user role)
  • Create new user accounts
  • Manage language settiongs (delete language, create new application languages and set translation of current words to new language, edit current translations)
Now let`s see user manual for every Application module.

Dashboard widgets


Dashboard widgets which can access Employee
  1. Time Tracker
  2. Calendar
  3. Today`s vacations
  4. Not yet decided Meeting Invitations
  5. Today`s meetings
Dashboard widgets which can access Employer (Administrator account)
  1. Time Tracker
  2. Calendar
  3. Today`s vacations
  4. Not yet decided Meeting Invitations
  5. Today`s meetings
  6. Vacation Requests Waiting for Approval
  7. Timesheets Waiting for Approval
  8. Blocked Users

Time Tracker

  1. User can start time tracker (than stop it) to know how much time he spent on task.
  2. After stopping he will be redirected to Timesheet management where duration in Time entry form will be filled automaticaly with time from Time Tracker


Calendar

  1. Showing your`s future and past vacations. (green color)
  2. Showing your`s future and past meetings where you have accepted meeting invitation. (blue color)


Today`s vacations

  1. Shows which user have vacation today


Not yet decided Meeting Invitations

  1. Shows list of meeting invitations which were addressed to you
  2. Allows you to view meeting and accept / decline invitation directly from dashboard


Today`s meetings

  1. Shows today`s meetings where you were invited with invitation status


Vacation Requests Waiting for Approval

  1. Shows list of new vacation request waiting for decission
  2. Allows you to view / approve / reject user`s vacation request


Timesheets Waiting for Approval

  1. Shows list of timesheets waiting for decission (approve, reject, return for correction)
  2. Allows you to view / approve / reject / return for correction user`s timesheet. Also Export timesheet to PDF.
  3. Shows only timesheets where the month of timesheet has ended


Blocked Users

  1. Shows list of currently blocked users
  2. Allows you to activate their account directly from dashboard


Timesheet Management

Timesheet Management can access Employee and also Administrator (Employer) Here you can:
  1. View all your`s timesheets.
  2. Make action calls for Viewing a timesheet. Make action calls for Exporting timesheet to PDF.
  3. Create new Timeentry.

View Timesheet

  1. View timesheet status.
  2. View all timeentries within currently viewed timesheet.
  3. Make action calls for timesheet approval / rejection / returning for correction (possible actions depends on timesheet status) or for Exporting timesheet to PDF. You can access this actions only if you are an Employer (Administrator account).
  4. View Employer decission info (If he had already made his choice).
  5. Create new timeentry.
  6. Delete chosen timeentry.


Exported Timesheet (PDF)


Update Timesheet`s timeentry informations
Just click on higlighted field and enter new value.


Approve Vacation requests
This part can access only user with Administrator (Employer) account.

  1. View list of all Timesheets.
  2. Make action calls for View timesheet / Approve timesheet / Reject timesheet / Return timesheet for correction or for Exporting timesheet to PDF. If Employer approves or rejects timesheet then User (owner of the timesheet) cannot modify his timesheet. But when Employer decides that he return timesshet for correction to his owner, this owner can modify timesheet informations again.
  3. Create new Workspace. Workspaces are used in timesheet view. It is an item on which the user can work in your company.
  4. View list of all Workspaces with action for their deleting. List also allows inline edition of workspace data.


Reject / Approve Vacation request
When you click on approve / reject / return for correction action modal window is shown and you can provide information why you made this choice.


Vacation Management

Vacation Management can access Employee and also Administrator (Employer) Here you can:
  1. View all user`s vacation requests.
  2. List vacation requests which you have created.
  3. Make action calls. View vacation request / Update vacation request / Delete vacation request.

Crete new Meeting
In calendar select date when you want to have a vacation. (Select specific cells in calendar) Then fill out required informations.


View Vacation request

  1. View when is vacation request planned to take date (blue). Your other vacation requests (black).
  2. View basic informations about vacation request.
  3. Make action calls. Edit vacation request (if you have created this request) / Delete vacation request (if you have created this request) / Approve vacation request (if you are an Employer - administrator account) / Decline vacation request (if you are an Employer - administrator account).
  4. View Employer decission info (If he had already made his choice).
  5. View list of your`s previous vacation requests.
  6. Make action call for viewing information about this vacation request.


Update Vacation request informations

  1. View when is the vacation planned.
  2. Edit basic informations about vacation request.


Approve Vacation requests
This part can access only user with Administrator (Employer) account.

  1. View all Vacation requests in month / week / day.
  2. View list of all Vacation requests.
  3. Make action calls for View vacation request / Approve vacation request / Decline vacation request.


Reject / Approve Vacation request


Meeting management

Meeting Management can access Employee and also Administrator (Employer) Here you can:
  1. View all meetings in selected week / month / day.
  2. List meetings which you have created.
  3. Make action calls. View meeting / Update meeting / Delete meeting.
  4. List meetings to which you have been invited.
  5. Make action calls for meeting where you were invited. View meeting / Confirm invitation (Going to meeting) / Decline invitation (You are not going).

Crete new Meeting
In calendar select date and time where the meeting should be held. (Select specific cells in calendar) Then fill out required informations.


View Meeting

  1. View when is the meeting held.
  2. View basic informations about meeting.
  3. Make action calls. Edit meeting (if you have created this meeting) / Delete meeting (if you have created this meeting) / Accept invitation (if you are viewing a meeting to which you have beein invited) / Decline invitation (if you are viewing a meeting to which you have beein invited).
  4. View users which have been invited to this meeting.
  5. Delete invitation to users which have been invited to this meeting (Only if you have created meeting which you are viewing).


Update Meeting informations

  1. View when is the meeting held.
  2. Edit basic informations about meeting.


User management

User Management can access only Administrator (Employer) Here you can:
  1. List user accounts.
  2. Make action calls. View account / Update account / Delete account.
  3. Create new user accounts.
  4. Make quick action - Change user role (switch between Employee and Administrator).
  5. Make quick action - Block /Unblock user account (If the account is blocked then User is not able to login into application).

View User account

  1. View user accounts.
  2. Make action calls. Update account / Delete account / Block or Unblock action.


Update user account informations


Language Settings

Built in modification of my SimpleLanguage item whitch it used to create a multilanguage website. Language settings can access only Administrator (Employer) Here you can:
  1. Edit informations about created languages. Add new terms to dictionary.
  2. Create new languages.
  3. Change translation of words in dictionary. Define new ones for new languages. Delete terms.

Create new language
Name and abbreviation are required. Name is used for language identification and abbreviation is used in URL links.


Edit/Delete language info
Name and abbreviation are required. Name is used for language identification and abbreviation is used in URL links.


Add new terms
Term specification field is required.
Section is optional. It is set only for helping fiter results in dictionary.


Filter dictionary entries

  • Sorting ascending / descending order
  • Filter by columns
  • Find specific entry

Edit dictionary entries directly in datatable

  • Double click on column entry
  • Provide new value
  • Press submit button

My account

Alows you to:
  • View your profile
  • Logout from application

Language change

Alows you to:
  • Change default language used in application for your account

Credits

Used plugins:
THANK YOU FOR YOUR PURCHASE!