Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • If the damobject instance has been created by a user who has the rights to publish the asset, the workflow action publish will be executed for the asset

  • If the damobject instance has been created by a user who has the rights to submit the asset, the workflow action submit will be executed for the asset.
    To sum up, with those 2 transformations, the new asset will have the Published status if the user who created the asset has rights to publish it. Otherwise, if the surfer has the rights to submit it, the workflow action submit will be executed on the asset.

Portal configuration

Expand
titleSpace domain full configuration
  • back-to.json

  • cursors

    • collaborative-spaces-items.json

    • collaborative-spaces.json

  • default-cursor-name.json

  • explore

    • items

      • actions.json

    • sort

      • default-cursor-config.json

      • hide-sort.json

  • explore-items

    • filters

      • default-resource-config.json

    • items

      • actions.json

      • detail

        • comments

          • filter-options.json

          • sort-options.json

      • display

        • default-config

          • spaces-item-block.json

      • duplicates

        • authorized-resources.json

        • display.json

        • status-color.json

      • workflows

        • asset

          • display-order.json

          • hidden-statuses.json

          • rejected-status-id.json

        • hidden-actions.json

        • statuses-config.json

  • layouts

    • default-resource-config.json

You’ll find above the tree view of the new config domain for spaces. We will now go through all the config points and see their customization possibilities.

back-to.json
Status
colourPurple
titleCAN BE CUSTOMISED

Here you will define the name of the route that will be used with the click of the back-to button from the space list view.

...

Status
colourPurple
titleCAN BE CUSTOMISED

Here you can define/redefine cursors. Inside this folder we can find: collaborative-spaces.json, this cursor defines the way that spaces are retrieved.

...

Status
colourPurple
titleCAN BE CUSTOMISED

Here you are defining the cursor to use for the space entities retrieval

...

Status
colourRed
titleCAN'T BE CUSTOMISED

Inside this folder, we are defining the layouts config, the same way it is defined for the dam domain. We have a default-resource-config.json file which describes all the available layouts and the default layout used to display space item entities

Note

Avoid making changes to this configuration for now. Although we currently have only one layout, it may evolve, and we plan to provide additional layouts for users to switch to.

...

Status
colourPurple
titleCAN BE CUSTOMISED

Inside this folder, we can find configuration files and folders about the space entities display.

We have a sort folder that will contain JSON files like in the dam domain. These files can be customized.

We also have a folder called items inside this folder we have actions.json which will contain all the available actions for a space entity. You can edit this file to add new actions (if they are prepared and if they exist) or to remove unwanted ones.

...

Status
colourYellow
titleCAN BE PARTLY CUSTOMISED

This folder contains a lot of configuration files and folder about the space items display and features, we will go through them in a slightly different way.

filters

...

Workflow configuration

The creative workflow is based on using “massimport” objects just as the upload. The workflow currently used on the object massimportitem (wkfmassimportitem) can be customized.

Note

We do not recommend removing existing actions or changing their target statuses. There are multiple “key” statuses/actions on this workflow, we’ll go through some of them :

  • check/tocheck => Default status on item creation, “tocheck” action from draft to check is necessary and used by dam_utils.

  • approved => Required status for the item publish feature

  • review/toreview => As it is delivered by default, massimportitem structure is configured (by tags) to have its instances set to review status if a comment is posted on them and their original status was check.

  • If you need to refactor the actions and statuses related to the state validate, you’ll need to adapt the parameters of the plugin PACKAGED_CreativeWorkflow related to the approval logic. See this page for an explanation of those parameters and their default values : https://crossmedia.atlassian.net/wiki/spaces/WD/pages/2849210423/How+does+Creative+Workflow+works#PACKAGED_CreativeWorkflow

But If you need a new status, you can add it directly on wkfmassimportitem. Then if you add some actions …

...

… and this is what you get without any portal configurations.

...

...

We can see that the new status is correctly displayed on the dropdown. But we need to configure the filter and the hidden-actions or add an i18n key to have the correct behavior. If the position of the “customstatus” is not the one you want, you can configure it on the display-order config.

Here is the result after some config on the files mentioned above.

image-20240223-155933.pngImage Addedimage-20240223-155959.pngImage Addedimage-20240223-160059.pngImage Added

Add new targeted notifications

Notifications are delivered by default; here is the complete list: Creative workflow notifications

It is possible to add notifications based on project needs that would be triggered by specific actions (upload, status change, or others).

Here you will find more detailed information about the notification system setup for the creative workflow.

We are currently sending email notifications on each status change for each teammember or only for the owner according to PACKAGED_CreativeWorkflow.send_notification_to_team 's value.

As status change email notifications are based on the delayed notification system, if you want to add a customized behavior for a specific status (for example), you will have to create your Groovy script (you can check existing ones for inspiration) and update the configuration of PACKAGED_CreativeWorkflow.batch_topics_processors. You will have to follow the instructions described in the link provided above.

Portal configuration (advanced configuration)

