LogoLogo
HomePricingDocumentation
  • 💿Getting Started
    • Installation and Project Setup
    • Hello Perigee!
    • Perigee Application Design
    • Hello Configuration
    • Hello Logs
    • Hello Integration
    • Troubleshooting
    • Case Studies
  • 📃License + Notice
    • 📂Licensing
    • Notice of Third Party Agreements
  • 🚀Perigee and Beyond
    • Extending - Threads
    • Extending - Loaders
    • ⏳All about CRON
  • 🔮API Generation
    • What is API Generation?
    • API Builder
  • 🗺️Architecting YOUR App
    • Design and Requirements
    • Define Sources
    • Requirements
  • 🧩Core Modules
    • 🌐PerigeeApplication
    • 🪡Thread Registry
    • Event Sources
      • Scheduled/Logic
        • CRON Thread
        • Scheduler
        • Sync Agent
      • Watchers
        • SalesForce
        • Sharepoint
        • Directory Watch
        • Directory Notifier
        • IMAP
    • Credential Management
      • Connection Strings
      • Custom Refresh Logic
      • RestSharp Authenticator
      • Credential Store SDK
      • ⁉️Troubleshooting Credentials
    • Integration Utilities
      • HTTP(S) - RestSharp
      • Transaction Coordinator
      • Limiter
      • Watermarking
    • Alert Managers
      • SMS
      • Email
      • Discord
      • Teams
    • File Formats
      • Excel
      • CSV
    • 📁File System Storage
      • File Revision Store
      • Concurrent File Store
      • FileSync + Cache
    • Third Party
      • SmartSheets
      • Microsoft Graph
    • Perigee In Parallel
      • Parallel Processing Reference
      • Extensions
      • GroupProcessor
      • SingleProcessor
    • 🧱Utility Classes
      • Metrics
      • F(x) Expressions
      • Multi-Threaded Processor (Scatter Gather)
      • OpenAI - GPT
      • XML Converter
      • Dynamic Data Table
      • Debounce
      • Thread Conditions
      • Perigee Utility Class
      • Network Utility
      • Lists
      • FileUtil
      • Inclusive2DRange
      • Strings, Numbers, Dates
      • Nested Sets
      • Behavior Trees
      • JsonCompress
      • Topological Sorting
      • DBDownloader
    • 🈁Bit Serializer
  • 📣Examples and Demos
    • API + Perigee
    • 📰Excel Quick Load
    • SalesForce Watcher
    • Report Scheduler
    • Agent Data Synchronization
    • 📩IMAP Echo bot
    • Watch and load CSVs
    • Graph Delegated Authorization + DataVerse
    • Coordinator Demo
    • Azure Service Bus
    • QuickBooks Online
  • 📘Blueprints
    • Perigee With .NET Hosting
    • Web Host Utilities
    • 🔌Plugin Load Context
  • 🎞️Transforms
    • 🌟What is Transforms?
    • 📘Terminology
    • 🦾The Mapping Document
    • 👾Transformation Process
    • 😎Profile
    • 🎒Automation
      • 🕓Package Options
      • 🔳Configuration
    • 🔧Utilities
      • 🧹Clean
      • 📑Map File
      • 🔎File Identification
      • 🗺️Map Generation
      • 🪅Insert Statement Generation
  • 🗃️Transform SDK
    • 👋Quick Start Guide
    • 🥳MapTo
    • 🔌Authoring Plugins
      • 🔘File IO Process
      • 📢Data Quality
      • 🟢Transform Process
    • SDK Reference
      • 🔘FileIOProcessData
      • 📢DataQualityContext
      • 🎛️TransformDataContext
      • 🏅TransformResult
Powered by GitBook
On this page
  • Input file / Source File
  • Mapping Specification (.map)
  • Lookup Values Map (.lvm)
  • Destination File / Target File / Output File
  • Transformation Report
  • Data Quality Report
  • Segmentation File
Export as PDF
  1. Transforms

Terminology

PreviousWhat is Transforms?NextThe Mapping Document

Last updated 1 year ago

It will help you better understand transforms when we all use the same terminology. Let's have a quick review of a few items we will consistently use and talk about.

Input file / Source File

This is the raw, or untransformed data file. Typically in CSV, Excel, or Json format. The system uses this input file as it's starting point to begin the transform.

Mapping Specification (.map)

This document defines the target format for your Input file. It assigns data types, requirements, character lengths and decimal scale. It also assigns and maps the input columns to the target columns.

The second incredibly important thing this defines is how the data is moved between source and target columns, known as the . This tells the system if the input colum is ignored, copies, mapped through a lookup, defaulted, etc.

A transform is not possible without having a map.

Lookup Values Map (.lvm)

The lookup values map is file that contains 3 columns: MapKey, SourceField, TargetField. When your transform type is assigned to MAP, the Lookup Values Map is used to transform the source column value to a destination column value.

MapKey
SourceField
TargetField

StateCode

AZ

Arizona

StateCode

NC

North Carolina

PropertyCode

A12

AB001200

PropertyCode

Z19

AB001900

Destination File / Target File / Output File

Transformation Report

The transformation report also contains warnings about missing map keys, missing maps, decimal overflow, etc.

Think of the Transformation Report as being the generated report on your transformation process. If the file contains no issues, the report shows a clean bill of health. If it had to truncate a value to fit the map, the report shows what value was truncated, what row it was on, and gives you the information you need to correct the problem.

Data Quality Report

  • Does my data contain newline characters in the cells?

  • Does my data have special (non regular ASCII) characters?

  • Does my file contain irregular amounts?

Data Quality gives you one final preview of how clean your input data was.

Segmentation File

Perigee Transforms contains a fully written segmentation validation engine when working with Yardi Segment Rules.

Unlike the "standard" reporting options you get that may be cryptic and only give you a single issue, our engine runs every single segment through every rule and reports on any issues. No more guessing if you've fixed the last segment issue or even worse, turning off segmentation all together to load a file.

This is the result of processing an -> through -> that results in the destination file. This file is guaranteed to match the format defined in the map, and it's columns and cells constrained to the restrictions (both in type, and length) provided by the map.

Once you've obtained the , you'll also have access to the Transformation Report. This report contains every single issue, warning, and cell that contained erroneous or bad results.

Data Quality Reporting differs from as it doesn't care about the mapping specification you fed the transformation engine. It's look at the quality of your data only.

Input File
a map
Target File
Transformation Reporting
🎞️
📘
Mapping Specification
Transformation Type
77B
LookupValuesMap.csv
Page cover image