Client Actions ZipNShip Envelope

Owned by Shaun Forbes
Last updated: 31 Jan, 2020
4 min read

Provides options to export data from the current extent to a zip file in various formats

ID

weave.zipnshipenvelope

Notes

The layer tags in a group that has raster set to true refer to layer ids from the underlying map service.

When raster isn't set (or is set to false) then they're mappers configured through a spatial mapper tag. This way you can add new layers to be exported as vectors by defining a new spatial mapper, without the need to setup a corresponding entity tag.

welcome and license are optional, the panel won't show if they're not set.

If only one size is set then the size selection panel won't show.

A group with raster set to but with no layers will generate an image representing the current map as the user sees it.

The available vector and raster formats are determined by the zipnship client bundles that are installed.

Any files you drop into ...\platform\workspace\zipnship will be included in the generated zip file.

Example

	<item action="weave.zipnshipenvelope">
		<tooltip>
			<title>Export</title>
			<text>Set you scale between 2000 and 15000 to be able to export</text>
		</tooltip>
		<minScale>2000</minScale>
		<maxScale>15000</maxScale>
		<welcome>This is the text to be displayed on the first wizard screen</welcome>
		<license><![CDATA[These are the terms and contitions that you <b>must</b> agree to before downloading this data.<br/>Further information will be contained within the generated content.]]></license>
		<size width="400" height="400"/>
		<size width="800" height="600"/>
		<size width="1024" height="768"/>
		<size width="1200" height="1000"/>
		<size width="1600" height="1600"/>
		<group id="base" label="Base Layers" disabled="true" checked="true">
			<layer>property</layer>
			<layer>roads</layer>
			<metadata><![CDATA[Base layers metadata goes here]]></metadata>
		</group>
		<group id="pipes" label="Pipes Layers">
			<layer>drainage</layer>
			<metadata><![CDATA[Pipe Layers related <i>metadata</i> goes here]]></metadata>
		</group>
		<group id="contours" label="Contours" maxScale="3000">
			<layer>manningham.contour</layer>
			<layer>manningham.con2m</layer>
			<layer>manningham.con5m</layer>
			<layer>manningham.con10m</layer>
		</group>
		<group id="aerial" label="Aerial Photo" checked="true" raster="true">
			<layer>manningham.aerial</layer>
			<metadata><![CDATA[More metadata can be specified here]]></metadata>
		</group>
		<group id="current" label="Current Map" raster="true"/>
	</item>

<item action="weave.zipnshipenvelope">
        <acl:acl id="acl.public"/>
        <tooltip>
                <title>Export Vector</title>
                <text>Export Vector Data to file</text>
        </tooltip>
        <maxScale>5000</maxScale>
        <welcome><![CDATA[Welcome text here]]></welcome>
        <license><![CDATA[License text here]]></license>
        <size width="1024" height="768"/>
        <group id="base" label="Base Layers" disabled="true" checked="true">
                <layer>property</layer>
                <layer>road</layer>
                <metadata><![CDATA[Metadata text here]]></metadata>
        </group>
        <group id="water" label="Water Layers">
                <layer>asset_ww</layer>
                <layer>asset_sw</layer>
                <layer>asset_ws</layer>
                <metadata><![CDATA[Metadata text here]]></metadata>
        </group>
        <group id="other" label="Other Layers">
                <layer>park</layer>
                <layer>education</layer>
                <metadata><![CDATA[Metadata text here]]></metadata>
        </group>
        <group id="aerial" label="Aerial Photography" raster="true">
                <layer>photo250to500</layer>
                <layer>photo500to2500</layer>
                <layer>photo2500to10000</layer>
        </group>
</item>
Grouping entires into categories
<item action="weave.zipnshipenvelope">
        <group id="base" label="Base Layers" disabled="true" checked="true" category="Main">
                <layer>property</layer>
                <layer>road</layer>
        </group>
        <group id="water" label="Water Layers" category="Main">
                <layer>asset_ww</layer>
                <layer>asset_sw</layer>
                <layer>asset_ws</layer>
        </group>
        <group id="other" label="Other Layers" category="Other">
                <layer>park</layer>
                <layer>education</layer>
        </group>
        <group id="aerial" label="Aerial Photography" raster="true" category="Other">
                <layer>photo250to500</layer>
                <layer>photo500to2500</layer>
                <layer>photo2500to10000</layer>
        </group>
</item>