Change Configuration Options

Titleā€ƒ Change Configuration Options

Summary

Lets you set default configuration settings, output formats, and paths for PISCES. Think of these settings as environment variables for PISCES. Some tools that use these will let you override them (specifically the Generate Map tool), but when you cannot override them, these values are in effect.

Advanced users can also edit this configuration by editing the file config.py in the scripts/PISCES folder instead,


Usage

Syntax

ChangeConfig (Username, {Export_MXD}, {Export_PNG}, {Export_PDF}, {Export_Shapefile}, {Export_KML}, {Export_Data_Driven_Pages}, {Output_Common_Name}, {Export_Metadata}, {Debug_Mode}, Database_Location, Static_Map__PDF__PNG__Output_Folder, Map_Document__MXD__Output_Folder, Web_Layers__Shapefile__KML__Output_Folder, {Export_Layer_Package})

Parameter Explanation Data Type
Username Dialog Reference

Your PISCES username. One should be given to you, or you can use the default of CDFW. Usernames only control what items show by default and are not designed for security.

String
Export_MXD (Optional) Dialog Reference

Checking this box means PISCES will save out an MXD file when generating maps.

Boolean
Export_PNG (Optional) Dialog Reference

Checking this box means PISCES will save out PNG image file when generating maps. These are useful for web display and quick interchange and are often more faithful representations than PDFs.

Boolean
Export_PDF (Optional) Dialog Reference

Checking this box means PISCES will save out a PDF file when generating maps.

Boolean
Export_Shapefile (Optional) Dialog Reference

Checking this box means PISCES will save out a shapfile (stored as a zip file) for every layer in each configured map when generating maps.

Boolean
Export_KML (Optional) Dialog Reference

Checking this box means PISCES will save out a KMZ (compressed KML) file for every layer in the map documents being exported when generating maps. These files are useful for visualization and are supported by many web clients and Google Earth

Boolean
Export_Data_Driven_Pages (Optional) Dialog Reference

For maps that have a Data Driven Pages option configured, this setting controls whether it is enabled or disabled by default. Data Driven Pages allows a single map to have multiple views of the same range exported.

Boolean
Output_Common_Name (Optional) Dialog Reference

For layers that are species-derived, but which don't have an explicit name defined (some of the more obscure maps), this setting makes sure that output layers use the species' common name rather than the species code.

Boolean
Export_Metadata (Optional) Dialog Reference

Controls whether to attach metadata by default to exported layers (and their derived outputs, such as layer packages, shapefiles, etc). Not all maps have metadata output configured. This is a very slow operation that should only be enabled when needed.

Boolean
Debug_Mode (Optional) Dialog Reference

When enabled, debug mode doesn't attempt to print nice error messages and warnings, but instead will lead to crashes with more information. It can also be slower as more diagnostic information is output. Enable only when needed.

Boolean
Database_Location Dialog Reference

The location of the main PISCES database. If you wish to move it, go to the data folder in the PISCES main folder and make a copy of the database to your desired location (since you will need it in the original location in order to open and run this tool). Then run this tool, and browse to the new location in this field, and click OK to save the result. You can then delete the original copy.

File
Static_Map__PDF__PNG__Output_Folder Dialog Reference

The folder that all static maps should be placed in. This parameter cannot be chosen in the Generate Maps tool itself, so all exports will end up in the location specified here.

Folder
Map_Document__MXD__Output_Folder Dialog Reference

The folder that all exported map documents (MXDs) should be placed in. This parameter cannot be chosen in the Generate Maps tool itself, so all map documents will end up in the location specified here.

Folder
Web_Layers__Shapefile__KML__Output_Folder Dialog Reference

The folder that all layer exports generated during mapping should be placed in. This parameter cannot be chosen in the tool itself, so all exports will end up in the location specified here.

Folder
Export_Layer_Package (Optional) Dialog Reference

Checking this box means PISCES will save out a layer file for every layer in the map documents being exported when generating maps. These files are useful for interchange of PISCES data since they include the resulting features, metadata, and symbology in a single file.

Boolean

Code Samples

Tags

config, configuration, options, preferences, settings, PISCES, change, update, manage, environments, environment, variables

Credits

Use limitations