PowerClerk Support Center

Program Design
Automations
Questions to ask yourself
Locating the Automations feature
Creating an Automation
FAQs
Communication Templates
Questions to ask yourself
Locating the Communications feature
Creating Communication templates
Feature reference
FAQs
Deadlines
Questions to ask yourself
Locating the Deadlines feature
How to create Deadlines
Feature reference
FAQs
Forms
Questions to ask yourself
Locating the Forms feature
How to create and edit Forms
Adding data fields
Configuring Forms
VersaForms
Sensitive Data Fields
Feature reference
FAQs
Roles
Questions to ask yourself
Locating the Roles feature
How to create and edit a Role
Feature reference
FAQs
Workflow
Questions to ask yourself
Locating the Workflow feature
How to create and edit the Workflow
Transitions
Changing a project's status
Feature reference
FAQs
Advanced Program Design
Channels
Locating the Channels feature
What are Channels?
Channels Checklist
3-Step Publishing Process
Channel Type A: Mark As Child
Channel Type B: Make Successor
Channel Type C and D: Create/Submit Related Project
Sending Signals
Document Templates
Questions to ask yourself
Locating the Document Templates feature
How to define a new Template
Feature reference
eSignatures
DocuSign template tags
Mapping eSignature tags
FAQs
Formulas and Calculated Fields
Questions to ask yourself
Locating the Formulas feature
How to create a Formula
Formula Data Dictionary
FAQs
Front Page
Questions to ask yourself
Locating the Front Page feature
How to edit the Front Page
FAQs
Incentive Design
Questions to ask yourself
Locating the Incentive Design feature
How to design an Incentive
Incentive Options
FAQs
Single Sign On (SSO)
Azure AD
Okta IDP Configuration
SP Configuration
PowerClerk API
Custom API IDs
FAQ
API Documentation for Developers
Application & Process Automation
Getting Started
Common Usage Scenarios
Using Custom IDs
API Method Reference
Code Samples
Administration
Business Days
Questions to ask yourself
Locating the Business Days feature
Setting up Business Days
FAQs
Dashboards
Questions to ask yourself
Locating the Dashboards feature
How to create widgets in your Dashboard
Other Dashboard Actions
Data Import
Questions to ask yourself
Locating the Data Import feature
How to validate a Data Import
FAQs
Duplicate Check
Questions to ask yourself
Locating the Duplicate Check feature
How to use Duplicate Checks
FAQs
ePayments
Questions to ask yourself
Locating the ePayments History feature
How to add ePayments
FAQ
Import From V2
Questions to ask yourself
Locating the Import From V2 feature
How to Import From V2
FAQs
Operation Status
Questions to ask yourself
Locating the Operation Status feature
How to use the Operation Status feature
FAQs
Program Info
Project Inquiry
Questions to ask yourself
Locating the Program Info feature
How to edit the Program Info menu
Notification Banners
Billing Info
FAQs
Program Statistics
Questions to ask yourself
Locating the Program Statistics feature
How to use Program Statistics
FAQs
Reports
Questions to ask yourself
Locating the Reports feature
How to setup Reports
Multi-instance reports
Integrate scheduled Reports
Cross-Program Reports
FAQs
Test Environment
Questions to ask yourself
Locating the Test Environment feature
How to setup a Test Environment
FAQs
User Administration
Questions to ask yourself
Locating the User Administration feature
How to work with User Administration
FAQs
Web Adapter Factory
Questions to ask yourself
Locating the Web Adapter Factory
What are Web Adapters
Input and Output Fields
Connecting, Testing, and Enabling
Maintenance and Alterations
Web Adapter Message Format
FAQ
Program Reporting
Data Fields
Questions to ask yourself
Locating the Data Fields feature
How to work with Data Fields
Custom Lists and Data Field Groups
Table form element
PV System + batteries element
FAQs
Milestones
Questions to ask yourself
Locating the Milestones feature
How to define a Milestone
FAQs
Project List Columns
Questions to ask yourself
Locating the Project List Columns feature
How to use Project List Columns
FAQs
Project Summary
Questions to ask yourself
Locating the Project Summary feature
FAQs
How to edit the Project Summary
Project Views
Questions to ask yourself
Locating the Project Views feature
How to edit Project Views
FAQs
Settings
My Account
Questions to ask yourself
Locating the My Account feature
How to use the My Account feature
Setting up Multi-Factor Authentication
MFA Recovery Guidelines
FAQs
FormSense
Questions to ask yourself
Locating the FormSense feature
How to use the FormSense feature
FAQs
Grant Access
Questions to ask yourself
Locating the Grant Access feature
How to Grant Access to users
FAQs
Integration Guides
Integration Guide 001: How to configure a Web Adapter – ArcGIS Implementation
Integration Guide 002: How to configure Electric Power Research Institute’s (EPRI) DRIVE Connect software with PowerClerk
PowerClerk Video Guides
New User Video Guide
Setting up Business Days
Dashboards
Edit Forms - Tutorial #1
Edit Forms - Tutorial #2
Configuring Forms
FormSense
Build A Formula
Automation with Formulas in Action Rules
Formulas and Advanced Visibility Rules
Calculated Fields
Milestones
Project Summary
Roles and User Administration
Visualize Workflows
PowerClerk User Group Sessions (UGS)
PowerClerk Responsive Admin View

Custom API IDs

Standardize the naming convention for programmatically affecting PowerClerk data fields by defining Custom API IDs.

Custom API IDs


Questions to ask yourself about Custom API IDs:

Which Data Fields do I want to designate Custom API ID for?
Which kind of naming conventions does make sense for my Custom API IDs?

Locating the Custom API IDs feature

Anyone in a Role with the Edit Custom API ID privilege can edit Custom IDs after this feature has been switched on for your program by opening the PROGRAM DESIGN menu and clicking on Custom API IDs. Please note: To be able to assign the Edit Custom API ID privilege within the Roles section, your Clean Power Research representative will have to switch on this feature for your program.

 

Custom API IDs

Figure 1: PROGRAM DESIGN >> Incentive Design

 

How to edit a Custom API ID

To alter a data field ID that PowerClerk automatically designates to a Custom API ID defined per your naming convention, please identify the respective Data Field in the list of data fields available in your program and click on EDIT:
 

Edit Custom API ID

Figure 2: Edit Custom API ID


Enter the Custom API ID you wish to address this data field with via the PowerClerk API and acknowledge your definition:
 

Define Custom API ID

Figure 3: Define Custom API ID

Video Guides

Would a video guide help to better explain Incentive Designs? Contact us and let us know.

FAQs

Q: Can Data Field IDs change?
A: When working with PowerClerk's API and Custom API IDs you may notice while working in a Test Environment, that the Data Field IDs in the Test Environment change upon recreating the Test Environment. Please note that the Data Field IDs in the underlying non-Test Environment remain constant and cannot be altered or changed.

Have additional questions? Contact us to nominate your FAQ and help others find answers to your own questions concerning this feature.

Create A Support Ticket

Not finding your answer here?  Submit a question to our support team at the PowerClerk Ticket System and leverage the PowerClerk team’s expertise.