Documentation: Developers - Overview - Gitana

Documentation: Developers - Overview - Gitana Status Releases Registry Blog Cloud CMS Platform Content Management Create, Approve and Publish quality content to production on-time. Easy editorial and workflow tools let your best work reach your customers. Enterprise Data Engine Manage, collaborate, search and distribute your highly-structured data across branches, versions and workflow-driven lifecycle. Automate Automate your content creation and approval flows while taking advantage of AI servi

Gitana / 4.0 / Forms / Fields / Markdown Editor Field

Markdown Editor Field The markdown field. The Markdown Editor field renders the SimpleMDE Markdown editor control that allows users to visually work with Markdown. Properties Title Markdown Description Provides an instance of a Markdown Editor control for use in editing HTML Field Type markdown Base Field Type textarea Schema Property Type Default Description allowOptionalEmpty Allows this non-required field to validate when the value is empty autocomplete string Allows you to specify the autoco

Gitana / 4.0 / Forms / Fields / Number Field

Number Field The number field. Properties Title Number Description Number field Field Type number Base Field Type text Schema Property Type Default Description allowOptionalEmpty Allows this non-required field to validate when the value is empty autocomplete string Allows you to specify the autocomplete attribute for the underlying input control whether or not field should have autocomplete enabled. data object Allows you to specify a key/value map of data attributes that will be added as DOM at

Gitana / 4.0 / Forms / Fields / Summernote Editor Field

Summernote Editor Field The summernote field. The Summernote Editor field renders the Summernote editor control that allows users to visually work with HTML and save the results back into a text property. Properties Title Summer Note Editor Description Provides an instance of a Summernote Editor control for use in editing HTML. Field Type summernote Base Field Type text Schema Property Type Default Description allowOptionalEmpty Allows this non-required field to validate when the value is empty

Gitana / 4.0 / Forms / Fields / TinyMCE Field

TinyMCE Field The tinymce field. The TinyMCE Field renders the Tiny MCE editor control to allow users to visually work with HTML and save the results back into a text property. Properties Title Tiny MCE Description Provides an instance of a TinyMCE control for use in editing HTML Field Type tinymce Base Field Type textarea Schema Property Type Default Description allowOptionalEmpty Allows this non-required field to validate when the value is empty autocomplete string Allows you to specify the au

Gitana / 4.0 / Forms / Fields / Token Field

Token Field The token field. This provides an implementation of the Bootstrap TokenField plugin on top of a text field to allow for autocomplete and typeahead tokens in a comma (or alternative separator) delimited string. For full documentation on the options available for the Bootstrap Tokenfield plugin, see: http://sliptree.github.io/bootstrap-tokenfield For full documentation on the options available for the Twitter Bloodhound Suggestion engine, see: https://github.com/twitter/typeahead.js/bl

Gitana / 3.2 / Guide / Guide / UI Developers Guide / Templates / List Items

List Items List Items exist in multiple places in CloudCMS UI. They consist of an icon on the left and some detailed descriptions on the right. Below is an example of some list items configured with the default template. You can customize the description on the right using Templates. The Default Template

{{title data}}

Gitana / 4.0 / Developers / User Interface Customization / Templates / List Items

List Items List Items exist in multiple places in CloudCMS UI. They consist of an icon on the left and some detailed descriptions on the right. Below is an example of some list items configured with the default template. You can customize the description on the right using Templates. The Default Template

{{title data}}

Gitana / 3.2 / Guide / Guide / Deployment / Deployment Handlers / HTTP Deployment Handler

