Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.53 KB

README.md

File metadata and controls

29 lines (19 loc) · 1.53 KB
Raw

SFDC ID conversion utility

Simple library that converts Salesforce IDs between the SFDC internal 15-character form, and the case-insensitive 18-character form.

More background and description of the algorithm from this StackExchange post, but essentially: The last 3 characters are used to encode case information of the first 15 characters, so that IDs can be reliably compared in systems that treat string comparison case-insensitively (like Excel):

  • Each 15-digit ID is split into 3 5-digit chunks
  • Each 5-digit chunk's casing information is encoded into a 5-bit integer (MSB to the right), mapped to the character set [A-Z0-5], in that order
  • These three digits are appended to the end of the 15-bit ID, making it unique case-insensitive.

Requirements

None besides the Python standard library (this was written on Python 3.8)

Usage

Pass a valid 15- or 18-digit Salesforce ID to convert() to get the corresponding 15- or 18-digit Salesforce ID back. Some quick checks will be done -- invalid characters will cause errors raised through logging (and the input being passed back as-is), while mangled cases for 18-digit IDs will be coerced to the canonical form based on the information in the last 3 digits, and converted with a warning.

import sfdc_ids

sfdc_ids.convert('aaaabaaaabaaaabAAA')
>> 'aaaabaaaabaaaab'

sfdc_ids.convert('aaaabaaaabaaaabQAB')
>> 'aaaaBaaaabAaaab'

sfdc_ids.convert('aaaabaaaabaaaab')
>> 'aaaabaaaabaaaabAAA'