Clean Power Research Support Center logo

PowerClerk Support Center

Project Pages
Project Admin Page
Locating the Project Admin Page
How to Use the Project Admin page
Project View/Edit Page
Locating the Project View/Edit Page
How to use the Project View/Edit Page
Program Design Menu
Automations
Questions to Ask
Locating the Automations feature
How to create an Automation
Automation Triggers
Automation Action Rules
Validation Rules
Scheduled Triggers
Troubleshooting Automations
FAQs
Channels
Questions to ask yourself
Locating the Channels feature
What are Channels?
Types of Channels
Channel Type: Mark as Child
Channel Type: Make Successor
Channel Type: Create Related Project
Channel Type: Submit Related Project
Channel Type: Project Lookup
How to create a Channel
Channel Signals and Automations
Using Channels in Test Environments
FAQs
Communications
Questions to ask yourself
Locating the Communications feature
Creating Communication templates
Finding Data Tags
Images in Communications
Sending Mass Communications
Project Attachments and Content Library Items
Smart Templates
Upgrading to Smart Templates
Upgrading when a Test Environment Exists
Broken Template Tags
Examples of Broken Template Tags
PowerClerk Mass Communication Policy
FAQs
Connections
Questions to ask yourself
Locating the Connections feature
What are Connections
How to Create a Web Connector
Define the Web Connector
Connecting, Testing, and Enabling the Web Connector
Creating a Web Connector Configuration
Utilizing Connections on PowerClerk
Maintaining and Editing the Web Connector
Web Connector Payload Type Format
Retrieving Project Information via Built in Fields
Error Handling
Custom List Lookup
Create a Custom List Lookup
Utilizing Custom List Lookup
FAQs
Content Library
Questions to ask yourself
Locating the Content Library feature
Uploading content to the Content Library
Use with Communication Templates
Use for Front Page content
FAQs
Custom API IDs
Questions to Ask
Locating the Custom API IDs feature
How to edit a Custom API ID
FAQs
Data Fields
Questions to ask yourself
Locating the Data Fields feature
Viewing Available Data Fields
Managing Data Fields
Attachment Data Fields
Referencing Data Fields with Template Tags
Text Validation Rules
Custom Lists and Data Field Groups
Table form element
Enabling PV + Battery Element
FAQs
Deadlines
Questions to ask yourself
Locating the Deadlines feature
What are Deadlines
How to Create a Deadline
Deadline Automation Action Rules
Utilizing Project Admin Page for Deadlines
Communication Templates for Deadlines
Deadline Set/Satisfy Options
Program-Wide Deadline Actions
Reporting on Deadlines
Deadlines in Project List Columns
FAQs
Document Templates
Questions to ask yourself
Locating the Document Templates feature
How to define a new Template
Configuring Excel Files using PowerClerk Data Field Tags
How to define a new Merged Document
eSignatures
DocuSign template tags
Mapping eSignature tags
Smart Templates
FAQs
eSignature Envelopes
Questions to Ask
Locating the eSignature Feature
What are eSignature Envelopes?
eSignature Checklist: The Prerequisites to create a new Envelope
How to set up Advanced eSignature Envelopes Step-by-Step
How to add an eSignature Envelope to a form
eSignature Automation Trigger
Viewing Completed eSignature Envelopes
Resending eSignature Notifications
Canceling eSignatures
FAQs
Forms
Questions to ask yourself
Locating the Forms feature
How to create and edit Forms
Adding data fields
Configuring Forms
Saving a Form as a Draft
Form Field Elements
Field Properties
Conditional Visibility
Sensitive Data Fields
Location Form Element
Address Autocomplete
VersaForms
FAQs
Formulas and Calculated Fields
Questions to ask yourself
Locating the Formulas feature
How to work with Formulas and Calculated Fields
Formula Data Dictionary
Dynamic Formula References
Rules of Formula References
Advanced Visibility Rules
Video Guides: Formulas
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 create and edit Incentive Designs
Incentive Options for One-Time Incentive Type
Incentive Design Options
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
How to edit the Project Summary
FAQs
Project Views
Questions to ask yourself
Locating the Project Views feature
How to edit Project Views
FAQs
Roles
Questions to ask yourself
Locating the Roles feature
How to create and edit a Role
Access Groups
Access Groups and Automations
Access Groups and Data Imports
Access Groups and Reports
FAQs
Themes
Overview
How Themes are Stored in PowerClerk
Creating a Theme
PowerClerk Theme Example
Workflow
Questions to ask yourself
Locating the Workflow feature
How to create and edit the Workflow
Transitions
Workflow Example Overview
FAQs
Admin Menu
Announcements
Locating the Announcements feature
Creating an Announcement
Triggering an Announcement
Managing Announcements Topic List
Managing Announcement Topic Enrollment Via User Account
Prerequisites for Using Announcements
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
Steps to Complete a Data Import
Data Import Configurations
Column Header Types
Automatic Data Imports via SFTP
Revert Data Imports
FAQs
Duplicate Check
Questions to ask yourself
Locating the Duplicate Check feature
How to use Duplicate Checks
FAQs
Import Projects
Questions to ask yourself
Locating the Import Projects feature
How to Import From V2
FAQs
Operation Status
Questions to ask yourself
How to use the Operation Status feature
Locating the Operation Status feature
FAQs
Program Info
Project Inquiry
Locating the Project Inquiry feature
How to edit the Project Inquiry Settings
Automating Communications for Project Inquires
Inquiry Summary
Questions to ask yourself
Locating the Program Info feature
How to edit the Program Info menu
Notification Banners
Usage Info
FAQs
Program Statistics
Questions to ask yourself
Locating the Program Statistics feature
FAQs
How to use Program Statistics
Reports
Questions to ask yourself
Locating the Reports feature
How to setup Reports
Multi-instance reports
Sharing Reports
Integrate scheduled Reports
Cross-Program Reports
Handling Sensitive Data in Reports
Viewing Report Failures
Maximum Number of Columns Allowed in a Report
FAQs
User Administration
Questions to ask yourself
Locating the User Administration feature
How to work with User Administration
FAQs
Test Environment
What are Test Environments
Locating the Test Environment feature
How to Open a Test Environment
Questions to ask yourself
Test Environment Behavior
PowerClerk Sandbox Instance
FAQs
Tools Menu
My Account
Questions to Ask
Locating the My Account feature
How to use the My Account feature
Setting up Multi-Factor Authentication
Missing, lost, or stolen mobile devices: resetting Multi-Factor Authentication
Disabling Multi-Factor Authentication
Recovery Guidelines for MFA Administrators
FAQs
FormSense
Questions to Ask
Locating the FormSense feature
How to use the FormSense feature
FAQs
Grant Access
Project Grants vs Broad Grants (i.e. "Grant Access")
Questions to Ask
Locating the Project Grant feature
Locating the Grant Access feature
How to use the Grant Access feature
FAQs
Integration Guides & API
ePayments
Questions to ask yourself
Locating the ePayments History feature
How to add ePayments
FAQ
PowerClerk API
Integrating with the PowerClerk API
Questions to Ask
What is the PowerClerk API?
API Documentation for Developers
What can the PowerClerk API do?
Single Sign On (SSO)
Questions to Ask
PowerClerk SSO Configuration
Entra ID Configuration (SAML)
Entra ID Configuration (OIDC)
Okta IDP Configuration (SAML)
SP Configuration
SSO for multiple programs
IDP Configuration Troubleshooting
FAQs
Integration Guide 001: How to configure an ArcGIS Connector – ArcGIS Implementation
Integration Guide 002: How to configure Electric Power Research Institute’s (EPRI) DRIVE Connect software with PowerClerk
PowerClerk Video Guides
Setting up Roll-up Reports
New User Video Guide
Configuring Forms
Roles and User Administration
Setting up Business Days
Formulas and Advanced Visibility Rules
Visualize Workflows
Dashboards
FormSense
Milestones
ArcGIS
Project Summary
Automation with Formulas in Action Rules
API
Edit Forms - Tutorial #1
SFTP Automatic Data Import
Calculated Fields
Web Connector Setup
Edit Forms - Tutorial #2
Build A Formula
Help Articles
Understanding Your PowerClerk Program Design
Workflow
Forms
Automations
Communications
Data Fields
Deadlines
PowerClerk Program Launch
PowerClerk User Group Sessions (UGS)
Learning Management System (LMS)
Join us for Reflow!
NEW: PowerClerk Certifications

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. Custom API ID’s can be found by opening the Program Design menu and selecting Custom API ID. Please note: To enable the Custom API ID role permission and access the feature, please contact the Support team by submitting a ticket through the PowerClerk Ticket System.

 

Custom API IDs

Figure 1: PROGRAM DESIGN >> Custom API IDs

 

What are Custom API Id’s

Custom API ID’s provide added flexibility by allowing users to assign their own custom ID values to specific PowerClerk elements, rather than relying on the automatically generated public IDs. This enables more precise integration and control when working with external systems. Custom API IDs can be applied to the following PowerClerk features:

  • Data Fields
  • Data Field Groups
  • Attachments
  • Statuses
  • Forms
How to edit a Custom API ID

To create a Custom ID, locate the desired Data Field in the program’s list of data fields and click Edit:
 

Edit Custom API ID

Figure 2: Edit Custom API ID


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

Define Custom API ID

Figure 3: Define Custom API ID

 
After entering the desired Custom API IDs, scroll to the bottom of the page and click Save. Any new changes will not be applied unless you click this button.
 
Please Note: A custom ID can be created to reference the data fields; however, the system-generated Public ID in PowerClerk cannot be changed.

Video Guides

Would a video guide help to better explain Custom API IDs? Contact us and let us know.

FAQs

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.