Creately-doc

From Creately Developer

Jump to: navigation, search

Overview

The creately-doc tag defines the Creately diagram file. This will be the root tag of the document and all xml data will be under this tag.


Specification

Element/Attribute Type Parent Element Description Introduced in Removed in
creately-doc Element None Root element of the Document. Defines a Creately document 1.0 N/A
format-version Attribute creately-doc Version of the Creately File Format specification. As the specification changes this version would change 1.0 N/A
id Attribute creately-doc Unique identifier of the document used within Creately 1.0 -
revision Attribute creately-doc The Revision number of the diagram. Generally denotes the times the document has been saved. 1.0 -
date-created Element creately-doc The date the document was created 1.0 -
date-updated Element creately-doc The date the document was last updated 1.0 -
source-tool Element creately-doc Indicates from which tool the file was generated. Can have the following values
SAAS - Creately online version
SAAS-EDITOR - Creately online editor integrated with API
API - Generated from Creately online API
PLUGIN-{an identifier for the plugin}. - Creately Plugin for other tools. Example PLUGIN-FOGBUGZ
DESKTOP - Creately Desktop version
3RDPARTY - Generated by a 3rd party tool
UNKNOWN - Generated by a source that is not known.
1.0 -
docname Element creately-doc The name of the document 1.0 -
creator Element creately-doc The email address of the user who created the diagram 1.0 -
creator-uid Element creately-doc The Creately User ID of the user who created the diagram 1.0 -
revision-user Element creately-doc The email address of the user who last updated the diagram 1.0 -
diagram-type-id Element creately-doc A identifier of a Creately Diagram Type 1.0 -
description Element creately-doc A description of the diagram 1.0 -
tags Element creately-doc All tags of the diagram in a comma separated string. 1.0 -
save-comments Element creately-doc A comment/description entered while saving a diagram. Usually the changed of the current revision. 1.0 -
save-type Element creately-doc Indicates a value to say during what action the file was generated
SAVE_MANUAL - Generated by a save action done in the system by the user. Would not be seen in SaaS.
SAVE_AUTO - Generated by a save action done by the system. Would not be seen in SaaS.
EXPORT - Generated by a export action requested by the user
1.0 -
canvas-width Element creately-doc Width of the document canvas in pixels 1.0 -
canvas-height Element creately-doc Height of the document canvas in pixels 1.0 -
published Element creately-doc Indicates if the diagram is published by "true" or "false" 1.0 -
published-image-url Element creately-doc Will contain the public url of the published diagram. Will have a valid value only if the "published" is "true" 1.0 -
objects Element creately-doc Contains the list of objects that are in the diagram. Each object will be described under the "object" tag 1.0 -
object Element objects Defines are kobject/shape 1.0 -
connectors Element creately-doc Contains the list of connectors/lines that are in the diagram. Each object will be described under the "connector" tag 1.0 -
connector Element connectors Defines are connector/line 1.0 -
ko-def-ids Element creately-doc Contains a list of KObject Definition ID's of all the objects that are in the diagram. For further explanation see File Usage Guidelines 1.0 -
def-id Element ko-def-ids An ID of a KObject definition that is used within the diagram. For further explanation see File Usage Guidelines 1.0 -
comments Element creately-doc Contains the thread of comments that are in the diagram. Each comment will be described under the "comment" tag 1.0 -
comment Element comments Defines are comment/message added by a collaborator of the diagram 1.0 -
libraries Element creately-doc Contains a list of Creately object Library ID's of the libraries that are used in the diagram. The libraries of all objects in the diagram will be listed here 1.0 -
lib-id Element libraries An ID of a Creately object Library that is used within the diagram. Any object that is used in the diagram will belong to a library. This ID will relate to the specific library 1.0 -
resources Element creately-doc Contains a list of resources that are used by the diagram. Each resource will be described under the "resource" tag 1.0 -
resource Element resources Defines a resource that is used by the diagram. Can be any type of known standard content 1.0 -

Example

See a a example of a full Creately File in Example Document

Personal tools