Sample Data Populator

The sample data populator included with the Assets Models Sample can also be used to populate Governance Registry for demonstrations and proof-of-concept scenarios. The following types of functionality are supported by the populator. 

The populator is executed using an Ant build script. There are some Pre-configured Asset Models which can be used. However, if you want to introduce your own, that can be done by including the following script inside the build.xml file.

    <property name="foo.dir" value="../Foo"/>
    <target name="run-foo" depends="jar-foo, jar">        
        <java classname="org.wso2.carbon.registry.samples.populator.Main" classpathref="javac.classpath"
              fork="true">             
            <sysproperty key="carbon.home"  value="${registry.home}"/>
            <arg value="-ch" />
            <arg value="${registry.home}"/>
            <arg value="-h"/>
            <arg value="${host}"/>
            <arg value="-p" />
            <arg value="${port}"/>
            <arg value="-u" />
            <arg value="${username}"/>
            <arg value="-pw" />
            <arg value="${password}"/>
            <arg value="-l" />
            <arg value="${foo.dir}"/>
        </java>
    </target>

The above script recompiles the populator code, and also compiles any source code for extensions. Each of the Pre-configured Asset Models deploy some extensions to Governance Registry, but that is not mandatory. If you do not have any extension .jar files, you can omit the jar-foo target. The populator source code is capable of performing the following set of operations. If required, the populator can be customized to perform your own actions. This can be done by making changes to the Populator\src\org\wso2\carbon\registry\samples\populator\Main.java file.

Handler Definitions

Handler definitions can be registered using the populator. For each handler definition to work, the populator expects that the corresponding source code is already deployed or installed as an extension using the populator. The configurations for all handlers need to be done inside a single file handler-def/handlers.xml. The structure of the file is as follows:

<handlers>
    <handler>
    ...
    </handler>
</handlers>

More than one handler can be configured at the same time using this. If no handlers are added during the population process, the populator expects a file to be present at the handler-def/handlers.xml location with the following content:

<handlers>
</handlers>

See Handlers for more information.

Extension JAR Files

The populator can install one or more .jar files located inside the target folder. These .jar files can only contain registry extensions. Since the populator is run using an Ant build script, these .jar files can either be compiled during the population process, or pre-compiled and made available inside the target folder. The following is a set of Ant targets that can used to do a clean build of the source code found inside the src folder.

    <property name="foo.dir" value="../Foo"/>
    <target name="jar-foo" depends="clean-foo, compile-foo">
        <jar jarfile="${foo.dir}/target/com.foo-${version}.jar">
            <fileset dir="${foo.dir}/target/classes">
                <include name="**/*.class"/>
            </fileset>
        </jar>
    </target>
    <target name="clean-foo">
        <delete dir="${foo.dir}/target" quiet="true"/>
        <delete dir="${foo.dir}/target/classes" quiet="true"/>
    </target>
    <target name="compile-foo" depends="init-ext">
        <mkdir dir="${foo.dir}/target/classes"/>
        <javac srcdir="${foo.dir}/src" destdir="${foo.dir}/target/classes">
            <classpath refid="javac.classpath"/>
        </javac>
    </target>

See Extensions for more information.

Reports and Jasper Report Templates

Templates for generating reports using Governance Registry can be installed using the populator. These .jrxml files should be located inside the reporting-templates folder. Please note that you can upload any number of templates and these need not be limited to the reports configured using this populator. To configure reports using the populator, the required configuration needs to be defined inside a Microsoft Excel Workbook at the location reports/list.xls. Only the rows in the first sheet are considered, and each row should have all the following values in the given order.

1. Report Name
2. Jasper Report Template (e.g.:- /_system/governance/repository/components/org.wso2.carbon.governance/templates/foo_template.jrxml)
3. Type (e.g.:- PDF, Microsoft Excel, HTML)
4. Report Generator Class

See Reports for more information.

Lifecycle Configurations

You can configure lifecycles for Governance Registry using the populator. One or more lifecycle configurations defined in SCXML should be located inside the lifecycles folder. Please note that this folder can only contain valid lifecycle configurations, and having any other file can lead to runtime errors.

See Configuring Lifecycles for more information.

Subscriptions

Subscriptions to receive notifications for events generated by operations on resources and collections can be done using the populator. Each subscription needs to be defined inside a Microsoft Excel Workbook at the location subscriptions/list.xls. Only the rows in the first sheet are considered, and each row should have all the following values in the given order.

1. Resource or Collection path
2. Endpoint URL (e.g.:- mailto:john@doe.com)
3. Event Name (e.g.:- CollectionUpdated, ResourceDeleted, ApprovalNeeded, etc.)