We use cookies to make your experience better. To comply with the new e-Privacy directive, we need to ask for your consent to set the cookies. Learn more.
GraFxStudio-Connector Documentation
Complete guide to configuring and using the GraFxStudio-Connector for your Magento2.x platform.
Quick Setup Guide
API Connection
Configure the connection between your Magento2.x systetem and GraFxStudio Environment.
Access Credentials
Enter the access credentials from your GraFxStudio environment in order to access it by Magento2.x
Stores → Configuration → GraFxStudio → GraFxStudio Credentials → Default Credentials → Grafx Webservice Url
By default it's the general service url "https://integration-login.chiligrafx.com"
Stores → Configuration → GraFxStudio → GraFxStudio Credentials → Default Credentials → Grafx Baseurl
E.g. "https://cp-xyz-123.chili-publish-sandbox.online/grafx"
Stores → Configuration → GraFxStudio → GraFxStudio Credentials → Default Credentials → Grafx Environment
E.g. "cp-xyz-123"
Stores → Configuration → GraFxStudio → GraFxStudio Credentials → Default Credentials → Grafx Client Id / Api User
ClientId from your GraFxStudio Integration. Please refer to the GraFxStudio documentation, how to create an integration.
Stores → Configuration → GraFxStudio → GraFxStudio Credentials → Default Credentials → Grafx Client Secret / Api Key
Client Secret from your GraFxStudo Integration
Stores → Configuration → GraFxStudio → GraFxStudio Credentials → Default Credentials → Grafx Frontend Client Id / Api User
Please enter the same ClientId as above. This is just a preparation for an upcoming feature of GraFxStudio!
Stores → Configuration → GraFxStudio → GraFxStudio Credentials → Default Credentials → Grafx Frontend Client Secret / Api Key
Please enter the same ClientSecret as above. This is just a preparation for an upcoming feature of GraFxStudio!
General Settings
Basic configuration options for the connector.
Enable Connector
Enable or disable the GraFxStudio-Connector functionality.
Stores → Configuration → GraFxStudio → GraFxStudio → Frontend → Enabled: Yes/No
Enable to activate the GraFxStudio Editor for the storefront.
GraFxStudio Userinterface
Choose between production and sandbox environments.
Stores → Configuration → GraFxStudio → GraFxStudio → Default → Grafx User Interface: Dropdown (Selection of values from GraFxStudio userinterfaces.
This is the default userinterface. Values can be overwritten for every product.
Product Configuration
Configure how GraFxStudio integrates with your product pages.
Product Attributes
Configure the product in order to activate it for customization.
Catalog → Product → Product-Detail → GraFxStudio → Grafx Enabled: YesActivate it, to enable the GraFxStudio Editor for this product.
Catalog → Product → Product-Detail → GraFxStudio → Grafx Document: Id of TemplateEnter the template-id from the GraFxStudio environment.
Catalog → Product → Product-Detail → GraFxStudio → Grafx Studio Standard Renderer Settings:
Create a renderer setting to enable the download functionality in a certain area of Magento2.x.
Available areas are: Order-Backend, Order-Frontend, Order-Email, Editor
Advanced Settings
Fine-tune the connector.
Debug Mode
Enable debug mode for troubleshooting integration issues.
Stores → Configuration → GraFxStudio → Advanced Settings → Enable Logging: Yes/No
Saves a separate communication logfile (communication between Magento and GraFxStudio API) to var/logs.
GraFxStudio Credentials (System Configuration)
Please go to "Stores → Configuration → GraFxStudio → GraFxStudio Credentials → Default Credentials"
| Parameter Name | Description | Default Value | Required |
|---|---|---|---|
| Grafx Webservice Url | API-Url to GraFx environment | None | No |
| Grafx Baseurl | Base-Url to GraFx environment e.g. "https://cp-xyz-123.chili-publish-sandbox.online/grafx" | None | No |
| Grafx Environment | E.g. "cp-xyz-123" | None | No |
| Grafx Client Id / Api User | ClientId from your GraFxStudio Integration. Please refer to the GraFxStudio documentation, how to create an integration. | None | No |
| Grafx Client Secret / Api Key | ClientSecret from your GraFxStudio Integration. Please refer to the GraFxStudio documentation, how to create an integration. | None | No |
| Grafx Frontend Client Id / Api User | Please enter the same ClientSecret as above. This is just a preparation for an upcoming feature of GraFxStudio! | None | No |
| Grafx Frontend Client Secret / Api Key | Please enter the same ClientSecret as above. This is just a preparation for an upcoming feature of GraFxStudio! | None | No |
GraFx Studio (System Configuration)
Stores → Configuration → GraFxStudio → GraFxStudio
| Parameter Name | Description | Default Value | Required |
|---|---|---|---|
| Default Values → UrlDocument Naming Type | Deprecated! How documents are organized on the GraFxStudio environment? Copies of Templates are created by the REST-API of the GraFxStudio. Each copy is stored to a given project-id in the context of the REST-API integration client. Actually it's not possible to access those environments, since they are only "virtual" accessable for the integration clients. | By Default it will fall back to the system configuration settings | No |
| Default Values → Grafx User Interface | Dropdown selection of available user interfaces of the GraFxStudio environment. | None | No |
| Frontend → Enabled | Enables GraFxStudio in storefront of Magento | Yes/ No (Default: No) | No |
| Frontend → Show Edit Document Link In Cart | Enables link in cart item row to edit the document directly. | Yes/ No (Default: No) | No |
| Frontend → Show Edit Item Link In Cart | Enables link in cart item row, to jump back to product configuration. Note: This is Magento default behaviour! | Yes/ No (Default: Yes) | No |
| Frontend → Show Edit Document Link In Wishlist | Enables link in wishlist item, to edit document. | Yes/ No (Default: No) | No |
| Frontend → Show Edit Item Link In Wishlist | Enables link in wishlist item, to edit the product configuration. Note: This is Magento default behaviour! | Yes/ No (Default: Yes) | No |
| Frontend → Assign Account Relation Attributes to Grafx Studio | @TODO: Enables Javascript preassignemtn of relation attribute values. Note: Has to be moved to different tab! | Yes/ No (Default: No) | No |
| Frontend → Add CSS to Editor-Page | @TODO: Enables custom styles for GraFxStudio editor.Important: This an experimental feature and may cause trouble! Please use the "Add UiOptions to Editor-Page" configuration to use more standard based styling options.Note: Has to be removed or moved to different tab! | Yes/ No (Default: No) | No |
| Panel Layouts → Show Price | @TODO: Shows price in GraFxStudio editor.Note: Deprecated! Will be removed with next version! | Yes/ No (Default: No) | No |
| Panel Layouts → Show Quantity | @TODO: Shows quantity field in GraFxStudio editor.Note: Deprecated! Will be removed with next version! | Yes/ No (Default: No) | No |
| Panel Layouts → Show Product Name | @TODO: Shows name of product in GraFxStudio editor. | Yes/ No (Default: No) | No |
| Button Configuration → Save and Close Button Enabled (Note that you must also enable the general wish list functionality of Magento) | Shows name of product in GraFxStudio editor. | Yes/ No (Default: No) | No |
| Button Configuration → Save Button Enabled(depends on button above!) | @TODO: Shows "save" button in GraFxStudio editor.Note: Shouldn't have dependency from button above! Shoudn't work if wishlist is disabled! | Yes/ No (Default: No) | No |
| Button Configuration → Download Button Enabled | @TODO: Shows "Download" button in GraFxStudio editor. The download button shows possible renderer and advanced renderer options. If not configured, the "Download"-button doesn't appear in storefront.NoteMay interfere with the default download button of the GraFxStudio. See below!Note: Should be "No" by default. | Yes/ No (Default: Yes) | No |
| Button Configuration → Studio UI "Integrated Download" Button Enabled | Shows default "download"-button from GraFxStudio. Note: The download renderer are attached to the user interface! Use this option carefully in conjunction with the previous option. | Yes/ No (Default: Yes) | No |
| Advanced Settings → Enable Logging | @TODO: Enables logging of communication between Magento and GraFxStudio API. Logfile is stored to var/logs. | Yes/ No (Default: No) | No |
| Advanced Settings → Add UiOptions to Editor-Page | Adds the possibility to add styling options to editor via Javascript-API.Note: Experimental feature! Maybe replaced by styling option through GraFxStuio interface! | Yes/ No (Default: No) | No |
GraFxStudio Advanced Renderer (System Configuration)
Please go to "Stores → Configuration → GraFxStudio → GraFxStudio Advanced Renderer → General"
| Parameter Name | Description | Default Value | Required |
|---|---|---|---|
| Grafx Advanced Renderer | Possibility to create an advanced renderer configuration. You can create settings with: - Label for Renderer (Shown in Frontend) -Grafx Advanced Renderer-Configuration(Created in the Magento backend at GraFx → GraFx Advanced Renderer -Display Area (Area of Magento, where the rendering is activated. Possible areas are: Order Backend, Order Frontend, Order Email, EditorNote: This is the default configuration setting. A renderer can also be defined per product. |
None | No |
GraFxStudio Configuration (Product Configuration)
Please go to "Catalog → Products → Your Product → GraFxStudio"
| Parameter Name | Description | Default Value | Required |
|---|---|---|---|
| Grafx Enabled | Enable the GraFxStudio Editor for this product. | None | No |
| Grafx Document | Valid template from GrafxStudio environment. | None | No |
| Grafx User Interface | Possiblity to override the user interface from the default store configuration. | None | No |
| Grafx Studio Standard Renderer Settings | Possiblity to create renderer settings. You can create settings with: - Label (Label for renderer which is shown in the storefront) - Grafx Standard Renderer (Dropdown selection of available renderer settings from GraFxStudio environment. - Layout: Dropdown-Selection of available layouts of the template. -Display Area (Area of Magento, where the rendering is activated. Possible areas are: Order Backend, Order Frontend, Order Email, Editor |
None | No |
| Grafx Order Digital Output | Disables Qty-Field for Checkout products (because it doesn't make sense for digital products). | None | No |
| Grafx Advanced Renderer | Enables "advanced renderer feature" Option are: - "use config" (uses settings of system configuration) - "yes" (enables advanced renderer) - "no" (disables advanced renderer |
None | No |
| Grafx Studio Advanced Renderer Settings | Possibility to create an advanced renderer configuration. You can create settings with: - Label for Renderer (Shown in Frontend) -Grafx Advanced Renderer-Configuration(Created in the Magento backend at GraFx → GraFx Advanced Renderer -Display Area (Area of Magento, where the rendering is activated. Possible areas are: Order Backend, Order Frontend, Order Email, EditorNote: If enabled this configuration will be merged with possible system configuration settings. |
None | No |
| Grafx Instant Checkout | Enables Digital Output? | None | No |
Frequently Asked Questions
How can i license the GraFxStudio-Connector? I can't find it at the Magento marketplace.
To license our GraFxStudio-Connector you have to get in touch with us first. We will have to create a valid subription first and then activate the extension-repo for you. After that, you will be able to install the connector via composer. Our GraFxStudio-Connector is not available at the Magento marketplace, because this product is tighlty bundled with the GraFxStudio environment as well. Since you have to get in touch with CHILIpublish to setup an environment first, it doesn't make sense the extension from the marketplace anonymously.
How do I update the connector?
Updates are provided through the private repo automatically. Use always composer to update the connector! E.g. composer update enobis/module-grafx-studio
Is the GraFxStudio-Connector "production ready"?
From the Magento perspective it's "production ready"! But since the GraFxStudio is "currently under development" it depends on the features you need in detail.
Missing GraFxStudio features which may prevent you from using this in production are maybe:
- Lack of flexibility to create user interfaces like you may know from workspaces of the GraFxPublisher.
- Missing possibility to access documents which are created by the API for e.g. in support cases.
Why isn't the customization button appearing?
If the customization button isn't appearing, check that:
1. The connector is enabled in the configuration
2. The product is enabled for customization
3. A valid GraFxStudio template is assigned to the product
4. Your theme isn't hiding the button with CSS
Can customers save their drafts for later?
Yes, customers can save their drafts if they are logged in. Their drafts will be stored in their account and can be accessed from their account dashboard.