Administration Guide

Content
Search Results
Loading, please wait ...

Loading

  • Welcome
  • Getting Started
    • Configuring a New System
    • Accessing Management Console
      • Setting the Language and Region
      • Comparison of Windows and Web Versions of Management Console
    • Starting and Stopping the Server
    • Installing the Client Tools
    • Network Ports
  • Security
    • Security Model
    • Users
      • Adding a User
      • Changing a Password
      • Setting a Minimum Password Length
      • Changing Your Email Address
      • Disabling a User Account
      • Deleting a User
      • User Account Locking
        • Unlocking the admin Account
      • Automatic Logout Due to Inactivity
    • Roles
      • Creating a Role
      • Deleting a Role
      • Secured Entity Types - Advanced Matching Module
      • Secured Entity Types - Business Steward Module
      • Secured Entity Types - Data Federation Module
      • Secured Entity Types - Data Hub Module
      • Secured Entity Types - Data Normalization Module
      • Secured Entity Types - Database Resources
      • Secured Entity Types - Enterprise Data Integration Module
      • Secured Entity Types - External Web Services
      • Secured Entity Types - Location Intelligence Module
      • Secured Entity Types - Metadata Insights
      • Secured Entity Types - Platform
    • Access Control
      • Configuring Access Control
      • Deleting Access Control Settings
    • Security for the Location Intelligence Module
      • Access Control for Datasets
      • Creating a Named Resources Administrator
      • Creating a Spatial Dataflow Designer
      • Limiting WebDAV Access to the Repository
      • Using WebDAV with HTTPS
    • Limiting Server Directory Access
    • Configuring HTTPS Communication
      • Configuring HTTPS on AIX systems
      • Using WebFolders to Access Spectrum Spatial Repository Resources
      • Implementing self-signed certificates
    • Web Service Authentication
      • Disabling Basic Authentication for Web Services
      • Disabling Authentication for Web Services
      • Enabling CORS
    • Using LDAP or Active Directory for Authentication
      • Mapping LDAP Attribute Values to Roles
      • Enabling SSL Communication with LDAP
      • Disabling SSL Communication with LDAP
    • Implementing Spectrum Single Sign-on (SSO)
      • Configuration assumptions and SSO deployment checks
      • Server configurations for authentication support
        • Set security authentication
        • Set server authentication properties
        • Set keystore configuration properties
        • Manage AD FS session timeout properties
        • Setup SAML2 assertion
        • Set SSO binding properties
      • SSO in a clustered configuration
      • Managing and mapping roles and properties
      • Mapping SSO_STS roles to Spectrum™ Technology Platform roles
    • Certificate-based encryption
      • Define trust certificates
      • Generate node certificates
      • Setup keystores and truststore
      • Specify distinguished names
      • Encryption methods
        • Method 1: Configure Spectrum to accept user-provided CA certificates
        • Method 2: Configure Spectrum with self-signed certificates provided by Pitney Bowes
        • Method 3: Configure Spectrum with your own, self-signed certificates
        • Separate configurations
          • Separately configure HTTP or HTTPS
          • Separately configure caching - Hazelcast
          • Separately configure indexing - Elasticsearch
          • CLI encryption setup - Windows client only
        • Encryption properties
  • Data Sources
    • Data Source connections
    • Defining Connections
      • Connecting to Amazon
        • Connecting to Amazon DynamoDB
          • Amazon DynamoDB Limitations
        • Connecting to Amazon S3
          • Using Amazon S3 Cloud Encryption
        • Connecting to Amazon SimpleDB
          • Amazon SimpleDB Limitations
      • Connecting to Apache Cassandra
        • Apache Cassandra Limitation
      • Connecting to Azure Cloud
      • Connecting to a Flat File
        • Connecting to a Delimited Flat File
        • Connecting to a Fixed-Width Flat File
        • Date Time Formats in a File Connection
      • Connecting to an FTP Server
      • Connecting to Google Cloud Storage
      • Connecting to Hadoop
        • Compression Support for Hadoop
      • Connecting to Hive
      • Connecting to a JDBC Database
        • Importing a JDBC Driver
        • Manually Adding a JDBC Driver
        • Deleting an Imported JDBC Driver
        • Supported Database Data Types
        • Supported Database Data Types for the Location Intelligence Module
      • Connecting to Knox
      • Connecting to a Windows Mapped Drive
      • Connecting to Marketo
        • Marketo Limitations
        • Supported Entities and Operations
      • Connecting to Microsoft Dynamics 365
        • Connecting to Microsoft Dynamics 365 Online
        • Connecting to Microsoft Dynamics 365 On Premise
        • Limitations
        • Supported Entities and Operations
      • Connecting to a Model Store
      • Connecting to NetSuite
        • NetSuite Limitations
        • Supported Entities and Operations
      • Connecting to NoSQL
      • Connecting to Salesforce
        • Salesforce Limitation
      • Connecting to SAP NetWeaver
        • SAP NetWeaver Limitations
        • Supported Entities and Operations
      • Connecting to SharePoint
      • Connecting to Splunk
        • Splunk Limitations
        • Supported Entities and Operations
      • Connecting to SuccessFactors
        • SuccessFactors Limitations
        • Supported Entities and Operations
      • Connecting to SugarCRM
        • SugarCRM Limitations
        • Supported Entities and Operations
      • Connecting to Oracle Eloqua
        • Special Operations
        • Limitations
        • Supported Entities and Operations
    • Compression Support for Cloud File Servers
    • Deleting a Connection
  • Spectrum Databases
    • Introduction to Spectrum Databases
    • Installing a Spectrum Database
    • Adding a Spectrum Database
    • Database Pool Size and Runtime Instances
    • Deleting a Spectrum Database
  • Services
    • Spectrum Services
      • Specifying Default Service Options
      • Previewing a Service
      • Optimizing Services
      • Remote Servers
        • Adding a Remote Server
        • Routing a Service to a Remote Server
        • Troubleshooting Remote Server Errors
    • External Web Services
      • Adding an External Web Service
      • Previewing an External Web Service
      • Exporting an External Web Service Definition
      • Importing an External Web Service Definition
      • Deleting an External Web Service
  • Flows
    • Configuring Flow Defaults
      • Setting Data Type Conversion Defaults
        • Date and Time Patterns
        • Number Patterns
      • Setting the Malformed Records Default
      • Setting Report Defaults
    • Scheduling Flows
      • Scheduling a Flow
      • Viewing Schedules
      • Deleting a Schedule
    • Viewing Flow Status and History
      • Downloading Flow History
      • Purging Execution History
    • Triggering a Flow with a Control File
    • Command Line Execution
      • Running A Job from the Command Line
        • Overriding Job File Locations
        • Overriding the File Format at the Command Line
        • Using a Job Property File
          • Overriding Input and Output Files Using a Job Property File
          • Overriding File Format Using a Job Property File
      • Running a Process Flow from the Command Line
        • Using a Process Flow Property File
        • Overriding Process Flow File Locations
    • Adding Dataflow Runtime Options
  • Performance
    • Performance Tuning Checklist
      • Design Guidelines for Optimal Performance
      • Dataflow Pool Size
      • Database Pool Size and Runtime Instances
      • Setting Default Sort Performance Options
      • Configuring Remote Component Options
      • Heap Size Configuration for Elasticsearch
      • Optimizing Individual Stages
        • Optimizing Matching
        • Optimizing Candidate Finder
        • Optimizing Transforms
        • Optimizing Write to DB
        • Optimizing Address Validation
        • Optimizing Geocoding
      • JVM Performance Tuning
      • Micro-Batch Processing
    • Monitoring Performance
      • Monitoring Performance with the Administration Utility
        • The Performance Log
      • Monitoring Performance with the JMX Console
        • JMX Performance Monitor Statistics
  • Monitoring
    • Email Notification
      • Configuring a Mail Server
      • Configuring Expiration Notification
      • Selecting Items for Expiration Notification
    • Audit Log
      • Viewing the Audit Log
      • Audit Log Archiving
    • System Log
      • Viewing System Events
      • Setting Logging Levels for Services
    • Logging the Record that Caused a Flow to Fail
    • Transaction Limit Warnings
    • Viewing Version Information
    • Viewing and Exporting License Information
  • Backup and Restore
    • Scheduling Backups
    • Creating a Backup Manually
    • Restoring a Server
  • Administration Utility
    • Getting Started with the Administration Utility
    • Setting up Command Line Interface (CLI) properties in an https-enabled server environment
    • Using a Script with the Administration Utility
    • Data Hub Module
      • hub backup all
      • hub backup delete
      • hub backup list
      • hub backup model
      • hub backup restore
      • hub job list
      • hub job status
      • hub model clear
      • hub model copy
      • hub model create security
      • hub model delete
      • hub model list
      • hub model reindex
      • hub schema copy
      • hub schema delete entityProperty
      • hub schema delete entityType
      • hub schema delete relationshipLabel
      • hub schema delete relationshipProperty
      • hub schema export
      • hub schema import
      • hub schema importLogicalModel
      • hub schema list all
      • hub schema list entityProperties
      • hub schema list entityTypes
      • hub schema list relationshipLabels
      • hub schema list relationshipProperties
      • hub schema modify indexType
      • hub schema rename entityProperty
      • hub schema rename entityType
      • hub schema rename relationshipLabel
      • hub schema rename relationshipProperty
    • Data Sources
      • FTP
        • data source ftp add
        • data source ftp delete
        • data source ftp list
        • data source ftp test
        • data source ftp update
      • JDBC Database
        • Connections
          • dbconnection add
          • dbconnection delete
          • dbconnection export
          • dbconnection import
          • dbconnection list
          • dbconnection test
          • dbconnection update
        • Drivers
          • dbdriver delete
          • dbdriver export
          • dbdriver import
          • dbdriver list
    • Dataflows
      • dataflow delete
      • dataflow export
      • dataflow expose
      • dataflow import
      • dataflow list
      • dataflow lock list
      • dataflow sourcesink list
      • dataflow unexpose
      • dataflow unlock
      • dataflow version list
    • Enterprise Routing Module
      • ermdb list
      • ermdb get
      • ermdb add
      • ermdb delete
      • ermdb modify
      • ermdb import
      • ermdb export
      • erm getpointdata
      • erm getsegmentdata
      • erm createpointupdate
      • erm resetpointupdate
      • erm createsegmentupdate
      • erm resetsegmentupdate
      • erm getsegmentupdates
      • erm createroadtypeupdate
      • erm resetroadtypeupdate
      • erm getroadtypeupdates
      • erm getallupdates
      • erm resetallupdates
    • Folders
      • folder browse
      • folder create
      • folder delete
      • folder move
      • folder rename
    • Information Extraction Module
      • iemodel delete
      • iemodel evaluate model
      • iemodel evaluate train_model
      • iemodel export
      • iemodel import
      • iemodel list
      • iemodel train
      • iemodel trainAndevaluate model
    • Jobs
      • job history list
      • job execute
        • Using a Job Property File
        • Overriding Job Files
        • Overriding File Format
    • Lineage & Impact Analysis
      • notes export
      • notes import
    • Location Intelligence Module
      • limrepo export
      • limrepo import
      • limrepo mwsimport
    • Match Rules
      • matchrule delete
      • matchrule export
      • matchrule import
      • matchrule list
    • Notification
      • notification daystoexpire set
      • notification enabled set
      • notification expirationsettings list
      • notification smtp get
      • notification smtp set
      • notification smtp test
      • notification subscriber add
      • notification subscriber delete
    • Open Parser Cultures
      • openparser culture export
      • openparser culture import
    • Open Parser Domains
      • openparser domain export
      • openparser domain import
      • openparser domain list
    • Performance Monitor
      • performancemonitor enabled get
      • performancemonitor enabled set
        • The Performance Log
    • Permissions
      • permission list
    • Physical and Logical Models
      • logicalmodel bulkExport
      • logicalmodel bulkImport
      • logicalmodel export
      • logicalmodel import
      • logicalmodel list
      • modelstore bulkExport
      • modelstore deploy
      • modelstore export
      • modelstore import
      • modelstore bulkImport
      • modelstore list
      • modelstore undeploy
      • physicalmodel bulkExport
      • physicalmodel bulkImport
      • physicalmodel export
      • physicalmodel import
      • physicalmodel list
    • Process Flows
      • processflow delete
      • processflow execute
        • Overriding Process Flow File Locations
      • processflow export
      • processflow expose
      • processflow import
      • processflow list
      • processflow history list
      • processflow unexpose
      • processflow version list
    • Remote Servers
      • remoteserver list
      • remoteserver add
      • remoteserver delete
      • remoteserver test
      • remoteserver update
      • remoteserver refresh
    • Roles
      • role create
      • role delete
      • role export
      • role import
      • role list
      • role permission export
      • role permission import
    • Search Indexes
      • index list
      • index delete
      • index export cancel
      • index export progress
      • index export start
      • index snapshot create
        • index snapshot list
      • index snapshot delete
      • index snapshot repository
      • index snapshot restore
        • index restore list
    • Services
      • service list
      • service loglevel list
      • service loglevel set
      • service option list
      • service option set
    • Spectrum Databases
      • Enterprise Geocoding Module for Global Databases
        • egmglobaldb create sample file
        • egmglobaldb delete
        • egmglobaldb import
        • egmglobaldb export
        • egmglobaldb get
        • egmglobaldb list
        • egmglobaldb poolsize set
      • Enterprise Geocoding Module for US Databases
        • egmusadb add
        • egmusadb delete
        • egmusadb import
        • egmusadb export
        • egmusadb get
        • egmusadb list
        • egmusadb poolsize set
      • Enterprise Geocoding Module for Great Britain Databases
        • egmgbrdb create sample file
        • egmgbrdb delete
        • egmgbrdb import
        • egmgbrdb export
        • egmgbrdb get
        • egmgbrdb list
        • egmgbrdb poolsize set
      • Enterprise Geocoding Module for Australia Databases
        • egmausdb create sample file
        • egmausdb delete
        • egmausdb import
        • egmausdb export
        • egmausdb get
        • egmausdb list
        • egmausdb poolsize set
      • Enterprise Geocoding Module for World Databases
        • egmworlddb create sample file
        • egmworlddb delete
        • egmworlddb import
        • egmworlddb export
        • egmworlddb get
        • egmworldb list
        • egmworlddb poolsize set
      • Enterprise Tax Module Databases
        • geotaxdb delete
        • geotaxdb import
        • geotaxdb export
        • geotaxdb get
        • geotaxdb list
        • geotaxdb poolsize set
      • Global Addressing Module Databases
        • gamdb create
        • gamdb delete
        • gamdb export
        • gamdb get info
        • gamdb import
        • gamdb listdatasets
        • gamdb listdbresources
        • gamdb modify
        • gamdb poolsize set
      • Global Geocoding Databases
        • globalgeocodedb create sample file
        • globalgeocodedb delete
        • globalgeocodedb import
        • globalgeocodedb export
        • globalgeocodedb get
        • globalgeocodedb list
        • globalgeocodedb poolsize set
      • Universal Addressing Module Databases
        • uamdb create
        • uamdb modify
        • uamdb delete
        • uamdb import
        • uamdb export
        • uamdb get resource info
        • uamdb list
        • uamdb listdatasets
        • uamdbglobalmultipath create_sample_file
        • uamdb poolsize set
        • uamdbglobalmultipath create_sample_file
    • System
      • close
      • connect
      • date
      • exit
      • help
      • license expirationinfo export
      • license expirationinfo list
      • licenseinfo export
      • licenseinfo list
      • server backup
      • script
      • system loglevel get
      • system loglevel set
      • system properties
      • versioninfo export
      • versioninfo list
    • Tables
      • table delete
      • table export
      • table import
      • table list
    • Tokens
      • token list
      • token refreshsecret
      • token revoke
      • token userrevoke
    • User Accounts
      • user create
      • user delete
      • user description set
      • user email set
      • user enabled set
      • user list
      • user password set
      • user role grant
      • user role list
      • user role revoke
  • Clustering
    • Clustered Architecture
    • Using Enterprise Designer with a Cluster
    • Starting a Cluster
    • Stopping a Cluster
    • Upgrading a Cluster
    • Removing a Node from a Cluster
    • Managing a Cluster for the Location Intelligence Module
      • Clustered Architecture for the Location Intelligence Module
      • Setting Up a Common Repository Database
      • Configuring Your System
        • Configure the Map File Share
          • Creating a Map Image File Share on Unix/Linux
          • ***
        • Modifying OGC Service Configurations for Clustering
        • Modifying the Java Properties Files in All Nodes
        • Configuring Ports for Multiple Spectrum Instances
        • Shared Spectrum Local Data
  • About Spectrum™ Technology Platform
    • What Is Spectrum™ Technology Platform?
    • Enterprise Data Management Architecture
    • Spectrum™ Technology Platform Architecture
    • Modules and Components