GraFx Studio Connector - Document Lifecycle
Introduction
The "Document Lifecycle"-Extension for "GraFxPublisher-Connector" provides a comprehensive overview about the document lifecylce in a Magento system.
Features Overview:
- Tracking of document states within the Magento system - from the first editing, to a draft and to finished and ordered document.
- All changes are tracked in a document history which is accessible from the backend
- Several Massactions available
Document Overview
GraFxStudio->GraFx Document Lifecycle
Find all relevant documents details at one place:
| Table Column | Type | Description | Editable |
|---|---|---|---|
| document | String | document_id of document - refers to item_id of chili server | No |
| created_at | Date_Time | Datetime of document creation | No |
| updated_at | Date_Time | Datetime of last document updated | No |
| current template | String | document_id of current template for document - refers to item_id of chili server | No |
| Template | String | document_id of template for document - refers to item_id of chili server | No |
| document_backup | String | document_id of document, which is stored, before the "Master Template Update"-Function is used | Yes |
| template_backup | STring | document_id of template, which is stored, before the "Master Template Update"-Function is used | Yes |
| template_changed_at | Date | document_id of template, which is stored, before the "Master Template Update"-Function is used | Yes |
| update_master_template_status | String | Status of "Master Template Update" process. Possible values are "Success, "Error" | No |
| entity_type | String | Possible values are: temp, quote_item, sales_order_item, wishlist_item, workflow_item | No |
| entity_id | String | id of entity - refers to entity_type | No |
| store_id | String | store_id where the document belongs to | No |
| product_id | String | id of product of document/ template | No |
| parent_product_id | String | id of parent_product of document/ template in case of a configurable product | No |
| sku | String | sku of product of document/ template | No |
| relation_id | String | Id of relation of customer (in case of related entities) | No |
| relation_account_number | String | accountnumber of relation of customer (in case of related entities) | No |
| relation_account_name | String | accountname of relation of customer (in case of related entities) | No |
| user_email | String | email of user (could to different from customer_email in case of manual backend editing etc. | No |
| customer_email | String | email of user | No |
| user_type | String | Type of user (frontend, Backend) | No |
| scope | String | Type of user (frontend, Backend) | No |
| item action | Action | possible values are: "new", "edit", "add", "approved", "delete", "requested" | No |
| Update_Master_Template_Status | String | Possible Values are: "empty" | No |
| Info | String | Type of user (frontend, Backend) | Yes |
Document History
Each Document has a history with the following values:
| Table Column | Type | Description | Editable |
|---|---|---|---|
| Id | Int | Unique Id of History Entry | No |
| Document | String | Unique Document Id of GraFx Environment | No |
| Template | String | Unique Template Id of GraFx Environment (Source of document) | No |
| Created at | Datetime | Date of Creation | No |
| Updated at | Datetime | Date of Update | No |
| Entity_Type | String | Entity to which the document belongs to | No |
| Storeview | String | Storeview to which the document belongs to | No |
| product_id | String | Id of product to which the document template belongs to | No |
| parent_product_id | String | Id of parent product (in case of configurable products) | No |
| customer_id | String | Id of customer (owner of document) | No |
| customer_email | String | Email of customer (owner of document) | No |
| entity_id | String | ??? | No |
| sku | String | Sku of product of document template | No |
| relation_id | String | Id of relation of customer (in case of related entities) | No |
| relation_account_number | String | accountnumber of relation of customer (in case of related entities) | No |
| relation_account_name | String | accountname of relation of customer (in case of related entities) | No |
| user_email | String | Email of customer (owner of document) | No |
| user_type | String | Type of user (frontend, Backend) | No |
| scope | String | Type of user (frontend, Backend) | No |
| last action | String | Type of user (frontend, Backend) | No |
| Info | String | Type of user (frontend, Backend) | Yes |
| action | Action | Edit data | No |
Supported Entity Types
- temp
- quote_item
- wishlist_item
- sales_order_item
- document_workflow_item
Actions
Update Master Template (Massaction)
- Stores current document as a backup-document with a new id. Stores this document-id to the document lifecylce.
- Loads current template from product, loads values of current document and saves values into current document id. (So it creates a new document with an old document id)
Options:
- Keep existing snippets: placed snippets will stay in document. If deactivated, placed snippets will be removed from the document
- keep existing datasource values: datasource values will remain in document. If deactivated, the datasource values will be removed
- keep existing variable values: values of variables will stay in document. If deactivated, the values will be deleted
Restore Backup Document (Massaction)
- Restore an old document version and store this instead of current document.
Preview Download
- Renders a document preview (based on the preview settings) and downloads it in the backend
Required Extensions
"enobis/module-grafx-studio-connector"
Install
Magento2.x and composer
To install the extension use composer via ssh:
composer require enobis/module-xxx
Afterwards you have to update your Magento2.x installation by
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:clean
php bin/magento indexer:reindex
Support
If you need help using the extension, please get in touch with us by sending an email to support@enobis.de.
Changelog
1.1.2 (2026-04-09)
-
2026-04-09Logging removed from the module (f493764) -
2026-04-09Version: 1.1.2 (e75a1a1)- Logging removed from the module
1.1.1 (2026-03-23)
-
2026-03-23- Fallback: Retrieve the missing data from the relation or product in the special case where wishlist items are copied. (0b0f3cd) -
2026-03-23Version: 1.1.1 (a398c1f)- Fallback: Retrieve the missing data from the relation or product in the special case where wishlist items are copied.
1.1.0 (2026-03-10)
-
2026-03-10Drop PHP7.4support (198dbd7) -
2026-03-10Allow PHP8.3(5739d7d) -
2026-03-10Tweak code (43a29eb) -
2026-03-10Merge branch 'php83-compat' into dev (684e0d1) -
2026-03-10Version 1.1.0 (3c2ad67)Allow PHP 8.3
#14375
1.0.0 (2025-04-09)
-
2025-04-09Version 1.0.0 (02b7613)Bump version
0.1.0 (2025-04-09)
-
2025-04-03Tweak code (a7006ab) -
2025-04-03Remember installed or uninstalled date in system (a29f11f) -
2025-04-03Add exceptions (ff72890) -
2025-04-03Add system configuration (6383125) -
2025-04-03Add grafx document lifecycle admin menu entry (83550e0) -
2025-04-03Add apis (0b91ede) -
2025-04-03Add models (9dedd7c) -
2025-04-03Tweak code (ef0f095) -
2025-04-03Add grafx document lifecycle db table (abcac2f) -
2025-04-03Update unit test setup traits (07a19fa) -
2025-04-03Tweak code (b9e9eb3) -
2025-04-03Add helper (ea18524) -
2025-04-03Add Lifecycle updates (3d8ff6c) -
2025-04-03Tweak code (1a68c7e) -
2025-04-04Update unit test setup traits (3e39f05) -
2025-04-07Add observers (8f3aae5) -
2025-04-07Tweak code (3fc9683) -
2025-04-07Update unit test setup traits (13d057d) -
2025-04-07Update unit tests (193356a) -
2025-04-07Tweak code (586d1bf) -
2025-04-08Add grafx document lifecycle admin ui (b632d74) -
2025-04-09Uodate unit tests (31fb852) -
2025-04-09Tweak code (d13b337) -
2025-04-09Add change document owner to grafx_document_lifecycle edit form in backend (510b42f) -
2025-04-09Tweak code (b4794b2) -
2025-04-09Tweak code (c2b1de9) -
2025-04-09Version 0.1.0 (7a39912)First release
0.0.1 (2025-04-03)
2025-04-03Module base files (5faf4a3)