{{Path1|title=Developer: WeoFile|1=[[Third Party Developer Documentation]]}} The “WeoFile” is an XML document that provides instructions to WeoGeo on how to properly process your dataset and list it within your Library and/or on the WeoGeo Market. The WeoFile contains the description (metadata), location, and geometry information, as well as pricing and search options for your listing. A normal XML Schema string that only allows null values. Some other data types use this to accept empty instances of this tag. A boolean literal that also allows null values. A weofloat that also allows null values. A normal XML Schema unsigned integer that also allows null values. A normal XML Schema date that also allows null values. A well-formed token, as generated by the WeoGeo server. This will be checked to match the form: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX where each ''X'' is a hexadecimal digit. A standard XML Schema float, with a tooltip description. A standard XML Schema integer, with a tooltip description. A standard XML Schema unsigned integer, with a tooltip description. A space separated list of unsigned integer values, where each value is the identifier for a group that will be allowed to access this dataset. See the [[Developer:_WeoFile#dataset.2Fgroup_ids | Group IDs]] tag for more information. A positive integer value, used to describe which of the bands in the dataset will be used as the red, green, or blue bands during visualization. Either of the boolean literal names "true" or "false" (case insensitive), or the numeric values 0 (false) or 1(true) One of "raster", "vector", or "other" (case insensitive). See the [[Developer:_WeoFile#dataset.2Fdata_type | Data Type]] tag for more information. A normal XSD String, limited to 100 characters. One of the datums we support for raster processing. Currently allowed are: ''WGS84'', ''NAD27'', and ''NAD83''. (case insensitive) A space separated list of datums. The only allowed members are those supported by the above ''datum'' type. One of the supported file formats. Allowed are ''envi'', ''erdas_img'', ''esri_bil'', ''geotiff'', ''esri_shp'', ''mapinfo_tab'', and ''jpeg'' (case insensitive) A positive integer value representing the size of a file in bytes Represents the market action to be taken. An empty tag or ''push'' are allowed values. The value ''complete'' is only used internally and should not be specified. A description of the byte-level layout used to represent individual pixels in the dataset or rasterized preview. Allowed values are one of: ''unknown'', ''byte'', ''uint16'', ''int16'', ''cint16'', ''uint32'', ''cint32'', ''float32'', ''cfloat32'', ''float64'', ''cfloat64'' (case insensitive) One of the two possible price types for use in market sales. Allowed are: ''fixed'', ''variable'' (case insensitive). One of the projections we natively support. Allowed values are: ''utm'', ''geo'', ''tm'', ''lcc'', and ''ace'' (case insensitive) A space separated list containing only the projections we natively support.. See the above ''projection'' type for more information. Either ''credited'' or ''uncredited'' (case insensitive) Either ''market'' or ''library'' (case insensitive) This tag is a container for all of the information needed to upload a dataset to WeoGeo. This includes any relevant Market or Library information. On the client side, this is the top-level tag for the WeoFile. A unique token, generated by the WeoGeo Library defined in dataset/weogeo_host. This unique token is linked to the dataset. The web address of the Library that the dataset will be uploaded to. A container for information used to connect to the server that receives uploaded datasets. The address where the server side processor is located. This should be an IP address or a fully qualified domain name. The port number that the server side processor is listening on. By default the processor runs on port 80. The path to an image that represents an alpha mask. This will be applied when making the preview tiles. Utilizing this can be beneficial in creating attractive Low Resolution KMLs. If a mask is not provided, the raw preview file is used. A semicolon delimited list of file paths to all of the files being uploaded in addition to the image file. A boolean value stating if a contrast stretch should be applied to the preview tiles when they are created. When true, a 2% contrast stretch is applied. When false, no contrast stretch is applied. One of ''raster'', ''vector'', or ''other'', used to describe the type of data being uploaded. Some of WeoGeo's features, such as the ability to reproject a file before it is downloaded, are dataset classified as ''other''. The date this data was created. Although this is an optional field, the dataset will be omitted in searches that specify a creation date, even if they would otherwise be a valid search result. Many users prefer having this information available when determining how useful a dataset will be to them. Please note that this should not necessarily be the date of submission, or the creation/last modified date of the relevant file in the filesystem. A description of the data being uploaded. This should be provided by the user and is allowed to contain some html tags. Note that, if HTML tags are used, these should be wrapped in a [http://en.wikipedia.org/wiki/CDATA CDATA] section. This field is only relevant on WeoGeo Libraries in which Access Controls have been activated (by default they are not). On such Libraries, the Administrator may assign uploaded datasets to an access group. This provides data security and ensures that datasets are only viewed and downloaded by appropriate Users. To assign datasets to groups in the WeoFile, the Group IDs Tag is used with a space-delimited list of groups a dataset should belong to, identified by their integer ids. Library Specific tags are required for WeoGeo library, but ignored by WeoGeo market. Groups are unique to each Library, and are created and maintained by the administrator. For more info, see [[Set-up_access_controls_on_WeoGeo_Library | Access Control with Groups and Roles]] Optional numeric identifier assigned to a license provided through the license api. This field ensures the dataset is correctly associated with that license on upload. A space delimited list of names for the layers in the dataset. Each layer name is mapped in order to the layers in the data file. Additional names beyond the last layer in the data file will be truncated on the server. This is an optional tag. If not specified, WeoApp will look to the dataset to try to fill out this info. If that is unsuccessful, monotonically increasing layer names are generated. This tag is required for vector data uploads. If the layers are specified by the user, WeoGeo check that the length of this array matches the number of layers in the dataset. If there are more layers specified here then in the dataset, this list is truncated. If there are less, WeoGeo adds in places holder names. The layer names can be edited later in the admin interface. The Name is the primary method used to describe a listing. As with all metadata, providing meaningful information within the Name tag will help users to decide if a listing meets their needs. A space delimited list of the job tokens from files used to make this entry. If this product has not been derived from a dataset already on WeoGeo, this tag can be omitted. Parent job tokens are used to maintain a datasets geneology and possibly collect royalty transactions if specified. Tags are a space-delimited list of keywords that describe a Listing, the area that is covered, or anything else that may be relevant to describing or marketing a Listing. Tags may be used within the Advanced Filter to search for Listings and are thus a useful way to group similar listings. At least one tag must be specified. This value should be set to true in almost all cases. That being said, datasets may either be “Listed” or “Hosted and Listed” on WeoGeo. The "Hosted" option is enabled by setting the Hosted Tag to “TRUE”. When the dataset is only Listed, the WeoApp generates preview images and customization options are still available. However, the content provider is required to fulfill the order by geoprocessing the dataset and uploading it to WeoGeo. When a dataset is Hosted and Listed on WeoGeo, the preview image is created as before, and the geocontent is also uploaded to WeoGeo so that the WeoGeo processing service can fulfill customization orders. Geoprocessing and delivery is performed entirely by the WeoGeo Library or Market so orders are fulfilled automatically, which typically provides a superior user experience. This tag is only used for raster data sets. An optional field used to specify which layers in the dataset are represented as red, blue, and green bands. We use a 1-indexing scheme for all files. If these tags are not provided we will use red=1, green=2, blue=3 by default. The red band in the dataset The green band in the dataset The blue band in the dataset Set to "push" if the dataset should be placed on the Market in addition to the Library. If omitted or left blank the dataset will only be placed on the Library. Setting this to push will require pricing info and model to be specified. The pricing type for a dataset can be either FIXED or VARIABLE . Variable means the provider is willing to discount the data's price if less then the full file is requested. Fixed indicates that the provider does not want to offer this ability. The royalty model for a dataset determines if the user will be paid for the sale of datasets derived from this dataset. A value of "credited" means that the user will be paid for the sale of child datasets, "uncredited" datasets do not receive this payment. The default value for this tag if it is omitted is "credited". The date after which a subsidy on sales of this dataset, if requested, expires. If this tag is left blank or omitted the subsidy does not expire. See [[Developer:_WeoFile#dataset.2Fprovider_discount_rate | Provider Discount Rate]]. The percentage discount provided while a dataset is subsidized. This must be specified as an integer value in increments of ten. The amount of money the user wishes to receive from a sale of their entire entry. An example of how pricing is calculated can be found here: [[Transaction_Fees]] The maximum discount a provider will commit to while their dataset is subsidized. This value cannot exceed the provider's requested margin. For "variable" price models, this specifies the minimum amount that the provider wishes to collect from any sale of their dataset. For "fixed" price models, this must be set to 0.0 or omitted. Specify parameters connected with the projection. Only the projection specified in the projection tag will be read. All others, if present, will be ignored. Parameters for the Albers Conic Projection. Parameters for the Lambert Conic Conformal. Parameters for the Transverse Mercator Parameters for the Univeral Transverse Mercator Specify parameters connected with the projection. Only the projection specified in the projection tag will be read. All others, if present, will be ignored. Parameters for the Albers Conic Projection. Parameters for the Lambert Conic Conformal. Parameters for the Transverse Mercator Parameters for the Univeral Transverse Mercator This tag and its subtags contain the boundary information that describes the dataset being uploaded. The subtags will contain more description. The data boundaries are not calculated. They reflect the original data. Boundaries for the final preview image are stored here. This field is calculated by WeoApp from the native preview boundaries. The native boundaries match the original data boundaries in the original projection. However, these boundaries reflect a possible downsampling required to meet the size restriction WeoGeo has imposed on preview files (currently limited to 64,000px by 64,000px) The geo boundaries are those calculated for the file in a WGS84/geographic projection. This is performed by WeoApp. It is used for the low resolution KML. And it is used to draw the outline rectangle on the world map. The format of the main file for the dataset. Allowed values are: For raster data types: ''envi'', ''erdas_img'', ''esri_bil'', ''geotiff'', and ''jpeg'' (case insensitive) For vector data types: ''esri_shape'', ''mapinfo_tab'' For other data types: Not used. A semicolon-delimited list of the paths to the data files being uploaded. The first file in the list should be the primary data file for the dataset, and will be used to create preview images by WeoApp if the [[Developer:_WeoFile#dataset.2Fdata_type | data_type]] is Raster. The remaining files are the support files (header files, etc) for the main dataset file. Preview raster file used in place of a data set which cannot be used for tiling purposes. A semicolon-delimited list of the MD5 hashes for the data files being uploaded. This field will be generated by WeoApp during the file upload. The (compressed) size of the data file(s) being uploaded. This field will be generated by WeoApp during the file upload. The path to the file that should be used as an alpha mask. This is generated from the [[Developer:_WeoFile#dataset.2Fmask | mask]] tag by WeoApp. The size of the data file after decompression. This field is generated by WeoApp. The file format for user-provided tiles. Options are 'png' and 'jpg'. Defaults to 'jpg'. The tiling scheme for preview tiles. Options are 'XYZ' and 'kamap'. Defaults to 'kamap'. The size of kml files being uploaded. An optional file used to specify a KML preview. If this file is not provided, WeoApp will generate it from other data. A semicolon-delimited list of the preview files. Both a normal and a contrast stretched file should be included, in that order. For raster files only: if this list is not provided, it will be generated by WeoApp during the file upload. A semicolon-delimited list of the original paths to the preview files. This list is generated by WeoApp during the file upload. The (compressed) size in bytes of the original preview file. This field is generated by WeoApp during the file upload. The (uncompressed) size in bytes of the original preview file. This field is generated by WeoApp during the file upload. The (compressed) size in bytes of the contrast-stretched preview file. This field is generated by WeoApp during the file upload. The (uncompressed) size in bytes of the contrast-stretched preview file. This field is generated by WeoApp during the file upload. During the upload process, the contents of the [[Developer:_WeoFile#dataset.2Fmisc_files | misc_files]] tag are compressed into an archive file by WeoApp. If that file exceeds 2GB in size, it is broken apart into several archive files that are each 2GB or smaller. WeoApp records the paths to those files in this field. The original file paths to the archive files generated by WeoApp during the file upload. This field is generated by WeoApp during the upload process. A list of the MD5 sums for miscellaneous files. This field is generated by WeoApp during the upload process. The size in bytes of the (compressed) set of miscellaneous files. The size in bytes of the (uncompressed) miscellaneous files. This field is used to record files that were uploaded but have not been listed in any of the other file tags. It is generated automatically on the server and should not be filled in. For raster data files, this field records if the data file is paletted. It is generated by WeoApp during the upload process. Paletted GeoTiffs are the only type of paletted images WeoGeo currently accepts. For raster data files, this field describes the data type of the data(byte, float, etc). It is generated by WeoApp during the upload process. For raster data files, this field contains the number of layers in the dataset. For preview files, this field contains the number of layers in the dataset. This field is used internally by WeoApp. Please do not modify the contents of this field or any of its children. The file size for the preview tile pack. This will be generated by WeoApp when it creates the tile pack. The file location for the preview tile pack. The tile pack is generated automatically by WeoApp. This is a tag is about to be deprecated. Only 'Library' is a valid option. This tag contains information used by WeoGeo when displaying the preview tiles. It is generated automatically by WeoApp. A semicolon delimited list of zoomed in preview images. A semicolon delimited list of zoom levels. Numbers correlate with dataset/tileset/preview_files. A 316x316 thumbnail file. A 61x61 thumbnail file. This tag contains information used by WeoGeo when displaying the preview tiles. It is generated automatically by WeoApp.