diff --git a/.github/workflows/lychee-link-checker.yml b/.github/workflows/lychee-link-checker.yml index 868c61ad..fa434f51 100644 --- a/.github/workflows/lychee-link-checker.yml +++ b/.github/workflows/lychee-link-checker.yml @@ -2,7 +2,12 @@ name: Links checker on: push: + branches: + - main pull_request: + types: [opened, synchronize, reopened] + branches: + - main jobs: linkChecker: @@ -14,7 +19,7 @@ jobs: uses: lycheeverse/lychee-action@v1.8.0 with: # All supported file formats to be verified and accept 403 (Forbidden) as correct link - args: --verbose -a 200,202,403 './**/*.md' './**/*.html' './**/*.rst' --exclude '^https:\/\/cp' + args: --verbose -a 200,202,403 './**/*.md' './**/*.html' './**/*.rst' --exclude '^https:\/\/cp' --exclude 'https://login.chiligrafx.com/login/callback' --exclude 'https://my.chili-publish.com' --exclude 'https://chili-publish.com/CGXGroups' format: markdown # Add job summary in github action jobSummary: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30b1c1a1..d74ca529 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -139,4 +139,4 @@ Your pull request will be reviewed and approved before being merged into the `ma ## License -Any approved and merged content you submit will be subject to the terms of the project's [license](LICENSE.md). Ensure your contributions consist of original material, or content that is freely available for commercial use and requires no attribution. Exceptions apply for media content depicting CHILI publish software. \ No newline at end of file +Any approved and merged content you submit will be subject to the terms of the project's [license](LICENSE). Ensure your contributions consist of original material, or content that is freely available for commercial use and requires no attribution. Exceptions apply for media content depicting CHILI publish software. \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..805d7955 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,7 @@ +FROM python:3 + +WORKDIR /usr/grafx-docs + +COPY requirements.txt ./ + +RUN pip install -r requirements.txt diff --git a/README.md b/README.md index 71bf25ba..4c6c0370 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,60 @@ -# CHILI GraFx-documentation +# CHILI GraFx Documentation -Documentation source in MarkDown for CHILI GraFx and applications +Welcome to the CHILI GraFx Documentation! This project is designed to assist developers and designers new to CHILI GraFx and its applications. -The GraFx Documentation is built using [MkDocs](https://www.mkdocs.org/) +## Getting Started with Contributing -To install the required packages to build and develop the documentation locally please use -``` -pip install -r requirements.txt -``` +We welcome contributions from the community! To get started, please familiarize yourself with our contribution guidelines by reading the [CONTRIBUTING.md](CONTRIBUTING.md) file. -You can then start the local development server with -``` -mkdocs serve -``` +## Setting Up the Documentation Environment +The CHILI GraFx documentation is built using [MkDocs](https://www.mkdocs.org/), a static site generator that's geared towards project documentation. + +If you are looking to just make a small change, such as editing a single page, you probably don't need to setup a documenation environment. Please see [CONTRIBUTING.md](CONTRIBUTING.md). + +However, if you are going to be making many changes you will need to setup a documentation environment. You can set up your documentation environment using one of the following methods: + +### Option 1: Using Docker with Codespaces + +For a quick and easy setup, you can use Docker in conjunction with [GitHub Codespaces](https://github.com/features/codespaces). + +**Steps:** + +1. **Select a Branch**: Go to the GitHub repository, select a branch, and click on the `Code` button. Then, choose `Codespaces`. You can either continue with an existing Codespace or create a new one for your selected branch. + +2. **Create and Access Codespace**: Click on "Create codespace on [branch name]". This will set up a new Codespace and open an online version of VSCode in a new tab. + +3. **Terminal Operations**: In the VSCode terminal, wait for the Python installation to complete, or switch to `Bash` for immediate access. + +4. **Start Documentation Server**: Type `docker-compose up` in the terminal. The server initialization might take a short while. Once ready, a notification will allow you to open the documentation site in a new tab. + +### Option 2: Using Docker Locally + +If you have [Docker Desktop](https://docs.docker.com/desktop/) (for Windows, Mac, or Linux) or [Docker](https://docs.docker.com/engine/) and [Docker-Compose](https://docs.docker.com/compose/) (for Linux) installed on your machine, setting up the documentation locally is straightforward. + +**Steps:** + +1. **Ensure Docker is Running**: For Mac and Windows, Docker can be managed via the GUI. On Linux, use `sudo systemctl start docker`. + +2. **Launch the Server**: Navigate to the documentation project folder in the terminal and execute `sudo docker-compose up`. The documentation site will be hosted locally on `http://localhost:8000`. + +### Option 3: Using Python Locally + +If you prefer not to use Docker, you can set up the environment with Python. + +**Prerequisites:** + +Ensure that the latest version of Python 3 is installed on your system. You can download it from [Python's official site](https://www.python.org/downloads/). + +**Steps:** +1. **Go To Project Folder**: Navigate to the documentation project folder in your terminal. + +2. **Install Requirements**: Run `pip install -r requirements.txt` to install all necessary dependencies. + +3. **Start the Server**: Launch the local development server by executing `mkdocs serve`. Access the documentation site at `http://localhost:8000`. + +## Conclusion + +Choose the setup that works best for you and start contributing to the CHILI GraFx documentation. Your contributions are valuable to the community and help in making our project more accessible and user-friendly. + +Happy Documenting! \ No newline at end of file diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 00000000..318d77db --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,10 @@ +version: "3" +services: + app: + container_name: grafx-documentation + build: . + volumes: + - ./:/usr/grafx-docs + command: /bin/sh -c "mkdocs serve -a 0.0.0.0:8000" + ports: + - "8000:8000" diff --git a/docs/CHILI-GraFx/admin/index.md b/docs/CHILI-GraFx/admin/index.md index 2dbb1d28..2526f9ec 100644 --- a/docs/CHILI-GraFx/admin/index.md +++ b/docs/CHILI-GraFx/admin/index.md @@ -1,6 +1,6 @@ # CHILI GraFx platform administration -Account & Platform administration can be found under the dropdown in the icon on the top right. +Account & Platform administration can be found under the dropdown in the avatar on the top right. ![Account Dropdown](myaccount2.png) diff --git a/docs/CHILI-GraFx/applications/editor-comparison/features.xlsx b/docs/CHILI-GraFx/applications/editor-comparison/features.xlsx index 9392789e..a05346a9 100644 Binary files a/docs/CHILI-GraFx/applications/editor-comparison/features.xlsx and b/docs/CHILI-GraFx/applications/editor-comparison/features.xlsx differ diff --git a/docs/CHILI-GraFx/applications/editor-comparison/index.md b/docs/CHILI-GraFx/applications/editor-comparison/index.md index 252b710f..eae69947 100644 --- a/docs/CHILI-GraFx/applications/editor-comparison/index.md +++ b/docs/CHILI-GraFx/applications/editor-comparison/index.md @@ -1,19 +1,16 @@ # Smart Template Editors compared -**CHILI GraFx** is the platform to enable multi channel creative automation. +**CHILI GraFx** is the platform to enable multichannel creative automation. Our vision is to provide you with 1 smart template editor for animated digital, static digital and print output. **GraFx Publisher** has been around for a while and is the editor for smart templates intended for static digital and (variable-data) PDF output. -**GraFx Studio** is the next generation smart template editor. Our first goal is to provide you with all the tools for animated and static digital output, for the self-service use-case and for any automated workflow. -Therefore we redesigned the editor, SDK and API from scratch. - -Features for print will be added with every future release. +**GraFx Studio** is the next generation smart template editor. Our goal is to provide you with all the tools for animated, static digital and print output, for the self-service use-case and for any automated workflow. -If your use case is **print only**, then **GraFx Publisher** is the choice for your smart templates. +Therefore we redesigned the editor, SDK and API from scratch. -If you aim to have **animated** or **static digital** output only, then **GraFx Studio** is the place for you to start. +Today, the feature set for print in GraFx Publisher is still more extensive. But day by day, print-related features are added. When you want to have both channels combined, please have a look at the feature comparison below. This will help you decide where to start. diff --git a/docs/CHILI-GraFx/applications/overview/index.md b/docs/CHILI-GraFx/applications/overview/index.md index 48d27524..761265d5 100644 --- a/docs/CHILI-GraFx/applications/overview/index.md +++ b/docs/CHILI-GraFx/applications/overview/index.md @@ -12,7 +12,7 @@ Create Smart Templates to allow your customers to serve static digital and print ![svg_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) -Create Smart Templates to allow your customers to serve animated and static digital output +Create Smart Templates to allow your customers to serve multichannel animated, static digital and print output [See GraFx Studio documentation](/GraFx-Studio/) diff --git a/docs/CHILI-GraFx/concepts/federated-single-sign-on/index.md b/docs/CHILI-GraFx/concepts/federated-single-sign-on/index.md index 0009b26e..9e86c40d 100644 --- a/docs/CHILI-GraFx/concepts/federated-single-sign-on/index.md +++ b/docs/CHILI-GraFx/concepts/federated-single-sign-on/index.md @@ -28,7 +28,7 @@ This section explains the relationship between the components and how those resp Those customers who use the CHILI GraFx platform without SSO federation host their users and the permissions of those in the platform itself. -Within the components of the platform, there is an identity hub that manages both the **Authentication** of the users and the **permissions** they have on each platform component. +Within the components of the platform, there is an identity hub that manages both the **Authentication** of the users and the **permissions** they have on each platform component. These permissions include Individual access, Groups, and Group memberships. ``` mermaid erDiagram @@ -39,7 +39,9 @@ erDiagram GraFx-Media ||--|| CHILI-GraFx-Identity-Hub : A-P CHILI-GraFx-Identity-Hub { handles Authentication - handles Permissions + handles Individual-Access + handles Groups-Definition + handles Group-Membership } ``` @@ -47,7 +49,7 @@ erDiagram Those customers who use the SSO Federation host their own users and take care of the authentication process. This enables the use of multiple factors for the authentication, and those mechanisms to be shared with other systems of the company. -In this case, the CHILI GraFx Identity Hub only takes care of the **permission management** of the users. Plus, of course, the management of the trust relationship between CGX and the customer’s IDP. +In this case, the CHILI GraFx Identity Hub only takes care of the **Individual access** of the users and the definition of the permissions of the **User groups**. Plus, of course, the management of the trust relationship between CGX and the customer’s IDP. ``` mermaid erDiagram @@ -58,10 +60,12 @@ erDiagram GraFx-Media ||--|| CHILI-GraFx-Identity-Hub : A-P CHILI-GraFx-Identity-Hub ||--|| Customer-Identity-Provider : A CHILI-GraFx-Identity-Hub { - handles Permissions + handles Individual-Access + handles Groups-Definition } Customer-Identity-Provider { handles Authentication + handles Group-Membership } ``` @@ -86,4 +90,4 @@ A Client Success colleague can assist you in the setup process. ## Federated SSO via the SAML protocol -[Details for the SAML protocol](saml/) \ No newline at end of file +[Details for the SAML protocol](saml/) diff --git a/docs/CHILI-GraFx/concepts/federated-single-sign-on/oidc/index.md b/docs/CHILI-GraFx/concepts/federated-single-sign-on/oidc/index.md index 0b8bb837..069986f0 100644 --- a/docs/CHILI-GraFx/concepts/federated-single-sign-on/oidc/index.md +++ b/docs/CHILI-GraFx/concepts/federated-single-sign-on/oidc/index.md @@ -15,6 +15,7 @@ This document lists the info for your OIDC Identity Providers in the CGX Platfor - Claim with the email of the user: email - Claim with the given name of the user: given_name - Claim with the family name of the user: family_name +- Claim with the group memberships of the user: https://chili-publish.com/CGXGroups ## Get in touch! diff --git a/docs/CHILI-GraFx/concepts/federated-single-sign-on/saml/index.md b/docs/CHILI-GraFx/concepts/federated-single-sign-on/saml/index.md index 469fe5bf..0bb2f65e 100644 --- a/docs/CHILI-GraFx/concepts/federated-single-sign-on/saml/index.md +++ b/docs/CHILI-GraFx/concepts/federated-single-sign-on/saml/index.md @@ -10,6 +10,7 @@ This document lists the info for your SAML Identity Providers in the CGX Platfor - Email (default is email) - First Name (default is given_name) - Last Name (default is family_name) + - Group memberships (default is https://chili-publish.com/CGXGroups) - Identity attribute ## We will provide you diff --git a/docs/CHILI-GraFx/concepts/integrations/index.md b/docs/CHILI-GraFx/concepts/integrations/index.md index 52706a2d..ddf3e839 100644 --- a/docs/CHILI-GraFx/concepts/integrations/index.md +++ b/docs/CHILI-GraFx/concepts/integrations/index.md @@ -18,7 +18,7 @@ For instructions on setting up an Integration, [see our guide](/CHILI-GraFx/guid The **GraFx Platform API** allows you to manage GraFx Platform resources. -Some exmaple use cases are: +Some example use cases are: - User management - Environment creation diff --git a/docs/CHILI-GraFx/concepts/renders/index.md b/docs/CHILI-GraFx/concepts/renders/index.md index 9f5192e7..5d92f940 100644 --- a/docs/CHILI-GraFx/concepts/renders/index.md +++ b/docs/CHILI-GraFx/concepts/renders/index.md @@ -24,41 +24,64 @@ This average is used to size your allowance in your subscription. ### Animated Digital Output -1 render is counted towards each second of output. +Basic concept: 1 render is counted towards each (started) second of output. + +CHILI GraFx looks at the length of the animation. Not at the output framerate or whether or not only part of the clip or the whole clip is animated. + +!!! Note + **Some examples** + + - An animation with a duration of 0.1 seconds: 1 render + - An animation with a duration of 0.5 seconds: 1 render + - An animation with a duration of 1.5 seconds: 2 render + - An animation with a duration of 2 seconds: 2 renders + - An animation with a duration of 2,5 seconds: 3 renders + - An animation with a duration of 3 seconds: 3 renders + +Watermarked output does not count as a render. ### Static PDF output 1 render is counted towards each PDF file. +### Static PDF output with variable data (datasource) + When variable output is used, this is the formula to count renders. -The first 50 renders are counted individually, then each set of 50 is counted as 1 render. +The first 50 renders are counted individually, then each subsequent set of 50 add 1 render. !!! Formula - V = Variable Data source size (e.g. 1000 records) + **V** = Variable Data source size (e.g. 1000 records) - Amount of Renders = 50 + (V-50)/50 + **Renders** = 50 + (V-50)/50 - e.g. 50 + (1000-50)/50 = 50 + 19 = 69 + In this case: 50 + (1000-50)/50 = 50 + 19 = 69 The first 50 renders count as 50, then every 50 renders are counted as 1. ## Fair use policy -In your subscription, you're entitle to a render quota. +In your subscription, you're entitled to a render quota. -Your dashboard will show the actual status of renders. (with a delay of ±1 day). +Your dashboard will show the actual status of renders for the full subsciption (all environments, with a delay of ±1 day). -![Renders](renders.png) +![screenshot-full](renders01.png) The light blue line shows the "6 month rolling average". +--- + +When you select an environment, you'll see the details. + +![screenshot-full](renders02.png) + + Render quota are not a hard limit per month. If you generate more output than the render quota, we won’t block or watermark the output. -You are allowed to go over the monthly limit. +The system will not stop working at the limit. -When the 6 month rolling average exceeds the render quota, it's time to add extra render packs to increase your render quota to at least the 6 month average. +When the 6 month rolling average exceeds the render quota, you will be invoiced an extra render pack to increase your render quota to at least the 6 month average. !!! Average 6 month average calculation: diff --git a/docs/CHILI-GraFx/concepts/renders/renders01.png b/docs/CHILI-GraFx/concepts/renders/renders01.png new file mode 100644 index 00000000..1bf56557 Binary files /dev/null and b/docs/CHILI-GraFx/concepts/renders/renders01.png differ diff --git a/docs/CHILI-GraFx/concepts/renders/renders02.png b/docs/CHILI-GraFx/concepts/renders/renders02.png new file mode 100644 index 00000000..5515884f Binary files /dev/null and b/docs/CHILI-GraFx/concepts/renders/renders02.png differ diff --git a/docs/CHILI-GraFx/concepts/sandbox/index.md b/docs/CHILI-GraFx/concepts/sandbox/index.md index 1e28fe21..a66c2402 100644 --- a/docs/CHILI-GraFx/concepts/sandbox/index.md +++ b/docs/CHILI-GraFx/concepts/sandbox/index.md @@ -6,6 +6,10 @@ A sandbox environment is like a test version of the CHILI GraFx platform or appl This means that any changes made in the sandbox will not affect the production data. The sandbox allows you to test new features to make sure they work properly before they are used in the live version. +Output generated in a sandbox environment has a watermark and is not counted as a [render](/CHILI-GraFx/concepts/renders/). + +![screenshot](sample.jpeg) + ## Production Production is the live version of CHILI GraFx that customers use to access and use the actual platform and applications. It is where all the real work happens, and any changes made in production are immediately reflected to the end-users. @@ -28,4 +32,4 @@ Depending on your contract CHILI GraFx is hosted on a multi-tenant or private te The timeframe when a Sandbox is updated is equal for all customers on the same tenant. -With a private tenant, you have more control on the timing when a Sandbox or Production setup is upgraded. \ No newline at end of file +With a private tenant, you have more control on the timing when a Sandbox or Production setup is upgraded. diff --git a/docs/CHILI-GraFx/concepts/sandbox/sample.jpeg b/docs/CHILI-GraFx/concepts/sandbox/sample.jpeg new file mode 100644 index 00000000..8b316c90 Binary files /dev/null and b/docs/CHILI-GraFx/concepts/sandbox/sample.jpeg differ diff --git a/docs/CHILI-GraFx/guides/example-federated-groups-entraid/index.md b/docs/CHILI-GraFx/guides/example-federated-groups-entraid/index.md new file mode 100644 index 00000000..0da9e8f4 --- /dev/null +++ b/docs/CHILI-GraFx/guides/example-federated-groups-entraid/index.md @@ -0,0 +1,41 @@ +# Example configuration: Entra ID (formerly Azure ID) + +!!! Warning "Disclaimer" + The objective of this sample is not the definition of a canonical implementation, but to serve as an illustrative example of one possible way to implement the integration on the customer side. + +## Introduction + +The federation with CHILI GraFx is based on standard protocols (SAML and OIDC) and the requirements made by CHILI GraFx for a successful integration are based on those protocols. + +At the same time, we want to help our customers with a sample configuration to be done in Microsoft Entra ID (Former Azure AD). + +In this example, we assume the federation configuration is working correctly. For that reason, this example is focused on the management of groups and memberships. + +## Concepts + +We will be using the following concepts from **Entra ID** + +### Application role + +Permissions are defined at the application level. In our case, the application is the one used to define the federation. An Application role can be linked to a user or a group + +### User group + +This is defined beyond the application. A User group can be assigned one or many Application Roles. All user members of that User group get all of the Application roles of the group. + +### Group membership + +Associating a user to a User group + +## Procedure + +Once the Federated SSO connection is configured as an application in Entra ID, follow these steps to make a user of your company member of a CGX group: + +- Create the User in Entra ID following your procedures. We’ll call the user “Mike” +- Create a User group in Entra ID. We’ll call the group “marketing_group” +- Create a User group in CGX and copy the Group ID (follow the CGX documentation if needed) +- Create an Application role with the ID of the CGX Group ID. We’ll use the value “CGX-marketing-ID” +- Add the group “marketing_group” to the Application Role “CGX-marketing-ID” +- Add user “Mike” as a member of the group “marketing_group” + +The next time the user “Mike” logs into CGX, he will have all of the permissions of group “CGX-marketing-ID” \ No newline at end of file diff --git a/docs/CHILI-GraFx/guides/integrations/index.md b/docs/CHILI-GraFx/guides/integrations/index.md index 32f07fce..e03034d2 100644 --- a/docs/CHILI-GraFx/guides/integrations/index.md +++ b/docs/CHILI-GraFx/guides/integrations/index.md @@ -34,13 +34,13 @@ Click an existing integration to edit its details. ![screenshot](integration4.png) -### Step 3: Obtaining Integration Credentials +## Step 3: Obtaining Integration Credentials After saving the integration configuration, click on the integration name, to see the details panel. When looking at the details for your integration, you will notice that there are two tabs. -##### The General Tab +### The General Tab The `General` tab contains the information about your integration and the authentication credentials. The CHILI GraFx platform will generate a set of credentials specifically for this integration. @@ -49,16 +49,16 @@ These credentials include a `Client ID` and `Client Secret`. Make sure to secure ![screenshot](integration5.png) -##### Your Environment Swagger +### Your Environment Swagger At the bottom of the `General` tab you will notice that there are links to the Environment API and Platform API Swagger pages for your environment that you can interactively test endpoints with **after** [generating an access token](#step-4-generating-an-access-token) -##### The Permissions tab +### The Permissions tab The `Permissions` tab is where you can control the level of access your integration has to your environment. Permissions are presented as API scopes, and will determine the access your integration has on the environment. ![screenshot](integration6.png) -### Step 4: Generating an Access Token +## Step 4: Generating an Access Token Now we can request an access token using our `Client ID` and `Client Secret`. This token will serve as your application's authorization for subsequent API calls. @@ -225,7 +225,7 @@ Extract the access token from the authentication response and securely store it The access token is issued with an expiration offset. You can find this in the `expires_in` JSON property of the response. Ensure your application refreshes it's token when necessary. You simply repeat the process generate a new token. -### Step 6: Making API Calls +## Step 5: Making API Calls With the access token in hand, you can now include it in the headers of your API requests to the CHILI GraFx platform. `Authorization: Bearer ` diff --git a/docs/CHILI-GraFx/guides/manage-group-access/index.md b/docs/CHILI-GraFx/guides/manage-group-access/index.md new file mode 100644 index 00000000..0b664950 --- /dev/null +++ b/docs/CHILI-GraFx/guides/manage-group-access/index.md @@ -0,0 +1,22 @@ +# User Group Access + +!!! Info "Access" + Access is the set of rules that defines the role a user gets in a certain environment. + +## Manage Access + +Click the "Access" tab, on the group page. + +![screenshot-full](ug013.png) + +Click "Manage Access" to add or revoke access to that group. + +![screenshot](ug014.png) + +Under Access, add or remove the Environments. + +At the bottom part, you'll see each environment listed in the access field. Add the role the group members will receive in that environment. By default, the "End User" role is assigned, and you can add additional roles if wanted, for each Environment. + +## Template Designer Seats + +You won't be able to give Template Designer Seat through a group assignment. You'll have to [assign the Seat](/CHILI-GraFx/users/template-designer/) to each individual user. \ No newline at end of file diff --git a/docs/CHILI-GraFx/guides/manage-group-access/ug013.png b/docs/CHILI-GraFx/guides/manage-group-access/ug013.png new file mode 100644 index 00000000..601a74cd Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-group-access/ug013.png differ diff --git a/docs/CHILI-GraFx/guides/manage-group-access/ug014.png b/docs/CHILI-GraFx/guides/manage-group-access/ug014.png new file mode 100644 index 00000000..a1dbf32f Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-group-access/ug014.png differ diff --git a/docs/CHILI-GraFx/guides/manage-group-membership/index.md b/docs/CHILI-GraFx/guides/manage-group-membership/index.md new file mode 100644 index 00000000..84f9628d --- /dev/null +++ b/docs/CHILI-GraFx/guides/manage-group-membership/index.md @@ -0,0 +1,50 @@ +# User Group Membership + +## Manage membership of non-federated users + +Go to User Management, click "Groups", click on the group you want to manage. "Graphics Production Team" + +![screenshot](ug013.png) + +The members will be listed, if no members are present, click "+ Assign members" + +![screenshot-full](ug007.png) + +To add members, click on the second tab "Add members". You'll see a list of users, that have not been assigned as a member. + +If you don't see the user you want to add: + +- They are already a member +- They don't exist as a user in the Subscription + +![screenshot](ug009.png) + +Click on the "+" (plus) sign to add the user to the current group. + +They disappear from the list, and will be under the "Assigned members" tab. + +![screenshot](ug010.png) + +Under "Assigned members" you can "delete" a member. This will revoke group membership, but will nog remove the user from the Subscription. + +![screenshot](ug011.png) + +When done, you'll see the members under the "Members" tab. + +![screenshot-full](ug012.png) + +## Manage membership of Federated users + +Group membership of federated users are managed in the third-party identity provider (IDP). + +All group membership operations are disabled for federated users because group membership information from the third-party IDP overrides the informaion in CGX. + +When a user authenticates in a third-party IDP, the authentication must include the identifiers of the groups the user belongs to. + +To get the identifier from a group, click on "Copy group ID" in the group drop-down. + +![screenshot-full](ug014.png) + +For additional information on the claims used, check, the related security protocol [SAML](/CHILI-GraFx/concepts/federated-single-sign-on/saml/) or [OpenID Connect](/CHILI-GraFx/concepts/federated-single-sign-on/oidc/) + +The details on managing the group membership in the third-party IDP varies from vendor to vendor. Please contact your IT support team for further details. \ No newline at end of file diff --git a/docs/CHILI-GraFx/guides/manage-group-membership/ug007.png b/docs/CHILI-GraFx/guides/manage-group-membership/ug007.png new file mode 100644 index 00000000..7996441d Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-group-membership/ug007.png differ diff --git a/docs/CHILI-GraFx/guides/manage-group-membership/ug009.png b/docs/CHILI-GraFx/guides/manage-group-membership/ug009.png new file mode 100644 index 00000000..c60ca0db Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-group-membership/ug009.png differ diff --git a/docs/CHILI-GraFx/guides/manage-group-membership/ug010.png b/docs/CHILI-GraFx/guides/manage-group-membership/ug010.png new file mode 100644 index 00000000..e1319fe3 Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-group-membership/ug010.png differ diff --git a/docs/CHILI-GraFx/guides/manage-group-membership/ug011.png b/docs/CHILI-GraFx/guides/manage-group-membership/ug011.png new file mode 100644 index 00000000..cb131286 Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-group-membership/ug011.png differ diff --git a/docs/CHILI-GraFx/guides/manage-group-membership/ug012.png b/docs/CHILI-GraFx/guides/manage-group-membership/ug012.png new file mode 100644 index 00000000..68c16d62 Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-group-membership/ug012.png differ diff --git a/docs/CHILI-GraFx/guides/manage-group-membership/ug013.png b/docs/CHILI-GraFx/guides/manage-group-membership/ug013.png new file mode 100644 index 00000000..433bbb89 Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-group-membership/ug013.png differ diff --git a/docs/CHILI-GraFx/guides/manage-group-membership/ug014.png b/docs/CHILI-GraFx/guides/manage-group-membership/ug014.png new file mode 100644 index 00000000..a44e4d5a Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-group-membership/ug014.png differ diff --git a/docs/CHILI-GraFx/guides/manage-individual-access/changerole-4.png b/docs/CHILI-GraFx/guides/manage-individual-access/changerole-4.png new file mode 100644 index 00000000..843b4c3a Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-individual-access/changerole-4.png differ diff --git a/docs/CHILI-GraFx/guides/manage-individual-access/changerole-5.png b/docs/CHILI-GraFx/guides/manage-individual-access/changerole-5.png new file mode 100644 index 00000000..c193db2d Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-individual-access/changerole-5.png differ diff --git a/docs/CHILI-GraFx/guides/manage-individual-access/changerole-6.png b/docs/CHILI-GraFx/guides/manage-individual-access/changerole-6.png new file mode 100644 index 00000000..477fb6d0 Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-individual-access/changerole-6.png differ diff --git a/docs/CHILI-GraFx/guides/manage-individual-access/changerole-7.png b/docs/CHILI-GraFx/guides/manage-individual-access/changerole-7.png new file mode 100644 index 00000000..ac18980c Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-individual-access/changerole-7.png differ diff --git a/docs/CHILI-GraFx/guides/manage-individual-access/changerole-8.png b/docs/CHILI-GraFx/guides/manage-individual-access/changerole-8.png new file mode 100644 index 00000000..201cb8b5 Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-individual-access/changerole-8.png differ diff --git a/docs/CHILI-GraFx/guides/manage-individual-access/index.md b/docs/CHILI-GraFx/guides/manage-individual-access/index.md new file mode 100644 index 00000000..a125d7a9 --- /dev/null +++ b/docs/CHILI-GraFx/guides/manage-individual-access/index.md @@ -0,0 +1,24 @@ +# User Management + +## Set individual access + +Select the user you want to change, and select the tab "Individual access" + +![screenshot](changerole-4.png) + +Click "Manage access" + +![screenshot](changerole-5.png) + +In the "Individual access" field, add / remove Environments. +For each environment in the list, assign / remove roles in the list below. + +![screenshot](changerole-6.png) + +![screenshot](changerole-7.png) + +Click the role dropdown, and assign or remove the role for that environment. + +The "User" role is default, and cannot be removed. + +![screenshot](changerole-8.png) \ No newline at end of file diff --git a/docs/CHILI-GraFx/guides/manage-user-groups/index.md b/docs/CHILI-GraFx/guides/manage-user-groups/index.md new file mode 100644 index 00000000..4614cd6e --- /dev/null +++ b/docs/CHILI-GraFx/guides/manage-user-groups/index.md @@ -0,0 +1,46 @@ +# User Group Management + +## Create User Group + +Go to User Management, and click "Groups" + +![screenshot](ug000.png) + +Start with "+ Create group". + +![screenshot-full](ug001.png) + +Give the user group a name. (Step 1/3) + +![screenshot](ug002.png) + +Give an (optional) description (Step 2/3) + +![screenshot](ug003.png) + +Assign Access, similar to [Individual Access assignment](/CHILI-GraFx/guides/set-individual-access/). + +- Select the Environments the group has access to +- Select the Role everybody in this group will have, for this Environment + +![screenshot](ug004.png) + +![screenshot](ug005.png) + +The group will appear in the list, showing "0" members. + +![screenshot-full](ug006.png) + +## Delete a User Group + +To delete a group, select the group, en "Delete Group" under the Actions drop down menu + +![screenshot](ug008.png) + +Upon deletion, all members are removed from the group, and the related access is revoked. + +Unless if the person still has access through [Individual Access](/CHILI-GraFx/guides/set-individual-access/), or through membership of another group. + +## Manage User Group Membership + +See [Manage Group Membership](/CHILI-GraFx/guides/manage-group-membership/) \ No newline at end of file diff --git a/docs/CHILI-GraFx/guides/manage-user-groups/ug000.png b/docs/CHILI-GraFx/guides/manage-user-groups/ug000.png new file mode 100644 index 00000000..78a1f3e2 Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-user-groups/ug000.png differ diff --git a/docs/CHILI-GraFx/guides/manage-user-groups/ug001.png b/docs/CHILI-GraFx/guides/manage-user-groups/ug001.png new file mode 100644 index 00000000..aa8c5a3c Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-user-groups/ug001.png differ diff --git a/docs/CHILI-GraFx/guides/manage-user-groups/ug002.png b/docs/CHILI-GraFx/guides/manage-user-groups/ug002.png new file mode 100644 index 00000000..80522455 Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-user-groups/ug002.png differ diff --git a/docs/CHILI-GraFx/guides/manage-user-groups/ug003.png b/docs/CHILI-GraFx/guides/manage-user-groups/ug003.png new file mode 100644 index 00000000..15396fbe Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-user-groups/ug003.png differ diff --git a/docs/CHILI-GraFx/guides/manage-user-groups/ug004.png b/docs/CHILI-GraFx/guides/manage-user-groups/ug004.png new file mode 100644 index 00000000..45109a45 Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-user-groups/ug004.png differ diff --git a/docs/CHILI-GraFx/guides/manage-user-groups/ug005.png b/docs/CHILI-GraFx/guides/manage-user-groups/ug005.png new file mode 100644 index 00000000..36cac629 Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-user-groups/ug005.png differ diff --git a/docs/CHILI-GraFx/guides/manage-user-groups/ug006.png b/docs/CHILI-GraFx/guides/manage-user-groups/ug006.png new file mode 100644 index 00000000..da26782b Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-user-groups/ug006.png differ diff --git a/docs/CHILI-GraFx/guides/manage-user-groups/ug008.png b/docs/CHILI-GraFx/guides/manage-user-groups/ug008.png new file mode 100644 index 00000000..db0937be Binary files /dev/null and b/docs/CHILI-GraFx/guides/manage-user-groups/ug008.png differ diff --git a/docs/CHILI-GraFx/guides/role-access-update/changerole-1.png b/docs/CHILI-GraFx/guides/role-access-update/changerole-1.png new file mode 100644 index 00000000..8bf3dfa2 Binary files /dev/null and b/docs/CHILI-GraFx/guides/role-access-update/changerole-1.png differ diff --git a/docs/CHILI-GraFx/guides/role-access-update/changerole-2.png b/docs/CHILI-GraFx/guides/role-access-update/changerole-2.png new file mode 100644 index 00000000..f27fdc85 Binary files /dev/null and b/docs/CHILI-GraFx/guides/role-access-update/changerole-2.png differ diff --git a/docs/CHILI-GraFx/guides/role-access-update/changerole-3.png b/docs/CHILI-GraFx/guides/role-access-update/changerole-3.png new file mode 100644 index 00000000..49efd525 Binary files /dev/null and b/docs/CHILI-GraFx/guides/role-access-update/changerole-3.png differ diff --git a/docs/CHILI-GraFx/guides/role-access-update/changerole-4.png b/docs/CHILI-GraFx/guides/role-access-update/changerole-4.png new file mode 100644 index 00000000..843b4c3a Binary files /dev/null and b/docs/CHILI-GraFx/guides/role-access-update/changerole-4.png differ diff --git a/docs/CHILI-GraFx/guides/role-access-update/changerole-5.png b/docs/CHILI-GraFx/guides/role-access-update/changerole-5.png new file mode 100644 index 00000000..c193db2d Binary files /dev/null and b/docs/CHILI-GraFx/guides/role-access-update/changerole-5.png differ diff --git a/docs/CHILI-GraFx/guides/role-access-update/changerole-6.png b/docs/CHILI-GraFx/guides/role-access-update/changerole-6.png new file mode 100644 index 00000000..477fb6d0 Binary files /dev/null and b/docs/CHILI-GraFx/guides/role-access-update/changerole-6.png differ diff --git a/docs/CHILI-GraFx/guides/role-access-update/changerole-7.png b/docs/CHILI-GraFx/guides/role-access-update/changerole-7.png new file mode 100644 index 00000000..ac18980c Binary files /dev/null and b/docs/CHILI-GraFx/guides/role-access-update/changerole-7.png differ diff --git a/docs/CHILI-GraFx/guides/role-access-update/changerole-8.png b/docs/CHILI-GraFx/guides/role-access-update/changerole-8.png new file mode 100644 index 00000000..201cb8b5 Binary files /dev/null and b/docs/CHILI-GraFx/guides/role-access-update/changerole-8.png differ diff --git a/docs/CHILI-GraFx/guides/role-access-update/index.md b/docs/CHILI-GraFx/guides/role-access-update/index.md new file mode 100644 index 00000000..2ea13932 --- /dev/null +++ b/docs/CHILI-GraFx/guides/role-access-update/index.md @@ -0,0 +1,37 @@ +# User management + +## Change role & access + +### Subscription Admin + +If you have access to multiple subscriptions, first select the subscription where you want to make changes. + +![ui](changerole-1.png) + +If you have access to only 1 subscription, you will see your subscription only. (without dropdown icon) + +![ui](changerole-2.png) + +### Environment Admin + +As Environment admin the process is similar. But you won't need to choose a subscription. And you only see the subscriptions you have access to. + +If you don't see an environment you should see, please contact your Subscription Admin, to provide you access to other environments. + +### Changing access and role + +Go to User Management + +![ui](changerole-3.png) + +#### Set Individual Access + +[Set individual access](/CHILI-GraFx/guides/set-individual-access) + +#### Access through a group + +[Greate User Group](/CHILI-GraFx/guides/manage-user-groups) + +[Group Membership](/CHILI-GraFx/guides/manage-group-membership) + +[Group Access](/CHILI-GraFx/guides/manage-group-access) diff --git a/docs/CHILI-GraFx/trust/compliance/index.md b/docs/CHILI-GraFx/trust/compliance/index.md new file mode 100644 index 00000000..0ddad7db --- /dev/null +++ b/docs/CHILI-GraFx/trust/compliance/index.md @@ -0,0 +1,25 @@ +# Compliance + +## Privacy + +We are committed to protecting the privacy of your and your customers' data, and preventing it from unauthorized access with industry best-practices. + +See [privacy statement](https://www.chili-publish.com/legal/) + +## Security + +All CHILI publish associates are formally trained on the proper use of four different information classification levels to make sure your data is handled safely. + +These classifications are [listed on our website](https://www.chili-publish.com/security/). + +## Compliance + +Our compliance team works hard to meet your organization’s compliance needs. We are proud to annouce we are ISO27001:2017 certified. + +![Logo](https://www.datocms-assets.com/11099/1643128549-iso-brand-compliance.png?auto=format&dpr=0.62&w=600) + +[Download statement of applicability](https://cdn6.chili-publish.com/hub/Legal/CHILI_publish_ISO27001_Statement_of_Applicability_v120.pdf) + +[ISO 27001:2017 Certificate](https://cdn6.chili-publish.com/hub/Legal/NL_1527.1.1-CHILI_publish_N.V.-ISO_27001.pdf) + + diff --git a/docs/CHILI-GraFx/trust/data-centers/index.md b/docs/CHILI-GraFx/trust/data-centers/index.md new file mode 100644 index 00000000..0ec2dc8b --- /dev/null +++ b/docs/CHILI-GraFx/trust/data-centers/index.md @@ -0,0 +1,30 @@ +# CHILI publish Data Centers + +Data at rest is stored in secure data centers. We distinguish between [Service Data](/CHILI-GraFx/trust/definitions/#service-data), [Platform Data](/CHILI-GraFx/trust/definitions/#platform-data) and [Support Data](/CHILI-GraFx/trust/definitions/#support-data). + +## Service Data + +The Customer can select a data center in a region, offered by CHILI publish to store [Service Data](/CHILI-GraFx/trust/definitions/#service-data): + +- West-Europe (The Netherlands - Amsterdam) +- East US (Virginia) +- Australia East (New South Wales) +- South UK (London) +- France Central (Paris) + +## Platform Data + +[Platform data](/CHILI-GraFx/trust/definitions/#platform-data) is stored at rest in the Azure region West-Europe (The Netherlands, Amsterdam) + +## Support Data + +[Support Data](/CHILI-GraFx/trust/definitions/#support-data) is stored at rest in West Europe. + +## Compliance + +The data centers have been certified as ISO 27001, PCI/DSS Service Provider Level 1and/or SOC 2 compliance. + +More information can be found on the following pages. +[Azure compliance](https://azure.microsoft.com/en-us/overview/trusted-cloud/compliance/) and [Azure Security](https://docs.microsoft.com/en-us/azure/security/) + + diff --git a/docs/CHILI-GraFx/trust/definitions/index.md b/docs/CHILI-GraFx/trust/definitions/index.md new file mode 100644 index 00000000..412c9bc8 --- /dev/null +++ b/docs/CHILI-GraFx/trust/definitions/index.md @@ -0,0 +1,18 @@ +# Definitions + +## Service Data + +Service Data is any information, including personal data, which is stored in or transmitted via the CHILI publish services, by, or on behalf of, our customers and their end-users. + +## Platform Data + +Platform Data covers user account and subscription data (incl. contract details, credentials, permissions, …). +Platform Data is stored at rest in the Azure region Europe. + +## Support Data + +Support Data means the data Customer provides to CHILI publish on the support platform. Support Data is stored within Europe. + +## Data Hosting Location + +CHILI publish leverages Microsoft AZURE data centers in different regions. The Customer can select a data center in a region, offered by CHILI publish [See Data centers](/CHILI-GraFx/trust/data-centers/). \ No newline at end of file diff --git a/docs/CHILI-GraFx/trust/gdpr/index.md b/docs/CHILI-GraFx/trust/gdpr/index.md new file mode 100644 index 00000000..5864ae34 --- /dev/null +++ b/docs/CHILI-GraFx/trust/gdpr/index.md @@ -0,0 +1,38 @@ +# GDPR + +CHILI publish’s approach has been anchored with a strong commitment to privacy, security, compliance and transparency. This approach includes supporting our customers’ compliance with EU data protection requirements, including those set out in the General Data Protection Regulation (“GDPR”), which replaced the EU Data Protection Directive and became enforceable on May 25, 2018. + +If a company collects, transmits, hosts or analyzes personal data of data subjects, the GDPR requires the company to use third-party data processors who guarantee their ability to implement the technical and organizational requirements of the GDPR. To further earn our customers’ trust, our DPA has been updated to provide our customers with contractual commitments regarding our compliance with applicable EU data protection law and to implement additional contractual provisions required by the GDPR. + +## What is the GDPR? + +The [General Data Protection Regulation](https://gdpr.eu/what-is-gdpr/) (“GDPR”) is the European privacy regulation. The GDPR addresses the processing of personal data and the free movement of such data. It aims to strengthen the security and protection of personal data in the EU and harmonize EU data protection law. Broadly, it sets out a number of data protection principles and requirements which must be adhered to when personal data is processed. +The GDPR also established the European Data Protection Board (“EPDB”), which ensures that the data protection law is applied consistently across the EU and works to ensure effective cooperation amongst data protection authorities. + +## How does the GDPR apply to customers? + +CHILI publish customers that collect and store personal data are considered data controllers under the GDPR. Data controllers bear the primary responsibility for ensuring that their processing of personal data is compliant with relevant EU data protection law, including the GDPR and uniquely determine what personal data is submitted to, and processed by, CHILI publish in accordance with the Services. + +In its capacity as data processor, how does CHILI publish handle requests made by End-Users? + +If CHILI publish receives a data subject request from a Customer’s End-User (i.e., a user of the CHILI publish online Services to whom a Customer has provided our Services), CHILI publish is the Processor, and CHILI publish will, to the extent that applicable legislation does not prohibit CHILI publish from doing so, promptly inform the End-User to contact our Customer (i.e. the Controller) directly about any request relating to his/her Personal Data such as access or deletion. CHILI publish will not further respond to a data subject request without Customer’s prior consent. + +## What are the “Standard Contractual Clauses”? + +The European Commission has approved a set of standard provisions called the Standard Contractual Clauses (“SCC”) which provide a data controller a compliant legal mechanism to transfer personal data to a data processor outside the European Economic Area (“EEA”). In addition, the parties have to assess if the personal data transferred to countries outside the EEA would be afforded an adequate level of data protection according to the GDPR requirements. The Model Clauses are appended to the CHILI publish DPA to help provide adequate protection for data transfer outside of the EEA or Switzerland. + +Does CHILI publish replicate the Service Data it stores? +CHILI publish periodically replicates data for purposes of archival, backup and audit logs. + +## Data Processing Agreement + +CHILI publish offers active Customers a Data Processing Agreement (“DPA”) to reflect the parties’ agreement with regard to the processing of personal data. + +### What is a Data Processing Agreement (“DPA”) + +CHILI publish offers customers a Data Processing Agreement governing the relationship between the Customer (acting as a Data Controller) and CHILI publish (acting as a Data Processor). The DPA facilitates CHILI publish’s customers’ compliance with their obligations under EU data protection law and contains strong privacy commitments and has been updated to confirm our compliance with the GDPR. The DPA also contains data transfer frameworks to ensure that our customers can lawfully transfer personal data to CHILI publish outside of the European Union by our Standard Contractual Clauses. In addition, CHILI publish conducts a comprehensive assessment to determine whether the data importer in a third country, if it has not been recognized by the European Commission as offering an adequate level of data protection, can actually guarantee an adequate level of data protection as stipulated in the GDPR and in the SCC. + +### Additional questions about the DPA + +If you have additional questions, please contact your CHILI publish Account Executive or alternatively, open a case with the CHILI publish Privacy Manager by contacting [security@chili-publish.com](mailto:security@chili-publish.com) +  diff --git a/docs/CHILI-GraFx/trust/introduction/1643128549-iso-brand-compliance.png b/docs/CHILI-GraFx/trust/introduction/1643128549-iso-brand-compliance.png new file mode 100644 index 00000000..01ad9c3d Binary files /dev/null and b/docs/CHILI-GraFx/trust/introduction/1643128549-iso-brand-compliance.png differ diff --git a/docs/CHILI-GraFx/trust/introduction/index.md b/docs/CHILI-GraFx/trust/introduction/index.md new file mode 100644 index 00000000..e2187838 --- /dev/null +++ b/docs/CHILI-GraFx/trust/introduction/index.md @@ -0,0 +1,3 @@ +# Data Security at CHILI publish and CHILI GraFx + +CHILI publish empowers graphic designers and marketers to scale their graphic production efficiently and safely. Keeping your trust is at the heart of this effort. diff --git a/docs/CHILI-GraFx/trust/security-policy/index.md b/docs/CHILI-GraFx/trust/security-policy/index.md new file mode 100644 index 00000000..7635fd6b --- /dev/null +++ b/docs/CHILI-GraFx/trust/security-policy/index.md @@ -0,0 +1,163 @@ +# CHILI publish Security Policy + +Our customers trust CHILI publish with their data, and this responsibility is something we take seriously. We take appropriate security measures to ensure our customer and business data is protected. + +## Data center and network security + +We ensure the confidentiality and integrity of your data with industry best practices. CHILI publish primarily hosts Service Data (as defined below) in Microsoft AZURE data centers that have been certified as ISO 27001, PCI/DSS Service Provider Level 1, and SOC 2 compliant. Authentication and authorization data is stored and managed in [Auth0](https://auth0.com/security). +See [Azure Compliance](https://azure.microsoft.com/en-us/overview/trusted-cloud/compliance/) and [Azure Security](https://docs.microsoft.com/en-us/azure/security/) for more information. + + +## Application security + +We take steps to securely develop and test against security threats to ensure the safety of our customer data. In addition, CHILI publish employs third-party security experts to perform detailed penetration tests on different applications within our family of products. This according to formalized procedures. + +## Product security features + +We make it seamless for customers to manage user access. All communications with CHILI publish servers are encrypted using industry standard HTTPS over public networks, meaning the traffic between you and CHILI publish is secure. + +## Compliance + +We use guidance of general accepted security and privacy frameworks to help our customers to meet their own compliance standards. CHILI publish is ISO27001:2017 certified. + +You can find the Certificate itself and The Statement of applicability [here](/CHILI-GraFx/trust/compliance/) + +## Network security + +### Protection + +Our network is protected through the use of key AZURE security services, integration with protection networks, regular audits, and network intelligence technologies which monitor and/or block known malicious traffic and network attacks. + +### Architecture + +Our network security architecture consists of multiple security zones. More sensitive systems, like database servers, are protected in our most trusted zones. Other systems are housed in zones commensurate with their sensitivity, depending on function, information classification, and risk. Depending on the zone, additional security monitoring and access controls will apply. + +### Third-Party Penetration Tests + +In addition to our extensive internal scanning and testing program, each year, CHILI publish employs third-party security experts to perform a broad penetration test of key CHILI services. + +### Intrusion Detection and Prevention + +Service ingress and egress points are instrumented and monitored to detect anomalous behavior. These systems are configured to generate alerts when incidents and values exceed predetermined thresholds and use regularly updated signatures based on new threats. This includes 24/7 system monitoring. + +### DDoS Mitigation +CHILI publish has architected a multi-layer approach to DDoS mitigation. The use of Microsoft AZURE scaling and protection tools provide deeper protection along with our use of Microsoft AZURE DDoS specific services. + +### Logical Access +Access to the CHILI publish Production Network is restricted by an explicit need-to-know basis, utilizes least privilege, is frequently audited and monitored, and is controlled by our Operations Team. + +### Security Incident Response +In case of a system alert, events are escalated to our teams providing Operations, Network Engineering, and Security coverage. Employees are trained on security incident response processes, including communication channels and escalation paths. + + +## Encryption + +### Encryption in Transit +All communications with CHILI publish UI and APIs are encrypted via industry standard HTTPS/TLS (TLS 1.2 or higher) over public networks. This ensures that all traffic between you and CHILI publish is secure during transit. + +### Encryption at Rest +Service Data is encrypted at rest in Microsoft AZURE. + +## Availability and Continuity + +### Uptime + +Uptime identifies the availability of the services excluding scheduled maintenance. +Scheduled maintenance is maintenance that might include downtime and is planned and communicated beforehand: + +- At least 3 business days in advance: send out a notification to inform about the scheduled work, its purpose, and foreseen outages +- At the completion of the changes confirming the maintenance is finished and the actual downtime taken + +### Redundancy +CHILI publish employs service clustering and network redundancies to eliminate single points of failure. Our strict backup regime allows us to deliver high level of service availability, as Service Data is replicated across availability zones. + +### Disaster Recovery +Our Disaster Recovery (DR) program ensures that our services remain available and are easily recoverable in the case of a disaster. This is accomplished through building a robust technical environment, creating Disaster Recovery plans, and testing activities. + + +### Business Continuity Recovery +Business continuity recovery point objectives (“RPO”) will be twenty-four (24) hours and recovery time objectives (“RTO”) will be twelve (12) hours or up to forty-eight hours (48) in case the disaster occurs between Friday 4PM and Monday 8AM CET, depending on support hours. + +Recovery Point Objective (RPO) means, for a given function, the maximum tolerable period in hours in which data might be lost from such function due to a disaster or business continuity event. + +Recovery Time Objective (RTO) means, for a given service, the duration of time in hours within which such service must be restored after a disaster recovery or business continuity event such that the Provider is providing the service and is able to meet the service levels associated with such service. + + +### Non-Compliance +The compliance of the CHILI publisher software is affected when: + +- The Subscription date is out of range. +- The number of environments is exceeding the subscription limits +- The Renders and/or Storage is exceeding the allowed limits. +- Overdue invoice(s) + +The effect of non-compliance is the temporary suspension of the CHILI publisher service for all environments and regions, until the compliance issue has been resolved. + + +## Secure Development (SDLC) + +## Framework Security Controls + +CHILI publish leverages modern and secure frameworks with security controls to mitigate security risks. + + +## Quality Assurance + +Our Quality Assurance (QA) department reviews and tests our code base. + +## Separate Environments + +Testing and staging environments are logically separated from the Production environment. Service Data will never be used for development and testing. + + +## Vulnerability Management + +### Static Code Analysis + +The source code repositories are scanned for security issues via our integrated static analysis tooling. + + +### Vulnerability Scanning + +CHILI leverages vulnerability management technology and tools to constantly guard against common vulnerabilities and exposures. + +### Third-party Penetration Testing + +In addition to our extensive internal scanning and testing program, CHILI publish employs third-party security experts to perform detailed penetration tests on different applications within our family of products. + +## Authentication Security + +### Service Credential Storage + +CHILI publish follows secure credential storage best practices by never storing passwords in human readable format, and only as the result of a secure, salted, one-way hash. + +## Additional product security features + +### Role-Based Access Controls + +Access to data within CHILI publish applications is governed by role-based access control (RBAC) and can be configured to define granular access privileges. + + +## Privacy certificates + +### Privacy Policy + +See [privacy policy at CHILI publish](https://www.chili-publish.com/legal/) + +## Security Awareness + +### Policies + +CHILI publish is developing a comprehensive security policy covering a range of topics. This policy is shared with and made available to all employees and contractors with access to CHILI publish information assets. + +### Training + +All employees and contractors attend a Security Awareness Training which is given upon hire and annually thereafter. All engineers receive annual Secure Code Training. The Security team provides additional security awareness updates via email, blog posts, and in presentations during internal events. + + +## Employee vetting + +### Confidentiality Agreements + +All new hires are required to sign Non-Disclosure and Confidentiality agreements. + diff --git a/docs/CHILI-GraFx/users/deactivate/deactivate01.png b/docs/CHILI-GraFx/users/deactivate/deactivate01.png new file mode 100644 index 00000000..a8d4172d Binary files /dev/null and b/docs/CHILI-GraFx/users/deactivate/deactivate01.png differ diff --git a/docs/CHILI-GraFx/users/deactivate/deactivate02.png b/docs/CHILI-GraFx/users/deactivate/deactivate02.png new file mode 100644 index 00000000..99032a72 Binary files /dev/null and b/docs/CHILI-GraFx/users/deactivate/deactivate02.png differ diff --git a/docs/CHILI-GraFx/users/deactivate/deactivate03.png b/docs/CHILI-GraFx/users/deactivate/deactivate03.png new file mode 100644 index 00000000..ca3cb7be Binary files /dev/null and b/docs/CHILI-GraFx/users/deactivate/deactivate03.png differ diff --git a/docs/CHILI-GraFx/users/deactivate/deactivate04.png b/docs/CHILI-GraFx/users/deactivate/deactivate04.png new file mode 100644 index 00000000..e303e41f Binary files /dev/null and b/docs/CHILI-GraFx/users/deactivate/deactivate04.png differ diff --git a/docs/CHILI-GraFx/users/deactivate/deactivate05.png b/docs/CHILI-GraFx/users/deactivate/deactivate05.png new file mode 100644 index 00000000..78a99f45 Binary files /dev/null and b/docs/CHILI-GraFx/users/deactivate/deactivate05.png differ diff --git a/docs/CHILI-GraFx/users/deactivate/index.md b/docs/CHILI-GraFx/users/deactivate/index.md new file mode 100644 index 00000000..1d426a98 --- /dev/null +++ b/docs/CHILI-GraFx/users/deactivate/index.md @@ -0,0 +1,31 @@ +# User management + +## Deactivate a user + +In situations where a user's access to the platform needs to be temporarily suspended, you have the option to deactivate their account. + +During this deactivation period, the user will not have access to any platform resources. + +However, their access settings and group memberships are retained. This ensures that once the account is reactivated, the user can resume work seamlessly with their previous settings and group affiliations intact. + +### Deactivate + +In the user management, hover over the three dots on the right. + +![ui-full](deactivate01.png) + +Confirm the deactivation + +![ui](deactivate02.png) + +The user will appear gray. + +![ui-full](deactivate03.png) + +### Activate + +Click Activate under the same "..." menu to reactivate the user. + +![ui-full](deactivate04.png) + +![ui-full](deactivate05.png) \ No newline at end of file diff --git a/docs/CHILI-GraFx/users/delete/delete01.png b/docs/CHILI-GraFx/users/delete/delete01.png new file mode 100644 index 00000000..dffd4d86 Binary files /dev/null and b/docs/CHILI-GraFx/users/delete/delete01.png differ diff --git a/docs/CHILI-GraFx/users/delete/delete02.png b/docs/CHILI-GraFx/users/delete/delete02.png new file mode 100644 index 00000000..6d96d018 Binary files /dev/null and b/docs/CHILI-GraFx/users/delete/delete02.png differ diff --git a/docs/CHILI-GraFx/users/delete/index.md b/docs/CHILI-GraFx/users/delete/index.md new file mode 100644 index 00000000..a1f3ec40 --- /dev/null +++ b/docs/CHILI-GraFx/users/delete/index.md @@ -0,0 +1,19 @@ +# User management + +## Delete a user + +In CHILI GraFx, deleting a user results in the permanent removal of their account. This action is irreversible. + +Once a user account is deleted, all associated access privileges are permanently eradicated. It's crucial to consider the implications of this action carefully, as it cannot be undone. + +This ensures complete removal of the user's access and data from the platform. + +### Delete + +In the user management, hover over the three dots on the right. + +![ui-full](delete01.png) + +Confirm the action, if you are sure. + +![ui-full](delete02.png) diff --git a/docs/CHILI-GraFx/users/intro/index.md b/docs/CHILI-GraFx/users/intro/index.md index b7b273be..8b45c491 100644 --- a/docs/CHILI-GraFx/users/intro/index.md +++ b/docs/CHILI-GraFx/users/intro/index.md @@ -1,79 +1,80 @@ -# User management +# User Management ## Introduction -4 basic concepts define the user management. Below you can find the details of each concept. +Five basic concepts define user management. Below you can find the details of each concept. -There are 4 different concepts that make up the user management process in CHILI GraFx. +There are four different concepts that make up the user management process in CHILI GraFx: - - Resources - - Permissions - - Roles - - CHILI GraFx Users +- Resources +- Access +- Roles +- CHILI GraFx Users +- User Groups -Let's dive in to each concept below to see what they do, and how they relate. +Let's dive into each concept below to see what they do, and how they relate. ### Resources !!! Definition - Any item that will be impacted by the user management system. + Any item that will be impacted by the user management system. -Resources are items that make up CHILI GraFx. Control and management of these resources require the proper _permissions_ +Resources are items that make up CHILI GraFx. Control and management of these resources require the proper _access_. + +An example of resources are collections. You can give access to collections through user groups (soon). **Example resources:** GraFx Media assets, GraFx Templates, Users, Environments -!!! Definition - A Person or system identified by a username that performs an operation over the resource - -We defined a CHILI GraFx User as a person or a system. In many cases you will interact as a human with the CHILI GraFx UI. - -In some cases, you'll also need a system user, that can be used to interact with the CHILI GraFx API's. It's wise to unlink this system user from a person. In case the human user changes jobs or roles, you don't need to redefine the access or role for the system user. - -### Permissions +### Access !!! Definition - The authorization to perform an operation over a resource. + The authorization to perform an operation over a resource. -In order to be able to perform an action over a resource, the user must have a role assigned to them that contains the proper permission to do so. +In order to perform an action over a resource, the user must have a role assigned to them that contains the proper permission to do so. -Permissions in CHILI GraFx not assigned on an individual user, but are assigned to a *Role*. +Permissions in CHILI GraFx are not assigned on an individual user basis, but are assigned to a *Role*. **Examples** -create, read, update, delete an asset - -create, read, update, delete a user - -create, remove an environment +- Create, read, update, delete an asset +- Create, read, update, delete a user +- Create, remove an environment ### Roles !!! Definition - A set of permissions that eases the management of permissions to users or groups. + A set of permissions that eases the management of permissions for users or groups. -Normally users are going to have more than just a single permission. It is also likely that you may want to be able to update the permissions of multiple users simultaneously. Roles make this possible. +Normally users will have more than just a single permission. It is also likely that you may want to update the permissions of multiple users simultaneously. Roles make this possible. A Role is a container for permissions. Roles should contain all the necessary permissions needed for an intended purpose or workflow. - ### CHILI GraFx Users !!! Definition - An individual with access to GraFx. + A person or system identified by a username that performs an operation over a resource + +We define a CHILI GraFx User as a person or a system. In many cases, you will interact as a human with the CHILI GraFx UI. + +In some cases, you'll also need a system user, which can be used to interact with the CHILI GraFx APIs. It's wise to unlink this system user from a person. In case the human user changes jobs or roles, you don't need to redefine the access or role for the system user. -A user is someone that has credentials to GraFx. A user can have 1 or more roles assigned to them. These roles will dictate the permissions that the user have which in turn controls their ability to view, create, update, and destroy resources in GraFx +### User Groups +User Groups in CHILI GraFx represent a collection of users — in the same subscription — who share common access needs and roles. Each user group is defined by the access and roles, which collectively determine the actions members of the group can perform in the system. By categorizing users into groups, you simplify access management, allowing administrators to efficiently assign and modify access rights for multiple users simultaneously, enhancing both security and operational efficiency. +Access to a resource (e.g., Environment) is additive. Meaning if you get End User access through group 1, and Environment Admin access through membership of group 2, you will have both access levels assigned. -### Relation between concepts +### Relation Between Concepts ``` mermaid erDiagram GraFx-Subscription ||--|{ Resources : Has GraFx-Subscription ||--|{ GraFx-User : Has - Permission ||--|{ Resources : Impacts - Role ||--|{ Permission : Has - GraFx-User ||--|{ Role : Has-one-or-more + Access ||--|{ Resources : Impacts + Role ||--|{ Access : Defines + GraFx-User ||--|{ Role : Has + User-Group ||--|{ GraFx-User : Has + User-Group ||--|{ Role : Has ``` diff --git a/docs/CHILI-GraFx/users/roles/index.md b/docs/CHILI-GraFx/users/roles/index.md index b2086481..f8068a15 100644 --- a/docs/CHILI-GraFx/users/roles/index.md +++ b/docs/CHILI-GraFx/users/roles/index.md @@ -1,5 +1,51 @@ # User management + +## Overview of Role Access + +We are enhancing our SaaS platform's user management through a phased approach. + +Currently, Subscription Admins and Environment Admins can create templates to familiarize themselves with the system. + +However, these shouldn't be part of your main workflow, as permissions will change in upcoming phases. We're working towards an optimized platform, and we appreciate your adaptability during this transition. + +### Phase 1 (today) + +| Roles | User | SA | EA | TD | CA | +|:---:|:---:|:---:|:---:|:---:|:---:| +|![smallapplogo](/assets/CHILI_publisher_RGB.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | +|![smallapplogo](/assets/CHILI_LOGOS_OK-09.svg)
TD Workspace| 🚫 | ✅ | ✅ | ✅ | ✅| +|![smallapplogo](/assets/CHILI_LOGOS_OK-09.svg)| ✅ | ✅ | ✅ | ✅ | ✅ | +|![smallapplogo](/assets/CHILI_LOGOS_OK-07.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | +|![smallapplogo](/assets/CHILI_LOGOS_OK-11.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | + +### Phase 2 (early 2024) + +| Roles | User | SA | EA | TD | CA | +|:---:|:---:|:---:|:---:|:---:|:---:| +|![smallapplogo](/assets/CHILI_publisher_RGB.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | +|![smallapplogo](/assets/CHILI_LOGOS_OK-09.svg)
TD Workspace| 🚫 | 🚫 | 🚫 | ✅ | ✅(1)| +|![smallapplogo](/assets/CHILI_LOGOS_OK-09.svg)| ✅ | ✅ | ✅ | ✅ | ✅ | +|![smallapplogo](/assets/CHILI_LOGOS_OK-07.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | +|![smallapplogo](/assets/CHILI_LOGOS_OK-11.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | + +In phase 2, Subscription Admins and Environment Admins will have the opportunity to function as Template Designers when they are allocated a Template Designer Seat. + +(1) Content Admins will be able to create Templates, but the output will be watermarked. + +!!! Info "Legend" + **Roles** + + - *End User*: [End User](#end-user) + - *CA*: [Content Admin](#content-administrator) + - *EA*: [Environment Admin](#environment-admin) + - *TD*: [Template Designer](#template-designer) + - *CA*: [Content Admin](#content-administrator) + + **Specific application** + + - *TD Workspace*: The workspace where Template Designers can edit Smart Templates in GraFx Studio + ## Roles ### Subscription Admin @@ -8,14 +54,13 @@ Permissions - - View all subscription(s) assigned to - View usage reporting - View subscription details -- View overview of all the environments in a subscription +- View an overview of all the environments in a subscription - Request add-ons (eg. extra storage) - Directly contact to Client Success Manager -- User management for all users in the subscription (CRUD actions) +- User management for all users in the subscription (CRUD) - Invite users to all available environments in the subscription In the API, this role is labeled as "SA". @@ -29,16 +74,16 @@ In the API, this role is labeled as "SA". !!! Tip "Subscription Admin" **Important**: a Subscription Admin can assign the role 'Subscription Admin' to other users on 'User Detail page'. + A Subscription Admin can take away the role of another **Subscription Admin**. ### Environment Admin -**Definition**: An Environment Admin manages the CHILI GraFx environment(s) where he is assigned to by his Subscription Admin +**Definition**: An Environment Admin manages the CHILI GraFx environment(s) where they are assigned to by their Subscription Admin Permissions - Access to environments where you are Environment Admin -- View overview of all the environments where you are Environment Admin -- Access to GraFx Publisher +- View an overview of all the environments where you are Environment Admin - Manage the CHILI GraFx environment where you are Environment Admin - Environment Settings (eg. branding) - User management (CRUD actions) for the users of environments where you are Environment Admin @@ -46,100 +91,56 @@ Permissions In the API, this is labeled as "EA". -### User +### End User -**Definition**: A User works as an end user in the CHILI GraFx environment(s) where they are assigned to. This is the default role, and cannot be removed. +**Definition**: An "End User" works as an end user in the CHILI GraFx environment(s) to which they are assigned. This is the default role, and cannot be removed. Permissions -- Access to the environments the user is assigned to -- View overview of all the environments where the user is Environment User -- Limited in what applications they can access (see table below) +- Access to the environments the End User is assigned to +- View an overview of all the environments where the End User has access +- Limited in what applications they can access (see table) +- Create "[My projects](/GraFx-Studio/guides/create-projects/)" based on Collections (using fonts & media that are made available in the template) -In the API, this is labeled as "EU". +In the API, this is labeled as "EU". (End User) !!! Warning "Template Designer" - - If an Environment user wants to create templates in the CHILI GraFx environment this user needs to have an additional role: [Template Designer](#template-designer). + - If an End User wants to create templates in the CHILI GraFx environment this user needs to have an additional role: [Template Designer](#template-designer). See also [Phased approach in roles](#overview-of-role-access) ### Template Designer -See the [Template Designer Seat](/CHILI-GraFx/users/template-designer-seat/) page +See the [Template Designer Seat](/CHILI-GraFx/users/template-designer/) page ### Content Administrator **Definition**: A content Administrator is a legacy role, available to users that have been converted from CHILI publisher Online. -A content Administrator can create and use GraFx Publisher templates. There is no limit to Content Administrators for converted CHILI publisher Online customers. +A content Administrator can create and use GraFx Publisher templates. There is no limit to Content Administrators for converted CHILI publisher Online customers. This role will not be visible to Subscriptions without a prior CHILI publisher Online subscription. -Content Administrators will be able to create templates in GraFx Studio, but the output will be watermarked in [phase 2](#phase-2-2024). - -## Overview of Role Access - -We're enhancing our SaaS platform's user management through a phased approach. - -Currently, Subscription Admins and Environment Admins can create templates to familiarize themselves with the system. - -However, these shouldn't be part of your main workflow, as permissions will change in upcoming phases. We're working towards an optimized platform, and we appreciate your adaptability during this transition. - -### Phase 1 (today) - -| Roles | User | SA | EA | TD | CA | -|:---:|:---:|:---:|:---:|:---:|:---:| -|![smallapplogo](/assets/CHILI_publisher_RGB.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | -|![smallapplogo](/assets/CHILI_LOGOS_OK-09.svg)
TD Workspace| 🚫 | ✅ | ✅ | ✅ | ✅| -|![smallapplogo](/assets/CHILI_LOGOS_OK-09.svg)| ✅ | ✅ | ✅ | ✅ | ✅ | -|![smallapplogo](/assets/CHILI_LOGOS_OK-07.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | -|![smallapplogo](/assets/CHILI_LOGOS_OK-11.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | - -### Phase 2 (End of 2023) - -| Roles | User | SA | EA | TD | CA | -|:---:|:---:|:---:|:---:|:---:|:---:| -|![smallapplogo](/assets/CHILI_publisher_RGB.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | -|![smallapplogo](/assets/CHILI_LOGOS_OK-09.svg)
TD Workspace| 🚫 | 🚫 | 🚫 | ✅ | ✅(1)| -|![smallapplogo](/assets/CHILI_LOGOS_OK-09.svg)| ✅ | ✅ | ✅ | ✅ | ✅ | -|![smallapplogo](/assets/CHILI_LOGOS_OK-07.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | -|![smallapplogo](/assets/CHILI_LOGOS_OK-11.svg)| 🚫 | ✅ | ✅ | ✅ | ✅ | - - -In phase 2, Subscription Admins and Environment Admins will have the opportunity to function as Template Designers when they are allocated a Template Designer Seat. - -(1) Content Admins will be able to create Templates, but the output will be watermarked. - -!!! Info "Legend" - **Roles** - - - *SA*: Subscription Admin - - *EA*: Environment Admin - - *TD*: Template Designer - - *CA*: Content Admin - - **Specific application** - - - *TD Workspace*: The workspace where Template Designers can edit Smart Templates +Content Administrators will be able to create templates in GraFx Studio, but the output will be watermarked. ## User creation and invitation ### First user -The first user will be the subscription admin, and is created by CHILI GraFx, as a result of a signed contract. +The first user will be the [Subscription Admin](/CHILI-GraFx/users/roles/#subscription-admin), and is created by CHILI publish, as a result of a signed contract. ### Subsequent Users -All users (except the first (subscription admin) user) can be invited to CHILI GraFx by +Other users can be invited to CHILI GraFx by - A Subscription Admin - An Environment Admin Only the Subscription Admin & the Environment Admin can access the User Management page on CHILI GraFx where they can: -- view an overview of the users -- view an overview of the roles on CHILI GraFx -- invite users to CHILI GraFx +- View an overview of the users +- Invite users to CHILI GraFx +- Give access to users ## Changing roles -Click here to see how to [change roles & Environment access](/CHILI-GraFx/users/update/). +Click here to see how to [change roles & Environment access](/CHILI-GraFx/users/update/). \ No newline at end of file diff --git a/docs/CHILI-GraFx/users/scope/index.md b/docs/CHILI-GraFx/users/scope/index.md index 96d2a61b..412f2181 100644 --- a/docs/CHILI-GraFx/users/scope/index.md +++ b/docs/CHILI-GraFx/users/scope/index.md @@ -1,26 +1,30 @@ # User management -## Scope of permissions +## Scope of roles -The scope of the permissions is the concept that not all permissions have the same impact. Some permissions have impact on a different level. +Roles on the Subscription level, have a different impact than a role on the Environment level. -The schema below shows the relation between the levels in a CHILI GraFx Subscription, to then explain the impact of permissions (roles) on these levels +When you are SubScription Admin, you can define who's an Environment Admin, for each Environment. + +When you are (only) an Environment Admin, you don't have access to the subscription level. + +The schema below shows the relation between the levels in a CHILI GraFx Subscription, to then explain the impact of access on these levels ``` mermaid erDiagram - CHILI-GraFx-Client ||--|{ GraFx-Subscription : Has - GraFx-Subscription ||--|{ GraFx-Environment : Has + CHILI-GraFx-Client ||--|{ GraFx-Subscription : Has-one-or-more + GraFx-Subscription ||--|{ GraFx-Environment : Has-one-or-more ``` ### A GraFx Subscription -Roles defined on the Subscription level have permission with impact for all environments. -These contain operations like managing the lifecycle of identities and environments. +Roles on the subscription level define access for all environments. +These contain operations like managing the lifecycle of users and environments. ### Environment -An environment is the smallest level, where documents are grouped to serve an application. The minimum restriction you can apply to a set of resources, is the environment level. +An environment is the base level, where documents are grouped to serve an application. The minimum restriction you can apply to a set of resources is the environment level. ### Roles -[Roles](/CHILI-GraFx/users/roles/) (and permissions) on the environment level affect only the specific environment. \ No newline at end of file +[Roles](/CHILI-GraFx/users/roles/) on the environment level affect only the specific environment. \ No newline at end of file diff --git a/docs/CHILI-GraFx/users/template-designer/index.md b/docs/CHILI-GraFx/users/template-designer/index.md index ade54d2f..2b025c58 100644 --- a/docs/CHILI-GraFx/users/template-designer/index.md +++ b/docs/CHILI-GraFx/users/template-designer/index.md @@ -14,19 +14,19 @@ Assigned permissions - Update templates - delete templates -!!! Warning "Different permissions then Environment user" +!!! Warning "Different permissions than Environment user" - Different permissions than Environment User - - The Template Designer has to be assigned on the Subscription Management page since this role is an paying add-on - - A Template Designer is assigned on Subscription Level and gives this user access to all the environments of that subscription + - The Template Designer has to be assigned on the Subscription Management page since this role is a paying add-on + - A Template Designer Seat is assigned on the Subscription Level. If the user has access to an environment, with a Seat assigned, they can make templates in the environments they have access to. - To use the Desktop plugins you don't need a template designer seat: importing content in GraFx Publisher or GraFx Studio doesn't require a template designer seat but making the templates smart does require a seat. -Template designer seats (role) is assigned on the Subscription page +Template designer seats (role) are assigned on the Subscription page ![Template Designer Seat](tds_assign_seat.png) -In the Assigned seats tab, you can free seats to allow other users in your seat. +In the Assigned Seats tab, you can free seats to allow other users in your seat. ![Template Designer Seat](tds_remove_seat.png) !!! warning "Important for CHILI publish Online customers" - The restriction does not apply for GraFx Publisher, for customers that had a previous CHILI publish Online subscription. You are still able to add users, assign the [Content Administrator](/CHILI-GraFx/users/roles/#content-administrator) role, and these people will be able to make and use GraFx Publisher templates. \ No newline at end of file + The restriction does not apply for GraFx Publisher, for customers that had a previous CHILI publish Online subscription. You are still able to add users, and assign the [Content Administrator](/CHILI-GraFx/users/roles/#content-administrator) role, and these people will be able to make and use GraFx Publisher templates. \ No newline at end of file diff --git a/docs/CHILI-GraFx/users/transition/GraFx-Publisher_01.png b/docs/CHILI-GraFx/users/transition/GraFx-Publisher_01.png index 4bdd1644..00f8fefd 100644 Binary files a/docs/CHILI-GraFx/users/transition/GraFx-Publisher_01.png and b/docs/CHILI-GraFx/users/transition/GraFx-Publisher_01.png differ diff --git a/docs/CHILI-GraFx/users/transition/GraFx-Publisher_03.png b/docs/CHILI-GraFx/users/transition/GraFx-Publisher_03.png index ce1169c4..764da5ba 100644 Binary files a/docs/CHILI-GraFx/users/transition/GraFx-Publisher_03.png and b/docs/CHILI-GraFx/users/transition/GraFx-Publisher_03.png differ diff --git a/docs/CHILI-GraFx/users/transition/GraFx-Publisher_04.png b/docs/CHILI-GraFx/users/transition/GraFx-Publisher_04.png new file mode 100644 index 00000000..ba070012 Binary files /dev/null and b/docs/CHILI-GraFx/users/transition/GraFx-Publisher_04.png differ diff --git a/docs/CHILI-GraFx/users/transition/GraFx-Publisher_05.png b/docs/CHILI-GraFx/users/transition/GraFx-Publisher_05.png new file mode 100644 index 00000000..ec4ba145 Binary files /dev/null and b/docs/CHILI-GraFx/users/transition/GraFx-Publisher_05.png differ diff --git a/docs/CHILI-GraFx/users/transition/index.md b/docs/CHILI-GraFx/users/transition/index.md index a3635b03..8af044a7 100644 --- a/docs/CHILI-GraFx/users/transition/index.md +++ b/docs/CHILI-GraFx/users/transition/index.md @@ -53,8 +53,26 @@ If you logged in via the right URL, you'll see this: ![screenshot](GraFx-Publisher_02.png) -Continue with "Users" and create the "API" user. We called it "API" but feel free to give the user a different name. +Continue with "Users" and create the "API" user. We called it "AP1" but feel free to give the user a different name. ![screenshot](GraFx-Publisher_03.png) -Now your API user for Integration with GraFx Publisher is ready. \ No newline at end of file +Now link your API user with the user groups you need. + +### Create a GraFx Publisher Group + +When logging into Publisher you'll see this: + +![screenshot](GraFx-Publisher_04.png) + +Continue with "User groups" and create a group. We called it "end user". Then select the permission categories and individual permissions you users will need. + +![screenshot](GraFx-Publisher_05.png) + +Please note these groups are specific for CHILI GraFx Publisher and work for API users for Publisher. + +### Note for Chili-Publish Online customers + +We have removed the OLD checkbox "Environment Administrator" from the Publisher interface. + +If your API users need to have all of the permissions in the environment, you can create a group (you can call it "Environment Administrator"), set all of the privileges to that group, and use this group as you would use the checkbox. \ No newline at end of file diff --git a/docs/GraFx-Data/index.md b/docs/GraFx-Data/index.md deleted file mode 100644 index 0316feeb..00000000 --- a/docs/GraFx-Data/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Introduction - -![applogo](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS-Data_logo.svg) - -Connect GraFx Data with any data provider—or add your own data—then use GraFx Studio to drive fully-automated graphical production. - -!!! Info - Available soon \ No newline at end of file diff --git a/docs/GraFx-Developers/grafx-studio/ui/index.md b/docs/GraFx-Developers/grafx-studio/ui/index.md new file mode 100644 index 00000000..c28ec763 --- /dev/null +++ b/docs/GraFx-Developers/grafx-studio/ui/index.md @@ -0,0 +1,44 @@ +# Integrate GraFx Studio UI + +## Introduction + +**Making Smart Templates** + +To make Smart Templates in GraFx Studio, you'll need a "template designer seat." Once your template is ready, it moves to the stage where end users can interact with it, specifically in "[My Projects](/GraFx-Studio/guides/create-projects/)." This area is where templates come to life, allowing end users to consume and customize them to fit their needs. + +![screenshot-full](studio-ui.png) + +**In your webportal** + +Moreover, this end user interface isn't limited to just the CHILI GraFx environment; it's designed for broader application and can be seamlessly integrated into custom web portals. + +This flexibility opens up numerous possibilities for customizing and enhancing the user experience. For detailed instructions on integrating the end user interface into your web portal, refer to the guide below. + +## Token + +!!! warning + Before you start, take note on how to generate a token. + +Since you don't want to pass secure credentials, your server side code will need to generate a token. + +[This page](/CHILI-GraFx/guides/integrations/#step-4-generating-an-access-token) explains how. + +## Quick start + +On [this page on Github](https://github.com/chili-publish/studio-ui?tab=readme-ov-file#studio-ui), you can get started in no time to have your own GraFx Studio UI integrated. + +- Define a `
` on your page +``` html +
+``` +- Inject the JavaScript +```html + +``` +- Define custom logic and credentials (examples can be found on [Github](https://github.com/chili-publish/studio-ui?tab=readme-ov-file#studio-ui)) + +All information can be found here: [see all details on Github](https://github.com/chili-publish/studio-ui?tab=readme-ov-file#studio-ui) + +## Advanced integration + +If the basics don't cover your needs, this more [advanced page](https://github.com/chili-publish/studio-ui/blob/main/documentation/advanced-integration.md) explains all in more detail. diff --git a/docs/GraFx-Developers/grafx-studio/ui/studio-ui.png b/docs/GraFx-Developers/grafx-studio/ui/studio-ui.png new file mode 100644 index 00000000..6e6297c2 Binary files /dev/null and b/docs/GraFx-Developers/grafx-studio/ui/studio-ui.png differ diff --git a/docs/GraFx-Developers/index.md b/docs/GraFx-Developers/index.md index 4abc8f0c..b9efe709 100644 --- a/docs/GraFx-Developers/index.md +++ b/docs/GraFx-Developers/index.md @@ -1,6 +1,6 @@ # Integrate CHILI GraFx apps -To communicate with GraFx, please use these two APIs. You can learn more about the role of each API below. +To communicate with CHILI GraFx, use these two APIs. You can learn more about the role of each API below. - [Platform API](https://api.chiligrafx.com/swagger/index.html) - [Environment API](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) @@ -9,14 +9,9 @@ Client side - [GraFx Studio SDK](https://chili-publish.github.io/studio-sdk/index.html) -**You can access the specific interactive Swagger for your environment API via the following format** - -Production: `.chili-publish.online/grafx/swagger/index.html` - -Sandbox: `.chili-publish-sandbox.online/grafx/swagger/index.html` ## Platform API -The GraFx Platform API allows you to manage GraFx Platform resources. +The CHILI GraFx Platform API allows you to manage CHILI GraFx Platform resources. Some example use cases are: @@ -27,6 +22,10 @@ Some example use cases are: ## Environment API +**You can access the specific interactive Swagger for your environment API via integration setup** + +![ui](integration01.png) + Through the **GraFx Environment API** you can manage your CHILI GraFx environment. Some example use cases are: @@ -76,9 +75,9 @@ You can find out more about generating credentials in our [Integration Guide](/C ## GraFx Publisher -- [REST API Reference](https://mydocumentation.chili-publish.com/search?text=rest%20api%20endpoints){target="_blank"} -- [Javascript API](https://mydocumentation.chili-publish.com/search?text=Getting%20started%20with%20your%20JavaScript%20integration){target="_blank"} -- [Getting Started](https://mydocumentation.chili-publish.com/search?text=chili%20api%20guide){target="_blank"} +- [REST API Reference](https://chilipublishdocs.atlassian.net/wiki/spaces/CPDOC/pages/1413560/REST+API+Endpoints){target="_blank"} +- [Javascript API](https://chilipublishdocs.atlassian.net/wiki/spaces/CPDOC/pages/1412075/Getting+started+with+your+JavaScript+integration){target="_blank"} +- [Getting Started](https://chilipublishdocs.atlassian.net/wiki/spaces/CPDOC/pages/1412012/CHILI+API+Guide){target="_blank"} ## GraFx Media diff --git a/docs/GraFx-Developers/integration01.png b/docs/GraFx-Developers/integration01.png new file mode 100644 index 00000000..f0ff7794 Binary files /dev/null and b/docs/GraFx-Developers/integration01.png differ diff --git a/docs/GraFx-Insights/index.md b/docs/GraFx-Insights/index.md deleted file mode 100644 index 2020f6f0..00000000 --- a/docs/GraFx-Insights/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# Introduction - -![applogo](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS-Insights-1.svg) - -Get analytics and reports on your Smart Templates usage in GraFx Studio, and start assessing your big return on investment with GraFx Insights. - -CHILI GraFx also has powerful connectivity at core, ending creative silos and making it incredibly easy to link to any external digital asset management (DAM) system, font manager, style set manager, and more. - -!!! Info - Available soon \ No newline at end of file diff --git a/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter0.png b/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter0.png new file mode 100644 index 00000000..a43c5a2a Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter0.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter1.png b/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter1.png new file mode 100644 index 00000000..3d8daf41 Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter1.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter2.png b/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter2.png new file mode 100644 index 00000000..e4995d1c Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter2.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter3.png b/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter3.png new file mode 100644 index 00000000..3c472cef Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter3.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter4.png b/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter4.png new file mode 100644 index 00000000..6a87626e Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-Illustrator/converter4.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-Illustrator/index.md b/docs/GraFx-Publisher/convert/Adobe-Illustrator/index.md new file mode 100644 index 00000000..cd3ee808 --- /dev/null +++ b/docs/GraFx-Publisher/convert/Adobe-Illustrator/index.md @@ -0,0 +1,53 @@ +# GraFx Publisher Converter for Adobe® Illustrator® + +## Download + +Download the newest version + +[Version 8.0 here](https://s3.eu-central-1.amazonaws.com/releases.chili-publish.com/releases/Desktop_Tools/8.0.0.0_Ai_202403130815/CHILI_Illustrator_Plugin_8.0.0.0.zip). + +## Converter Overview + +![screenshot](converter0.png) + + +### Server Connection Setup + +![screenshot](converter1.png) + +- **Preset**: Save your server connection as a preset for easy future access. +- **URL**: Enter the URL to your GraFx Publisher instance. + - GraFx Publisher format: `https://[your CHILI url]/main.asmx` + - Legacy systems format: `https://[your CHILI url]/CHILI/main.asmx` +- **Environment**: Specify the name of your environment. +- **Login**: Authenticate using your CHILI GraFx platform credentials. +- **Status**: Check your connection status. + +### Exporting to GraFx Publisher + +![screenshot](converter2.png) + +Configure your export settings: + +- **Preset**: Use a previously saved preset. +- **Destination**: Choose between uploading to GraFx Publisher or creating a local CHILI package. +- **Folders**: Designate folders for documents, images, and fonts. Ensure these exist before conversion. +- **Document Name**: Set your file's name. + +### Preflight Checks + +Identify potential issues before conversion with Preflight checks. + +![screenshot](converter3.png) + +### Preferences + +![screenshot](converter4.png) + +Customize your settings: + +- **Language** +- **Overwrite Options** +- **Logging**: Enable detailed conversion logs. +- **Log Level**: Select the amount of detail for your logs. +- **Version**: View the current version. \ No newline at end of file diff --git a/docs/GraFx-Publisher/convert/Adobe-InDesign/extension1.png b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension1.png new file mode 100644 index 00000000..c3f9345c Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension1.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-InDesign/extension2.png b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension2.png new file mode 100644 index 00000000..9ff5e0b1 Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension2.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-InDesign/extension3.png b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension3.png new file mode 100644 index 00000000..ab482d64 Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension3.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-InDesign/extension4.png b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension4.png new file mode 100644 index 00000000..2c546a8b Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension4.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-InDesign/extension5.png b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension5.png new file mode 100644 index 00000000..5a33fc33 Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension5.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-InDesign/extension6.png b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension6.png new file mode 100644 index 00000000..50717de8 Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension6.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-InDesign/extension7.png b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension7.png new file mode 100644 index 00000000..bf1e6197 Binary files /dev/null and b/docs/GraFx-Publisher/convert/Adobe-InDesign/extension7.png differ diff --git a/docs/GraFx-Publisher/convert/Adobe-InDesign/index.md b/docs/GraFx-Publisher/convert/Adobe-InDesign/index.md new file mode 100644 index 00000000..657b77fe --- /dev/null +++ b/docs/GraFx-Publisher/convert/Adobe-InDesign/index.md @@ -0,0 +1,109 @@ +# GraFx Publisher Converter for Adobe® InDesign® + +## Download + +Download the newest version + +[Version 8.0 (Unsigned)](https://s3.eu-central-1.amazonaws.com/releases.chili-publish.com/releases/Desktop_Tools/8.0.0.0_Id_202403130816/CHILI_InDesign_Extensions_8.0.0.0_Unsigned.zip) + +[Version 8.0](https://s3.eu-central-1.amazonaws.com/releases.chili-publish.com/releases/Desktop_Tools/8.0.0.0_Id_202403130816/CHILI_InDesign_Extensions_8.0.0.0.zip) + +## How to access Converter? + +You can find the GraFx Publisher converter in Adobe® InDesign® under the "Window" menu. + +![screenshot](extension1.png) + +There are two ways of working: online and offline. +When working offline the conversion of the document will happen locally and the end result will be a GraFx Publisher Package file [.zip] saved to your local drive. + +This file will contain the converted document as well as all the images and fonts used in the document. This file will be uploaded to GraFx Publisher in a later stage. + +When working online, a direct connection is made. To do that you specify the link to the server, the environment where you want to upload the document, and a username and password. + +Once logged in you are presented with a similar interface as when working offline. If you are logged in as an admin you are still able to select another environment if necessary. +In this mode, the converted file, images and fonts will be uploaded immediately to the server after conversion. + +Working in online modus also offers you the possibility to convert a GraFx Publisher document back to InDesign® via the "Export to InDesign®" panel. + +## Export an Indesign® document to GraFx Publisher + +### Server panel + +- Preset: From the drop down menu you can select previously saved login settings. When you regularly need to connect to different servers this will save you time. +- New - Save - Delete: Via these buttons you can save and create presets for different connections to GraFx Publisher servers or different environments on one server. +- Preset name: Name used for the preset when saving connection settings +- URL: Connection to a GraFx Publisher server. http:// your server IP address or domain /CHILI/main.asmx +- Environment let's you specify the environment for which you have an account +- Name: your username +- Password: your password +- Auto login: click this button to login to the server and environment +- Status: displays the connection status + +![screenshot](extension2.png) + +## Import settings panel + +![screenshot](extension4.png) + +- **Preset**: From the drop down menu you can select previously saved login settings. When you regularly need to connect to different servers this will save you time. +- **New - Save - Delete**: Via these buttons you can save and create presets for different connections to GraFx Publisher servers or different environments on one server. +- **Preset name**: Name used for the preset when saving connection settings +- **Documents** specifies the destination path of the document on the GraFx Publisher server after conversion. +- **Images**: specifies the destination path of the images on the GraFx Publisher server after conversion. +- **Fonts**: specifies the destination path of the fonts on the GraFx Publisher server after conversion. + +Paths can be entered manually or selected via the browse button. If the destination folder doesn't exist yet, it will be created automatically.  +  + +- **Log file**: specifies the destination path for the log file. This is a local path on your computer (f.e. path on a macintosh: /Users/Usersname/chiliLog.txt) +- **Log detail**: Specifies the level of detail when logging items in the log file. +- **Include Document Preview** creates a preview of the InDesign® file along with the conversion +- **Convert gradients** to PDF will convert complex gradients to pdf and places them as an image in the online document. +- **Include hidden layers** includes the hidden layers of the InDesign® document +- **Use high resolution for locked layers** converts everything on the selected layer to pdf and places this on the layer +- **Import selection only** converts only the frames selected in the document. + +## Export to GraFx Publisher + +![screenshot](extension5.png) + +- **Source** specifies the document to convert (as multiple document can be opened in InDesign®) +- **Destination** allows to switch between online (server) or offline (package) conversion +- **Environment** let's you specify the environment where the converted document will be uploaded to [the selection is only available if your account gives you access to multiple environments] +- **Pages**: Specify the range of pages to convert or convert all pages +- **Locked Layers** is used to lock all elements on the selected layer [and the layer] automatically in the online version after conversion Saving you time. Layers with "lock" in the name or layers called "background" will be selected here by default +- **Go!** Starts the conversion. When you're working in offline, you will be asked where to save the package file after conversion +- **Open document** in browser Only available in online mode. After conversion the document will be opened in your default webbrowser when this is checked +- **Create ZIP** starts the conversion and the creation of the CHILI Package in offline modus + +## Export to InDesign® + +![screenshot](extension6.png) + +- **Environment** let's you specify the environment where the target document can be found +- **Document Name** Select the file for conversion +- **Layout** specifies which alternate lay-out will be converted in case the CHILI document has several defined [more about alternate lay-outs can be found here: Alternate Layouts] +- **Export setting** specifies which IDML preset to use for the conversion. More information can be found here: IDML conversion settings +- **Destination folder** specifies the save location on your local disk +- **File name**: Name of the file after conversion +- **Create document folder** creates a folder that will contain the converted document and the assets and fonts +- **Export** initiates the conversion process + +## How to change the settings for the conversion of locked layers and images.  + +With the installation of the converter 3 PDF presets are configured in Adobe® InDesign® as well, that control the conversion to PDF of locked layers and images. + +![screenshot](extension7.png) + +The default presets are tested and guaranteed to work with GraFx Publisher and we offer full support for these. +You're welcome to change the settings at your own risk. Changes to these default settings are beyond our responsibility. + +## Adobe PDF Presets + +**Converter - Images**: This preset defines the settings for the conversion to pdf of images used in the InDesign® file (tiff, eps, psd, ai). GraFx Publisher supports these type of files natively as well, but when the conversion is done, images are optimized according to their dimensions used in the document (300dpi, at placed dimensions). + +**Converter - Locked Layers High Res**: This preset defines the settings for the conversion to pdf of locked layers when the checkbox "Use high resolutions for Locked Layers" is selected. + +**Converter - Locked Layers Low Res**: This preset defines the settings for the conversion to pdf of locked layers + diff --git a/docs/GraFx-Publisher/convert/intro/index.md b/docs/GraFx-Publisher/convert/intro/index.md new file mode 100644 index 00000000..9b9405d3 --- /dev/null +++ b/docs/GraFx-Publisher/convert/intro/index.md @@ -0,0 +1,11 @@ +# Convert Desktop files to CHILI GraFx + + +CHILI GraFx enhances Smart Template creation for digital and print formats, positioned at the workflow's end, from concept through approval to end-user interaction. It facilitates converting existing documents into GraFx Publisher, where Document Intelligence and brand rules are applied, allowing user engagement. + +To support this streamlining template adaptation and integration, CHILI GraFx has extensions like + +- GraFx Publisher Converter for Adobe InDesign +- Data Manager +- Live Preflight +- Converter for Adobe Illustrator diff --git a/docs/GraFx-Studio/concepts/actions/index.md b/docs/GraFx-Studio/concepts/actions/index.md index 8b1fae19..4d83db56 100644 --- a/docs/GraFx-Studio/concepts/actions/index.md +++ b/docs/GraFx-Studio/concepts/actions/index.md @@ -1,53 +1,53 @@ -# Actions - -## Introduction - -"Hi Jane. The customer asked if we can make this price stand out when it's a promotion?" - -![](ad1.png) - -Jane: "Like this?" - -![](ad2.png) - -"Yes, perfect! And now let's make this happen automatically for all 76,500 items." - -Jane: "I will add a trigger on the 'Promo' variable. If it says 'promo', then I will show a shape behind the price to make it stand out." - -## Concept - -The concept of an Action in GraFx Studio is simple: What should the GraFx Smart Template do, and when should it do it. - -### When: Triggers - -"When" is covered by Triggers. - -Imagine Triggers as a system that monitors what is happening in the Template. When a predefined change is detected (triggered), an Action will be performed. - -### What: Actions - -Actions are the scripts that will be executed when this change is detected. - -## Triggers - -What can be detected? - -- Select layout changed -- Frame moved -- Page size changed -- Document loaded -- Variable value changed - -If any of the above situations occur, a trigger is called. - -It is important to know that a trigger can be called through the manipulation of the template by an end-user. A trigger can also be called if a condition is met through the execution of batch output. - -## Actions - -The second tab in the Trigger popup screen shows the Action editor. - -Enter your JavaScript code that should be executed. - -![image](actioncode.png) - +# Actions + +## Introduction + +"Hi Jane. The customer asked if we can make this price stand out when it's a promotion?" + +![](ad1.png) + +Jane: "Like this?" + +![](ad2.png) + +"Yes, perfect! And now let's make this happen automatically for all 76,500 items." + +Jane: "I will add a trigger on the 'Promo' variable. If it says 'promo', then I will show a shape behind the price to make it stand out." + +## Concept + +The concept of an Action in GraFx Studio is simple: What should the GraFx Smart Template do, and when should it do it. + +### When: Triggers + +"When" is covered by Triggers. + +Imagine Triggers as a system that monitors what is happening in the Template. When a predefined change is detected (triggered), an Action will be performed. + +### What: Actions + +Actions are the scripts that will be executed when this change is detected. + +## Triggers + +What can be detected? + +- Select layout changed +- Frame moved +- Page size changed +- Document loaded +- Variable value changed + +If any of the above situations occur, a trigger is called. + +It is important to know that a trigger can be called through the manipulation of the template by an end-user. A trigger can also be called if a condition is met through the execution of batch output. + +## Actions + +The second tab in the Trigger popup screen shows the Action editor. + +Enter your JavaScript code that should be executed. + +![image](actioncode.png) + See further [How to create an action](/GraFx-Studio/guides/actions/create/) and [Intro to writing JavaScript](/GraFx-Studio/guides/actions/javascript/) \ No newline at end of file diff --git a/docs/GraFx-Studio/concepts/grafx-genie/index.md b/docs/GraFx-Studio/concepts/grafx-genie/index.md index 43e5737d..bb81757f 100644 --- a/docs/GraFx-Studio/concepts/grafx-genie/index.md +++ b/docs/GraFx-Studio/concepts/grafx-genie/index.md @@ -15,16 +15,16 @@ It's designed to assist you in creating actions, which play a vital role within ## Example -You have a retail template. A variable field allows the users of the template to enter a discount percentage. +You have a retail template. A template variable field allows the users of the template to enter a discount percentage. When the discount drops below — let's say — 30%, you (as a template designer) want to show an extra asset, to hi-light the steep discount. ![image](template.png) -A variable makes sure a user can change the discount. +A template variable makes sure a user can change the discount. ![image](variable.png) -Now, let's make an action, that will be triggerd with a variable value changes. +Now, let's make an action, that will be triggerd when a template variable value changes. ![image](trigger.png) @@ -32,7 +32,7 @@ To create the action, click on the Action tab. ![image](action.png) -You can now ask Genie to write the script for you. +You can now ask GraFx Genie to write the script for you. Click on the GraFx Genie icon. @@ -40,18 +40,18 @@ Click on the GraFx Genie icon. ![image](genie1.png) -And ask Genie what functionality you need in your Smart Template +Ask GraFx Genie what functionality you need in your Smart Template ![image](genie2.png) -Genie will now suggest a JavaScript you can use to perform the functionality. +GraFx Genie will now suggest a JavaScript you can use to perform the functionality. ![image](action2.png) -As you see, Genie knows about the context. Without specifiing that discount is a variable name, it will understand and use this information to write the script. +As you see, GraFx Genie knows about the context. Without specifying that discount is a template variable name, it will understand and use this information to write the script. If you're not 100% convinced, you can still tweak the script, or ask a Developer colleague to take a look for the final touches. The result: -![image](genie-in-action.gif) \ No newline at end of file +![image](genie-in-action.gif) diff --git a/docs/GraFx-Studio/concepts/variables/index.md b/docs/GraFx-Studio/concepts/variables/index.md index fc53bf8a..81f4e30c 100644 --- a/docs/GraFx-Studio/concepts/variables/index.md +++ b/docs/GraFx-Studio/concepts/variables/index.md @@ -1,45 +1,78 @@ -# Variables +# Understanding Variables in GraFx Studio -!!! Info +In GraFx Studio, we utilize the concept of variables in two distinct contexts to enhance automation and flexibility in document creation. This page aims to clarify the differences and uses of "**JavaScript variables**" and "**Template variables**". - A variable is a named container for a particular set of data (text, image reference, date, etc...). +## JavaScript Variables - Source: [Wikipedia](https://en.wikipedia.org/wiki/Variable_(computer_science)){target="_blank"} +### Definition and Purpose - In the context of **GraFx Studio**, that variable is used in a frame as placeholder to be replaced with the content of the variable or datasource. +**JavaScript Variables** are used within Actions to automate the document. -## Example +These variables are integral in scripting custom behaviors, controlling document flow, and manipulating data in real-time. -!!! Text - "Hello , +### Example Use-Case - How is life?" +Suppose you need to calculate a total based on other parameters. A **JavaScript variable** can be used to store the total and update it in the Actions script. +```javascript +var firstvalue = 10; // JavaScript Variable +var secondvalue = 20; // JavaScript Variable +var total = firstvalue + secondvalue; // total will hold the value 30 +``` -This text contains a placeholder for a **firstname**. +## Template Variables -We assume it's supposed to be a firstname, because of the name. +### Definition and Purpose -But the name of the variable **firstname** is not related to the content. +**Template Variables**, are used within a GraFx Studio template to store variable content. They allow end users to customize and change elements like text and images in a predefined template. These variables make templates flexible and adaptable to different needs and scenarios. -It could also have been: +### Example Use-Cases -!!! Text - "Hello , +![image](template-variable-1.png) - How is life?" +![image](template-variable-2.png) -Variables are placeholders, that will be replaced with variable content. -## Types of content +## Bridging Actions and Templates -The type of content for the variable will differ with the context. In the previous example, this most likely will be a piece of text. +Now, how do these two types of variables interact? Let's use a simple example to explain: -In other cases, it could be a reference to an image (or other digital asset). +As in the screenshot above, we have a Template variable named "headline", and you want to use this headline in an action. Here's how you can do it: -!!! Info - https://upload.wikimedia.org/wikipedia/commons/6/68/Raffael_058.jpg +Imagine this Action in your template - ![Image](https://upload.wikimedia.org/wikipedia/commons/6/68/Raffael_058.jpg) +```javascript +let a = getVariableValue('headline'); +let newheadline = a + " Now"; +setVariableValue('headline', newheadline); +``` -When the frame has a source reference **$ImageRef** then you can replace the variable **$ImageRef** with the source that is relevant at any moment. \ No newline at end of file +### Getting the Template Variable Value + +There is a [helper function](/GraFx-Studio/concepts/helper-functions/#get) called `getVariableValue()`. This function acts like a question you ask to your template: "Hey, what's the current value of this Template Variable?" + +You can then store this value in a JavaScript Variable. For example + +```javascript +var a = getVariableValue('headline'); +``` + +This line says: "Store the headline's content in a container named 'a'." + +### Using the Value + +Once the value from the Template Variable is stored in the JavaScript Variable 'a', you can use it or manipulate it in your script. + +```javascript +var newheadline = a + " Now"; +``` + +### Going back to the Template + +Once the Javascript action has done its magic, you can use the new contents of the JavaScript variable, to store it back into the Template variable. + +```javascript +setVariableValue("headline", a); +``` + +This allows a seamless interaction between the content in your template and the actions you can script using JavaScript. diff --git a/docs/GraFx-Studio/concepts/variables/template-variable-1.png b/docs/GraFx-Studio/concepts/variables/template-variable-1.png new file mode 100644 index 00000000..4f47adbb Binary files /dev/null and b/docs/GraFx-Studio/concepts/variables/template-variable-1.png differ diff --git a/docs/GraFx-Studio/concepts/variables/template-variable-2.png b/docs/GraFx-Studio/concepts/variables/template-variable-2.png new file mode 100644 index 00000000..1e7ad125 Binary files /dev/null and b/docs/GraFx-Studio/concepts/variables/template-variable-2.png differ diff --git a/docs/GraFx-Studio/guides/actions/create/action.png b/docs/GraFx-Studio/guides/actions/create/action.png index 6fff35cc..aabc399f 100644 Binary files a/docs/GraFx-Studio/guides/actions/create/action.png and b/docs/GraFx-Studio/guides/actions/create/action.png differ diff --git a/docs/GraFx-Studio/guides/actions/create/actionlist.png b/docs/GraFx-Studio/guides/actions/create/actionlist.png index 7f17ab6f..e3165587 100644 Binary files a/docs/GraFx-Studio/guides/actions/create/actionlist.png and b/docs/GraFx-Studio/guides/actions/create/actionlist.png differ diff --git a/docs/GraFx-Studio/guides/actions/create/index.md b/docs/GraFx-Studio/guides/actions/create/index.md index 9f3865ae..62af369f 100644 --- a/docs/GraFx-Studio/guides/actions/create/index.md +++ b/docs/GraFx-Studio/guides/actions/create/index.md @@ -2,7 +2,7 @@ ## Add Action -Open the [Automation panel](GraFx-Studio/overview/properties/#automation-properties). +Open the [Automation panel](/GraFx-Studio/overview/properties/#automation-properties). By default, a new document will not have any Actions. @@ -20,6 +20,10 @@ If applicable, select the scope for the Trigger. The scope is the object (frame, variable, etc.) that will be monitored. You can also choose to monitor "Any variable" or "Any frame". +!!! info "Template Variables" + When referring to **variables** in this context we mean **[Template variables](/GraFx-Studio/concepts/variables/#template-variables)**. + + ![screenshot](triggerscope.png) What Triggers are available? @@ -74,7 +78,7 @@ When creating a new action the default name “Action 1” is given. Every new a The order of the actions in the list defines the order of execution. This means that if an event triggers multiple actions, the first one in the list will be executed first. The order can be changed by drag and drop. -![Reorder Actions](/release-notes/reorder-actions.gif) +![Reorder Actions](reorder-actions.gif) It is possible that an action causes another event to fire, which can trigger another action. If this happens, all actions triggered by the first event will be executed first. When they are all processed, the actions triggered by the new event will be executed. As an example, we have this list of actions: diff --git a/docs/GraFx-Studio/guides/actions/create/reorder-actions.gif b/docs/GraFx-Studio/guides/actions/create/reorder-actions.gif new file mode 100644 index 00000000..a9a170f4 Binary files /dev/null and b/docs/GraFx-Studio/guides/actions/create/reorder-actions.gif differ diff --git a/docs/GraFx-Studio/guides/actions/create/trigger.png b/docs/GraFx-Studio/guides/actions/create/trigger.png index 43f6a00b..0e9149d5 100644 Binary files a/docs/GraFx-Studio/guides/actions/create/trigger.png and b/docs/GraFx-Studio/guides/actions/create/trigger.png differ diff --git a/docs/GraFx-Studio/guides/actions/create/triggerscope.png b/docs/GraFx-Studio/guides/actions/create/triggerscope.png index 91050fdd..737b1364 100644 Binary files a/docs/GraFx-Studio/guides/actions/create/triggerscope.png and b/docs/GraFx-Studio/guides/actions/create/triggerscope.png differ diff --git a/docs/GraFx-Studio/guides/actions/example-changelayout/action-definition.png b/docs/GraFx-Studio/guides/actions/example-changelayout/action-definition.png index 7de7c40b..a3f653d1 100644 Binary files a/docs/GraFx-Studio/guides/actions/example-changelayout/action-definition.png and b/docs/GraFx-Studio/guides/actions/example-changelayout/action-definition.png differ diff --git a/docs/GraFx-Studio/guides/actions/example-changelayout/actionlist.png b/docs/GraFx-Studio/guides/actions/example-changelayout/actionlist.png new file mode 100644 index 00000000..e3165587 Binary files /dev/null and b/docs/GraFx-Studio/guides/actions/example-changelayout/actionlist.png differ diff --git a/docs/GraFx-Studio/guides/actions/example-changelayout/index.md b/docs/GraFx-Studio/guides/actions/example-changelayout/index.md index 4ac62c4d..1c2ab5ef 100644 --- a/docs/GraFx-Studio/guides/actions/example-changelayout/index.md +++ b/docs/GraFx-Studio/guides/actions/example-changelayout/index.md @@ -2,6 +2,9 @@ For basic intro into Actions, look at the [concept](/GraFx-Studio/concepts/actions/) page. +!!! info "Template Variables" + When referring to **variables** on this page we refer to **[Template variables](/GraFx-Studio/concepts/variables/#template-variables)** unless stated differently. + ## Intro A trigger is set to act upon a variable value change. @@ -39,16 +42,16 @@ In this case, the trigger is initiated when the "Variable value changed", specif The script (action) executed upon the trigger ``` js -const layoutName = studio.variables.getStringValue(triggers.variableValueChanged); +let layoutName = studio.variables.getStringValue(triggers.variableValueChanged); studio.layouts.select(layoutName); ``` -A [const](https://www.w3schools.com/js/js_const.asp) variable **layoutName** is defined as the [string](https://www.w3schools.com/js/js_strings.asp) value of the variable that triggered the action. In this case this is the name of the selected ad size. +A Javascript variable **layoutName** is defined as the [string](https://www.w3schools.com/js/js_strings.asp) value of the Template variable that triggered the action. In this case this is the name of the selected ad size. -This const variable is then used to select the layout with the same name (the items in the "Ad size" list variable need to have the same name as the layouts). +This JavaScript variable is then used to select the layout with the same name (the items in the "Ad size" list Template variable need to have the same name as the layouts). ### The result -When the end-user changes the value of the list variable, the GraFx Studio layout will change to the chosen name. +When the end-user changes the value of the list variable (Template), the GraFx Studio layout will change to the chosen name. -Output will be based on the chosen layout. \ No newline at end of file +Output will be based on the chosen layout. diff --git a/docs/GraFx-Studio/guides/actions/example-changelayout/trigger.png b/docs/GraFx-Studio/guides/actions/example-changelayout/trigger.png index 7de584f6..b2e4247a 100644 Binary files a/docs/GraFx-Studio/guides/actions/example-changelayout/trigger.png and b/docs/GraFx-Studio/guides/actions/example-changelayout/trigger.png differ diff --git a/docs/GraFx-Studio/guides/actions/example-currency/action.png b/docs/GraFx-Studio/guides/actions/example-currency/action.png index aa0ac335..3b7f71c8 100644 Binary files a/docs/GraFx-Studio/guides/actions/example-currency/action.png and b/docs/GraFx-Studio/guides/actions/example-currency/action.png differ diff --git a/docs/GraFx-Studio/guides/actions/example-currency/index.md b/docs/GraFx-Studio/guides/actions/example-currency/index.md index 1e0e6138..f22357dd 100644 --- a/docs/GraFx-Studio/guides/actions/example-currency/index.md +++ b/docs/GraFx-Studio/guides/actions/example-currency/index.md @@ -2,6 +2,9 @@ For basic intro into Actions, look at the [concept](/GraFx-Studio/concepts/actions/) page. +!!! info "Template Variables" + When referring to **variables** on this page we refer to **[Template variables](/GraFx-Studio/concepts/variables/#template-variables)** unless stated differently. + ## Intro A trigger is set to act upon the currency. @@ -48,7 +51,7 @@ else studio.variables.setValue("displayCurrency", "£"); A JavaScript variable **currency** is defined to hold the [string](https://www.w3schools.com/js/js_strings.asp) value of the "Currency" variable in the template. -A series of if-then-else statements run through the possible options, and set the value of the Variable **displayCurrency** to the relevant currency symbol. +A series of if-then-else statements run through the possible options, and set the value of the Template variable **displayCurrency** to the relevant currency symbol. ### The result diff --git a/docs/GraFx-Studio/guides/actions/example-currency/trigger.png b/docs/GraFx-Studio/guides/actions/example-currency/trigger.png index 659bc871..70bc24c7 100644 Binary files a/docs/GraFx-Studio/guides/actions/example-currency/trigger.png and b/docs/GraFx-Studio/guides/actions/example-currency/trigger.png differ diff --git a/docs/GraFx-Studio/guides/actions/example-hideframe/action-definition.png b/docs/GraFx-Studio/guides/actions/example-hideframe/action-definition.png index 4198820f..3b1de958 100644 Binary files a/docs/GraFx-Studio/guides/actions/example-hideframe/action-definition.png and b/docs/GraFx-Studio/guides/actions/example-hideframe/action-definition.png differ diff --git a/docs/GraFx-Studio/guides/actions/example-hideframe/action-triggers.png b/docs/GraFx-Studio/guides/actions/example-hideframe/action-triggers.png index e85c14d9..70bc24c7 100644 Binary files a/docs/GraFx-Studio/guides/actions/example-hideframe/action-triggers.png and b/docs/GraFx-Studio/guides/actions/example-hideframe/action-triggers.png differ diff --git a/docs/GraFx-Studio/guides/actions/example-hideframe/index.md b/docs/GraFx-Studio/guides/actions/example-hideframe/index.md index e322c91a..2180d0ce 100644 --- a/docs/GraFx-Studio/guides/actions/example-hideframe/index.md +++ b/docs/GraFx-Studio/guides/actions/example-hideframe/index.md @@ -2,6 +2,10 @@ For basic intro into Actions, look at the [concept](/GraFx-Studio/concepts/actions/) page. +!!! info "Template Variables" + When referring to **variables** on this page we refer to **[Template variables](/GraFx-Studio/concepts/variables/#template-variables)** unless stated differently. + + ## Intro A trigger is set to act upon the presence of a value in a variable. diff --git a/docs/GraFx-Studio/guides/actions/example-multipleframes/action-definition.png b/docs/GraFx-Studio/guides/actions/example-multipleframes/action-definition.png index 551f26ed..70bc24c7 100644 Binary files a/docs/GraFx-Studio/guides/actions/example-multipleframes/action-definition.png and b/docs/GraFx-Studio/guides/actions/example-multipleframes/action-definition.png differ diff --git a/docs/GraFx-Studio/guides/actions/example-multipleframes/index.md b/docs/GraFx-Studio/guides/actions/example-multipleframes/index.md index 4df34e04..0d11a3f0 100644 --- a/docs/GraFx-Studio/guides/actions/example-multipleframes/index.md +++ b/docs/GraFx-Studio/guides/actions/example-multipleframes/index.md @@ -2,6 +2,9 @@ For basic intro into Actions, look at the [concept](/GraFx-Studio/concepts/actions/) page. +!!! info "Template Variables" + When referring to **variables** on this page we refer to **[Template variables](/GraFx-Studio/concepts/variables/#template-variables)** unless stated differently. + ## Intro A trigger is set to act upon the value for a discount. diff --git a/docs/GraFx-Studio/guides/actions/javascript/js3.png b/docs/GraFx-Studio/guides/actions/javascript/js3.png index 2cc9dfdf..07ef3f51 100644 Binary files a/docs/GraFx-Studio/guides/actions/javascript/js3.png and b/docs/GraFx-Studio/guides/actions/javascript/js3.png differ diff --git a/docs/GraFx-Studio/guides/add-fonts/fonts-3.png b/docs/GraFx-Studio/guides/add-fonts/fonts-3.png index dd65a15d..24bb44cc 100644 Binary files a/docs/GraFx-Studio/guides/add-fonts/fonts-3.png and b/docs/GraFx-Studio/guides/add-fonts/fonts-3.png differ diff --git a/docs/CHILI-GraFx/guides/create-projects/index.md b/docs/GraFx-Studio/guides/create-projects/index.md similarity index 100% rename from docs/CHILI-GraFx/guides/create-projects/index.md rename to docs/GraFx-Studio/guides/create-projects/index.md diff --git a/docs/CHILI-GraFx/guides/create-projects/myp1.png b/docs/GraFx-Studio/guides/create-projects/myp1.png similarity index 100% rename from docs/CHILI-GraFx/guides/create-projects/myp1.png rename to docs/GraFx-Studio/guides/create-projects/myp1.png diff --git a/docs/CHILI-GraFx/guides/create-projects/myp2.png b/docs/GraFx-Studio/guides/create-projects/myp2.png similarity index 100% rename from docs/CHILI-GraFx/guides/create-projects/myp2.png rename to docs/GraFx-Studio/guides/create-projects/myp2.png diff --git a/docs/CHILI-GraFx/guides/create-projects/myp3.png b/docs/GraFx-Studio/guides/create-projects/myp3.png similarity index 100% rename from docs/CHILI-GraFx/guides/create-projects/myp3.png rename to docs/GraFx-Studio/guides/create-projects/myp3.png diff --git a/docs/CHILI-GraFx/guides/create-projects/myp4.png b/docs/GraFx-Studio/guides/create-projects/myp4.png similarity index 100% rename from docs/CHILI-GraFx/guides/create-projects/myp4.png rename to docs/GraFx-Studio/guides/create-projects/myp4.png diff --git a/docs/CHILI-GraFx/guides/create-projects/myp5.png b/docs/GraFx-Studio/guides/create-projects/myp5.png similarity index 100% rename from docs/CHILI-GraFx/guides/create-projects/myp5.png rename to docs/GraFx-Studio/guides/create-projects/myp5.png diff --git a/docs/CHILI-GraFx/guides/create-projects/myp6.png b/docs/GraFx-Studio/guides/create-projects/myp6.png similarity index 100% rename from docs/CHILI-GraFx/guides/create-projects/myp6.png rename to docs/GraFx-Studio/guides/create-projects/myp6.png diff --git a/docs/CHILI-GraFx/guides/create-projects/myp7.png b/docs/GraFx-Studio/guides/create-projects/myp7.png similarity index 100% rename from docs/CHILI-GraFx/guides/create-projects/myp7.png rename to docs/GraFx-Studio/guides/create-projects/myp7.png diff --git a/docs/GraFx-Studio/guides/cropping/index.md b/docs/GraFx-Studio/guides/cropping/index.md index f6f1d121..c2d392bd 100644 --- a/docs/GraFx-Studio/guides/cropping/index.md +++ b/docs/GraFx-Studio/guides/cropping/index.md @@ -24,7 +24,7 @@ You can also enter crop mode by double clicking on the image. (with the Arrow to ### Arrow -Use the arrow-tool to manually poisition the image in the crop frame. +Use the arrow-tool to manually positioning the image in the crop frame. ![screenshot-fullwidth](manual-position.png) diff --git a/docs/GraFx-Studio/guides/output/gif/index.md b/docs/GraFx-Studio/guides/output/gif/index.md index fcd590bd..402b9232 100644 --- a/docs/GraFx-Studio/guides/output/gif/index.md +++ b/docs/GraFx-Studio/guides/output/gif/index.md @@ -20,4 +20,9 @@ Click "Export as" and choose GIF in the dropdown. ![Output](export.png) -When the export is ready, your browser will download the file into your downloads folder. \ No newline at end of file +When the export is ready, your browser will download the file into your downloads folder. + +!!! Warning + When outputting to GIF format in GraFx Studio, it's important to be aware of the color limitations inherent to GIF files. The GIF format supports a limited color palette, which can affect the fidelity of color reproduction in your images. This means that complex graphics with a wide range of colors might not be accurately represented in the GIF format. Understanding these limitations is crucial when choosing the appropriate file format for your output needs. + + The GIF format has a hard limit of 256 colors, which is a significant constraint compared to other image formats that can handle millions of colors. This limitation can lead to color banding or a reduction in image quality, especially in graphics with gradients or a wide color spectrum. When exporting to GIF, it's crucial to consider how this color cap might affect the visual outcome of your content. \ No newline at end of file diff --git a/docs/GraFx-Studio/guides/variables/assign/assign.png b/docs/GraFx-Studio/guides/template-variables/assign/assign.png similarity index 100% rename from docs/GraFx-Studio/guides/variables/assign/assign.png rename to docs/GraFx-Studio/guides/template-variables/assign/assign.png diff --git a/docs/GraFx-Studio/guides/template-variables/assign/index.md b/docs/GraFx-Studio/guides/template-variables/assign/index.md new file mode 100644 index 00000000..a72e8a1c --- /dev/null +++ b/docs/GraFx-Studio/guides/template-variables/assign/index.md @@ -0,0 +1,39 @@ +# How to work with template variables + +!!! info "Template Variables" + When referring to **variables** we can mean **[Template variables](/GraFx-Studio/concepts/variables/#template-variables)** or **[JavaScript variables](/GraFx-Studio/concepts/variables/#javascript-variables)**. + In the context of this page, we are talking about Template variables, unless stated differently. + + +Be sure to also check the [concept page](/GraFx-Studio/concepts/template-variables/) + +## Insert template variable in a text frame + +Choose "Insert" from the variable "..." menu to insert it into a text frame + +![Variables](insert-variable.png) + +In edit mode, the template variable name is shown in a gray box in the text. + +![Variables](variables-1.png) + +![Variables](variables-2.png) + +If the frame is not wide enough to show the full name, the name will be truncated to avoid overflow. + +![Variables](variables-3.png) + + +## Assign template variable to image frame + +Select the image frame you want to assign the template variable to. + +In the variable tab, choose the image variable from the "Insert variable" drop-down menu. + +![Variables](assign.png) + +## Un-assign a template variable from an image frame + +To remove the template variable from the image frame, select the frame and choose "None" from the "Insert variable" drop-down menu. + +![Variables](unassign.png) \ No newline at end of file diff --git a/docs/GraFx-Studio/guides/variables/assign/insert-variable.png b/docs/GraFx-Studio/guides/template-variables/assign/insert-variable.png similarity index 100% rename from docs/GraFx-Studio/guides/variables/assign/insert-variable.png rename to docs/GraFx-Studio/guides/template-variables/assign/insert-variable.png diff --git a/docs/GraFx-Studio/guides/variables/assign/unassign.png b/docs/GraFx-Studio/guides/template-variables/assign/unassign.png similarity index 100% rename from docs/GraFx-Studio/guides/variables/assign/unassign.png rename to docs/GraFx-Studio/guides/template-variables/assign/unassign.png diff --git a/docs/GraFx-Studio/guides/variables/assign/variables-1.png b/docs/GraFx-Studio/guides/template-variables/assign/variables-1.png similarity index 100% rename from docs/GraFx-Studio/guides/variables/assign/variables-1.png rename to docs/GraFx-Studio/guides/template-variables/assign/variables-1.png diff --git a/docs/GraFx-Studio/guides/variables/assign/variables-2.png b/docs/GraFx-Studio/guides/template-variables/assign/variables-2.png similarity index 100% rename from docs/GraFx-Studio/guides/variables/assign/variables-2.png rename to docs/GraFx-Studio/guides/template-variables/assign/variables-2.png diff --git a/docs/GraFx-Studio/guides/variables/assign/variables-3.png b/docs/GraFx-Studio/guides/template-variables/assign/variables-3.png similarity index 100% rename from docs/GraFx-Studio/guides/variables/assign/variables-3.png rename to docs/GraFx-Studio/guides/template-variables/assign/variables-3.png diff --git a/docs/GraFx-Studio/guides/template-variables/define/index.md b/docs/GraFx-Studio/guides/template-variables/define/index.md new file mode 100644 index 00000000..b923f4bd --- /dev/null +++ b/docs/GraFx-Studio/guides/template-variables/define/index.md @@ -0,0 +1,86 @@ +# Defining template variables + +!!! info "Template Variables" + When referring to **variables** we can mean **[Template variables](/GraFx-Studio/concepts/variables/#template-variables)** or **[JavaScript variables](/GraFx-Studio/concepts/variables/#javascript-variables)**. + In the context of this page, we are talking about Template variables, unless stated differently. + +In the headerbar, choose [Automate](/GraFx-Studio/overview/headerbar/) + +A panel will appear, where you can define your template variables. + +A list of all template variables that are available in the document shows + +- Variable name +- Variable type +- Visibility of the variable +- Number of occurrences of the variable in the document + +## Options + +Each template variable has a pencil icon, and three dots. +The pencil icon will bring up the "Settings" panel. + +The three dots will provide you below options: + +### Settings + +Opens the settings panel + +### Rename + +The template variable name goes into inline rename modus. +You can also double click/tap on the name. + +### Duplicate + +Creates a copy of the template variable and all its properties. +Since the name must be unique, the name is appended with an incrementing number. + +### Delete + +A confirmation dialog is shown before it's deleted. + +### Move to Top + +Will move the template variable to the top of the list + +You can also drag the template variable in the list to where you want to position it. + +This location does not have any effect on the working of your document. It will only help to guide the end-user to see them in a logical order. + +### Move to Bottom + +Will move the template variable to the bottom of the list + +You can also drag it in the list to where you want to position it. + +This location does not have any effect on the working of your document. It will only help to guide the end-user to see them in a logical order. + + +## Types + +### Single Line of Text + +A placeholder for text. + +### Image + +A placeholder for a reference to an image in the (GraFx) Media pool, or other sources through **Connectors** + +## Default state + +The default value your template variable will have. + +## Basic properties: + +- Name: Cannot be empty, must be unique +- Type: See [types](#types) above +- [Visible](#visibility-conditions): Enabled by default +- Read-only: Disabled by default + +### Appearance settings + +These setting define how the template variable is presented: + +- Label: Can be empty, must not be unique, by default it has the same value as the name (When the name is changed, the label is updated, unless if the label already has a different value) +- Label position diff --git a/docs/GraFx-Studio/guides/variables/organize/variables-1.png b/docs/GraFx-Studio/guides/template-variables/organize/variables-1.png similarity index 100% rename from docs/GraFx-Studio/guides/variables/organize/variables-1.png rename to docs/GraFx-Studio/guides/template-variables/organize/variables-1.png diff --git a/docs/GraFx-Studio/guides/variables/assign/index.md b/docs/GraFx-Studio/guides/variables/assign/index.md deleted file mode 100644 index 415fcd9b..00000000 --- a/docs/GraFx-Studio/guides/variables/assign/index.md +++ /dev/null @@ -1,34 +0,0 @@ -# How to work with variables - -Be sure to also check the [variables concept page](/GraFx-Studio/concepts/variables/) - -## Insert variable in a text frame - -Choose "Insert" from the variable "..." menu to insert it into a text frame - -![Variables](insert-variable.png) - -In edit mode, the variable name is shown in a gray box in the text. - -![Variables](variables-1.png) - -![Variables](variables-2.png) - -If the frame is not wide enough to show the full variable name, the variable name will be truncated to avoid overflow. - -![Variables](variables-3.png) - - -## Assign variable to image frame - -Select the image frame you want to assign the variable to. - -In the Variable tab, choose the image variable from the "Insert variable" drop-down menu. - -![Variables](assign.png) - -## Un-assign a variable from an image frame - -To remove the variable from the image frame, select the frame and choose "None" from the "Insert variable" drop-down menu. - -![Variables](unassign.png) diff --git a/docs/GraFx-Studio/guides/variables/define/index.md b/docs/GraFx-Studio/guides/variables/define/index.md deleted file mode 100644 index 3f2b8812..00000000 --- a/docs/GraFx-Studio/guides/variables/define/index.md +++ /dev/null @@ -1,114 +0,0 @@ -# Defining variables - -In the headerbar, choose [Automate](/GraFx-Studio/overview/headerbar/) - -A Variable panel will appear, where you can define your variables. - -A list of all variables that are available in the document shows - -- Variable name -- Variable type -- Visibility of the variable -- Number of occurrences of the variable in the document - -## Options for a variable - -Each variable has a pencil icon, and three dots. -The pencil icon will bring up the "Settings" panel. - -The three dots will provide you below options: - -### Settings - -Opens the settings panel of the variable - -### Rename - -The variable name goes into inline rename modus. -You can also double click/tap on the variable name. - -### Duplicate - -Creates a copy of the variable and all its properties. -Since the name of a variable must be unique, the name of the new variable is appended with an incrementing number. - -### Delete - -A confirmation dialog is shown before the variable is deleted. - -### Move to Top - -Will move the variable to the top of the list - -You can also drag the variable in the list to where you want to position it. - -This location does not have any effect on the working of your document. It will only help to guide the end-user to see them in a logical order. - -### Move to Bottom - -Will move the variable to the bottom of the list - -You can also drag the variable in the list to where you want to position it. - -This location does not have any effect on the working of your document. It will only help to guide the end-user to see them in a logical order. - - -## Variable Types - -### Single Line of Text - -A placeholder for text. - -### Image - -A placeholder for a reference to an image in the (GraFx) Media pool, or other sources through **Connectors** - -## Default state - -The default value your variable with have. - -## Basic properties: - -- Name: Cannot be empty, must be unique -- Type: See [types](#variable-types) above -- [Visible](#visibility-conditions): Enabled by default -- [Required](#required-variables): Disabled by default -- Read-only: Disabled by default - -### Required variables - -When checked, the Studio Editor will ask the user to provide a value. - -!!! Info - When a variable is required and it doesn't have a default value it doesn't show an error upon opening the document. - -An error is triggered upon these conditions: - -- When the input is in focus and left empty. -- When the user enters a value for the first time, deletes it again (so the input is empty again) the error message will be shown below the input until the error is resolved. -- When trying to save the document or generate output. A dialog is shown to inform the user that the document can't be saved or exported. - -To indicate that a variable is required an asterisk ( * ) is shown next to the variable label. - -### Visibility conditions - -When the "Visible" setting is enabled (is enabled by default), there is an option to add one or more visibility conditions. Only if ALL conditions are met the variable is visible for the end-user. - -The visibility conditions: - -- Variable … has value … -- Selected frame name contains … -- Selected frame is of type … -- Selected frame has private data … with value … -- Selected layout name contains … - -!!! Note - We limit the options to keep it simple. - If you want more advanced action, you can create a hidden variable that is set by an action and use that variable as a visibility condition. - -### Appearance settings - -These setting define how the variable is presented: - -- Label: Can be empty, must not be unique, by default it has the same value as the variable name (When the variable name is changed, the label is updated, unless if the label already has a different value) -- Label position \ No newline at end of file diff --git a/docs/GraFx-Studio/guides/variables/index.md b/docs/GraFx-Studio/guides/variables/index.md deleted file mode 100644 index e6f56589..00000000 --- a/docs/GraFx-Studio/guides/variables/index.md +++ /dev/null @@ -1,29 +0,0 @@ -# How to work with variables - -Be sure to also check the [variables concept page](/GraFx-Studio/concept/variables/) - -## Insert variable in a text frame - -Two ways of doing this - -### Insert - -Choose "Insert" from the variable "..." menu to insert it into a text frame - -### Dropdown select - -in edit mode in a text frame you can insert a variable by selecting the variable from a dropdown menu in the variables panel. - -This will insert the variable at the position of the caret and the caret will be placed after the variable object, so you can continue typing. The menu shows the variables that can be inserted in a text frame (text, number, date, …). The menu shows [None] when no variable is selected. - -### Double (forward) slash - -When in edit mode in a text frame you can insert a variable by typing `//` (the '/' character twice). This will open a list of all variables that can be inserted in a text frame (text, number, date, …). You can select the variable from the list or start typing to use auto-complete. - -## Insert variables in an image frame - -To assign a variable to an image frame, select the frame and select the variable that should be assigned to it from a dropdown menu in the variables panel. - -The menu shows the variables that can be assigned to an image frame (only image variables). - -The menu also shows [None] as an item to remove the variable again from the frame. \ No newline at end of file diff --git a/docs/GraFx-Studio/guides/variables/organize/index.md b/docs/GraFx-Studio/guides/variables/organize/index.md deleted file mode 100644 index 23275701..00000000 --- a/docs/GraFx-Studio/guides/variables/organize/index.md +++ /dev/null @@ -1,38 +0,0 @@ -# Organize variables in your document - - -In the properties panel, click the tool wrench. - -![Variables](variables-1.png) - -A Variable panel will appear, where you can define/organize your variables. - -## Selecting - -You can click to select / unselect a variable. - -With several variables selected, you can [group](#group-variables) variables. - -See [Define Variables](/GraFx-Studio/guides/variables/define/) for the other options. - -## Group variables - -You can put variables into variable groups. - -These groups can be used as a filter in the variable input form for the end-user. E.g. the variables can be presented as different steps the end-user needs to go through, with different input panels, each showing the variables from a specific variable group. - -It is possible to drag and drop one or more variables in and out of groups and from one group to another. - -## Ordering variables - -You can drag and drop variables in the variable list to change the order of the variables. - -This is also the order in which they will be presented to the end-user. - -It is possible to select multiple variables and move them together in a group. - -## Search variables - -This will search on variable name and label. - -Doing a search does not impact the list of variables that is presented to the end-user. It's just a tool to make it easier to find variables. \ No newline at end of file diff --git a/docs/GraFx-Studio/index.md b/docs/GraFx-Studio/index.md index 113c4c58..6e32cdc6 100644 --- a/docs/GraFx-Studio/index.md +++ b/docs/GraFx-Studio/index.md @@ -2,7 +2,7 @@ ![applogo](/assets/CHILI_LOGOS_OK-09.svg) -GraFx Studio is the Smart Template editor for (animated) digital output. +GraFx Studio is the multichannel Smart Template editor for (animated) digital and print output. With GraFx Studio, CHILI publish provides a whole new creative automation experience that focuses on intuitive UX, high performance, and easy integration. diff --git a/docs/GraFx-Studio/integration/getting-started/index.md b/docs/GraFx-Studio/integration/getting-started/index.md index 6e9865c8..170125bd 100644 --- a/docs/GraFx-Studio/integration/getting-started/index.md +++ b/docs/GraFx-Studio/integration/getting-started/index.md @@ -57,7 +57,7 @@ npm install @chili-publish/studio-sdk #### stateChanged event will be deprecated -You should subscribe to specific events instead of the global stateChanged event, which will be deprecated soon. You can find the available events in the [documentation](https://chili-publish.github.io/studio-sdk/classes/controllers_SubscriberController.SubscriberController.html){target="_blank"} or in the [code](https://github.com/chili-publish/studio-sdk/blob/main/src/controllers/SubscriberController.ts){target="_blank"}. +You should subscribe to specific events instead of the global stateChanged event, which will be deprecated soon. You can find the available events in the [documentation](https://chili-publish.github.io/studio-sdk/){target="_blank"}. ### Debug panel diff --git a/docs/GraFx-Studio/overview/stylekits/swatch-2.png b/docs/GraFx-Studio/overview/stylekits/swatch-2.png new file mode 100644 index 00000000..0543e35f Binary files /dev/null and b/docs/GraFx-Studio/overview/stylekits/swatch-2.png differ diff --git a/docs/assets/CHILI_LOGOS_OK-21.svg b/docs/assets/CHILI_LOGOS_OK-21.svg new file mode 100644 index 00000000..ae064de1 --- /dev/null +++ b/docs/assets/CHILI_LOGOS_OK-21.svg @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/CHILI_LOGOS_OK-22.svg b/docs/assets/CHILI_LOGOS_OK-22.svg new file mode 100644 index 00000000..6785a285 --- /dev/null +++ b/docs/assets/CHILI_LOGOS_OK-22.svg @@ -0,0 +1,77 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/index.md b/docs/index.md index 67b2b7cd..3af88ad2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,48 +1,116 @@ # CHILI GraFx Product documentation -As part of the CHILI publish Academy, the product documentation serves as a reference to point you in the right direction. +
 
-Each section provides you +## Latest updates + +
+ +- :material-clock-fast: __Release notes__ + + --- + + **March 2024**: Management for Federated User Groups ==GraFx Publisher==. + + [:octicons-arrow-right-24: Show all release notes](/release-notes/) + + + **March 2024**: New plugins for ==GraFx Publisher==. + + [:octicons-arrow-right-24: Show all release notes](/release-notes/) + +
- - Concepts - - How to manage or admin - - How to ... (perform this action) - - How to Integrate - - API reference - - Release notes ## The Platform & Applications -Platform: [CHILI GraFx](/CHILI-GraFx/) +
+ +- ![tinyapplogo](/assets/CHILI_LOGOS_OK-02.svg) __CHILI GraFx__ + + --- + + **CHILI GraFx** platform centralizes your account information, users, resources and documents. + + [:octicons-arrow-right-24: Getting started](/CHILI-GraFx/admin/) + +- ![tinyapplogo](/assets/CHILI_LOGOS_OK-10.svg) __GraFx Studio__ + + --- + + **GraFx Studio** is the multichannel Smart Template editor for (animated) digital and print output. + + [:octicons-arrow-right-24: Make your first Smart Template](/GraFx-Studio/guides/hello-world/) + +- ![tinyapplogo](/assets/CHILI_LOGOS_OK-21.svg) __GraFx Publisher__ + + --- + + Enter the 'phygital' age of marketing by producing high-quality print and static digital output with **GraFx Publisher**. + + [:octicons-arrow-right-24: Make your first Smart Template](/GraFx-Publisher/guides/hello-world/) + +- ![tinyapplogo](/assets/CHILI_LOGOS_OK-12.svg) __GraFx Media__ + + --- + + **GraFx Media** is the central repository to store your assets to be used in your Smart Templates. + + [:octicons-arrow-right-24: Upload your media](/GraFx-Media/guides/upload-media/) + +- ![tinyapplogo](/assets/CHILI_LOGOS_OK-08.svg) __GraFx Fonts__ + + --- + + **GraFx Fonts** serves Fonts and Font families for GraFx Studio + + [:octicons-arrow-right-24: Upload your fonts](/GraFx-Fonts/guides/upload-fonts/) + +- :octicons-git-branch-24: __Developer Center__ + + --- + + **Integrate** powerful GraFx Applications in your web application. + + [:octicons-arrow-right-24: Start Integrating](/GraFx-Developers/) + +
+ +## More Resources + +
+ +- :octicons-mortar-board-24: __Academy__ + + --- -Application: [GraFx Studio](/GraFx-Studio/) + The online learning platform where you can follow self-paced training. -Application: [GraFx Publisher](/GraFx-Publisher/) + [:octicons-link-external-24: Get Certified](https://product.chili-publish.academy/) - -## Resources +- :octicons-browser-24: __Demo__ -### CHILI publish (dot) Academy + --- -The online learning platform where you can follow self-paced training. + Try out concepts before you implement them. -[CHILI publish (dot) Academy](https://product.chili-publish.academy/){target="_blank"} + [:octicons-link-external-24: Visit Demo Portal](https://demoportal.thebigspicy.com/scenarios) -### Demo portal +- :octicons-people-24: __Support__ -Try out concepts before you implement them + --- -[Demo Portal: The Big Spicy](https://demoportal.thebigspicy.com/scenarios){target="_blank"} + Aks our award wining support staff. -### Support + [:octicons-link-external-24: Support Portal](https://mysupport.chili-publish.com/) -[Support website](https://mysupport.chili-publish.com/){target="_blank"} +
-### CHILI publish NV +--- ![svg_icon](/assets/CHILI_LOGOS_OK-01.svg) -All information on this portal is documentation on the products and services of [CHILI publish](https://www.chili-publish.com/contact-sales/). See [Application of CHILI GraFx](/CHILI-GraFx/applications/overview/). +All information on this portal is documentation on the products and services of [CHILI publish](https://www.chili-publish.com/contact-sales/). CHILI publish NV
Korte Keppestraat 9, bus 11
diff --git a/docs/release-notes/2022.md b/docs/release-notes/2022.md index 261dd00f..c24cfff2 100644 --- a/docs/release-notes/2022.md +++ b/docs/release-notes/2022.md @@ -20,9 +20,9 @@ Version 0.95.1, using Studio SDK [0.95.0](https://github.com/chili-publish/studi ### Features -- Next to paragraph styles, you can now also add character styles to your Stylekit and use them to style your text ([more information](https://docs.chiligrafx.com/GraFx_Studio/how_to/characterstyles/){target="_blank"}) +- Next to paragraph styles, you can now also add character styles to your Stylekit and use them to style your text ([more information](/GraFx-Studio/guides/characterstyles/){target="_blank"}) - Added support for most OTF fonts -- Enabled keyboard shortcuts for text navigation, text selection and text cut/copy/paste ([list of shortcuts](https://docs.chiligrafx.com/GraFx_Studio/concept/shortcuts/#text-cursor-manipulation){target="_blank"}) +- Enabled keyboard shortcuts for text navigation, text selection and text cut/copy/paste ([list of shortcuts](/GraFx-Studio/concepts/shortcuts/){target="_blank"}) ### Improvements diff --git a/docs/release-notes/2023.md b/docs/release-notes/2023.md new file mode 100644 index 00000000..33a27bd5 --- /dev/null +++ b/docs/release-notes/2023.md @@ -0,0 +1,1016 @@ +# Release notes + +## Dec 19, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Fixes + +- Fixed issue with PDF output containing hidden layers with copyfitted frames + +## Dec 5, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Improvements + +- Enhanced PDF output performance +Experience faster and more reliable generation of PDFs. + +### Fixes + +- Resolved root folder deletion anomaly +Previously, only subfolders were removed when deleting a root folder. This has been corrected to ensure the root folder is also eliminated. +- Fixed accessibility issue in GraFx Publisher +Users can now access GraFx Publisher again from within CHILI GraFx. + +## Dec 1, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +### Improvements + +- GraFx Publisher opens in separate tab +- The Application remains visible (won't collapse anymore) +- In GraFx Media, the URL indicates the asset's location sharing and back button navigation +- Environment avatars are shown in the environment overview +- Without the right permissions, the user will see a 'No access' page +- UI improvements in the subscription & environment drop-down +- UI improvements in the integration configuration + +## Dec 1, 2023 - GraFx Studio + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +### Features + +- Clear local text style overrides +You can now clear local text formatting overrides to revert to the applied paragraph or character style + +![releasenotes](clear-text-formatting.png) + +### Improvements + +- The panels for editing actions or selecting images/fonts can now be freely moved without obstructing workspace interaction +- The Template Designer workspace is now fully integrated into the CHILI GraFx platform using the same domain, eliminating the need for occasional re-logins due to the studio.chiligrafx.com domain change + +### Fixes + +- Fixed occasional images flicker during animation playback +- The text frame in animations now correctly displays the changed variable value when modified with an action +- Server-side rendering no longer utilizes incorrect layouts when actions alter the layout +- Duplicating a variable group now includes duplicating the associated variables +- Fixed rendering issues for certain fonts + +## Nov 27, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +### Improvements + +- Improved performance of getting renders information +- Optimization of authorization-related functions + +### Fixes + +- Fixed error response in case of failed users invitation + +CHILI GraFx [Platform API](https://api.chiligrafx.com/swagger/index.html) + +## Nov 22, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +CHILI GraFx [Environment API 1.3.3](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) + +### Improvements + +- Improved the performance of the 'Get' endpoints for media and templates. +- Transitioned to using a token cache service for fetching internal tokens, moving away from direct calls to the identity provider. +- Standardized the examples in Swagger documentation for consistency. + +### Fixes + +- Fixed the issue causing a 500 response when certain invalid arguments are used. +- Addressed an issue where URLs containing the 'environment' value in varying case sensitivities caused errors. +- Resolved a 500 error that occurred due to a concurrency issue when executing multiple requests to delete a single folder. +- Fixed a problem where templates became unattachable to any collection after being manually migrated to another environment without updating their ID. + +### New Endpoints + +- Introduced for Enhanced Media Preview Capabilities
`GET /api/v1/environment/{environment}/media/{mediaId}/preview/highestOrVector` + +## Nov 21, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Fixes + +- Fixed: EPS file previews missing after data migration + +## Nov 14, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Fixes + +- Improved PDF output performance +- Fixed duplicates for resources +- Fixed blank documents in rare occasions +- Fixed stuck tasks in queue after VDP output +- Fixed document image output + +## Nov 7, 2023 - GraFx Studio + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +### Features + +- Our new AI assistant [GraFx Genie](/GraFx-Studio/concepts/grafx-genie/) can help you write actions! Just tell it what the action should do and it will generate the JavaScript code for you (available in [experimental](/release-notes/experimental/) mode) +- You can change the unit of a layout to millimeters or inches. This is a first step toward enabling print output with GraFx Studio! (available in [experimental](/release-notes/experimental/) mode) + +### Improvements + +- You can reorder frames in the Layers panel by drag and drop. This changes the order in which frames are rendered on top of each other +- Improved handling of invalid input in the property input fields +- Added support for images with a custom crop in PDF output (available in [experimental](/release-notes/experimental/) mode) + +### Fixes + +- Assets are shown twice in the Media panel +- Selected frame is deleted when using the delete/backspace key while a dialog is open but the focus is not on the text input field +- Actions that use the "Frame moved" trigger are executed multiple times when the frame is moved by holding down an arrow key +- Action is not added to the undo/redo stack if the Folder setting for the GraFx Media connector was changed in the image variable settings +- Cannot insert an empty text variable in a text frame +- Not able to apply the default Arial font to text +- Font style does not display the correct style when the default Arial font is used +- Updated value of line height in character style is applied to the text only after entering text edit mode +- Paragraph style cannot be set after deleting the used font +- Paragraph style settings can't be opened by pencil icon if you clicked outside before +- 'Null' is present for character style settings when you provide an invalid value +- Copyfitting maximum value resets to the default value on frame movement +- Text overflow warning icon is shown for a second when you switch between text frames in text edit mode + +## Nov 2, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Fixes + +- Fixed resources consistency issue between Environment API and CPO. Sometimes folders where duplicated. + +## Oct 31, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Fixes + +- Fixed performance degradation of copy & move operations +- Fixed issue with using keyboard shortcut to delete a locked frame (when frame has constraints) + +## Oct 20, 2023 - We go live! + +GraFx Studio, GraFx Fonts & GraFx Media go live! + +### GraFx Media + +![rn_icon](/assets/CHILI_LOGOS_OK-11.svg) + +GraFx Media is the application on CHILI GraFx that enables you to manage template assets in one central library. Assets in GraFx Media are shared across GraFx Studio & GraFx Publisher. Asset management for GraFx Publisher can still be done in GraFx Publisher but with GraFx Media we offer an improved UX to manage assets more efficiently. + +#### Features +- You can upload an asset with format .eps, .jpg, .pdf, .png, .psd, .tif & .ai +- You can create folders +- You can rename or delete an asset +- You can filter on format of assets + +### GraFx Fonts + +![rn_icon](/assets/CHILI_LOGOS_OK-07.svg) + +GraFx Fonts introduces the concept of font families & font styles to CHILI GraFx and brings better brand consistency to CHILI GraFx. Important to know is that fonts in GraFx Fonts can only be used in GraFx Studio. Fonts used in GraFx Publisher are managed in GraFx Publisher separately. + +#### Features +- You can upload a font style & font family +- During the font upload you can change the font family and font style +- You can sort & delete font styles & font families +- You can access font styles details + +![2023-10-11_15-31-50](https://github.com/chili-publish/grafx-documentation/assets/122599725/fe98f3c4-6b13-4264-aa74-862cd3a35b2f) + +### GraFx Studio + +![rn_icon](/assets/CHILI_LOGOS_OK-09.svg) + +This is a big day for GraFx Studio, as it is now available for use in production! + +Managing templates and collections and access to the Template Designer workspace are now restricted to admins and template designers. Other users can use templates to create projects with personalized and localized content, but cannot edit the original templates. + +Even though it is now in production, GraFx Studio renders are not yet counted, as we want to give our users some time to get used to the new application first. We hope you enjoy it and are curious to hear your feedback! + +#### Features + +**Actions** + +Actions can be added to a template to define how it should react to user input. Actions let you show/hide a frame or variable, select a layout, change a variable value, change a color, and much more. Triggers can be set to control when actions should be executed. + +
 
+ + +It was already available as an [experimental](/release-notes/experimental/) feature but is now available for production use. + +**GraFx Fonts** + +With the introduction of GraFx Fonts, we also introduce the concept of font families and font styles in GraFx Studio. You can now add font families to the Stylekit of your template and the font styles from this family will be available for use in the template. + +**This is a breaking change!** All existing templates need to be updated (GraFx Publisher fonts are not accessible anymore through GraFx Studio and will fall back to Arial). This means you have to upload your fonts to GraFx Fonts, add them to the Stylekit of your template, and apply them again to the text and/or styles. Projects created from these templates are also impacted, it is advised to delete them and start new projects from the updated templates. + +**Image variable settings** + +Inside the image variable settings, the template designer can specify the folder inside GraFx Media where the assets for that variable are located. This results in a better experience for the user and prevents access to other assets. + +
 
+ + +For custom media connectors this also enables custom settings for image variables, as defined by the connector. Custom media connectors enable you to use assets from an external DAM system in GraFx Studio templates (this is still in [experimental](/release-notes/experimental/) mode). + +#### Improvements + +- Writing actions has been made easier with the introduction of [helper functions](/GraFx-Studio/concepts/helper-functions/) +- Renamed triggers that are used inside the action script (**This is a breaking change!** Please update any action that uses triggers.changedVariable, triggers.changedFrame, etc.) +- Improved error indications in the list of actions +- Proper support for undo/redo of actions +- Improved visual feedback on the canvas when an image is unable to load +- UI improvements in the Template Designer workspace +- UI improvements in the Studio UI +- When integrating the Studio UI you can configure the download and back buttons + +#### Fixes + +- Fixed issue with undo/redo and saving of changes to horizontal text alignment + +## Sep 19, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +- Output: Improve error handling of a corrupt PNG during output + +## Sep 12, 2023 - GraFx Studio + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +- Fixed issue with output generation in both Template Designer workspace and Studio UI +- You can now delete multiple paragraph and character styles, colors, and actions at once + +Improvements to **Actions** ([experimental](/release-notes/experimental/) feature): + +- An error icon is shown in the list of actions if the action contains errors +- We added more flexibility to get and set properties in an action +- We changed the method name to change the visibility of a frame: `.include()` is replaced by `.setVisible()` +**This is a breaking change! Please update any template that uses this method ([here](/GraFx-Studio/guides/actions/example-hideframe/) you can find an example of how it works). Projects created from these templates will also be impacted, so it is advised to delete them and start new projects from the updated templates.** + +## Sep 12, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Fixes + +- Fixed failing document preview because of failing preflight checks if a required variable is empty + +## Aug 30, 2023 - GraFx Studio + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +With this release, we introduced improvements to the GraFx Studio Smart Template editor + +- You're now able to reorder actions (this impacts the order of execution when multiple actions have the same trigger) + +![releasenotes](reorder-actions.gif) + +- Action script is saved even if it contains errors (indicated with a red squiggly line). This is useful when you're in the middle of writing an action and you need to close the action interface to check something + +![releasenotes](save-on-error.png) + +- Visual improvements to the action interface +- Rename action trigger to "Selected layout changed" +- Force action names to be unique +- Show notification when closing or reloading GraFx Studio with unsaved changes +- When inserting an image variable in an image frame that contains an image, this image is automatically set as default state for that image variable +- Dialog to edit a character/paragraph style is not hidden behind the animation timeline anymore +- Fixed issue with error tooltips +- Add percentage sign behind line height value +- Selecting another layout exits text editing mode +- It's no longer possible to use a URL for an image variable (an asset ID must be used) + +We also improved the GraFx Studio UI, the interface for the self-service use-case + +- Automatically zoom to page when another layout is selected by an action +- Shortcuts to select another tool are disabled to prevent end-users from accidentally going into inline edit mode +- Shortcut to open the debug panel is disabled +- Show indicator and block new downloads while download is in progress + + +## Aug 30, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +- User management in GraFx Publisher has changed to API User management. You are now able to manage GraFx Publisher [users in CHILI GraFx platform](/CHILI-GraFx/users/creation/). Existing users in GraFx Publisher are unaffected, but we advise migrating these users to [CHILI GraFx](/CHILI-GraFx/users/creation/). +- Fixed an issue in the DEL ‘/rest-api/v1.2/resources/Documents/folders’ endpoint to prevent data loss. + +## Aug 24, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +CHILI GraFx [Environment API 1.1.9](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) + +- Introduce GET /environments/{environmentId}/font-styles/{styleId} +
endpoint that provides font style information +- Introduce DELETE /environments/{environmentId}/font-styles?ids={comma-separated ids} +
endpoint that deletes font styles by id. +- Introduce DELETE /environments/{environmentId}/font-families?ids={comma-separated ids}
endpoint that deletes font families by id. +- Extend GET /environments/{environmentId}/font-familes +
endpoint with ‘search’ argument that provides ability to search by font family name + +## Aug 16, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +### Features + +- De-activate a user so the user can no longer access or use any of the resources within that subscription +- Re-activate a user that was deactivated so the user has exactly the same priviliges he had before being de-activated +- Delete a user so the user loses all his privileges within that subscription & the user isn't visible in the list of users anymore + +![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/b0b9bb66-1f25-4c70-bd95-e4e0c7e94f74) + +CHILI GraFx [Platform API](https://api.chiligrafx.com/swagger/index.html) + +### Improvements + +- GET /subscription/id and /subscription/id/renders were migrated to use GUIDs. Now all our endpoints use GUIDs for identifying entities. +- GET subscription/subscriptionId/users/userId has been deprecated to improve consistency in naming. GET subscription**s**/subscriptionId/users/userId is the new endpoint. + +## Aug 15, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +- Backoffice: Fixed issue with old preview being applied when copying document immediately after changes were made to original document +- Editor: Improved availability of [Publisher interface library](https://github.com/chili-publish/publisher-interface) +- Editor: Removed the use of the d= parameter in URL as it’s no longer supported in Chrome. (see [this Article](https://mysupport.chili-publish.com/hc/en-us/articles/360019722600-Dealing-With-CORS-Using-Custom-Subdomains) on CORS for more background) +- Editor: Fixed issue with assets without point of interest not showing on template when Smart Fit is applied +- System: Fixed performance degradation of copy & move operations +- Output: Added error detail for unsupported png files + +## Aug 4, 2023 - GraFx Studio + +Version 0.136.1, using Studio [SDK 0.136.0](https://github.com/chili-publish/studio-sdk/releases/tag/0.136.0) + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +### Features + +#### Variables +List items inside ‘Single Select List’ variable can be reordered. Updated order also will be shown in a drop-down inside variable settings and in Studio UI + +![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/f47de351-d8f0-4780-93de-8faf17fb55d9) + +New variable type ‘Boolean’ was introduced with two settings – + +- Default state’ which allows to set the default value +- Visible’ settings which controls visibility of variable in Studio UI + +![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/7a3110bc-e979-4b55-8173-8a03d2bd59ca) + +#### Output +PDF output is present in the list of available output formats. This is an [experimental](/release-notes/experimental/) feature which is not feature complete yet and can contain some differences with templates from which you want to generate output. + +![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/269dae35-7e71-462e-ae9d-0033c6ad1efe) + + +### Fixes + +- Fixed issue where ‘Rename’ option was available for several selected variables at once in the ‘Variable List’ +- Fixed issue where the ‘Delete’ option only removed one variable when multiple were selected. Right now all selected variables will be removed from the ‘Variable List’ +- Fixed issue where an executed action is added to undo stack when switching between text variable input fields +- Fixed issues where playing the animation, made the timeline player move in blocks instead of moving smoothly over the timeline. +- Fixed issue where the finished animation didn’t change the pause button back to play. + +## Aug 3, 2023 - GraFx Studio + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +### Features + +New action item ‘Collection settings’ was added to collections. This panel can be opened in two ways: +- Through the "Three dots" on the collection card and clicking "Collection settings" +- Inside a collection by clicking on the "Three dots" in the top right corner. +![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/377e0601-109c-4587-a92f-184ddb2aa803) + +It opens a panel with ‘Cover image’ option which allows to upload image that is shown on the collection card. For the uploaded image PNG, JPG and JPEG formats can be used and we don’t have restrictions for a file size. +![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/f013110d-140e-42c8-8bb1-f5f377c70fbb) + +### Fixes +- Fixed issue where a template could be opened as a project from ‘Collection’ tab. Now a template can be opened only from the ‘My projects’ tab + +## Aug 3, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +CHILI GraFx [Environment API 1.1.8](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) + +- Introduced DELETE /environment/{envId}/template-collections/{collectionId}/cover endpoint that provides the ability to remove an image cover of a Template Collection +- Fixed: When adding a dot in the middle of a Template's name resulted in cutting the part of the name off +- Fixed: When adding a file with extension in uppercase as a Template Collection cover caused 500 error + +## June 28, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +CHILI GraFx [Environment API 1.1.7](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) + +This release enables Template designers to create collections and manage templates in collections. + +End users can see collections, and create projects from templates in a collection. + +Fine grained access management will be added later. + +### Features + +- Template designers can now make [Collections](/CHILI-GraFx/concepts/template-management/#template-collection) +- Template designers can [manage templates](/CHILI-GraFx/guides/manage-collections/) in collections +- End-users can [create Projects](/CHILI-GraFx/concepts/template-management/#end-user) from Templates in a collection. +- Subscription Admins can now [create Integrations](/CHILI-GraFx/guides/integrations/) to allow external application to connect to CHILI GraFx + +### Improvements + +- Prevent the creation of folders with leading or trailing spaces in the names + + +## Jun 28, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +CHILI GraFx [Environment API 1.1.6](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) + +### Improvements + +- Improved stability of output generation + +## Jun 23, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +CHILI GraFx [Environment API 1.1.5](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) + +### Features + +**[experimental](/release-notes/experimental/)** + +- Introduce temporary POST api/experimental/environment/{environmentId}/output/pdf endpoint that provides ability to generate PDF output + +### Fixes + +- Fix ‘update Template body’ action to avoid data corruption. +- Fix ‘environment’ case sensitivity for My Project endpoints to avoid not-found errors +- Fix attempting to add My Project based on corrupted Template (avoid creation corrupted My Project) +- Update Environment API endpoints to restrict access for not activated users. + + +## June 23, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +CHILI GraFx [Platform API 1.12](https://api.chiligrafx.com/swagger/index.html) + +### Improvements + +- Added status in user endpoints + - GET /api/v1/subscription/{id}/users + - GET/api/v1/subscription/{subscriptionId}/users/{userId} +- Improved token generation for Integrations + +## Jun 19, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +CHILI GraFx [Environment API 1.1.4](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) + +### Features + +**Authentication** + +- Extended ‘full access’ configuration to support multiple applications having full access to Environment API and Platform API. + +**Machine to Machine** + +- Add support for scope-based authorization rules +- Enabled integrations access to Environment API endpoints. + +**Template Collections** + +- Managing the image cover of a Template Collection + +**My Projects** + +- Introduce GET api/v1/environments/{environmentId}/projects endpoint that provides list of ‘My Project’ data. +- Introduce GET api/v1/environment/{environmentId}/projects/{projectId} endpoint that provides ‘My Project’ data. +- Accessing My Project's previews +- Saving modified json document of a My Project document +- Output: Image and animation output from a Project + +### Improvements + +**GraFx Media** + +- Extended endpoints responses to return media file info + - GET api/v1/environment/{environmentId}/media + - GET api/v1/environment/{environmentId}/media/directory + +**Output** + +- Update ‘output’ endpoints: introduce ‘engineVersion’ parameter to override the engine version that is used during output rendering. + - POST api/v1/environment/{environmentId}/output/animation + - POST api/v1/environment/{environmentId}/output/image + + +### Fixes + +- Output: Fixed mp4 output for a template with uneven dimensions +- Fixed return code (from 500 to 400) for template collection creation when the name is duplicate. +- Fixed adding new My Project with invalid Template (prevent storing broken My Project). + +**Connectors ([experimental](/release-notes/experimental/))** + +- Added Connector module + + +## Jun 16, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +CHILI GraFx Platform API 1.11 + +### Features + +**User management** + +- Added endpoints for disabling and enabling users in the subscription + +**Manage Integrations** + +- Added endpoints to create, update, delete Integrations +- Added endpoint to get details of a single Integration +- Added endpoint to get available scopes for an Integration +- Added endpoint to Rotate client secret +- Added endpoints to manage scopes of Integrations + +**Authentication** + +- Add support for the bearer token with new grant type +- Add support for scope-based authorization rules + +## Jun 9, 2023 - GraFx Publisher plug-in for Adobe Illustrator® + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Features + +- Added support for Adobe® Illustrator®[^1] 2023 (27.x) + +[^1]: + Adobe and Illustrator are either registered trademarks or trademarks of Adobe in the United States and/or other countries. + +### Improvements + +- Preflighting a document is no longer adding items to the undo/redo stack +- When converting a document you are no longer prompted with a message for every text frame that contains right alignment + +### Resolved issues + +- Fixed issue with the plug-in panel going blank when reopening +- Fixed issue with missing images in documents exported to GraFx Publisher from macOS +- Fixed issue with failing conversion for documents containing circular text +- Fixed issue with upload when using heavy assets on Windows +- Fixed issue where the document name was not updated in the plug-in when opening a new document + +[Download page (behind login)](https://mysupport.chili-publish.com/hc/en-us/articles/360021250259-Latest-downloads) + +This version is compatible with Adobe® Illustrator®[^1] 2022 (26.x) and 2023 (27.x). + +This version is compatible with GraFx Publisher and the on-premise version of CHILI publisher (version 5.6 or above). + +## Jun 6, 2023 - GraFx Studio + +Version 0.123.1, using Studio SDK [0.123.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +### Features + +- You can change the [corner radius](/GraFx-Studio/guides/shape-frame/) of your rectangle and polygon shapes by dragging the round handles in the shape or by using the corner radius properties in the frame properties panel + +![animation](/GraFx-Studio/guides/shape-frame/corner-radius.gif) + +### Improvements + +- When a new frame is added it is only visible on the selected layout and its sub-layouts, on all other layouts the frame is hidden (if you want a frame to be visible on all layouts you should add it on the top-level layout) + +## Jun 6, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Fixes + +- Editor: Fixed issue where iframe caused the page to scroll when partially outside of view +- Editor: Fixed issue with transparent selection +- API: Removed redundant calls to file system to minimize probability for concurrency issues +- API: Fixed issue with ResourceSearchInFolder not returning items in response if includeSubDirectories property was false +- API: Strengthened security on REST API + +## May 31, 2023 - GraFx Studio + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +We are working hard on delivering an end-to-end process, from Smart Templates created by designers to output generated by end users. Check out the [template management](/CHILI-GraFx/concepts/template-management/) page to learn more about this new way of working. + +The first step in this process is organizing your templates in [collections](/CHILI-GraFx/guides/manage-collections/). This is available now! + +In the next step, end users will be able to browse the collections and start a project from one of the templates. The project will be opened in a user-friendly interface where you can make changes and generate output. + +![screen](/CHILI-GraFx/concepts/template-management/collections.png) + +## May 31, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +### Fixes + +- Updated error message if you want to invite more than 10 users at once to CHILI GraFx +- Disable 'Add Template Designer Seat' button when all Template Designer seats are assigned +- Fix issue with logout button on 'MyAccount' page + +## May 26, 2023 - GraFx Studio + + + +Version 0.122.1, using Studio SDK [0.122.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +### Features + +- You can [crop an image](/GraFx-Studio/concepts/crop/) to manually resize and position it inside an image frame +- [Snap guides](/GraFx-Studio/concepts/snapping/) show up when creating, moving or resizing a frame to help you to nicely align the frames in your design + +![screenshot-fullwidth](/GraFx-Studio/concepts/crop/rectcrop.png) + +![screenshot-fullwidth](/GraFx-Studio/concepts/snapping/snapping.gif) + +### Improvements + +- You can use the arrow keys to move a frame in steps of 1 pixel, holding down the Shift key moves it in steps of 10 pixels +- Creating, moving or resizing a frame is now done on a pixel grid, meaning that the x, y, width, and height properties have non-decimal values +- Punctuation marks stay together with the preceding word and will not move to the next line + +### Fixes + +- Fixed issue where the animation sometimes blinked at the beginning or the end +- Fixed issue where changing the width or height of a frame also caused an override on other properties +- Fixed issue with constraining proportions when changing the width or height of a frame in the properties panel + +## May 23, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Fixes + +- Output: Improved stability of VDP outputs with a large amount of rows and variables +- Output: Fixed output failure due to missing font +- Output: Improved reliability of PDF output when the system is under high load + +## May 16, 2023 - CHILI GraFx - Environment API + +![rn_icon](/assets/CHILI_LOGOS_OK-04.svg) + +### Added Endpoints + +User is able to **rename** template attached to collection + +- PATCH /api/v1/template-collections/{collectionId}/templates/{templateId} + +User is able to **create**, **rename** and **delete** project. + +- POST /api/v1/environments/{environmentId}/projects +- PATCH /api/v1/environments/{environmentId}/projects/{projectId} +- DELETE /api/v1/environments/{environmentId}/projects/{projectId} + +User is able to **download** project json. + +- GET /api/v1/environments/{environmentId}/projects/{projectId}/document + +### Updated Endpoints + +When a user attempts to **delete** a template attached to a collection, an error is returned. User is now able to use ‘force’ request parameter, the template will be deleted. + +- DELETE /api/v1/templates/{templateId} + +Http **method** is changed from ‘PUT’ to ‘PATCH’. + +The endpoint now allows partial update of template collection instead of full update. + +- PATCH /api/v1/template-collections/{templateCollectionId} + + +See Swagger [Environment API](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html). + + +## May 10, 2023 - GraFx Studio SDK + +We renamed our repository and package for the SDK. +The new name is studio-sdk, coming from editor-sdk. + +Also a new version has been pushed, we're now at version 0.121.0 + +??? note "Note for integrators" + + This means you'll have to update your integration dependency, and change it from @chili-publish/editor-sdk to @chili-publish/studio-sdk inside your `package.json`. + + +## Apr 20, 2023 - GraFx Publisher + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Features + +- You can now log into GraFx Publisher via GraFx user account. + + +## Apr 19, 2023 - CHILI GraFx + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) + +### Features + +- You can invite users to CHILI GraFx +- When you invite a user to CHILI GraFx you can assign this user to an GraFx environment and assign the role this user needs to have in this environment +- You can remove the role 'Subscription Admin' from other users +- You can add an existing user to additional GraFx environments and assign the role this user needs to have in this environment +- You can access GraFx Publisher within the CHILI GraFx environment with SSO +- You can login in GraFx Publisher from the direct URL with your CHILI GraFx account + +![2023-04-14_16-26-11](https://user-images.githubusercontent.com/122599725/233287606-4ef0e434-7af6-4b11-b148-a4abe1c6cbc7.gif) + +Read more about [User Management](/CHILI-GraFx/users/intro/). + +## Apr 14, 2023 - GraFx Studio + +Version 0.117.1, using Studio SDK [0.117.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + + +### Improvements + +- When applying a blend mode to a text frame you automatically go out of text edit mode (this way you can see the effect of the blend mode, because it is not applied while in text edit mode) +- You can now easily download the JSON file of the template with a "Download doc" trigger in the debug panel + +### Fixes + +- Fixed issue with MacBook being detected as a mobile device, causing issues with frame handles +- Fixed issue with opacity not being applied to fill and stroke for shapes +- Fixed issue when using a swatch as fill color for shapes, which caused the shape color to not change immediately on the canvas when the swatch color is changed +- Fixed issue with text not being selectable with the Text tool when a blend mode is applied to the text frame + +??? note "Note for integrators" + + There is a minor breaking change in the Studio SDK's typings. + It basically boils down to changing the import for the Id type, you can do it as follows:
+ Change `#!typescript import { Id } from '@chili-publish/studio-sdk/lib/types/CommonTypes'`
+ To `#!typescript import { Id } from '@chili-publish/studio-sdk'`
+ For more information, please check out the [SDK release notes](https://github.com/chili-publish/studio-sdk/releases/tag/0.117.0){target="_blank"}. + + +## Apr 18, 2023 - GraFx Publisher + +**Boost Platform Performance** + +GraFx Publisher comes with more than just a name change, this year it is all about improving platform performance. We've listened to your feedback and revamped our platform infrastructure to deliver blazing-fast file operations, including moving, copying, and deleting. This means you can work efficiently even in large environments! 🚀 + +Note: Smaller environments might not notice significant changes in performance. + +🔔 Heads up: We've fine-tuned the ResourceItemGetTree and ResourceItemGetTreeLevel API endpoints to optimize performance. Now, these endpoints return only the first 10,000 items, ensuring a smoother experience for all users. + +![rn_icon](/assets/CHILI_publisher_RGB.svg) + +### Fixes + +- API: Fixed issue with ResourceSearchInFolder not returning items in response if includeSubDirectories property was false +- API: Fixed 'ResourceGetTree/ResourceGetTreeLevel' for enabled support 'parentFolder' argument ending with slashes. +- API: Fixed 'rest-api/v1/resources/documents/items/{id}/privateinfo' endpoint to return 'fileInfo.xml' node + + +## Mar 31, 2023 - Infrastructure update + +Your [CHILI GraFx](/CHILI_GraFx/) infrastructure has been upgraded to have the latest update. + +With this update, we’re implementing platform infrastructure changes that greatly enhance performance. + +The update does require planned downtime, and will be transparant for you. + +The update will be implemented (starting April 5) gradually on all tenants, and will happen over the following days and weeks. + + +## Mar 29, 2023 - GraFx Studio + +Version 0.116.2, using Studio SDK [0.116.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +### Features + +- You can now add rectangle, ellipse, and polygon shapes to your design, by using a new Shape tool in the left toolbar. In the properties panel, you can set a blend mode and change the fill and stroke color, to customize as you want. (There are still a couple of known issues, which will be addressed in the next release!) + +![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/shapes.gif) + +### Improvements + +- You can select text on the page when the Text tool is active (previously it would create a new text frame instead) +- The layout name above the page is not scaled when zooming in or out +- Blend mode is not applied when in text edit mode (this makes editing text easier) +- Internal optimization to significantly increase the performance or rendering frames on the canvas + +### Fixes + +- Fixed issue with the Width and Height properties both getting an override when only one of the two was changed +- Fixed issue with changing a font in a text frame when the animation is paused inside an animation block for that frame + +## Mar 17, 2023 - GraFx Publisher + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK_publisher.svg) + +!!! danger "Sandbox Release" + + Information related to your Sandbox. + + When the update is in production, another release note will be added. + +Your [CHILI GraFx](/CHILI_GraFx/) sandbox has the latest update to [GraFx Publisher](/GraFx_Publisher/) + +- Our goal: Improve performance in handling templates, documents, assets. +- Our ask: Test in your sandbox now, and send us your feedback. + +With this update, we’re implementing a new platform infrastructure that greatly enhances performance. We **urge** you to test GraFx Publisher on your sandbox environment to experience this new level of performance for yourself. + +## Mar 16, 2023 - GraFx Studio + +Version 0.114.1, using Studio SDK [0.114.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + +### Features + +- We added [15 blend modes](/GraFx_Studio/concept/blendmodes/) that can be applied to your image and text content to improve your template design + +![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/blendmodes_rn.gif) + +### Improvements + +- Animation snaps to 0,1 seconds on the timeline, which makes it easier to align the animation of multiple frames + +![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/snap_rn.gif) + +- Frames are only selectable and editable on the canvas while they are visible in the animation (this fixes some issues with entering text edit mode) +- While in text edit mode, you can now also edit the frame properties and change the copyfitting settings + +### Fixes + +- Fixed some issues with the color picker component to select a custom color or a swatch or to change the opacity +- Fixed issue where fonts were not loaded when the dialog to add fonts was opened too quickly + +## Mar 6, 2023 - GraFx Media Alpha + +![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-11.svg) + +### Features + +- You can sort your assets on name +- You can see a preview of your asset + +![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/media_20230307.gif) + +## Mar 1, 2023 - GraFx Studio + +Version 0.111.2, using Studio SDK [0.111.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} + +### Features + +- You can constrain the proportions of a frame while resizing to preserve the aspect ratio + +![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/proportions.gif) + +- There is a new dropdown menu that allows you to control the zoom level +- A warning icon appears when part of your text is not visible because it doesn't fit inside the text frame + +![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/overflow3.gif) + +### Improvements + +- Variable settings panel does not close automatically anymore, it stays open until you manually close it + +### Fixes + +- Fixed issue where copyfitting property was not shown in yellow when it has an override +- Fixed issue where variable settings panel was only opened on second click +- Fixed issue with Media panel being empty when opened too fast + +## Feb 16, 2023 - GraFx Studio + +Version 0.107.4, using Studio SDK [0.107.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} + +### Features + +- You can make the content of an image frame variable by inserting an image variable +- You can browse your media and assign an image to an image variable + +### Improvements + +- The template is automatically zoomed to page when opened or when switching to another layout +- Added tooltips to the sidebar and header bar +- Added a loading indication while media previews are loading +- The variable settings panel is not opened when a new variable is created +- The variable name is truncated in the variable tag when it doesn't fit in the text frame, to prevent text overflow + +### Fixes + +- Fixed issue with resetting an override on the image fit mode +- Fixed issue with undo/redo of creating a new variable +- Fixed issue with undo/redo of creating a new layout +- Because of issues with calculating the number of occurrences of a variable, it's hidden in the variable list until the number is reliable +- Fixed infinite API calls when navigating to the bottom of the Media panel +- Media details are now retrieved using the new *details(id)* connector method +- Fixed issues with server-side rendering + +## Feb 16, 2023 - GraFx Media Alpha + +### Features + +- You can [browse](/GraFx_Media/how_to/browse/) between your assets in GraFx Media Alpha +- You can [search](/GraFx_Media/how_to/search/) for an asset in GraFx Media Alpha + +## Jan 30, 2023 - GraFx Studio + +Version 0.104.1, using Studio SDK [0.104.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} + +### Fixes + +- Fixed issue with loading media +- Fixed issue with font size and line height properties of a character style being set to 0 when clicked upon, and it was not possible to clear them (now you can leave them empty again to use the values from the applied paragraph style) +- Fixed issue with text rendering when line height is 0 +- Fixed issue with deleted font being shown in font dropdown menu +- Fixed issue with loading the default template +- Fixed weird behavior when using the Hand tool to move the page + +## Jan 23, 2023 - GraFx Studio + +Version 0.102.2, using Studio SDK [0.102.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} + +### Features + +- You can now add [swatches](/GraFx_Studio/how_to/swatches/) to your Stylekit and use them in your template, e.g. to change the color of your text via a paragraph or character style (👉 click the color field to open the color picker, where you can go to the swatches tab to select a swatch) +- The [color picker](/GraFx_Studio/how_to/swatches/#color-picker) now comes in two versions, one for defining a swatch (where you cannot set the opacity or select another swatch) and one for applying a color (where you can choose between a custom color or a swatch and where you can change the opacity) +- You can [pan and zoom](/GraFx_Studio/mouse_trackpad/) the canvas by using two-finger gestures on the trackpad, even if the Hand or Zoom tool is not selected + +### Improvements + +- Improved text selection and text cursor positioning +- Simplified the character style settings by removing the indeterminate state for fill color (👉 when you leave the fill color unchecked the color is not applied, which means the default black or the color from the applied paragraph style is used) +- The default Arial Regular font is always available in the dropdown menu where you can select a font +- Renaming a font in the Stylekit is blocked (👉 you cannot rename a font in the Stylekit, but this was not blocked and caused an incorrect rename state) +- Removed variable name input field from the variables settings panel (👉 you can rename a variable by double clicking the variable name in the list) + +### Fixes + +- Fixed issue with loading fonts +- Fixed issue where the default Arial Regular font was selected in the text properties panel, but it was not used for new text frames +- Fixed issue where the applied character style was not shown correctly in the text properties panel +- Fixed issue where color swatches were converted to custom colors in paragraph and character styles +- Fixed issue with using Ctrl/Command+A to select all text with a keyboard with Azerty layout +- Fixed issue with replacing selected text with copied text +- Fixed issue where changes to variable settings were not saved when clicking on another panel +- Fixed icon misalignment on Uppercase button in text properties panel +- Fixed issue with inconsistent truncation of list items +- Fixed issue where several action menus could be opened at the same time in the Layouts panel +- Fixed issue with hidden action menu on sortable lists when using Safari +- Fixed issue with hamburger menu being shown behind other panels +- Fixed issue with blocked Media panel when an image frame was selected +- Fixed issue with output generation being triggered after renaming a template +- Fixed issue that resulted in an error when removing a frame + + +## Jan 9, 2023 - CHILI GraFx + + +### Improvements + +- If you have multiple clients you can easily switch between these clients and get a list with environments of that client +- If you have multiple clients you can search for a specific client by typing the name of the client in the search bar diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 79ae1883..191679a4 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -1,992 +1,355 @@ # Release notes -## Dec 1, 2023 - CHILI GraFx - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) +## ![rn_icon](/assets/CHILI_LOGOS_OK-21.svg) Mar 28, 2024 - GraFx Publisher ### Improvements -- GraFx Publisher opens in separate tab -- The Application remains visible (won't collapse anymore) -- In GraFx Media, the URL indicates the asset's location sharing and back button navigation -- Environment avatars are shown in the environment overview -- Without the right permissions, the user will see a 'No access' page -- UI improvements in the subscription & environment drop-down -- UI improvements in the integration configuration +- Logging of PDF generation has been improved, giving you more insights. +- **DocumentProcessServerSide** endpoint output file is moved to a more sustainable location. +!!! Info + If you have hard-coded checks on the full path, you need to check your integration. The URL has changed. + + If you parse the result and use the download link provided, nothing needs to change. -## Dec 1, 2023 - GraFx Studio -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) -### Features +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) Mar 28, 2024 - CHILI GraFx -- Clear local text style overrides -You can now clear local text formatting overrides to revert to the applied paragraph or character style +### Features -![releasenotes](clear-text-formatting.png) +- Federated User Groups: Enable users in a User Group of your Identity Provider to get instant access to CHILI GraFx. +See [Federated Single Sign On](/CHILI-GraFx/concepts/federated-single-sign-on/) and [User Group Membership](/CHILI-GraFx/guides/manage-group-membership/#manage-membership-of-federated-users) for more details. -### Improvements +## ![rn_icon](/assets/CHILI_LOGOS_OK-21.svg) Mar 14, 2024 - GraFx Publisher -- The panels for editing actions or selecting images/fonts can now be freely moved without obstructing workspace interaction -- The Template Designer workspace is now fully integrated into the CHILI GraFx platform using the same domain, eliminating the need for occasional re-logins due to the studio.chiligrafx.com domain change +### New plugins -### Fixes +- for [Adobe® Illustrator®](/GraFx-Publisher/convert/Adobe-Illustrator/) +- for [Adobe® InDesign®](/GraFx-Publisher/convert/Adobe-InDesign/) -- Fixed occasional images flicker during animation playback -- The text frame in animations now correctly displays the changed variable value when modified with an action -- Server-side rendering no longer utilizes incorrect layouts when actions alter the layout -- Duplicating a variable group now includes duplicating the associated variables -- Fixed rendering issues for certain fonts +### Features -## Nov 27, 2023 - CHILI GraFx +- Added support for Adobe® Illustrator®[^2] 2024 (28.x), +- Added support for Apple® silicon CPUs, +- Added a possibility to login with GraFx (SSO). -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) +This version is compatible with Adobe® Illustrator® 2022 (26.x), 2023 (27.x) and 2024 (28.x). -### Improvements +This version is compatible with Adobe® InDesign® 2023 (18.x) and 2024 (19.x). -- Improved performance of getting renders information -- Optimization of authorization-related functions +This version is compatible with GraFx Publisher and the on-premise version of CHILI Publisher (6.6.5.0). -### Fixes -- Fixed error response in case of failed users invitation +!!! info -CHILI GraFx [Platform API](https://api.chiligrafx.com/swagger/index.html) + Please uninstall the previous versions of the CHILI Plugins to avoid unexpected issues with the new releases. + + **Mac OS** + + Applications/CHILI publish/CHILI Desktop Tools/uninstall + + **Windows OS** + + Control Panel > Programs > Programs and Features > Uninstall or change a program > + **Look for CHILI Desktop Tools** + + C:\Program Files (x86)\CHILI publish\CHILI Desktop Tools\uninstall.exe -## Nov 22, 2023 - CHILI GraFx -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) +[^2]: Adobe® InDesign® and Illustrator® are either registered trademarks or trademarks of Adobe® in the United States and/or other countries. -CHILI GraFx [Environment API 1.3.3](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) Mar 06, 2024 - CHILI GraFx ### Improvements -- Improved the performance of the 'Get' endpoints for media and templates. -- Transitioned to using a token cache service for fetching internal tokens, moving away from direct calls to the identity provider. -- Standardized the examples in Swagger documentation for consistency. +- PDF output endpoint has been moved from experimental to production +- Introduced endpoints to manage output settings +- Improved stability of connectors API ### Fixes -- Fixed the issue causing a 500 response when certain invalid arguments are used. -- Addressed an issue where URLs containing the 'environment' value in varying case sensitivities caused errors. -- Resolved a 500 error that occurred due to a concurrency issue when executing multiple requests to delete a single folder. -- Fixed a problem where templates became unattachable to any collection after being manually migrated to another environment without updating their ID. +- Fixed error during parsing of MacOS fonts ### New Endpoints -- Introduced for Enhanced Media Preview Capabilities
`GET /api/v1/environment/{environment}/media/{mediaId}/preview/highestOrVector` - -## Nov 21, 2023 - GraFx Publisher - -![rn_icon](/assets/CHILI_publisher_RGB.svg) - -### Fixes - -- Fixed: EPS file previews missing after data migration - -## Nov 14, 2023 - GraFx Publisher - -![rn_icon](/assets/CHILI_publisher_RGB.svg) - -### Fixes +Introduced output settings endpoints -- Improved PDF output performance -- Fixed duplicates for resources -- Fixed blank documents in rare occasions -- Fixed stuck tasks in queue after VDP output -- Fixed document image output +- GET /api/v1/environment/{environment}/output/settings +- DELETE /api/v1/environment/{environment}/output/settings +- GET /api/v1/environment/{environment}/output/settings +- PUT /api/v1/environment/{environment}/output/settings/{outputSettingsId} +- POST /api/v1/environment/{environment}/output/settings/jpg +- POST /api/v1/environment/{environment}/output/settings/png +- POST /api/v1/environment/{environment}/output/settings/pdf +- POST /api/v1/environment/{environment}/output/settings/gif +- POST /api/v1/environment/{environment}/output/settings/mp4 -## Nov 7, 2023 - GraFx Studio +Introduced PDF output task endpoint -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) +- POST /api/v1/environment/{environment}/output/pdf -### Features +CHILI GraFx [Environment API 1.3.6](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) -- Our new AI assistant [GraFx Genie](/GraFx-Studio/concepts/grafx-genie/) can help you write actions! Just tell it what the action should do and it will generate the JavaScript code for you (available in [experimental](/release-notes/experimental/) mode) -- You can change the unit of a layout to millimeters or inches. This is a first step toward enabling print output with GraFx Studio! (available in [experimental](/release-notes/experimental/) mode) +## ![rn_icon](/assets/CHILI_LOGOS_OK-21.svg) Mar 05, 2024 - GraFx Publisher ### Improvements -- You can reorder frames in the Layers panel by drag and drop. This changes the order in which frames are rendered on top of each other -- Improved handling of invalid input in the property input fields -- Added support for images with a custom crop in PDF output (available in [experimental](/release-notes/experimental/) mode) - -### Fixes - -- Assets are shown twice in the Media panel -- Selected frame is deleted when using the delete/backspace key while a dialog is open but the focus is not on the text input field -- Actions that use the "Frame moved" trigger are executed multiple times when the frame is moved by holding down an arrow key -- Action is not added to the undo/redo stack if the Folder setting for the GraFx Media connector was changed in the image variable settings -- Cannot insert an empty text variable in a text frame -- Not able to apply the default Arial font to text -- Font style does not display the correct style when the default Arial font is used -- Updated value of line height in character style is applied to the text only after entering text edit mode -- Paragraph style cannot be set after deleting the used font -- Paragraph style settings can't be opened by pencil icon if you clicked outside before -- 'Null' is present for character style settings when you provide an invalid value -- Copyfitting maximum value resets to the default value on frame movement -- Text overflow warning icon is shown for a second when you switch between text frames in text edit mode - -## Nov 2, 2023 - GraFx Publisher +- Enhanced CHILI GraFx's handling of large VDP[^1] jobs. +Media assets caching is improved, significantly reducing the overall processing time. -![rn_icon](/assets/CHILI_publisher_RGB.svg) +[^1]: VDP: Variable Data Processing, a.k.a. Variable Data Printing -### Fixes - -- Fixed resources consistency issue between Environment API and CPO. Sometimes folders where duplicated. - -## Oct 31, 2023 - GraFx Publisher - -![rn_icon](/assets/CHILI_publisher_RGB.svg) +- Improved performance +Several technical improvements to the tech stack result in overall better performance. +- Improved preview of assets with blend mode in the GraFx Publisher Editor +- Switched output download link to a more sustainable location (URL remains to not break your integrations) ### Fixes -- Fixed performance degradation of copy & move operations -- Fixed issue with using keyboard shortcut to delete a locked frame (when frame has constraints) - -## Oct 20, 2023 - We go live! - -GraFx Studio, GraFx Fonts & GraFx Media go live! - -### GraFx Media - -![rn_icon](/assets/CHILI_LOGOS_OK-11.svg) - -GraFx Media is the application on CHILI GraFx that enables you to manage template assets in one central library. Assets in GraFx Media are shared across GraFx Studio & GraFx Publisher. Asset management for GraFx Publisher can still be done in GraFx Publisher but with GraFx Media we offer an improved UX to manage assets more efficiently. - -#### Features -- You can upload an asset with format .eps, .jpg, .pdf, .png, .psd, .tif & .ai -- You can create folders -- You can rename or delete an asset -- You can filter on format of assets - -### GraFx Fonts - -![rn_icon](/assets/CHILI_LOGOS_OK-07.svg) - -GraFx Fonts introduces the concept of font families & font styles to CHILI GraFx and brings better brand consistency to CHILI GraFx. Important to know is that fonts in GraFx Fonts can only be used in GraFx Studio. Fonts used in GraFx Publisher are managed in GraFx Publisher separately. - -#### Features -- You can upload a font style & font family -- During the font upload you can change the font family and font style -- You can sort & delete font styles & font families -- You can access font styles details - -![2023-10-11_15-31-50](https://github.com/chili-publish/grafx-documentation/assets/122599725/fe98f3c4-6b13-4264-aa74-862cd3a35b2f) +- Fixed issue when asset previews can’t be recreated after calling ResourceItemReplaceFile +- Fixed an issue where a (wrong) error was shown on the login page -### GraFx Studio +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-10.svg) Feb 27, 2024 - GraFx Studio -![rn_icon](/assets/CHILI_LOGOS_OK-09.svg) - -This is a big day for GraFx Studio, as it is now available for use in production! - -Managing templates and collections and access to the Template Designer workspace are now restricted to admins and template designers. Other users can use templates to create projects with personalized and localized content, but cannot edit the original templates. - -Even though it is now in production, GraFx Studio renders are not yet counted, as we want to give our users some time to get used to the new application first. We hope you enjoy it and are curious to hear your feedback! - -#### Features - -**Actions** - -Actions can be added to a template to define how it should react to user input. Actions let you show/hide a frame or variable, select a layout, change a variable value, change a color, and much more. Triggers can be set to control when actions should be executed. - -
 
- - -It was already available as an [experimental](/release-notes/experimental/) feature but is now available for production use. - -**GraFx Fonts** - -With the introduction of GraFx Fonts, we also introduce the concept of font families and font styles in GraFx Studio. You can now add font families to the Stylekit of your template and the font styles from this family will be available for use in the template. - -**This is a breaking change!** All existing templates need to be updated (GraFx Publisher fonts are not accessible anymore through GraFx Studio and will fall back to Arial). This means you have to upload your fonts to GraFx Fonts, add them to the Stylekit of your template, and apply them again to the text and/or styles. Projects created from these templates are also impacted, it is advised to delete them and start new projects from the updated templates. - -**Image variable settings** - -Inside the image variable settings, the template designer can specify the folder inside GraFx Media where the assets for that variable are located. This results in a better experience for the user and prevents access to other assets. - -
 
- - -For custom media connectors this also enables custom settings for image variables, as defined by the connector. Custom media connectors enable you to use assets from an external DAM system in GraFx Studio templates (this is still in [experimental](/release-notes/experimental/) mode). - -#### Improvements - -- Writing actions has been made easier with the introduction of [helper functions](/GraFx-Studio/concepts/helper-functions/) -- Renamed triggers that are used inside the action script (**This is a breaking change!** Please update any action that uses triggers.changedVariable, triggers.changedFrame, etc.) -- Improved error indications in the list of actions -- Proper support for undo/redo of actions -- Improved visual feedback on the canvas when an image is unable to load -- UI improvements in the Template Designer workspace -- UI improvements in the Studio UI -- When integrating the Studio UI you can configure the download and back buttons - -#### Fixes - -- Fixed issue with undo/redo and saving of changes to horizontal text alignment - -## Sep 19, 2023 - GraFx Publisher - -![rn_icon](/assets/CHILI_publisher_RGB.svg) - -- Output: Improve error handling of a corrupt PNG during output - -## Sep 12, 2023 - GraFx Studio - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) - -- Fixed issue with output generation in both Template Designer workspace and Studio UI -- You can now delete multiple paragraph and character styles, colors, and actions at once - -Improvements to **Actions** ([experimental](/release-notes/experimental/) feature): - -- An error icon is shown in the list of actions if the action contains errors -- We added more flexibility to get and set properties in an action -- We changed the method name to change the visibility of a frame: `.include()` is replaced by `.setVisible()` -**This is a breaking change! Please update any template that uses this method ([here](/GraFx-Studio/guides/actions/example-hideframe/) you can find an example of how it works). Projects created from these templates will also be impacted, so it is advised to delete them and start new projects from the updated templates.** - -## Sep 12, 2023 - GraFx Publisher +### Improvements -![rn_icon](/assets/CHILI_publisher_RGB.svg) +- Media search improvements in the Studio UI ### Fixes -- Fixed failing document preview because of failing preflight checks if a required variable is empty - -## Aug 30, 2023 - GraFx Studio - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) - -With this release, we introduced improvements to the GraFx Studio Smart Template editor - -- You're now able to reorder actions (this impacts the order of execution when multiple actions have the same trigger) - -![releasenotes](reorder-actions.gif) - -- Action script is saved even if it contains errors (indicated with a red squiggly line). This is useful when you're in the middle of writing an action and you need to close the action interface to check something - -![releasenotes](save-on-error.png) - -- Visual improvements to the action interface -- Rename action trigger to "Selected layout changed" -- Force action names to be unique -- Show notification when closing or reloading GraFx Studio with unsaved changes -- When inserting an image variable in an image frame that contains an image, this image is automatically set as default state for that image variable -- Dialog to edit a character/paragraph style is not hidden behind the animation timeline anymore -- Fixed issue with error tooltips -- Add percentage sign behind line height value -- Selecting another layout exits text editing mode -- It's no longer possible to use a URL for an image variable (an asset ID must be used) +- Fixed issue with color slider in the color picker +- Fixed issue with Folder setting for GraFx Media in image variable settings +- Fixed issue with image preview when image variable value is set by name -We also improved the GraFx Studio UI, the interface for the self-service use-case - -- Automatically zoom to page when another layout is selected by an action -- Shortcuts to select another tool are disabled to prevent end-users from accidentally going into inline edit mode -- Shortcut to open the debug panel is disabled -- Show indicator and block new downloads while download is in progress - - -## Aug 30, 2023 - GraFx Publisher - -![rn_icon](/assets/CHILI_publisher_RGB.svg) - -- User management in GraFx Publisher has changed to API User management. You are now able to manage GraFx Publisher [users in CHILI GraFx platform](/CHILI-GraFx/users/creation/). Existing users in GraFx Publisher are unaffected, but we advise migrating these users to [CHILI GraFx](/CHILI-GraFx/users/creation/). -- Fixed an issue in the DEL ‘/rest-api/v1.2/resources/Documents/folders’ endpoint to prevent data loss. - -## Aug 24, 2023 - CHILI GraFx - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) - -CHILI GraFx [Environment API 1.1.9](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) - -- Introduce GET /environments/{environmentId}/font-styles/{styleId} -
endpoint that provides font style information -- Introduce DELETE /environments/{environmentId}/font-styles?ids={comma-separated ids} -
endpoint that deletes font styles by id. -- Introduce DELETE /environments/{environmentId}/font-families?ids={comma-separated ids}
endpoint that deletes font families by id. -- Extend GET /environments/{environmentId}/font-familes -
endpoint with ‘search’ argument that provides ability to search by font family name - -## Aug 16, 2023 - CHILI GraFx - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) - -### Features - -- De-activate a user so the user can no longer access or use any of the resources within that subscription -- Re-activate a user that was deactivated so the user has exactly the same priviliges he had before being de-activated -- Delete a user so the user loses all his privileges within that subscription & the user isn't visible in the list of users anymore - -![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/b0b9bb66-1f25-4c70-bd95-e4e0c7e94f74) - -CHILI GraFx [Platform API](https://api.chiligrafx.com/swagger/index.html) +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) Feb 26, 2024 - CHILI GraFx ### Improvements -- GET /subscription/id and /subscription/id/renders were migrated to use GUIDs. Now all our endpoints use GUIDs for identifying entities. -- GET subscription/subscriptionId/users/userId has been deprecated to improve consistency in naming. GET subscription**s**/subscriptionId/users/userId is the new endpoint. - -## Aug 15, 2023 - GraFx Publisher - -![rn_icon](/assets/CHILI_publisher_RGB.svg) - -- Backoffice: Fixed issue with old preview being applied when copying document immediately after changes were made to original document -- Editor: Improved availability of [Publisher interface library](https://github.com/chili-publish/publisher-interface) -- Editor: Removed the use of the d= parameter in URL as it’s no longer supported in Chrome. (see [this Article](https://mysupport.chili-publish.com/hc/en-us/articles/360019722600-Dealing-With-CORS-Using-Custom-Subdomains) on CORS for more background) -- Editor: Fixed issue with assets without point of interest not showing on template when Smart Fit is applied -- System: Fixed performance degradation of copy & move operations -- Output: Added error detail for unsupported png files +- The quality of the thumbnails for template & project in GraFx Studio have improved +- On the homepage the environments are now ranked with the most recent visited environment first +- On the user detail page it's indicated if a user is federated (= created in third party IDP of the client) or local (= created on CHILI GraFx) +- Restricted actions on federated users are now clarified by error messages +- You can now update the name and description of the created user groups. -## Aug 4, 2023 - GraFx Studio - -Version 0.136.1, using Studio [SDK 0.136.0](https://github.com/chili-publish/studio-sdk/releases/tag/0.136.0) - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) +![screenshot](updatename.png) ### Features -#### Variables -List items inside ‘Single Select List’ variable can be reordered. Updated order also will be shown in a drop-down inside variable settings and in Studio UI - -![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/f47de351-d8f0-4780-93de-8faf17fb55d9) - -New variable type ‘Boolean’ was introduced with two settings – - -- Default state’ which allows to set the default value -- Visible’ settings which controls visibility of variable in Studio UI - -![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/7a3110bc-e979-4b55-8173-8a03d2bd59ca) - -#### Output -PDF output is present in the list of available output formats. This is an [experimental](/release-notes/experimental/) feature which is not feature complete yet and can contain some differences with templates from which you want to generate output. - -![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/269dae35-7e71-462e-ae9d-0033c6ad1efe) - - -### Fixes - -- Fixed issue where ‘Rename’ option was available for several selected variables at once in the ‘Variable List’ -- Fixed issue where the ‘Delete’ option only removed one variable when multiple were selected. Right now all selected variables will be removed from the ‘Variable List’ -- Fixed issue where an executed action is added to undo stack when switching between text variable input fields -- Fixed issues where playing the animation, made the timeline player move in blocks instead of moving smoothly over the timeline. -- Fixed issue where the finished animation didn’t change the pause button back to play. - -## Aug 3, 2023 - GraFx Studio +- A default user group that contains all the users of a subscription is made available and can be used to easily assign all users to the same environment(s) with the same role(s) -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) - -### Features +### Security -New action item ‘Collection settings’ was added to collections. This panel can be opened in two ways: -- Through the "Three dots" on the collection card and clicking "Collection settings" -- Inside a collection by clicking on the "Three dots" in the top right corner. -![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/377e0601-109c-4587-a92f-184ddb2aa803) +- Security updates to the Platform API were made. -It opens a panel with ‘Cover image’ option which allows to upload image that is shown on the collection card. For the uploaded image PNG, JPG and JPEG formats can be used and we don’t have restrictions for a file size. -![releasenotes](https://github.com/chili-publish/grafx-documentation/assets/122599725/f013110d-140e-42c8-8bb1-f5f377c70fbb) +CHILI GraFx [Platform API](https://api.chiligrafx.com/swagger/index.html) + +## ![rn_icon](/assets/CHILI_LOGOS_OK-21.svg) Feb 20, 2024 - GraFx Publisher ### Fixes -- Fixed issue where a template could be opened as a project from ‘Collection’ tab. Now a template can be opened only from the ‘My projects’ tab - -## Aug 3, 2023 - CHILI GraFx - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) - -CHILI GraFx [Environment API 1.1.8](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) - -- Introduced DELETE /environment/{envId}/template-collections/{collectionId}/cover endpoint that provides the ability to remove an image cover of a Template Collection -- Fixed: When adding a dot in the middle of a Template's name resulted in cutting the part of the name off -- Fixed: When adding a file with extension in uppercase as a Template Collection cover caused 500 error -## June 28, 2023 - CHILI GraFx - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) - -CHILI GraFx [Environment API 1.1.7](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) - -This release enables Template designers to create collections and manage templates in collections. - -End users can see collections, and create projects from templates in a collection. - -Fine grained access management will be added later. - -### Features - -- Template designers can now make [Collections](/CHILI-GraFx/concepts/template-management/#template-collection) -- Template designers can [manage templates](/CHILI-GraFx/guides/manage-collections/) in collections -- End-users can [create Projects](/CHILI-GraFx/concepts/template-management/#end-user) from Templates in a collection. -- Subscription Admins can now [create Integrations](/CHILI-GraFx/guides/integrations/) to allow external application to connect to CHILI GraFx +- Fixed cache issues when requesting Documents previews. +Image preview download returns wront content type instead of image/png when async was set to false. +- Fixed issue where imageQuality property in PDF export settings isn't updated via Backoffice ### Improvements -- Prevent the creation of folders with leading or trailing spaces in the names - - -## Jun 28, 2023 - CHILI GraFx +- PDF generation performance has been improved when no post-processing options are selected in the PDF Export Settings. This is default for new PDF Export Settings. -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) - -CHILI GraFx [Environment API 1.1.6](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) Feb 20, 2024 - CHILI GraFx ### Improvements -- Improved stability of output generation - -## Jun 23, 2023 - CHILI GraFx - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) - -CHILI GraFx [Environment API 1.1.5](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) - -### Features - -**[experimental](/release-notes/experimental/)** - -- Introduce temporary POST api/experimental/environment/{environmentId}/output/pdf endpoint that provides ability to generate PDF output +- We added an `isGraFxPricebook` flag to subscription information in the API to reflect if a certain subscription belongs to a CHILI GraFx price book. ### Fixes -- Fix ‘update Template body’ action to avoid data corruption. -- Fix ‘environment’ case sensitivity for My Project endpoints to avoid not-found errors -- Fix attempting to add My Project based on corrupted Template (avoid creation corrupted My Project) -- Update Environment API endpoints to restrict access for not activated users. - - -## June 23, 2023 - CHILI GraFx +- Fixed an issue where data was shown incorrectly when user roles were updated in the individual access tab of the user -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) - -CHILI GraFx [Platform API 1.12](https://api.chiligrafx.com/swagger/index.html) - -### Improvements - -- Added status in user endpoints - - GET /api/v1/subscription/{id}/users - - GET/api/v1/subscription/{subscriptionId}/users/{userId} -- Improved token generation for Integrations - -## Jun 19, 2023 - CHILI GraFx - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) +CHILI GraFx [Platform API](https://api.chiligrafx.com/swagger/index.html) -CHILI GraFx [Environment API 1.1.4](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html) +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-10.svg) Feb 16, 2024 - GraFx Studio ### Features -**Authentication** - -- Extended ‘full access’ configuration to support multiple applications having full access to Environment API and Platform API. - -**Machine to Machine** - -- Add support for scope-based authorization rules -- Enabled integrations access to Environment API endpoints. - -**Template Collections** - -- Managing the image cover of a Template Collection - -**My Projects** - -- Introduce GET api/v1/environments/{environmentId}/projects endpoint that provides list of ‘My Project’ data. -- Introduce GET api/v1/environment/{environmentId}/projects/{projectId} endpoint that provides ‘My Project’ data. -- Accessing My Project's previews -- Saving modified json document of a My Project document -- Output: Image and animation output from a Project +- Added support for CMYK colors +- Added letter spacing (tracking) to the text style properties +- You can select multiple frames by holding the Shift key and move and resize them together +- In an action, you can use the name of an asset to easily change an image variable based on user input (previously, you could only use the asset ID) ### Improvements -**GraFx Media** - -- Extended endpoints responses to return media file info - - GET api/v1/environment/{environmentId}/media - - GET api/v1/environment/{environmentId}/media/directory - -**Output** - -- Update ‘output’ endpoints: introduce ‘engineVersion’ parameter to override the engine version that is used during output rendering. - - POST api/v1/environment/{environmentId}/output/animation - - POST api/v1/environment/{environmentId}/output/image - +- The height of the animation timeline panel can be changed +- The color picker and text style panels can be moved +- Added a search field when browsing for images in the Studio UI +- Next to specifying a folder for image variables, you can now also specify if subfolders are included or not +- Improved rendering performance of text frames +- Improvements to PDF output (experimental) ### Fixes -- Output: Fixed mp4 output for a template with uneven dimensions -- Fixed return code (from 500 to 400) for template collection creation when the name is duplicate. -- Fixed adding new My Project with invalid Template (prevent storing broken My Project). - -**Connectors ([experimental](/release-notes/experimental/))** +- Fixed compatibility with some browser extensions (e.g. ZoomInfo) +- Fixed size of text cursor for low copyfitting values +- Fixed issue with updating text variables when they are placed at the end of a text frame -- Added Connector module - - -## Jun 16, 2023 - CHILI GraFx - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) - -CHILI GraFx Platform API 1.11 - -### Features - -**User management** - -- Added endpoints for disabling and enabling users in the subscription - -**Manage Integrations** - -- Added endpoints to create, update, delete Integrations -- Added endpoint to get details of a single Integration -- Added endpoint to get available scopes for an Integration -- Added endpoint to Rotate client secret -- Added endpoints to manage scopes of Integrations - -**Authentication** - -- Add support for the bearer token with new grant type -- Add support for scope-based authorization rules - -## Jun 9, 2023 - GraFx Publisher plug-in for Adobe Illustrator® - -![rn_icon](/assets/CHILI_publisher_RGB.svg) - -### Features - -- Added support for Adobe® Illustrator®[^1] 2023 (27.x) - -[^1]: - Adobe and Illustrator are either registered trademarks or trademarks of Adobe in the United States and/or other countries. +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-12.svg) Feb 1, 2024 - GraFx Media ### Improvements -- Preflighting a document is no longer adding items to the undo/redo stack -- When converting a document you are no longer prompted with a message for every text frame that contains right alignment - -### Resolved issues - -- Fixed issue with the plug-in panel going blank when reopening -- Fixed issue with missing images in documents exported to GraFx Publisher from macOS -- Fixed issue with failing conversion for documents containing circular text -- Fixed issue with upload when using heavy assets on Windows -- Fixed issue where the document name was not updated in the plug-in when opening a new document +- In GraFx Media you can move an asset from one place within the environment to another using the quick actions menu. -[Download page (behind login)](https://mysupport.chili-publish.com/hc/en-us/articles/360021250259-Latest-downloads) +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) Feb 1, 2024 - CHILI GraFx -This version is compatible with Adobe® Illustrator®[^1] 2022 (26.x) and 2023 (27.x). +??? note "Change in URLs" -This version is compatible with GraFx Publisher and the on-premise version of CHILI publisher (version 5.6 or above). - -## Jun 6, 2023 - GraFx Studio - -Version 0.123.1, using Studio SDK [0.123.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) + We've updated the way how our URLs in the platform are built. + This means that if you have bookmarks (especially if they are linking to a certain environment) that the URLs will bring you to a 404. + This change was necessary to have a more consistent way of navigating the platform. + Please update your bookmarks to follow the new structure. ### Features -- You can change the [corner radius](/GraFx-Studio/guides/shape-frame/) of your rectangle and polygon shapes by dragging the round handles in the shape or by using the corner radius properties in the frame properties panel - -![animation](/GraFx-Studio/guides/shape-frame/corner-radius.gif) - -### Improvements - -- When a new frame is added it is only visible on the selected layout and its sub-layouts, on all other layouts the frame is hidden (if you want a frame to be visible on all layouts you should add it on the top-level layout) - -## Jun 6, 2023 - GraFx Publisher - -![rn_icon](/assets/CHILI_publisher_RGB.svg) - -### Fixes - -- Editor: Fixed issue where iframe caused the page to scroll when partially outside of view -- Editor: Fixed issue with transparent selection -- API: Removed redundant calls to file system to minimize probability for concurrency issues -- API: Fixed issue with ResourceSearchInFolder not returning items in response if includeSubDirectories property was false -- API: Strengthened security on REST API - -## May 31, 2023 - GraFx Studio - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) - -We are working hard on delivering an end-to-end process, from Smart Templates created by designers to output generated by end users. Check out the [template management](/CHILI-GraFx/concepts/template-management/) page to learn more about this new way of working. +- Introducing User Groups to invite users in bulk to environments with a specific role per environment +- A user can be added to a user group when they are invited to CHILI GraFx for the first time or from the User Management page on CHILI GraFx +- User Group membership, User Group details (name & description) and assignement of environment and roles are managed by the Subscription Admin -The first step in this process is organizing your templates in [collections](/CHILI-GraFx/guides/manage-collections/). This is available now! +[Documentation on user groups](/CHILI-GraFx/guides/manage-user-groups/) -In the next step, end users will be able to browse the collections and start a project from one of the templates. The project will be opened in a user-friendly interface where you can make changes and generate output. - -![screen](/CHILI-GraFx/concepts/template-management/collections.png) - -## May 31, 2023 - CHILI GraFx - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) - -### Fixes +### API updates -- Updated error message if you want to invite more than 10 users at once to CHILI GraFx -- Disable 'Add Template Designer Seat' button when all Template Designer seats are assigned -- Fix issue with logout button on 'MyAccount' page +We're aiming to keep things smooth with a CI/CD approach; automatically rolling out updates to make sure you get the best experience. We'll give you a heads-up in the release notes only when there's something new and cool that changes how you use the platform. -## May 26, 2023 - GraFx Studio +### Improvements Platform API +- Possibility to configure allowed federated domains for external users +- Introduced "isFederated" field in the user model to reflect the federation status +CHILI GraFx [Platform API](https://api.chiligrafx.com/swagger/index.html) -Version 0.122.1, using Studio SDK [0.122.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) - -### Features - -- You can [crop an image](/GraFx-Studio/concepts/crop/) to manually resize and position it inside an image frame -- [Snap guides](/GraFx-Studio/concepts/snapping/) show up when creating, moving or resizing a frame to help you to nicely align the frames in your design - -![screenshot-fullwidth](/GraFx-Studio/concepts/crop/rectcrop.png) +### Improvements Environment API -![screenshot-fullwidth](/GraFx-Studio/concepts/snapping/snapping.gif) +- New naming for default output settings +- Several minor updates and fixes -### Improvements +CHILI GraFx [Environment API 1.3.5](/GraFx-Developers/#environment-api) -- You can use the arrow keys to move a frame in steps of 1 pixel, holding down the Shift key moves it in steps of 10 pixels -- Creating, moving or resizing a frame is now done on a pixel grid, meaning that the x, y, width, and height properties have non-decimal values -- Punctuation marks stay together with the preceding word and will not move to the next line +## ![rn_icon](/assets/CHILI_LOGOS_OK-21.svg) Jan 30, 2024 - GraFx Publisher ### Fixes -- Fixed issue where the animation sometimes blinked at the beginning or the end -- Fixed issue where changing the width or height of a frame also caused an override on other properties -- Fixed issue with constraining proportions when changing the width or height of a frame in the properties panel - -## May 23, 2023 - GraFx Publisher +- Improved stability for larger VDP sizes +- Task status is set to ‘false’ when no output was produced -![rn_icon](/assets/CHILI_publisher_RGB.svg) +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) Jan 26, 2024 - CHILI GraFx ### Fixes -- Output: Improved stability of VDP outputs with a large amount of rows and variables -- Output: Fixed output failure due to missing font -- Output: Improved reliability of PDF output when the system is under high load - -## May 16, 2023 - CHILI GraFx - Environment API - -![rn_icon](/assets/CHILI_LOGOS_OK-04.svg) - -### Added Endpoints - -User is able to **rename** template attached to collection - -- PATCH /api/v1/template-collections/{collectionId}/templates/{templateId} - -User is able to **create**, **rename** and **delete** project. - -- POST /api/v1/environments/{environmentId}/projects -- PATCH /api/v1/environments/{environmentId}/projects/{projectId} -- DELETE /api/v1/environments/{environmentId}/projects/{projectId} - -User is able to **download** project json. - -- GET /api/v1/environments/{environmentId}/projects/{projectId}/document - -### Updated Endpoints - -When a user attempts to **delete** a template attached to a collection, an error is returned. User is now able to use ‘force’ request parameter, the template will be deleted. - -- DELETE /api/v1/templates/{templateId} - -Http **method** is changed from ‘PUT’ to ‘PATCH’. - -The endpoint now allows partial update of template collection instead of full update. - -- PATCH /api/v1/template-collections/{templateCollectionId} - - -See Swagger [Environment API](https://sandbox1.chili-publish-sandbox.online/grafx/swagger/index.html). - - -## May 10, 2023 - GraFx Studio SDK - -We renamed our repository and package for the SDK. -The new name is studio-sdk, coming from editor-sdk. - -Also a new version has been pushed, we're now at version 0.121.0 - -??? note "Note for integrators" - - This means you'll have to update your integration dependency, and change it from @chili-publish/editor-sdk to @chili-publish/studio-sdk inside your `package.json`. - - -## Apr 20, 2023 - GraFx Publisher - -![rn_icon](/assets/CHILI_publisher_RGB.svg) - -### Features - -- You can now log into GraFx Publisher via GraFx user account. - - -## Apr 19, 2023 - CHILI GraFx +- Fixed an error where you could not access the platform -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) - -### Features - -- You can invite users to CHILI GraFx -- When you invite a user to CHILI GraFx you can assign this user to an GraFx environment and assign the role this user needs to have in this environment -- You can remove the role 'Subscription Admin' from other users -- You can add an existing user to additional GraFx environments and assign the role this user needs to have in this environment -- You can access GraFx Publisher within the CHILI GraFx environment with SSO -- You can login in GraFx Publisher from the direct URL with your CHILI GraFx account - -![2023-04-14_16-26-11](https://user-images.githubusercontent.com/122599725/233287606-4ef0e434-7af6-4b11-b148-a4abe1c6cbc7.gif) - -Read more about [User Management](/CHILI-GraFx/users/intro/). - -## Apr 14, 2023 - GraFx Studio - -Version 0.117.1, using Studio SDK [0.117.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) Jan 25, 2024 - CHILI GraFx +CHILI GraFx [Environment API 1.3.4](/GraFx-Developers/#environment-api) ### Improvements -- When applying a blend mode to a text frame you automatically go out of text edit mode (this way you can see the effect of the blend mode, because it is not applied while in text edit mode) -- You can now easily download the JSON file of the template with a "Download doc" trigger in the debug panel +- Introduce png variable output endpoint +api/v1/environment/{environmentId}/output/png +- Introduce gif variable output endpoint +api/v1/environment/{environmentId}/output/gif +- Introduce jpg variable output endpoint +api/v1/environment/{environmentId}/output/jpg +- Introduce 'default' output settings +- Add 'scaling' option to output settings +- Sort font styles by weight ### Fixes -- Fixed issue with MacBook being detected as a mobile device, causing issues with frame handles -- Fixed issue with opacity not being applied to fill and stroke for shapes -- Fixed issue when using a swatch as fill color for shapes, which caused the shape color to not change immediately on the canvas when the swatch color is changed -- Fixed issue with text not being selectable with the Text tool when a blend mode is applied to the text frame - -??? note "Note for integrators" - - There is a minor breaking change in the Studio SDK's typings. - It basically boils down to changing the import for the Id type, you can do it as follows:
- Change `#!typescript import { Id } from '@chili-publish/studio-sdk/lib/types/CommonTypes'`
- To `#!typescript import { Id } from '@chili-publish/studio-sdk'`
- For more information, please check out the [SDK release notes](https://github.com/chili-publish/studio-sdk/releases/tag/0.117.0){target="_blank"}. - - -## Apr 18, 2023 - GraFx Publisher - -**Boost Platform Performance** +- Update authorization rules for Content Administrator role +- Fix video output issues +- Avoid potential resources duplicates +- Ignore font style 'width' property on upload -GraFx Publisher comes with more than just a name change, this year it is all about improving platform performance. We've listened to your feedback and revamped our platform infrastructure to deliver blazing-fast file operations, including moving, copying, and deleting. This means you can work efficiently even in large environments! 🚀 +### Experimental -Note: Smaller environments might not notice significant changes in performance. +- Introduce oauth-authorization-code endpoints +(api/experimental/environment/{environment}/connectors/{connectorId}/auth/oauth-authorization-code) +- Introduce 'none' auth for connector definition -🔔 Heads up: We've fine-tuned the ResourceItemGetTree and ResourceItemGetTreeLevel API endpoints to optimize performance. Now, these endpoints return only the first 10,000 items, ensuring a smoother experience for all users. - -![rn_icon](/assets/CHILI_publisher_RGB.svg) +## ![rn_icon](/assets/CHILI_LOGOS_OK-21.svg) Jan 24, 2024 - GraFx Publisher ### Fixes -- API: Fixed issue with ResourceSearchInFolder not returning items in response if includeSubDirectories property was false -- API: Fixed 'ResourceGetTree/ResourceGetTreeLevel' for enabled support 'parentFolder' argument ending with slashes. -- API: Fixed 'rest-api/v1/resources/documents/items/{id}/privateinfo' endpoint to return 'fileInfo.xml' node - - -## Mar 31, 2023 - Infrastructure update - -Your [CHILI GraFx](/CHILI_GraFx/) infrastructure has been upgraded to have the latest update. - -With this update, we’re implementing platform infrastructure changes that greatly enhance performance. - -The update does require planned downtime, and will be transparant for you. - -The update will be implemented (starting April 5) gradually on all tenants, and will happen over the following days and weeks. - - -## Mar 29, 2023 - GraFx Studio - -Version 0.116.2, using Studio SDK [0.116.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) - -### Features - -- You can now add rectangle, ellipse, and polygon shapes to your design, by using a new Shape tool in the left toolbar. In the properties panel, you can set a blend mode and change the fill and stroke color, to customize as you want. (There are still a couple of known issues, which will be addressed in the next release!) - -![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/shapes.gif) +- When outputting a PDF with a variable in the path name, the value of the variable is now used correctly. +- Fixed the issue where an asset could end up as duplicate using ResourceItemAdd, when a path was malformed. +- Fixed vulnerability where code details were shown in an error message +- Fixed incorrect behavior for the ResourceSearchInFolder API endpoint related to the parentFolderPath parameter. Previously, when includeSubDirectories was set to true, the endpoint performed a prefix search. This behavior has been corrected to conduct an exact search, aligning with expectations set in prior versions of CHILI. +- Fixed issue where some characters in REST endpoint query parameters cause the endpoint to fail ### Improvements -- You can select text on the page when the Text tool is active (previously it would create a new text frame instead) -- The layout name above the page is not scaled when zooming in or out -- Blend mode is not applied when in text edit mode (this makes editing text easier) -- Internal optimization to significantly increase the performance or rendering frames on the canvas - -### Fixes - -- Fixed issue with the Width and Height properties both getting an override when only one of the two was changed -- Fixed issue with changing a font in a text frame when the animation is paused inside an animation block for that frame - -## Mar 17, 2023 - GraFx Publisher - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK_publisher.svg) - -!!! danger "Sandbox Release" - - Information related to your Sandbox. - - When the update is in production, another release note will be added. - -Your [CHILI GraFx](/CHILI_GraFx/) sandbox has the latest update to [GraFx Publisher](/GraFx_Publisher/) - -- Our goal: Improve performance in handling templates, documents, assets. -- Our ask: Test in your sandbox now, and send us your feedback. - -With this update, we’re implementing a new platform infrastructure that greatly enhances performance. We **urge** you to test GraFx Publisher on your sandbox environment to experience this new level of performance for yourself. - -## Mar 16, 2023 - GraFx Studio +- A download will now be served from a more sustainable location +- Improved performance when copying a file with an existing name -Version 0.114.1, using Studio SDK [0.114.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-09.svg) - -### Features - -- We added [15 blend modes](/GraFx_Studio/concept/blendmodes/) that can be applied to your image and text content to improve your template design - -![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/blendmodes_rn.gif) +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) Jan 19, 2024 - CHILI GraFx ### Improvements -- Animation snaps to 0,1 seconds on the timeline, which makes it easier to align the animation of multiple frames - -![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/snap_rn.gif) - -- Frames are only selectable and editable on the canvas while they are visible in the animation (this fixes some issues with entering text edit mode) -- While in text edit mode, you can now also edit the frame properties and change the copyfitting settings +- Deprecated endpoints were deleted from the API ### Fixes -- Fixed some issues with the color picker component to select a custom color or a swatch or to change the opacity -- Fixed issue where fonts were not loaded when the dialog to add fonts was opened too quickly - -## Mar 6, 2023 - GraFx Media Alpha - -![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-11.svg) - -### Features - -- You can sort your assets on name -- You can see a preview of your asset - -![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/media_20230307.gif) - -## Mar 1, 2023 - GraFx Studio - -Version 0.111.2, using Studio SDK [0.111.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} - -### Features - -- You can constrain the proportions of a frame while resizing to preserve the aspect ratio - -![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/proportions.gif) - -- There is a new dropdown menu that allows you to control the zoom level -- A warning icon appears when part of your text is not visible because it doesn't fit inside the text frame +- Render visualization showed wrong metrics -![releasenotes](https://chilipublishdocs.imgix.net/releasenotes/overflow3.gif) - -### Improvements +CHILI GraFx [Platform API](https://api.chiligrafx.com/swagger/index.html) -- Variable settings panel does not close automatically anymore, it stays open until you manually close it +## ![rn_icon](/assets/CHILI_LOGOS_OK-21.svg) Jan 16, 2024 - GraFx Publisher ### Fixes -- Fixed issue where copyfitting property was not shown in yellow when it has an override -- Fixed issue where variable settings panel was only opened on second click -- Fixed issue with Media panel being empty when opened too fast - -## Feb 16, 2023 - GraFx Studio - -Version 0.107.4, using Studio SDK [0.107.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} +- Fixed issues where specific PDF assets caused corruption in the PDF output file -### Features - -- You can make the content of an image frame variable by inserting an image variable -- You can browse your media and assign an image to an image variable +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-04.svg) Jan 9, 2024 - CHILI GraFx ### Improvements -- The template is automatically zoomed to page when opened or when switching to another layout -- Added tooltips to the sidebar and header bar -- Added a loading indication while media previews are loading -- The variable settings panel is not opened when a new variable is created -- The variable name is truncated in the variable tag when it doesn't fit in the text frame, to prevent text overflow +- User groups +User groups allow admins to set permissions and access to user groups next to individual users. This release integrates user group permissions into our authorization process, available through the API. ### Fixes -- Fixed issue with resetting an override on the image fit mode -- Fixed issue with undo/redo of creating a new variable -- Fixed issue with undo/redo of creating a new layout -- Because of issues with calculating the number of occurrences of a variable, it's hidden in the variable list until the number is reliable -- Fixed infinite API calls when navigating to the bottom of the Media panel -- Media details are now retrieved using the new *details(id)* connector method -- Fixed issues with server-side rendering - -## Feb 16, 2023 - GraFx Media Alpha - -### Features +- Monthly renders of the last range weren't returned -- You can [browse](/GraFx_Media/how_to/browse/) between your assets in GraFx Media Alpha -- You can [search](/GraFx_Media/how_to/search/) for an asset in GraFx Media Alpha - -## Jan 30, 2023 - GraFx Studio - -Version 0.104.1, using Studio SDK [0.104.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} - -### Fixes - -- Fixed issue with loading media -- Fixed issue with font size and line height properties of a character style being set to 0 when clicked upon, and it was not possible to clear them (now you can leave them empty again to use the values from the applied paragraph style) -- Fixed issue with text rendering when line height is 0 -- Fixed issue with deleted font being shown in font dropdown menu -- Fixed issue with loading the default template -- Fixed weird behavior when using the Hand tool to move the page - -## Jan 23, 2023 - GraFx Studio +CHILI GraFx [Platform API](https://api.chiligrafx.com/swagger/index.html) -Version 0.102.2, using Studio SDK [0.102.0](https://github.com/chili-publish/studio-sdk/releases){target="_blank"} +## ![rn_icon](https://chilipublishdocs.imgix.net/logos/CHILI_LOGOS_OK-10.svg) Jan 4, 2024 - GraFx Studio ### Features -- You can now add [swatches](/GraFx_Studio/how_to/swatches/) to your Stylekit and use them in your template, e.g. to change the color of your text via a paragraph or character style (👉 click the color field to open the color picker, where you can go to the swatches tab to select a swatch) -- The [color picker](/GraFx_Studio/how_to/swatches/#color-picker) now comes in two versions, one for defining a swatch (where you cannot set the opacity or select another swatch) and one for applying a color (where you can choose between a custom color or a swatch and where you can change the opacity) -- You can [pan and zoom](/GraFx_Studio/mouse_trackpad/) the canvas by using two-finger gestures on the trackpad, even if the Hand or Zoom tool is not selected +- You can now cut (Ctrl/Cmd+X), copy (Ctrl/Cmd+C), paste (Ctrl/Cmd+V), and duplicate (Ctrl/Cmd+D) frames in the Template Designer workspace. This is possible with the shortcuts or via the quick actions in the Layers panel ### Improvements -- Improved text selection and text cursor positioning -- Simplified the character style settings by removing the indeterminate state for fill color (👉 when you leave the fill color unchecked the color is not applied, which means the default black or the color from the applied paragraph style is used) -- The default Arial Regular font is always available in the dropdown menu where you can select a font -- Renaming a font in the Stylekit is blocked (👉 you cannot rename a font in the Stylekit, but this was not blocked and caused an incorrect rename state) -- Removed variable name input field from the variables settings panel (👉 you can rename a variable by double clicking the variable name in the list) +- Added more tooltips to the Template Designer workspace and made some improvements to them +- Assigning an image to an image variable is now possible via a single click +- Changed the min and max values for copyfitting to 1% and 10.000% (it was 10% and 1.000%) +- Moved the "Clear style overrides" button to another location in the Template Designer workspace ### Fixes -- Fixed issue with loading fonts -- Fixed issue where the default Arial Regular font was selected in the text properties panel, but it was not used for new text frames -- Fixed issue where the applied character style was not shown correctly in the text properties panel -- Fixed issue where color swatches were converted to custom colors in paragraph and character styles -- Fixed issue with using Ctrl/Command+A to select all text with a keyboard with Azerty layout -- Fixed issue with replacing selected text with copied text -- Fixed issue where changes to variable settings were not saved when clicking on another panel -- Fixed icon misalignment on Uppercase button in text properties panel -- Fixed issue with inconsistent truncation of list items -- Fixed issue where several action menus could be opened at the same time in the Layouts panel -- Fixed issue with hidden action menu on sortable lists when using Safari -- Fixed issue with hamburger menu being shown behind other panels -- Fixed issue with blocked Media panel when an image frame was selected -- Fixed issue with output generation being triggered after renaming a template -- Fixed issue that resulted in an error when removing a frame +- Fixed issue with low quality image previews in the Studio UI +- Fixed issue with variable text not being updated after undo/redo +- Fixed issue with the number of triggers not being shown in red when hovered while in error state +- Fixed issue with the media connector sending multiple download requests +- Fixed issue with actions throwing the same error twice +- Fixed issue where a font that is used in the template could be deleted without getting a confirmation dialog +## ![rn_icon](/assets/CHILI_LOGOS_OK-21.svg) Jan 2, 2024 - GraFx Publisher -## Jan 9, 2023 - CHILI GraFx +### Fixes +- Fixed issue where datasource output with one record does not respect the PDF Name Pattern +- Fixed issue when deletion of a resource may cause deletion of other resources with similar name +- Improved error messaging when output generation fails -### Improvements +## 2023 -- If you have multiple clients you can easily switch between these clients and get a list with environments of that client -- If you have multiple clients you can search for a specific client by typing the name of the client in the search bar +See [this page](/release-notes/2023/) for 2023 release notes. diff --git a/docs/release-notes/reorder-actions.gif b/docs/release-notes/reorder-actions.gif index 98b740a6..a9a170f4 100644 Binary files a/docs/release-notes/reorder-actions.gif and b/docs/release-notes/reorder-actions.gif differ diff --git a/docs/release-notes/updatename.png b/docs/release-notes/updatename.png new file mode 100644 index 00000000..559a077d Binary files /dev/null and b/docs/release-notes/updatename.png differ diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 84a64675..9d980f41 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -34,6 +34,12 @@ img[alt=applogo] { img[alt=smallapplogo] { width: 70px; } +img[alt=tinyapplogo] { + --md-icon-size: 3.0em; + vertical-align: middle; + display: inline-flex; + height: var(--md-icon-size); +} img[alt=steps] { margin-left: 50px; border: 1pt #DDDDDD solid; @@ -64,7 +70,10 @@ p img[alt=svg_icon] { width: 100px; } img[alt=rn_icon] { - width: 75px; + --md-icon-size: 3.0em; + vertical-align: middle; + display: inline-flex; + height: var(--md-icon-size); } .md-header { background-color: #F0F0F0; diff --git a/docs/tags.md b/docs/tags.md deleted file mode 100644 index a58e0763..00000000 --- a/docs/tags.md +++ /dev/null @@ -1,3 +0,0 @@ -# Tagged search - -Tags used in the CHILI GraFx Documentation, with links to the associated pages \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 3384243c..49592402 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,6 +8,7 @@ theme: - navigation.tabs - content.tabs.link - navigation.footer + - content.footnote.tooltips font: text: Ubuntu palette: @@ -28,11 +29,11 @@ plugins: 'releasenotes/index.md': 'release-notes/index.md' - search - awesome-pages - - tags: - tags_file: tags.md - table-reader # - git-revision-date-localized: +# enable_creation_date: true # fallback_to_build_date: true +# type: iso-date markdown_extensions: - md_in_html @@ -45,6 +46,7 @@ markdown_extensions: class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - attr_list + - md_in_html - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg @@ -141,11 +143,18 @@ nav: - 'Intro' : 'CHILI-GraFx/users/intro/index.md' - 'Scope' : 'CHILI-GraFx/users/scope/index.md' - 'Roles' : 'CHILI-GraFx/users/roles/index.md' - - 'Change Roles & Access' : 'CHILI-GraFx/users/update/index.md' - 'Template Designer Seat' : 'CHILI-GraFx/users/template-designer/index.md' - 'Users & Invitation' : 'CHILI-GraFx/users/creation/index.md' + - 'Deactivate Users' : 'CHILI-GraFx/users/deactivate/index.md' + - 'Delete Users' : 'CHILI-GraFx/users/delete/index.md' - 'Transition' : 'CHILI-GraFx/users/transition/index.md' - 'How to': + - 'Change Roles & Access' : 'CHILI-GraFx/guides/role-access-update/index.md' + - 'Manage Individual Access' : 'CHILI-GraFx/guides/manage-individual-access/index.md' + - 'Manage User Groups' : 'CHILI-GraFx/guides/manage-user-groups/index.md' + - 'Manage Group Membership' : 'CHILI-GraFx/guides/manage-group-membership/index.md' + - 'Manage Group Access' : 'CHILI-GraFx/guides/manage-group-access/index.md' + - 'Example: Federated groups with Entra ID' : 'CHILI-GraFx/guides/example-federated-groups-entraid/index.md' - 'Create GraFx Studio template' : 'CHILI-GraFx/guides/create-studio-template/index.md' - 'Create GraFx Publisher template': 'CHILI-GraFx/guides/create-publisher-template/index.md' - 'Manage Collections' : 'CHILI-GraFx/guides/manage-collections/index.md' @@ -164,6 +173,13 @@ nav: - 'GraFx Studio intro': 'CHILI-GraFx/guides/onboarding/studio/index.md' - 'GraFx Media' : - 'GraFx Media intro': 'CHILI-GraFx/guides/onboarding/media/index.md' + - 'Trust': + - 'Introduction': 'CHILI-GraFx/trust/introduction/index.md' + - 'Security Policy': 'CHILI-GraFx/trust/security-policy/index.md' + - 'Compliance': 'CHILI-GraFx/trust/compliance/index.md' + - 'Data centers': 'CHILI-GraFx/trust/data-centers/index.md' + - 'GDPR': 'CHILI-GraFx/trust/gdpr/index.md' + - 'Definitions': 'CHILI-GraFx/trust/definitions/index.md' - 'GraFx Studio': - 'Introduction': 'GraFx-Studio/index.md' @@ -186,10 +202,10 @@ nav: - 'Layouts': 'GraFx-Studio/concepts/layouts/index.md' - 'Snapping': 'GraFx-Studio/concepts/snapping/index.md' - 'Shapes': 'GraFx-Studio/concepts/shapes/index.md' + - 'Variables': 'GraFx-Studio/concepts/variables/index.md' - 'Actions': 'GraFx-Studio/concepts/actions/index.md' - 'GraFx Genie': 'GraFx-Studio/concepts/grafx-genie/index.md' - 'Action Helper Functions': 'GraFx-Studio/concepts/helper-functions/index.md' - - 'Variables': 'GraFx-Studio/concepts/variables/index.md' - 'Crop': 'GraFx-Studio/concepts/crop/index.md' - 'Blend modes': 'GraFx-Studio/concepts/blendmodes/index.md' - 'Animation': 'GraFx-Studio/concepts/animation/index.md' @@ -209,9 +225,8 @@ nav: - 'How to: Animate': - 'Animate my frame': 'GraFx-Studio/guides/animate-frame/index.md' - 'How to: Automate': - - 'Define variables': 'GraFx-Studio/guides/variables/define/index.md' - - 'Organize variables': 'GraFx-Studio/guides/variables/organize/index.md' - - 'Add variables to document': 'GraFx-Studio/guides/variables/assign/index.md' + - 'Define template variables': 'GraFx-Studio/guides/template-variables/define/index.md' + - 'Add template variables': 'GraFx-Studio/guides/template-variables/assign/index.md' - 'Create Actions': 'GraFx-Studio/guides/actions/create/index.md' - 'Write Actions Javascript': 'GraFx-Studio/guides/actions/javascript/index.md' - 'Example: Change Layout': 'GraFx-Studio/guides/actions/example-changelayout/index.md' @@ -223,6 +238,8 @@ nav: - 'GIF': 'GraFx-Studio/guides/output/gif/index.md' - 'JPG and PNG': 'GraFx-Studio/guides/output/image/index.md' - 'PDF': 'GraFx-Studio/guides/output/pdf/index.md' + - 'How to: My projects': + - 'Create a project': 'GraFx-Studio/guides/create-projects/index.md' - 'Integrate GraFx studio': - 'Getting started': 'GraFx-Studio/integration/getting-started/index.md' - 'Local environment': 'GraFx-Studio/integration/environment/index.md' @@ -244,6 +261,11 @@ nav: - 'Variables': - 'General': 'GraFx-Publisher/guides/javascript/variables/index.md' - 'List': 'GraFx-Publisher/guides/javascript/variables/list/index.md' + - 'Plugins': + - 'Conversion': 'GraFx-Publisher/convert/intro/index.md' + - 'for Adobe® InDesign®': 'GraFx-Publisher/convert/Adobe-InDesign/index.md' + - 'for Adobe® Illustrator®': 'GraFx-Publisher/convert/Adobe-Illustrator/index.md' + - 'GraFx Media': - 'Introduction': 'GraFx-Media/index.md' @@ -280,12 +302,14 @@ nav: - 'Release notes': - 'Recent': 'release-notes/index.md' - - 'Experimental': 'release-notes/experimental/index.md' + - '2023': 'release-notes/2023.md' - '2022': 'release-notes/2022.md' + - 'Experimental': 'release-notes/experimental/index.md' - 'Developer Center': - 'Overview': 'GraFx-Developers/index.md' - 'Scopes': 'GraFx-Developers/scopes/index.md' + - 'GraFx Studio UI': 'GraFx-Developers/grafx-studio/ui/index.md' - 'GraFx Studio SDK': 'https://chili-publish.github.io/studio-sdk/index.html' - 'Platform API reference' : - 'Swagger' : 'https://api.chiligrafx.com/swagger/index.html' diff --git a/overrides/partials/toc.html b/overrides/partials/toc.html index 1d76b977..1e6f49d5 100644 --- a/overrides/partials/toc.html +++ b/overrides/partials/toc.html @@ -28,6 +28,25 @@