ORM Designer Blog

13Jun/110

Missing field-type icons in ORM Designer

If you don't see icons on the left of the field names, some Direct 2d drivers are probably missing or are out-dated on your computer. You can try to update Direct 2d drivers, or you can try another Drawing manager in ORM Designer.

To change Draw Manager open "Configuration window"

And change DrawManager to Microsoft GDI+ or Microsoft GDI compatability mode.

This settings might resolve your problem with missing icons.

Tagged as: No Comments
27May/110

Propel ORM Behaviors support!

Note: This feature is currently available only in beta-version 1.4.5. If you want to try it, please download latest version from http://www.orm-designer.com/beta.

Another news for Propel ORM users! Today I want to introduce you new Behaviours support feature.

ORM Designer supports two ways how to handle behaviours. The first way uses predefined behaviour list of already known behaviours, the second way uses customBehaviour type to define any behaviour by it's name and params.

Use of custom behaviors

For setup custom behaviour to any of your tables, follow next steps:

1) Mark the requested table

2) In ORM Properties list click "Add item" next to "Behaviors" property

3) Select "customBehavior" from the list

4) Enter behaviour name to relevant "name" property

5) If your behavior has some parameters, add them by using "Add item" next to "CustomParameters" property

6) After that you have to enter the parameter name and the parameter value. You can add unlimited number of additional parameters.

7) And this is it ;-) . Now when you export your model, you can see definitions like this:

Use of predefined behaviours

Using of predefined behaviours is better than custom one in several ways. As first, you don't have to write behavior name again and again but you can simply select it from a list. The same thing is for the behavior parameters. The second advantage is that for specific parameter values there is an automatic completion and offering of preferred values (booleans, column names, ... ). Now I show you how to define "Timestampable" behavior for a specific entity.

1) The first steps are the same as in the previous example. Select the requested entity, click "Add item" next to "Behaviors" property and select desired behavior. In our example "Timestampable".

2) Now you can configure timestampable behavior by using two predefined properties "create_column" and "update_column". When you click on the arrow next to property value, you can simply choose the one of available columns.

3) Each predefined behaviour has also an option to define another additional behaviour parameter. This can be simply achieve by using "customParameter" as well as in the case of the custom behaviors.

4) When you add one or more custom parameters you can simply configure them.

List of currently supported Propel ORM behaviors:

Note: Remembr that you can anytime use customBehavior if you need to use behavior not listed in list above. If you find any behavior which is common for more users and isn't listed here, let us know and we will add it to ORM Designer configuration.

 

I hope you like this new function and as always if you find any bug or have any idea feel free to let us know!

Tagged as: , No Comments
5May/110

Propel ORM validators support!

Note: This feature is currently available only in beta-version 1.4.5. If you want to try it, please download latest version from http://www.orm-designer.com/beta.

While working on a new ORM Designer version we prepared one significant improvement of the current ORM Designer version for all Propel ORM users.

From now, ORM Designer natively supports all Propel PHP validators mentioned on this page:  http://www.propelorm.org/wiki/Documentation/1.6/Validators

The usage is simple, as usually ;-) . Create an object, add few fields and commit changes. Then select desired field of the model and look to the ORM Properties editor:

Now, when you click on the add icon you can choose from the list of available validators or choose one of two special items "otherValidator" or "customValidator":

  • OtherValidator use in special cases when you want to use validator which isn't listed in this list. This validator choose if you would like to enter all validator identificators like name,value and message and these values will be added to the specific column.
  • CustomValidator is there for cases when you have implemented your own validator and want to use it in a specific column. In this case simply add a class name to this validator and ORM Designer will export it for you.

You can have zero,one or more validators of one type for one column because of multiple instances of custom or other validator. Here are few examples of already configured validators:

Now, when you press "Export" button, your XML file will look like this:

