You are looking at documentation for an older release. Not what you want? See the current release documentation.
This plugin is used to manage ChromatticSession in the Social project.
To use the plugin in the component configuration, you must use the following target-component:
<target-component>org.exoplatform.commons.chromattic.ChromatticManager</target-component>
Sample configuration:
<component-plugin>
<name>chromattic</name>
<set-method>addLifeCycle</set-method>
<type>org.exoplatform.social.common.lifecycle.SocialChromatticLifeCycle</type>
<init-params>
<value-param>
<name>domain-name</name>
<value>soc</value>
</value-param>
<value-param>
<name>workspace-name</name>
<value>social</value>
</value-param>
<value-param profiles="all,default,minimal">
<name>workspace-name</name>
<value>social</value>
</value-param>
<values-param>
<name>entities</name>
<value>org.exoplatform.social.core.chromattic.entity.ProviderRootEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.ProviderEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.IdentityEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.ProfileEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.ActivityProfileEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.RelationshipEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.RelationshipListEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.HidableEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.LockableEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.ActivityEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.ActivityListEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.ActivityDayEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.ActivityMonthEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.ActivityYearEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.ActivityParameters</value>
<value>org.exoplatform.social.core.chromattic.entity.SpaceRootEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.SpaceEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.SpaceListEntity</value>
<value>org.exoplatform.social.core.chromattic.entity.SpaceRef</value>
</values-param>
<properties-param>
<name>options</name>
<property name="org.chromattic.api.Option.root_node.path" value="/production"/>
<property name="org.chromattic.api.Option.root_node.create" value="true"/>
</properties-param>
</init-params>
</component-plugin>
In which:
Name:
chromattic
Set-method:
addLifeCycle
Type:
org.exoplatform.social.common.lifecycle.SocialChromatticLifeCycle
Init-params:
| Value-param | Possible value | Description |
|---|---|---|
| domain-name |
String
| The lifecycle domain name. |
| workspace-name |
String
| The repository workspace name that is associated with this lifecycle. |
| entities |
List<String>
| The list of chromattic entities that will be registered against the chromattic builder. |
Properties-param: option
| Property name | Possible value | Default value | Description |
|---|---|---|---|
| org.chromattic.api.Option.root_node.path |
String
|
/production
| The path of the root node. |
| org.chromattic.api.Option.root_node.create |
Boolean
|
true
| Specifies whether or not the root node is created by the ROOT_NODE_PATH option when it does not exist. |