salesforce: Update documentation and field descriptions

shmsr · shmsr · commit fe9753c2b76e · 2025-10-08T02:59:35.000+05:30
diff --git a/packages/salesforce/_dev/build/docs/README.md b/packages/salesforce/_dev/build/docs/README.md
diff --git a/packages/salesforce/changelog.yml b/packages/salesforce/changelog.yml
@@ -1,4 +1,9 @@
 # newer versions go on top
+- version: "1.5.0"
+  changes:
+    - description: Improve documentation and field descriptions.
+      type: enhancement
+      link: https://github.com/elastic/integrations/pull/15596
 - version: "1.4.0"
   changes:
     - description: Improve documentation
diff --git a/packages/salesforce/data_stream/apex/manifest.yml b/packages/salesforce/data_stream/apex/manifest.yml
@@ -10,27 +10,27 @@ streams:
         multi: false
         required: true
         show_user: false
-        default: 56.0
+        default: 65.0
       - name: period
         type: text
         title: Period
-        description: Period of fetching logs. Supported units for this parameter are h/m/s.
+        description: "Polling interval for fetching logs. Supported units: h, m, s."
         multi: false
         required: true
         show_user: true
         default: 1h
       - name: initial_interval
         type: text
         title: Initial Interval
-        description: Initial Interval to fetch historical data from. Supported units for this parameter are h/m/s.
+        description: "How far back to fetch historical data on the first run. Supported units: h, m, s."
         multi: false
         required: false
         show_user: true
         default: 168h
       - name: log_file_interval
         type: text
         title: EventLogFile Interval
-        description: EventLogFile Interval for Event Log. Supported values for this parameter are Hourly/Daily.
+        description: "EventLogFile granularity. Supported values: Hourly or Daily."
         multi: false
         required: false
         show_user: true
diff --git a/packages/salesforce/data_stream/login/fields/fields.yml b/packages/salesforce/data_stream/login/fields/fields.yml
@@ -3,7 +3,7 @@
   fields:
     - name: instance_url
       type: keyword
-      description: The Instance URL of the Salesforce instance.
+      description: The Salesforce instance URL.
     - name: login
       type: group
       fields:
@@ -84,7 +84,7 @@
           fields:
             - name: id
               type: keyword
-              description: The 18-character case-insensitive ID of the URI of the page receiving the login request.
+              description: The 18-character case-safe ID of the URI of the page receiving the login request.
         - name: transaction_security
           type: group
           fields:
diff --git a/packages/salesforce/data_stream/login/manifest.yml b/packages/salesforce/data_stream/login/manifest.yml
@@ -10,51 +10,51 @@ streams:
         multi: false
         required: true
         show_user: false
-        default: 56.0
+        default: 65.0
       - name: event_log_file
         type: bool
         title: EventLogFile Data Collection
-        description: EventLogFile Data Collection to fetching logs from EventLogFile
+        description: "Enable collection from EventLogFile."
         multi: false
         required: true
         show_user: true
         default: true
       - name: object
         type: bool
         title: Real-Time Object Data Collection
-        description: Real-Time Data Collection to fetching logs from Real-Time Data
+        description: "Enable collection from real-time events (LoginEvent)."
         multi: false
         required: true
         show_user: true
         default: true
       - name: elf_period
         type: text
         title: EventLogFile Period
-        description: EventLogFile Period of fetching logs. Supported units for this parameter are h/m/s.
+        description: "Polling interval for EventLogFile. Supported units: h, m, s."
         multi: false
         required: false
         show_user: true
         default: 1h
       - name: real_time_period
         type: text
         title: Real-Time Events Period
-        description: Real-Time Events Period of fetching logs. Supported units for this parameter are h/m/s.
+        description: "Polling interval for real-time events. Supported units: h, m, s."
         multi: false
         required: false
         show_user: true
         default: 5m
       - name: initial_interval
         type: text
         title: Initial Interval
-        description: Initial Interval to fetch historical data from. Supported units for this parameter are h/m/s.
+        description: "How far back to fetch historical data on the first run. Supported units: h, m, s."
         multi: false
         required: true
         show_user: true
         default: 168h
       - name: log_file_interval
         type: text
         title: EventLogFile Interval
-        description: EventLogFile Interval for Event Log. Supported values for this parameter are Hourly/Daily.
+        description: "EventLogFile granularity. Supported values: Hourly or Daily."
         multi: false
         required: false
         show_user: true
diff --git a/packages/salesforce/data_stream/logout/fields/fields.yml b/packages/salesforce/data_stream/logout/fields/fields.yml
@@ -3,7 +3,7 @@
   fields:
     - name: instance_url
       type: keyword
-      description: The Instance URL of the Salesforce instance.
+      description: The Salesforce instance URL.
     - name: logout
       type: group
       fields:
@@ -23,7 +23,7 @@
             - name: type
               type: keyword
               description: >