Note: Validators aren't supported for YAML export, because there isn't support in Propel ORM! (there is link: http://trac.symfony-project.org/ticket/1769 )

Tagged as: , No Comments
22Feb/110

How to change export format (schema.yml / schema.xml)

As a first step select module where you want to modify export format:

After that use context menu or simply double click to edit module settings:

Select second tab "Files and Export" and choose export format in "File Format" combo box.

Tagged as: No Comments
27Jan/112

How to import model from MySql Workbench

This is a step-by-step tutorial about importing existing MySql Workbench model to ORM Designer.

1) As first step create a new project or open your existing project where  you want to import your MySql Workbench file.

2) When you have your project created or opened, choose Import Existing Data to Model from Import menu.

3) Now select MySql Workbench import and press Import.

4) On a next screen select existing MySQL workbench file and destination module where you want to import selected model.

5) When you are done press  import and ORM Designer automatically import your model. After a while you will see result like this:

And we're done.

Tagged as: , 2 Comments
13Oct/100

New visual symbols for NULL/NOT NULL column types

Today I want to show you a new small feature in ORM Designer 1.4.2 which helps you with navigation in the model. Until now, ORM Designer has shown only three different icons in a column for primary keys, foreign keys and other columns. Today we have added another three types for differentiation of NULL and NOT NULL columns. Empty diamonds beside the column names symbolize columns where NULL is allowed, filled diamonds where value is requried.

Here is screenshot of this feature:

Currently is this feature in beta-version of ORM Designer. Download here: http://www.orm-designer.com/article/orm-designer-beta-versions

Tagged as: , No Comments
12Oct/100

Execute another application from ORM Designer import/export script

