Jingga/Organization-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Organization-Guide.git synced 2026-01-24 02:08:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix name

Browse Source
This commit is contained in:
Dennis Eichhorn 2022-02-19 14:51:23 +01:00
commit 8363799348
6 changed files with 52 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Policies & Guidelines/Confidentiality Policy.md
View File

@ -15,8 +15,8 @@ This policy affects all organization members, participants and affiliates who ma
Confidential information is defined as either
* technical information, including patent, copyright, trade secret, and other proprietary information, techniques, sketches, drawings, models, inventions, know-how, processes, apparatus, equipment, algorithms, software programs, software source documents, and formulae related to the current, future and proposed products and services regarding "Orange Management", or
* non-technical information relating to "Orange Management" products, including without limitation pricing, margins, merchandising plans and strategies, finances, financial and accounting data and information, suppliers, customers, customer lists, purchasing data, sales and marketing plans, future business plans and any other information which is proprietary and confidential to this project.
* technical information, including patent, copyright, trade secret, and other proprietary information, techniques, sketches, drawings, models, inventions, know-how, processes, apparatus, equipment, algorithms, software programs, software source documents, and formulae related to the current, future and proposed products and services regarding "Karaka", or
* non-technical information relating to "Karaka" products, including without limitation pricing, margins, merchandising plans and strategies, finances, financial and accounting data and information, suppliers, customers, customer lists, purchasing data, sales and marketing plans, future business plans and any other information which is proprietary and confidential to this project.
Members, participants and affiliates may have different levels of authorized access to confidential information.
@ -36,13 +36,13 @@ Members, participants and affiliates may have different levels of authorized acc
## Exceptions
Confidential information may occasionally have to be disclosed for legitimate reasons. In such cases, the holder of the confidential information should document their disclosure procedure and collect all needed authorizations from senior organization members. During this process it may be required by the receiver of the confidential information to sign a non-compete and/or non-disclosure agreement (NDA).
Confidential information may occasionally have to be disclosed for legitimate reasons. In such cases, the holder of the confidential information should document their disclosure procedure and collect all needed authorizations from senior organization members. During this process it may be required by the receiver of the confidential information to sign a non-compete and/or non-disclosure agreement (NDA).
Disclosing more information than needed must be avoided.
## Consequences
Disrespecting this policy possibly leads to legal actions.
Disrespecting this policy possibly leads to legal actions.
## Survival

6
Processes/Onboarding/Onboarding Cheat-Sheet.md
View File

@ -2,7 +2,7 @@
**How to initially setup the codebase?**
* run: `git clone -b develop https://github.com/Orange-Management/Orange-Management.git`
* run: `git clone -b develop https://github.com/Karaka-Management/Karaka.git`
* run: `git submodule update --init --recursive`
* run: `git submodule foreach git checkout develop`
@ -20,10 +20,10 @@ js: Jasmine
**How to run unit tests?**
* php:
* php:
* run in main directory: `php -d pcov.enabled=1 vendor/bin/phpunit -c tests/phpunit_no_coverage.xml `
* also possible for submodules if you want to test only a specific submodule (e.g. phpOMS)
* js:
* js:
**How to run code inspection?**

2
Processes/Onboarding/Onboarding Q&A.md
View File

@ -51,7 +51,7 @@ Yes, although only very few libraries.
* Static code analysis (phpstan)
* run: Build/Helper/testreport.sh
* run: `php -d pcov.enabled=1 vendor/bin/phpunit tests/phpunit_default.xml`
* It's recommended to run this in the Orange-Management/* main directory
* It's recommended to run this in the Karaka/* main directory
* Running this in the main directory will run all tests, also for the submodules (e.g. phpOMS, Modules, ...)
**Where are the config files for the different developer tools**

13
Project/Module Features.md
View File

@ -276,6 +276,9 @@ The client management module is for handling client data for companies.
| ----------------------- | ------------------------------------------------------------ |
| Profile | Client profile view showing customer data |
| Analysis | Sales analysis (sales, profit, cross selling potential, purchasing behavior, ...) |
| Accounts | Accounts can be assigned to clients which allows a client to manage its own data to an extend (e.g. download invoices) |
| References | Create references to other clients/suppliers |
| Attributes | Custom attributes which can be created and filled (optional or mandatory) |
### Supplier Management
@ -285,6 +288,9 @@ The supplier management module is for handling supplier data for companies.
| ----------------------- | ------------------------------------------------------------ |
| Profile | Supplier profile view showing supplier data |
| Analysis | Purchase analysis (costs, profit with purchased goods, prize increases, purchasing behavior, ...) |
| Accounts | Accounts can be assigned to suppliers which allows a supplier to manage its own data to an extend |
| References | Create references to other clients/suppliers |
| Attributes | Custom attributes which can be created and filled (optional or mandatory) |
### Item Management
@ -294,6 +300,13 @@ The item management module is for handling item/article data for companies.
| ----------------------- | ------------------------------------------------------------ |
| Profile | Item profile view showing item data |
| Analysis | Item analysis (sales, costs, prize increases, purchasing behavior, ...) |
| Parent items | Parent items allow to share files across child items without duplicating the files (e.g. data sheets) |
| Part list | Items used by/for this article (e.g. for production) |
| Machine list | Machines assigned for production/processing |
| Process list | Create process/production steps to be followed |
| Lot/SN | Items may have a LOT/SN and version (e.g. for documents) |
| Garbage | Information about the materials used for the product (e.g. for disposal regulations) |
| Attributes | Custom attributes which can be created and filled (optional or mandatory) |
### Warehouse Management