-                The session type that was used when logging out (e.g. API, Oauth2 or UI).
+                The session type that was used when logging out (for example, API, OAuth 2.0, or UI).
 
         - name: login_key
           type: keyword
diff --git a/packages/salesforce/data_stream/logout/manifest.yml b/packages/salesforce/data_stream/logout/manifest.yml
@@ -10,51 +10,51 @@ streams:
         multi: false
         required: true
         show_user: false
-        default: 56.0
+        default: 65.0
       - name: event_log_file
         type: bool
         title: EventLogFile Data Collection
-        description: EventLogFile Data Collection to fetching logs from EventLogFile
+        description: "Enable collection from EventLogFile."
         multi: false
         required: true
         show_user: true
         default: true
       - name: object
         type: bool
         title: Real-Time Object Data Collection
-        description: Real-Time Data Collection to fetching logs from Real-Time Data
+        description: "Enable collection from real-time events (LogoutEvent)."
         multi: false
         required: true
         show_user: true
         default: true
       - name: elf_period
         type: text
         title: EventLogFile Period
-        description: EventLogFile Period of fetching logs. Supported units for this parameter are h/m/s.
+        description: "Polling interval for EventLogFile. Supported units: h, m, s."
         multi: false
         required: false
         show_user: true
         default: 1h
       - name: real_time_period
         type: text
         title: Real-Time Events Period
-        description: Real-Time Events Period of fetching logs. Supported units for this parameter are h/m/s.
+        description: "Polling interval for real-time events. Supported units: h, m, s."
         multi: false
         required: false
         show_user: true
         default: 5m
       - name: initial_interval
         type: text
         title: Initial Interval
-        description: Initial Interval to fetch historical data from. Supported units for this parameter are h/m/s.
+        description: "How far back to fetch historical data on the first run. Supported units: h, m, s."
         multi: false
         required: true
         show_user: true
         default: 168h
       - name: log_file_interval
         type: text
         title: EventLogFile Interval
-        description: EventLogFile Interval for Event Log. Supported values for this parameter are Hourly/Daily.
+        description: "EventLogFile granularity. Supported values: Hourly or Daily."
         multi: false
         required: false
         show_user: true
diff --git a/packages/salesforce/data_stream/setupaudittrail/fields/fields.yml b/packages/salesforce/data_stream/setupaudittrail/fields/fields.yml
@@ -3,7 +3,7 @@
   fields:
     - name: instance_url
       type: keyword
-      description: The Instance URL of the Salesforce instance.
+      description: The Salesforce instance URL.
     - name: setup_audit_trail
       type: group
       fields:
@@ -15,7 +15,7 @@
         - name: created_by_id
           type: keyword
           description: >
-            The id under which the Setup change was made. For example, if Einstein uses cloud-to-cloud services to make a change in Setup, the value of this field is id of Einstein.
+            The ID under which the Setup change was made. For example, if Einstein uses cloud-to-cloud services to make a change in Setup, this field contains the ID of Einstein.
 
         - name: created_by_issuer
           type: keyword
@@ -30,12 +30,12 @@
         - name: display
           type: keyword
           description: >
-            The full description of changes made in Setup. For example, if the Action field has a value of PermSetCreate, the Display field has a value like “Created permission set MAD: with user license Salesforce."
+            The full description of changes made in Setup. For example, if the Action field has a value of PermSetCreate, the Display field might be “Created permission set MAD: with user license Salesforce.”
 
         - name: responsible_namespace_prefix
           type: keyword
           description: >
-            Unknown
+            The namespace of the package responsible for this change, if applicable.
 
         - name: section
           type: keyword
diff --git a/packages/salesforce/data_stream/setupaudittrail/manifest.yml b/packages/salesforce/data_stream/setupaudittrail/manifest.yml
@@ -1,5 +1,5 @@
 type: logs
-title: Salesforce setupaudittrail logs
+title: Salesforce SetupAuditTrail logs
 streams:
   - input: salesforce
     vars:
@@ -10,19 +10,19 @@ streams:
         multi: false
         required: true
         show_user: false
-        default: 56.0
+        default: 65.0
       - name: period
         type: text
         title: Period
-        description: Period of fetching logs. Supported units for this parameter are h/m/s.
+        description: "Polling interval for fetching logs. Supported units: h, m, s."
         multi: false
         required: true
         show_user: true
         default: 1h
       - name: initial_interval
         type: text
         title: Initial Interval
-        description: Initial Interval to fetch historical data from. Supported units for this parameter are h/m/s.
+        description: "How far back to fetch historical data on the first run. Supported units: h, m, s."
         multi: false
         required: false
         show_user: true
diff --git a/packages/salesforce/docs/README.md b/packages/salesforce/docs/README.md
diff --git a/packages/salesforce/manifest.yml b/packages/salesforce/manifest.yml