In this short article I want to show you how to execute another application from ORM Designer script. Since the version 1.4.2 ORM Designer has built-in a new script command called "execute-file" serving to launch the foreign applications from script. (1.4.2 is currently in beta stage, please download it from http://www.orm-designer.com/article/orm-designer-beta-versions )

Execute-file command

As first, let me show you the simplest way how to use this command.

 <uscript>
	<function name='Test'>
		<execute-file file='p:\ExternalUnitTestFiles\DataFormats\Bat\test.bat' params='unit-test'/>
	  </function>
 </uscript>

Using this snippet we defined a function called "Test" which launch our testing .bat file with parameter 'unit-test'. Whole command syntax is defined in XML Schema file script.xsd and looks like this:

	<xs:complexType name="sExecuteFile">
		<xs:attribute name="file" use="required" type="xs:string"/>
		<xs:attribute name="params" type="xs:string"/>
		<xs:attribute name="show" type="booleanEx" default="true"/>
		<xs:attribute name="working-dir" type="xs:string"/>
		<xs:attribute name="wait-for-exit" type="booleanEx" default="true"/>
	</xs:complexType>

By using parameter "working-dir" we can specify a working directory for executed command. If no param is passed,  the directory where executable file is located is used. Parameter "show" serves to launch application in invisible mode and parameter "wait-for-exit" servers to wait until external application has finished its work and then continues with script.

Overloading export script

Now let me show you another new feature of ORM Designer 1.4.2. It can happen that you need to call your own executable when ORM Designer finishes export from model to ORM framework definition files. So we prepared new overloading points in export script, where you can write your own functions which will be called in this points.

Overloading basis

Method overloading in ORM Designer script is processed by method names and prefixes. The simplest way is by defining a function with specific name. ORM Designer runs this function when it is available.
Sometimes we need to distinguish functions for concrete type of ORM. In this case ORM Designer offers prefix overloading ability. ORM Designer tries to find several prefixes when searching for specific function.
These prefixes have fixed order and priority, so we can define a  specific version of some ORMs and one common function for the rest of ORMs.

Order and prefixes are defined in following list. At first ORM Designer tries to find the function with "MVC.ORM." prefix. As next ORM Designer tries "ORM." prefix, then "default." and then without prefix.
ORM Designer stops the function search after a function with correspond name has been found .

${nameMvc}.${nameOrm}.${functionName}
${nameOrm}.${functionName}
default.${functionName}
${functionName}

So, when you have following definitions, if project using Doctrine ORM is being processed, the first function will be called. When processed project uses any other ORM, the second function is called:

<function name='Doctrine.Test'/>
<function name='Test'/>

Overloading in export script

Every export script has in its end a located fragment which enables us to call our overloaded function. This fragment looks like:

	<!-- notify export is done -->
	<call name='system.NotifyEvent'>
		<param name='projectID' value='${projectID}'/>
		<param name='functioName' value='onFinish.export'/>
	</call>

Now, if you need to create a custom function which is called anytime when ORM Designer exports model to ORM Definitions, follow next steps. As first, we create a file onfinish-export.uscript.xml (or any other name with ".uscript.xml" extension) in user configuration directory (more about user configuration files). As next, enter following script snippet to the created file:

<?xml version="1.0" encoding="utf-8" standalone="no" ?>
<uscript>
	<!-- ==== Doctrine2.onFinish.Export ==== -->
	<function name='Doctrine.onFinish.export'>
		<execute-file file='test.bat' params='Doctrine'/>
	</function>

	<!-- ==== default.onFinish.Export ==== -->
	<function name='default.onFinish.export'>
		<execute-file file='test.bat' params='default'/>
	</function>
</uscript>

Now, every time when ORM Designer exports a model it will execute one of these functions, based on the project ORM type.

Conclusion

Currently, a support for user-callbacks in scripts is limited only to export scripts. In future, we would like to add more callbacks places depending on users' requirements. If you have any questions about this topic, feel free to contact us.

Tagged as: , , No Comments
17Sep/102

How to share modules among several ORM Designer projects

In this short tip I want to show you how to share modules (plugins) bewteen serveral ORM Designer projects.

Save module to shared location

As first step you can create or select any module you want to share among several projects and double click on it. As the next step select "Files and export" tab and enter a path to the shared directory to the "Data storage" edit window. In our example we store shared module in the location c:\sharedlocation\plugin.data.xml. The situation looks as in our first screenshot:

Import existing module

As the third step, open any project where you want to use this shared module. After that, select "Attach existing ORMD file to model" from "Import" menu.

Shared module in another model

In "open file" window select shared module data file. In our case we select file c:\sharedlocation\plugin.data.xml and click OK. After that shared module is attached to the model.

Conclusion

By using this technique you can share your models among several projects with minimal effort. Instead of repeatable creating of entities over and over again you can simply attach your shared modules to any project. And every change you create in the shared module will be automatically shared in all your models. This behavior can be used in any ORM framework (PHP Doctrine, Doctrine2, Propel or CakePHP).

Tagged as: , 2 Comments
28Aug/100

Tip: How to setup associations in Doctrine2 project for correct export

In this tip I want to show you how to correctly setup associations in ORM Designer Doctrine2 project. Because Doctrine2 supports one-way or bidirectional associations, there is a need to tell ORM Designer how to export it. This is proceeded by Association alias. When you create association between two entities, you have to enter how you would like to access from one entity to another. Currently there are three ways how to do it:

Setup alias in association wizard

When you are creating a new association by using association wizard, you have to enter alias for direction you want to use. Below the alias edit boxes is a "Direction" item which shows you a type of created association.

Setup alias in association editor

Another option is to setup association alias in association editor (executed by "Edit object" menu item or simply double click on the association). In this window there are simmilar edit boxes as in the association wizard. Depending on values you entered into edit boxes the association is exported to your Doctrine2 schema files.

Enter alias using Property Editor

The third option how to setup association alias is in Property editor. Simply select the association you want to setup and in Property editor enter Owning alias or Property alias value.

Conclusion

I hope that this tip will help you to understand a way how ORM Designer proceeds associations export. Because Doctrine2 supports multi-direction associations, it is required this "Alias-enter" step. Please, leave us your comment about this feature if you have any opinion.

Tagged as: , , , No Comments
26Aug/100

Create support for your own framework in ORM Designer, part VII – export script

Part VII: How to write an export script

In this part of our serie I want to show you how to create an export script for your ORM framework. I'm going to show you basic script commands and how to communicate with ORM Designer project from the script. For an advanced usage of script language it is recommended to study the original ORM Designer scripts for Doctrine, Doctrine2, Propel and other frameworks located in Scripts folder in ORM Designer installation folder. Basic syntax of ORM Designer script is based on Phing XML language.

Export script testing

Before we start to write our first export script, I'm going to show you how to test and debug your scripts.  Article with all informations about this topic is available here http://www.orm-designer.com/article/ormd-developers-testing-import-export. Currently we need following switches:

OrmDesignerCore.exe -unit-test-import-export -input-project c:\project.ormdes -output-orm-file c:\project.out.xml

OrmDesignerCore.exe -unit-test-import-export -input-project c:\project.ormdes -output-export

First statement runs ORM Designer and load project stored in file "c:\project.ormdes". After the project has been loaded, the whole project is exported into a single file "c:\project.out.xml".
 Second statement also runs ORM Designer and load stored project. After that, project is exported in the same way as after user's click on "Export" button in ORM Designer application.

Note: Project stored in "project.ormdes" must have "AtomixORM" as ORM type.

Minimal script

Now let's see our minimal export script and how it will be launched by the command from previous paragraph:

<function name='AtomixORM.export'>
	<check>
		<is-set variable='projectID'/>
		<default variable='exportToOneFile' value=''/>
	</check>
</function>

Script "AtomixORM.export" will be executed with following values:

  • projectID: This variable will contain internal ID of project to export.
  • exportToOneFile: This variable will contain "c:\project.out.xml" in first command-line case, and is empty in second case.

First simple script

Now let's add few commands to our export script. As first step we tell ORM Designer to export the selected project to a single temporary XML file and then copy this file to the output file determined by command line param:

<function name='AtomixORM.export'>
	<check>
		<is-set variable='projectID'/>
		<default variable='exportToOneFile' value=''/>
	</check>

	<if>
		<not-equal value1='${exportToOneFile}' value2=''/>
		<then>
			<get-tmp-file-name variable='tmpOneFileExport' dir='ormd-export'/>
			<ormd-export-file output-xml='${tmpOneFileExport}' project='${projectID}'/>
			<copy-file from='${tmpOneFileExport}' to='${exportToOneFile}'/>
		</then>
	</if>

</function>
  • By using "if" and "not-equal" we test if variable "exportToOneFile" isn't empty. If it is true, we execute export statements which saves the whole project to one file.
  • "get-tmp-file-name" command assigns a unique temporary file name to variable tmpOneFileExport. Attribute "dir" serves to setup usage of subdirectory in temp directory. Result temporary file in our case will look like "....\temp\ormd-export\tmpXXXXXX.tmp".
  • By using a next command "ormd-export-file" ORM Designer exports project with a certain ID into output XML file determined by output XML attribute.
  • The last command will copy file from the temporary location to a destination path determined by exportToOneFile variable.

This script isn't much useful yet, but helps us to demonstrate how ORM Designer proceeds data export and allows you to examine how XML file exported from ORM Designer looks like. With this file we will do the next transformations and operations in next parts of this tutorial.

XSLT transformation

The next important step in import and export scripts are  the XSLT transformations. Now I'm going to show you how to transform an exported ORM Designer XML file to another XML file required by your ORM framework. Let's replace our previous script by following new one:

<function name='AtomixORM.export'>
	<check>
		<is-set variable='projectID'/>
		<default variable='exportToOneFile' value=''/>
	</check>
	<if>
		<not-equal value1='${exportToOneFile}' value2=''/>
		<then>
			<get-tmp-file-name variable='tmpOneFileExport' dir='ormd-export'/>
			<ormd-export-file output-xml='${tmpOneFileExport}' project='${projectID}'/>
			<xsl-transformation xslt='AtomixOrm/Xml2AtomixOrmAbstractXml.xslt' input-xml='${tmpOneFileExport}' output-xml='${tmpOneFileExport}_2'/>
			<copy-file from='${tmpOneFileExport}_2' to='${exportToOneFile}'/>
			<delete-file file='${tmpOneFileExport},${tmpOneFileExport}_2'/>
		</then>
	</if>

</function>

By using the command "xsl-transformation" we will perform XSLT transformation by using XSL template passed by "xsl" attribute (path is relative to script location). Other two attributes determine input and output XML file. Next new command which I use in this example is "delete-file". After we procees all required steps, it's a good practice to clean up all temporary files. So we delete both of them.

Hint:
If you want to store results from your script for debug purposes to some folder, you can use following statement:

	 <!-- debug -->
	<copy-file from='${tmpOneFileExport}' to='c:\ORM\US\AtomixOrm.export-1-proj-onefile.xml' only-debug='true'/>

This statement will be executed only if script runs only on debug  mode (export launched by using command line statement -unit-test-import-export).

XSLT
Now let's look to a simple XSL template used for transformation:

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:saxon="http://icl.com/saxon">
	<xsl:output indent="yes"/>

	<xsl:template match="*">
		<import-export-document>
			<xsl:apply-templates select="/orm-designer/module"/>
		</import-export-document>
	</xsl:template>

	<xsl:template match="/orm-designer/module">
		<import-export-file import-path="{@import-path}" import-format="{@import-format}">
			<atomix-orm>
				<xsl:copy-of select="./*"/>
			</atomix-orm>
		</import-export-file>
	</xsl:template>

</xsl:stylesheet>

This template creates XML with root element "import-export-document" which contains several "import-export-file" elements. These elements will contain copy of exported model from ORM Designer. We will use this prepared XML later in this tutorial to split file to several output XML files.

Example project files

Here is all files used in this tutorial:

Debug output

When you run ORM Designer with a command line params from the beginning of this article, you should see output like this:

(0019)Running function [AtomixORM.export] from file [p:/OrmDesignerCore/SetupCreator/Installed/config/AtomixOrm/AtomixOrm.uscript.xml]
(0020)  check
(0021)  - exist-variable [projectID]=TRUE (11)
(0022)  - default-variable-value [exportToOneFile] Exists=TRUE
(0020)  result-check = [TRUE]
(0026)  if
(0027)  - equal ['c:\project.out.xml'!='']=>TRUE
(0026)  - RESULT = [TRUE]
(0029)    get-tmp-file-name[tmpOneFileExport,ormd-export]=C:\Users\...\Temp\ormd-export\tmp7E69.tmp
(0030)    ormd-export-file [P:11] C:\Users\...\Temp\ormd-export\tmp7E69.tmp,
(0033)    copy-file[C:\Users\...\Temp\ormd-export\tmp7E69.tmp,c:\ORM\US\AtomixOrm.export-1-proj-onefile.xml]
(0036)    xsl-transform[p:\OrmDesignerCore\SetupCreator\Installed\config\AtomixOrm\Xml2AtomixOrmAbstractXml.xsl,C:\Users\...\Temp\ormd-export\tmp7E69.tmp,C:\Users\...\Temp\ormd-export\tmp7E69.tmp_2]
(0037)    copy-file[C:\Users\...\Temp\ormd-export\tmp7E69.tmp_2,c:\project.out.xml]
(0040)    delete-file[C:\Users\...\Temp\ormd-export\tmp7E69.tmp,C:\Users\...\Temp\ormd-export\tmp7E69.tmp_2]
(0040)    - deleting C:\Users\...\Temp\ormd-export\tmp7E69.tmp
(0040)    - deleting C:\Users\...\Temp\ormd-export\tmp7E69.tmp_2
Press any key to close the log.

Advanced export script

In previous paragraphs I showed you few simple examples of export script. Now let's look at more complicated export which exports data to several xml files. In this example I want to show you next new commands and scripting technique. First I'm going to show you a full script listing and then explain every single step.

<function name='AtomixORM.export'>
    <check>
        <is-set variable='projectID'/>
        <default variable='exportToOneFile' value=''/>
    </check>

    <!-- (1) export data from ORM Designer -->
    <get-tmp-file-name variable='tmpOneFileExport' dir='ormd-export'/>
    <ormd-export-file output-xml='${tmpOneFileExport}' project='${projectID}'/>

    <!-- (2) debug -->
    <copy-file from='${tmpOneFileExport}' to='c:\ORM\US\AtomixOrm.export-1-proj-onefile.xml' only-debug='true'/>

    <!-- (3) xslt transformation -->
    <xsl-transformation xslt='Xml2AtomixOrmAbstractXml.xsl' input-xml='${tmpOneFileExport}' output-xml='${tmpOneFileExport}_2'/>

    <!-- (4) debug -->
    <copy-file from='${tmpOneFileExport}_2' to='c:\ORM\US\AtomixOrm.export-2-after-first-transform.xml' only-debug='true'/>

    <!-- (5) split xml file to separated files -->
    <get-tmp-path variable='tmpSplitOutput' dir='ormd-export'/>
    <xml-split-file input-xml='${tmpOneFileExport}_2' output-xml-path='${tmpSplitOutput}' variable='splitFiles' />

    <!-- (6) do export for each file -->
    <for-each list='${splitFiles}' variable='file'>
        <!-- (7) debug -->
        <copy-file from='${file}' to='c:\ORM\US\AtomixOrm.export-3-splited-file.xml' only-debug='true'/>

        <!-- (8) read destination file from file -->
        <xml-read-values input-xml='${file}'>
            <read-value xpath='/import-export-file/@import-path' variable='destination_path'/>
        </xml-read-values>

        <!-- (9) if there is no destination-path for this module, skip it-->
        <if>
            <equal value1='${destination_path}' value2=''/>
            <then>
                <continue/>
            </then>
        </if>

        <!-- (10) do transform for output file -->
        <xsl-transformation xslt='AtomixOrmAbstract2AtomixOrmXml.xsl' input-xml='${file}' output-xml='${file}_2'/>

        <!-- (11) debug -->
        <copy-file from='${file}_2' to='c:\ORM\US\AtomixOrm.export-4-converted-xml-yml.xml' only-debug='true'/>

        <!-- (12) Save generated result. If exportOneFile is set, all result is stored to this file, otherwise file is stored to export location -->
        <if>
            <equal value1='${exportToOneFile}' value2=''/>
            <then>
                <copy-file from='${file}_2' to='${destination_path}'/>
            </then>
            <else>
                <append-file from='${file}_2' to='${exportToOneFile}'/>
            </else>
        </if>

        <!-- (13) clean-up -->
        <delete-file file='${file},${file}_2'/>
    </for-each>

    <!-- (14) clean-up -->
    <delete-file file='${tmpOneFileExport}_2,${tmpOneFileExport}'/>
</function>

Here is the explain of each step of this script:

  1. Generate temporary file name and call export from ORM Designer project.
  2. Copy generated file to our debug location.
  3. Call XSLT transformation on exported XML file.
  4. Copy transformed file to our debug location.
  5. Split transformed XML file by root children to separated files. These files will be stored in temp/ormd-export folder. List of the files will be stored in $splitFiles variable.
  6. Now enumerate all splitted files one by one.
  7. Copy splitted file to debug location.
  8. Read value from splitted file by using xpath expression "/import-export-file/@import-path" to variable $destination_path.
  9. If variable @import-path isn't filled, skip next expressions and proceed next file.
  10. Call next XSLT transformation on splitted file. File is again stored in temp with postfix "_2".
  11. Copy transformed file to our debug location.
  12. Save exported and transformed result to destination file or append it to passed one-file path.
  13. Delete temporary files from this cycle.
  14. Delete another temporary files from this script.

Pretty simple, right? ;-) . There is a lot of things that can be done by ORM Designer scripting language. But this sample should be sufficient to learn you how to create the export scripts for your framework. This script with both XSLT templates could be downloaded here: Final export script example.