Expand
titleSpace domain full configuration
  • back-to.json

  • cursors

    • collaborative-spaces-items.json

    • collaborative-spaces.json

  • default-cursor-name.json

  • explore

    • items

      • actions.json

    • sort

      • default-cursor-config.json

      • hide-sort.json

  • explore-items

    • filters

      • default-resource-config.json

    • items

      • actions.json

      • detail

        • comments

          • filter-options.json

          • sort-options.json

      • display

        • default-config

          • spaces-item-block.json

      • duplicates

        • authorized-resources.json

        • display.json

        • status-color.json

      • workflows

        • asset

          • display-order.json

          • hidden-statuses.json

          • rejected-status-id.json

        • hidden-actions.json

        • statuses-config.json

  • layouts

    • default-resource-config.json

You’ll find above the tree view of the new config domain for spaces. We will now go through all the config points and see their customization possibilities.

back-to.json
Status
colourPurple
titleCAN BE CUSTOMISED

Here you will define the name of the route that will be used with the click of the back-to button from the space list view.

cursors
Status
colourPurple
titleCAN BE CUSTOMISED

  • Filters for items can be modified, you can only add filters on massimportitems props.

  • Mainly composed by named-filters which can be found under common/named-filters.

items

detail

comments

...

filter-options.json

Status
colourRed
titleCAN'T BE CUSTOMISED

  • Configuration for comments filter feature dropdown.

...

Here you can define/redefine cursors. Inside this folder we can find: collaborative-spaces.json, this cursor defines the way that spaces are retrieved.

default-cursor-name.json
Status
colourPurple
titleCAN BE CUSTOMISED

  • Configuration for comments sort feature dropdown. You can modify this configuration to add sorting options or modify the existing one(s).

display

default-config

...

Here you are defining the cursor to use for the space entities retrieval

layouts
Status
colourRed
titleCAN'T BE CUSTOMISED

...

duplicates: In the creative workflow, we continue to offer a duplicate management system using the comparison modal, just as we did for the Upload feature.

...

Inside this folder, we are defining the layouts config, the same way it is defined for the dam domain. We have a default-resource-config.json file which describes all the available layouts and the default layout used to display space item entities

Note

Avoid making changes to this configuration for now. Although we currently have only one layout, it may evolve, and we plan to provide additional layouts for users to switch to.

explore
Status
colourPurple
titleCAN BE CUSTOMISED

  • This config is currently set to null because no restrictions were required.
    But it can be updated, it works in the same way as for the dam-import config.

...

display.json

Status
colourPurple
titleCAN BE CUSTOMISED

  • Currently this config is empty, but it can be edited to display additionnal informations about item’s props in the comparison modal.

...

status-color.json

Status
colourPurple
titleCAN BE CUSTOMISED

  • This config is used to define the color of the text used on the duplicates label. It can be edited.

workflows

asset

...

Inside this folder, we can find configuration files and folders about the space entities display.

We have a sort folder that will contain JSON files like in the dam domain. These files can be customized.

We also have a folder called items inside this folder we have actions.json which will contain all the available actions for a space entity. You can edit this file to add new actions (if they are prepared and if they exist) or to remove unwanted ones.

explore-items
Status
colourYellow
titleCAN BE PARTLY CUSTOMISED