HTTP Deployment Handler Handles the deployment of one or more Deployment Packages to a custom HTTP endpoint. The custom HTTP endpoint is described by: url statusUrl username password Custom HTTP endpoints are useful for a large variety of purposes, including writing data into custom databases, synchronizing content from Cloud CMS with existing Content Management products, hooking into custom logic for CDN or cache invalidation and much more. Configuration { "url": "{url}", "statusUrl": "

Gitana / 4.0 / Data Engine / Deployment / Deployment Handlers / HTTP Deployment Handler

HTTP Deployment Handler Handles the deployment of one or more Deployment Packages to a custom HTTP endpoint. The custom HTTP endpoint is described by: url statusUrl username password Custom HTTP endpoints are useful for a large variety of purposes, including writing data into custom databases, synchronizing content from Cloud CMS with existing Content Management products, hooking into custom logic for CDN or cache invalidation and much more. Configuration { "url": "{url}", "statusUrl": "

Gitana / 4.0 / Developers / API / Resources / principal / Creates a principal within a domain

Creates a principal within a domain The incoming JSON payload should contain properties for the newly created principal If a 'password' property is provided, an identity will be created in the domain's default directory

Gitana / 3.2 / Guide / Guide / Forms / Fields / Node Picker

Node Picker ID: node-picker The node-picker field type renders a modal picker for a node. The modal picker allows you to filter nodes as well as paginate, sort and inspect nodes. The picker supports single node and multi-node selection depending on how the field is configured. Sample configuration: { "type": "node-picker" } The node picker should be modeled on top of either an object or an array field. The former is used for selection of a single node whereas the latter is used for selectio

Gitana / 4.0 / Forms / CMS / Fields / Node Picker

Node Picker ID: node-picker The node-picker field type renders a modal picker for a node. The modal picker allows you to filter nodes as well as paginate, sort and inspect nodes. The picker supports single node and multi-node selection depending on how the field is configured. Sample configuration: { "type": "node-picker" } The node picker should be modeled on top of either an object or an array field. The former is used for selection of a single node whereas the latter is used for selectio

Gitana / 3.2 / Guide / Guide / Deployment / Deployment Handlers / FTP Deployment Handler

FTP Deployment Handler Handles the deployment of one or more Deployment Packages to an SFTP or FTP server. The remote S/FTP server is described by a URL, username and password. The contents of the Deployment Packages will be deployed sequentially to the target location. If any of the content within the Deployment Packages fails to copy, it will simply be skipped. Other content objects will be allowed to proceed unabated. Configuration { "url": "{url}", "username": "{username}", "pass

Gitana / 3.2 / Guide / Guide / Deployment / Deployment Handlers / Amazon S3 Deployment Handler

Amazon S3 Deployment Handler Handles the deployment of one or more Deployment Packages to an Amazon S3 bucket. The Amazon S3 bucket is described by: accessKey secretKey region bucketName And optionally: prefix The contents of the Deployment Packages will be deployed sequentially to the target location. If any of the content within the Deployment Packages fails to copy, it will simply be skipped. Other content objects will be allowed to proceed unabated. Configuration { "accessKey": "{a

Gitana / 4.0 / Data Engine / Deployment / Deployment Handlers / FTP Deployment Handler

FTP Deployment Handler Handles the deployment of one or more Deployment Packages to an SFTP or FTP server. The remote S/FTP server is described by a URL, username and password. The contents of the Deployment Packages will be deployed sequentially to the target location. If any of the content within the Deployment Packages fails to copy, it will simply be skipped. Other content objects will be allowed to proceed unabated. Configuration { "url": "{url}", "username": "{username}", "pass

Gitana / 4.0 / Data Engine / Deployment / Deployment Handlers / Amazon S3 Deployment Handler

Amazon S3 Deployment Handler Handles the deployment of one or more Deployment Packages to an Amazon S3 bucket. The Amazon S3 bucket is described by: accessKey secretKey region bucketName And optionally: prefix The contents of the Deployment Packages will be deployed sequentially to the target location. If any of the content within the Deployment Packages fails to copy, it will simply be skipped. Other content objects will be allowed to proceed unabated. Configuration { "accessKey": "{a

Gitana / 3.2 / Guide / Guide / Actions / Lock Node

Lock Node ID: lockNode Locks a node as the current user. Configuration Property Type Required Default Description repositoryId text true The ID of the repository of the node. branchId text true The ID of the branch of the node. nodeId text true The ID of the node.

Gitana / 4.0 / Data Engine / Behaviors / Actions / Lock Node

Lock Node ID: lockNode Locks a node as the current user. Configuration Property Type Required Default Description repositoryId text true The ID of the repository of the node. branchId text true The ID of the branch of the node. nodeId text true The ID of the node.

Gitana / 3.2 / Guide / Guide / Actions / Start Workflow

Start Workflow ID: startWorkflow Starts a workflow with the given node placed into the payload. Configuration Property Type Required Default Description model text true The ID of the workflow model to be used. swimlanes object false Identifies principals to be assigned into workflow swimlanes. The structure is: { "swimlane1": ["domainId1/principalId1"], "swimlane2": ["domainId2/principalId2"] } runtime object false Allows for manual specification of runtime properties including applica

Gitana / 3.2 / Guide / Guide / Deployment / Deployment Handlers / File System Deployment Handler

File System Deployment Handler Handles the deployment of one or more Deployment Packages to a file system. A file system is described by a local path on disk, such as: /www/files /data /Users/joesmith/files These paths, in turn, my describe mounts that are ephemeral or non-ephemeral (such as Amazon EBS mounted drives or shared network storage). The contents of the Deployment Packages will be deployed sequentially to the target location. If any of the content within the Deployment Packages fails

Gitana / 4.0 / Data Engine / Behaviors / Actions / Start Workflow

Start Workflow ID: startWorkflow Starts a workflow with the given node placed into the payload. Configuration Property Type Required Default Description model text true The ID of the workflow model to be used. swimlanes object false Identifies principals to be assigned into workflow swimlanes. The structure is: { "swimlane1": ["domainId1/principalId1"], "swimlane2": ["domainId2/principalId2"] } runtime object false Allows for manual specification of runtime properties including applica

Gitana / 4.0 / Data Engine / Deployment / Deployment Handlers / File System Deployment Handler

File System Deployment Handler Handles the deployment of one or more Deployment Packages to a file system. A file system is described by a local path on disk, such as: /www/files /data /Users/joesmith/files These paths, in turn, my describe mounts that are ephemeral or non-ephemeral (such as Amazon EBS mounted drives or shared network storage). The contents of the Deployment Packages will be deployed sequentially to the target location. If any of the content within the Deployment Packages fails

Gitana / 3.2 / Guide / Guide / Forms / Fields / File Picker

File Picker ID: file-picker The file-picker field type renders a modal picker for a file. This uses the File Folder service within Cloud CMS to let you browse through folder-based navigation. A breadcrumb is rendered at the top to help users step through the folder hierarchy. Sample configuration: { "type": "file-picker" } As with the node picker, the file picker should be modeled on top of either an object or an array field. The former is used for selection of a single node whereas the lat

Gitana / 4.0 / Forms / CMS / Fields / File Picker

File Picker ID: file-picker The file-picker field type renders a modal picker for a file. This uses the File Folder service within Cloud CMS to let you browse through folder-based navigation. A breadcrumb is rendered at the top to help users step through the folder hierarchy. Sample configuration: { "type": "file-picker" } As with the node picker, the file picker should be modeled on top of either an object or an array field. The former is used for selection of a single node whereas the lat