Script execution

Now you can run this script in one-file export mode and also in full export mode. When you run this script by using "-output-orm-file c:\project.out.xml" param, file project.out.xml should content this:

<?xml version="1.0"?>
<atomix-orm>
  <table name="Contact" visPositionX="28" visPositionY="36" visSizeX="0" visSizeX2="20" visSizeY="0" visSizeY2="20">
    <column auto-increment="true" name="ID" primary="true" required="true" type="integer"/>
    <column name="Name" type="string"/>
  </table>
  <table name="Address" visPositionX="17" visPositionY="136" visSizeX="0" visSizeX2="113" visSizeY="0" visSizeY2="73">
    <column auto-increment="true" name="ID" primary="true" required="true" type="integer"/>
    <column name="Street" type="string"/>
    <column name="City" type="string"/>
    <column name="Contact_ID" type="integer"/>
  </table>
  <foreign-key caption="Contact Address" from="Address" name="FK_Address_Contact_ID" to="Contact">
    <foreign-key-column from="Contact_ID" to="ID"/>
  </foreign-key>
</atomix-orm>
<?xml version="1.0"?>
<atomix-orm>
  <table name="BlogPost" visPositionX="56" visPositionY="100" visSizeX="0" visSizeX2="113" visSizeY="0" visSizeY2="59">
    <column auto-increment="true" name="ID" primary="true" required="true" type="integer"/>
    <column name="Text"/>
    <column name="Contact_ID" type="integer"/>
  </table>
  <foreign-key caption="Contact BlogPost" from="BlogPost" name="FK_BlogPost_Contact_ID" to="Contact">
    <foreign-key-column from="Contact_ID" to="ID"/>
  </foreign-key>