This folder contains a lot of configuration files and folder about the space items display and features, we will go through them in a slightly different way.

  • filters

    • default-resource-config.json

      Status
      colourPurple
      titleCAN BE CUSTOMISED

        • This config is used to reorder the status dropdown displayed on the item block card.
          It can be modified.

        hidden-statuses

        Filters for items can be modified, you can only add filters on massimportitems props.

      • Mainly composed by named-filters which can be found under common/named-filters.

  • items

    • detail

      • comments

        • filter-options.json

          Status
          colourPurpleRed
          titleCAN BE CUSTOMISED

          • This config is used to hide statuses and avoid showing them in the dropdown on the item block card. Mainly set for the “processing statuses” that are used when items are published. It can be modified.

          rejected-status-id

          'T BE CUSTOMISED

          • Configuration for comments filter feature dropdown.

        • sort-options.json

          Status
          colourPurple
          titleCAN BE CUSTOMISED

          • This config is used to configure the rejected status ID. This allows the CwSpacesBlockItem.vue component to know correctly which one of all the massimportitem's statuses is the real rejected status. It is used to define if the comparison modal link should be displayed. It can be modified.

        hidden-actions
          • Configuration for comments sort feature dropdown. You can modify this configuration to add sorting options or modify the existing one(s).

    • display

      • default-config

        • space-item-block.json

          Status
          colour

        Purple
        • Red
          titleCAN'T BE CUSTOMISED

          • This config contains the name of the named-display that is used to

          hide workflow actions. The main purpose of this config in the space domain is to hide all the workflow actions on the comparison modal. Only “torejected” is permitted. The config can be edited if you want to enable other actions from the comparison modal (or if you’ve added other statuses and actions and want the actions to be displayed).
        statuses-config
          • display an item of a space. The current spaceItemBlockis displayed with the itemBlockconfig (common/named-displays/item-block). We do not recommend this config to be updated, but if you want another title or subtitle for the space block items you can redefine the properties used to display title or subtitle.

    • duplicates: In the creative workflow, we continue to offer a duplicate management system using the comparison modal, just as we did for the Upload feature.

      • authorized-resources.json

        Status
        colourRedPurple
        titleCAN 'T BE CUSTOMISED

        • This config is a mapping config. It is mainly used to map a status config (id, label, tooltip, color) for the items indexingstatus value. While we do not recommend editing this configuration, you still have the flexibility to modify colors, labels, or icons (displayed just before the dropdowns on the item's block card).

      actions
        • currently set to null because no restrictions were required.
          But it can be updated, it works in the same way as for the dam-import config.

      • display.json

        Status
        colourPurple
        titleCAN BE CUSTOMISED

      • Contains all the available actions for a space item (massimportitem) entity. You can edit this file to add new actions (if they are prepared and they exist) or to remove unwanted ones.

Workflow configuration

The creative workflow is based on using “massimport” objects just as the upload. The workflow currently used on the object massimportitem (wkfmassimportitem) can be customized.

Note

We do not recommend removing existing actions or changing their target statuses. There are multiple “key” statuses/actions on this workflow, we’ll go through some of them :

  • check/tocheck => Default status on item creation, “tocheck” action from draft to check is necessary and used by dam_utils.

  • approved => Required status for the item publish feature

  • review/toreview => As it is delivered by default, massimportitem structure is configured (by tags) to have its instances set to review status if a comment is posted on them and their original status was check.

  • If you need to refactor the actions and statuses related to the state validate, you’ll need to adapt the parameters of the plugin PACKAGED_CreativeWorkflow related to the approval logic. See this page for an explanation of those parameters and their default values : https://crossmedia.atlassian.net/wiki/spaces/WD/pages/2849210423/How+does+Creative+Workflow+works#PACKAGED_CreativeWorkflow

But If you need a new status, you can add it directly on wkfmassimportitem. Then if you add some actions …

...

… and this is what you get without any portal configurations.

...

...

We can see that the new status is correctly displayed on the dropdown. But we need to configure the filter and the hidden-actions or add an i18n key to have the correct behavior. If the position of the “customstatus” is not the one you want, you can configure it on the display-order config.

Here is the result after some config on the files mentioned above.

image-20240223-155933.pngImage Removedimage-20240223-155959.pngImage Removedimage-20240223-160059.pngImage Removed

Add new targeted notifications

Notifications are delivered by default; here is the complete list: Creative workflow notifications

It is possible to add notifications based on project needs that would be triggered by specific actions (upload, status change, or others).

Here you will find more detailed information about the notification system setup for the creative workflow.

We are currently sending email notifications on each status change for each teammember or only for the owner according to PACKAGED_CreativeWorkflow.send_notification_to_team 's value.

...

        • Currently this config is empty, but it can be edited to display additionnal informations about item’s props in the comparison modal.

      • status-color.json

        Status
        colourPurple
        titleCAN BE CUSTOMISED

        • This config is used to define the color of the text used on the duplicates label. It can be edited.

    • workflows

      • asset

        • display-order.json

          Status
          colourPurple
          titleCAN BE CUSTOMISED

          • This config is used to reorder the status dropdown displayed on the item block card.
            It can be modified.

        • hidden-statuses.json

          Status
          colourPurple
          titleCAN BE CUSTOMISED

          • This config is used to hide statuses and avoid showing them in the dropdown on the item block card. Mainly set for the “processing statuses” that are used when items are published. It can be modified.

        • rejected-status-id.json

          Status
          colourPurple
          titleCAN BE CUSTOMISED

          • This config is used to configure the rejected status ID. This allows the CwSpacesBlockItem.vue component to know correctly which one of all the massimportitem's statuses is the real rejected status. It is used to define if the comparison modal link should be displayed. It can be modified.

      • hidden-actions.json

        Status
        colourPurple
        titleCAN BE CUSTOMISED

        • This config is used to hide workflow actions. The main purpose of this config in the space domain is to hide all the workflow actions on the comparison modal. Only “torejected” is permitted. The config can be edited if you want to enable other actions from the comparison modal (or if you’ve added other statuses and actions and want the actions to be displayed).

      • statuses-config.json

        Status
        colourRed
        titleCAN'T BE CUSTOMISED

        • This config is a mapping config. It is mainly used to map a status config (id, label, tooltip, color) for the items indexingstatus value. While we do not recommend editing this configuration, you still have the flexibility to modify colors, labels, or icons (displayed just before the dropdowns on the item's block card).

    • actions.json

      Status
      colourPurple
      titleCAN BE CUSTOMISED

      • Contains all the available actions for a space item (massimportitem) entity. You can edit this file to add new actions (if they are prepared and they exist) or to remove unwanted ones.