40
Project/PROJECT.md
View File

@ -18,15 +18,20 @@ Last update of this file: 2022.01.01
##### Framework
*
*
##### Media
* Added the reference media type (similar to collections) which allows to create references to existing media. This is ideal for showing the same media file in different places while making sure that deleting or changing the reference doesn't effect the actual media file.
* Create collection directories recursively (similar to `mkdir` with a recursion flag set to true)
##### Frontend
*
*
#### Bug fixes
*
*
#### Other
@ -49,11 +54,11 @@ Continue with milestone task implementation.
## Milestones
Based on the pilot candidate with whom the functionality will be implemented.
Based on the pilot candidate with whom the functionality will be implemented.
* The current costs are the annual value for the pilot candidate based on actual costs but subjectively split into more detailed cost positions (the invoices from the suppliers are not always detailed enough to differentiate between the different functions/modules).
* The current costs are the annual value for the pilot candidate based on actual costs but subjectively split into more detailed cost positions (the invoices from the suppliers are not always detailed enough to differentiate between the different functions/modules).
* The future costs are costs that currently don't exist but are expected to come up in the future if the pilot candidate intends to implement **some** of the current software needs.
* The new value is an estimation of how much the newly implemented software (Orange Management) will subjectively provide compared to current/future solutions. These are **NOT** the costs for the pilot candidate or cost savings. The costs for this will be discussed afterwards.
* The new value is an estimation of how much the newly implemented software (Karaka) will subjectively provide compared to current/future solutions. These are **NOT** the costs for the pilot candidate or cost savings. The costs for this will be discussed afterwards.
| Deadline | Done | Milestone | Current Costs | Future Costs | New Value |
| -------- | ---- | ------------------------------------------------------ | -------------- | -------------- | -------------- |
@ -79,7 +84,7 @@ Based on the pilot candidate with whom the functionality will be implemented.
### Cost basis
The estimated annual costs in the milestones above are based on the total annual costs from the software from the pilot candidate.
The estimated annual costs in the milestones above are based on the total annual costs from the software from the pilot candidate.
| Type | License | Customization | Total |
| -------------- | -------------- | -------------- | -------------- |
@ -205,6 +210,7 @@ The following overview tries to compare competitive software alternatives as fai
| | Sales | Allow to create visitor report on cell phone by using location matching (geolocation) |
| | Sales | Analyze reports per sales rep (e.g. use filter for export?) |
| | Item Management | Implement Names, base data, media files |
| | Item Management | Implement parent item which can hold information (e.g. files) which can be used across all children |
| | Item Management (SD) | Expand GSD Exchange importer to also import articles *(SD specific)* |
| | Billing | Basic invoice data (no stock movement) |
| | Billing (SD) | Expand GSD Exchange importer to bills *(SD specific)* |
@ -305,9 +311,9 @@ The following overview tries to compare competitive software alternatives as fai
#### Archived
| Deadline | Done | Category | Task |
| -------- | ---- | -------- | ---- |
| | | | |
| Deadline | Done | Category | Task |
| -------- | ---------- | -------- | ------------------------------------------------------------ |
| | 2022.02.12 | Media | Allow to create references (use type similar to 'collection' e.g. 'reference'). This way it is clear that it is only a reference and can never delete the actual file. |
## Todos
@ -484,7 +490,7 @@ Todos/tasks which are not important enough to be part of the milestones (or don'
| low | DataMapperAbstract | Implement data binding |
| low | DataMapper | Use `Mapper::class` or string names in the mappers. At the moment both can be found. This is not concise. The `Mapper::class` name is preferred in case of name changes. |
| low | Email | Find a way to localize some hard coded email content. Pass localization array? Manually overwrite email body if a hard coded/default message should be returned (maybe by checking for a flag/status code)? |
| low | Temp directory | Consider to create a temp directory in the main directory (Orange-Management) which can be used by all modules etc. Alternatively create this temp directory in `Modules/Media/Files` |
| low | Temp directory | Consider to create a temp directory in the main directory (Karaka) which can be used by all modules etc. Alternatively create this temp directory in `Modules/Media/Files` |
| low | DataMapper / ModelFactory | Some models may require special initialization. For such cases a model factory should be implemented and used by the data mapper. One solution could be to create a default `ModelFactory` which behaves as the current DataMapper functions which set/update the model members. This factory could be extended in case custom behavior becomes necessary. In the Mapper you would just have to define a `const FACTORY` constant which references the factory to use (instead of the default one). Since there hasn't been a situation where this was necessary it will not be implemented until we actually need this (it would additional overhead which maybe never becomes necessary) |
| low | Editor | Create special markdown content (calendar, chart, task, news, comment, media, ...) |
| low | Editor | Allow download as markdown, text, PDF, word |
@ -513,7 +519,10 @@ Todos/tasks which are not important enough to be part of the milestones (or don'
| low | Media | Implement external resources (URLs, dropbox, aws, ...) |
| low | Media | Allow to edit the breadcrumbs, which replaces them with a text field which can be changed then than automatically loads the new path |
| low | Media | Implement temporary file storage (very useful for making files downloadable for a limited time). Maybe create a new temp file directory or database collection where a available_until timedate gets defined (must be handled in the database). The biggest problem is how to delete them, this requires a background process/task scheduler. Additionally, these files must have permissions because they may be only for one user or a group of users |
| low | Media | Show virtual path in media view, maybe similar to the table view. This allows the user to jump to any parent directory |
| low | Media | List data from online drives such as dropbox, google drives, AWS |
| low | Media | Mark media elements as system elements (e.g. to prevent delete/name changes) |
| low | Media | Mark elements as deleted (this way the element can still exist with references but the content is removed). Maybe change the purpose of `isHidden` to `status` with different status codes (e.g. hidden, active, deleted) |
| low | Knowledgebase | Make docs versioned |
| low | Editor | Make docs versioned |
| low | Messages | Allow to transform a message as task |
@ -555,12 +564,17 @@ Todos/tasks which are not important enough to be part of the milestones (or don'
| low | BasicOcr | Implement image reading for non-mnist files (either convert to mnist or use something else) |
| low | Directory | If the object oriented/node version of the local file handler changes files the already loaded nodes need to be updated (e.g. when calling delete, add, ...) |
| low | ModuleManager | The basic module install function expects `dbPool`, `info`, ... while the external installer expects `app`. It makes more sense for both to expect the same data. Consider to pass `app` in the normal module installer as well. |
| low | TextAnalysis | Implement text similarity algorithms (https://medium.com/@adriensieg/text-similarities-da019229c894) |
| low | Image | Implement image de-noising (consider https://www.hindawi.com/journals/complexity/2021/5578788/) |
| low | Image | Fix kernel 5x5 implementation with `imagecolersat` and `imagecolerat` (https://rosettacode.org/wiki/Image_convolution). Currently not doing anything. |
| low | Image | Improve adaptive thresholding (consider https://homepages.inf.ed.ac.uk/rbf/HIPR2/flatjavasrc/AdapThresh.java) |
#### Archived
| Priority | Done | Category | Task |
| -------- | ---------- | -------- | ------------------------------------------------------------ |
| low | 2022.01.02 | News | In order to show which news are seen and which are not seen the `NewsSeen` model needs also to reference the article, currently only the user is referenced. Of course this doesn't work! |
| medium | 2022.02.13 | Media | Create recursive collection creator function similar to mkdir with the recursive flag. |
## Bugs
@ -609,7 +623,7 @@ Steps:
2. Create sub definitions such as quantity/unit, single price, total price, ...
3. How to identify end of list?
4. How to handle multiline line elements (e.g. detailed article/service description)
5. How to automatically find account (e.g. article number, description, template definition)?
5. How to automatically find account (e.g. article number, description, template definition)?
Software:
@ -645,7 +659,7 @@ if (!$hasPermission) {
->types([null, PermissionState::MEDIA])
->permission(PermissionType::READ)
->query(MediaMapper::PRIMARYFIELD);
$mapper->where($permWhere);
}

8
Strategy/Business Plan.md
View File

@ -2,7 +2,7 @@
## Organization
The Orange Management organization is located in Germany and founded in November 2015 by Dennis Eichhorn for developing the Orange Management application and sub-components which incorporates solutions such as CRM, SRM, CMS, ERP, Shop and many more.
The Karaka organization is located in Germany and founded in November 2015 by Dennis Eichhorn for developing the Karaka application and sub-components which incorporates solutions such as CRM, SRM, CMS, ERP, Shop and many more.
The main goal of the organization is to create solutions for companies and organizations of all sizes which allow them to seamless manage their operations from one application.
@ -72,8 +72,8 @@ The main goal of the organization is to create solutions for companies and organ
#### Vision
* **Early:** Orange Management solutions are used by at least 1.000 organizations/businesses in 2025
* **Late:** Orange Management is one of the industry standard solution provider for organizations and businesses
* **Early:** Karaka solutions are used by at least 1.000 organizations/businesses in 2025
* **Late:** Karaka is one of the industry standard solution provider for organizations and businesses
##### Goal
@ -206,7 +206,7 @@ In the following a ranking of numbers (1-10) will be used where 10 is the highes
| Easy to install on own server/pc | no | yes | yes | yes | yes | yes | no | no |
| Availability on third party hosts | 10 | 7 | 7 | 7 | 7 | 7 | 8 | 9 |
The decision why Orange Management decided to use PHP came down to the following points:
The decision why Karaka decided to use PHP came down to the following points:
1. Since the web applications are supposed to run on all sizes of organizations and businesses PHP has the advantage with availability on simple (cheap) webservers.
2. The request based code execution makes it less susceptible against errors (re-starting and monitoring the application etc.) and therefore better for non-tech people.