</atomix-orm>

As you can see, this is not valid XML file. This file is useful in unit-testing stage of your development process. You can simply compare result from export to some required pattern file. If you want to export data in the same format in which your users will see them, use second command line parameter "-output-export". After that, two files "models\app.xml" and "models\plugin.xml" will be created.

Debug log from processing of this script will look like this:

(0019)Running function [AtomixORM.export] from file [p:/OrmDesignerCore/SetupCreator/Installed/config/AtomixOrm/AtomixOrm.uscript.xml]
(0020)  check
(0021)  - exist-variable [projectID]=TRUE (19)
(0022)  - default-variable-value [exportToOneFile] Exists=TRUE
(0020)  result-check = [TRUE]
(0026)  get-tmp-file-name[tmpOneFileExport,ormd-export]=C:\Users\...\Temp\ormd-export\tmp1DBD.tmp
(0027)  ormd-export-file [P:19] C:\Users\...\Temp\ormd-export\tmp1DBD.tmp,
(0030)  copy-file[...\Temp\ormd-export\tmp1DBD.tmp,c:\ORM\US\AtomixOrm.export-1-proj-onefile.xml]
(0033)  xsl-transform[p:\OrmDesignerCore\SetupCreator\Installed\config\AtomixOrm\Xml2AtomixOrmAbstractXml.xsl,...\Temp\ormd-export\tmp1DBD.tmp,...\Temp\ormd-export\tmp1DBD.tmp_2]
(0036)  copy-file[...\Temp\ormd-export\tmp1DBD.tmp_2,c:\ORM\US\AtomixOrm.export-2-after-first-transform.xml]
(0039)  get-tmp-path[tmpSplitOutput,ormd-export]=...\Temp\ormd-export
(0040)  xml-split-file [...\Temp\ormd-export\tmp1DBD.tmp_2,...\Temp\ormd-export,splitFiles]
(0040)  - splitting file [...\Temp\ormd-export\_tmp100830173657742.tmp]
(0040)  - splitting file [...\Temp\ormd-export\_tmp100830173657753.tmp]
(0043)  for-each[file<='...\Temp\ormd-export\_tmp100830173657742.tmp,...\Temp\ormd-export\_tmp100830173657753.tmp'](0043)  - iteration [file=...\Temp\ormd-export\_tmp100830173657742.tmp]
(0045)    copy-file[...\Temp\ormd-export\_tmp100830173657742.tmp,c:\ORM\US\AtomixOrm.export-3-splited-file.xml]
(0048)    xml-read-values [...\Temp\ormd-export\_tmp100830173657742.tmp]
(0049)    - read-values [/import-export-file/@import-path=>destination_path] value:'c:\Article\models\app.xml'
(0053)    if
(0054)    - equal ['c:\Article\models\app.xml'='']=>FALSE
(0053)    - RESULT = [FALSE]
(0061)    xsl-transform[p:\OrmDesignerCore\SetupCreator\Installed\config\AtomixOrm\AtomixOrmAbstract2AtomixOrmXml.xsl,...\Temp\ormd-export\_tmp100830173657742.tmp,...\Temp\ormd-export\_tmp100830173657742.tmp_2]
(0064)    copy-file[...\Temp\ormd-export\_tmp100830173657742.tmp_2,c:\ORM\US\AtomixOrm.export-4-converted-xml-yml.xml]
(0067)    if
(0068)    - equal ['c:\project.out.xml'='']=>FALSE
(0067)    - RESULT = [FALSE]
(0073)      append-file[...\Temp\ormd-export\_tmp100830173657742.tmp_2,c:\project.out.xml]
(0078)    delete-file[...\Temp\ormd-export\_tmp100830173657742.tmp,...\Temp\ormd-export\_tmp100830173657742.tmp_2]
(0078)    - deleting ...\Temp\ormd-export\_tmp100830173657742.tmp
(0078)    - deleting ...\Temp\ormd-export\_tmp100830173657742.tmp_2
(0043)  - iteration [file=...\Temp\ormd-export\_tmp100830173657753.tmp]
(0045)    copy-file[...\Temp\ormd-export\_tmp100830173657753.tmp,c:\ORM\US\AtomixOrm.export-3-splited-file.xml]
(0048)    xml-read-values [...\Temp\ormd-export\_tmp100830173657753.tmp]
(0049)    - read-values [/import-export-file/@import-path=>destination_path] value:'c:\Article\models\plugin.xml'
(0053)    if
(0054)    - equal ['c:\Article\models\plugin.xml'='']=>FALSE
(0053)    - RESULT = [FALSE]
(0061)    xsl-transform[p:\OrmDesignerCore\SetupCreator\Installed\config\AtomixOrm\AtomixOrmAbstract2AtomixOrmXml.xsl,...\Temp\ormd-export\_tmp100830173657753.tmp,...\Temp\ormd-export\_tmp100830173657753.tmp_2]
(0064)    copy-file[...\Temp\ormd-export\_tmp100830173657753.tmp_2,c:\ORM\US\AtomixOrm.export-4-converted-xml-yml.xml]
(0067)    if
(0068)    - equal ['c:\project.out.xml'='']=>FALSE
(0067)    - RESULT = [FALSE]
(0073)      append-file[...\Temp\ormd-export\_tmp100830173657753.tmp_2,c:\project.out.xml]
(0078)    delete-file[...\Temp\ormd-export\_tmp100830173657753.tmp,...\Temp\ormd-export\_tmp100830173657753.tmp_2]
(0078)    - deleting ...\Temp\ormd-export\_tmp100830173657753.tmp
(0078)    - deleting ...\Temp\ormd-export\_tmp100830173657753.tmp_2
(0082)  delete-file[...\Temp\ormd-export\tmp1DBD.tmp_2,...\Temp\ormd-export\tmp1DBD.tmp]
(0082)  - deleting ...\Temp\ormd-export\tmp1DBD.tmp_2
(0082)  - deleting ...\Temp\ormd-export\tmp1DBD.tmp
Press any key to close the log.

Conclusion

In this example I showed you how to create the export script for ORM Designer. This topic might be a little complicated to understand, so if you find anything understandable, please leave us a comment bellow the post or contact me on support@orm-designer.com. If you are seriously interested in creating of support for your ORM Framework, please let us know. We will prepare the support for you for free if you have large enough community which can be interested in. If you have your own company framework and want to prepare support for your internal ORM, please let us know too, we also offer creating of an ORM support for company customers.

Tagged as: , , No Comments
   Older Entries »

Who writes this blog

This blog is written by ORM Designer developers and other team members.

You can find here all the stuff that didn't make it to the official website but we found it interesting some way or possibly helpful to others.

Categories

Archive

Tags

c++ cakephp deployment development Doctrine Doctrine 2 doctrine2 features import-export mysql mysql workbench orm designer orm designer extensions propel orm security tips xslt zend framework

Latest posts

RSS ORM Designer news