pict-section-formeditor 1.0.0

package/user-documentation/solverfunctions/dateseconddifference.md

@@ -0,0 +1,64 @@
+# dateseconddifference
+
+Calculates the difference between two dates in seconds.
+
+## Syntax
+
+```
+dateseconddifference(startDate, endDate)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `startDate` | String | Start date (ISO 8601 format) |
+| `endDate` | String | End date (ISO 8601 format) |
+
+## Returns
+
+String - The number of seconds between the two dates.
+
+## Description
+
+The `dateseconddifference` function calculates how many seconds have elapsed between two dates. The result is positive when endDate is after startDate, and negative otherwise.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = DATESECONDDIFFERENCE("2025-04-01T10:00:00.000Z", "2025-04-01T10:00:30.000Z")
+// Result: "30"
+```
+
+### Response Time
+
+```expression
+ResponseTime = DATESECONDDIFFERENCE(RequestSent, ResponseReceived)
+```
+
+### Timeout Check
+
+```expression
+SecondsSinceStart = DATESECONDDIFFERENCE(ProcessStart, Now)
+```
+
+## Use Cases
+
+- **Performance measurement**: Response times
+- **Timeouts**: Check elapsed time
+- **Rate limiting**: Time between requests
+- **Logging**: Precise durations
+
+## Related Functions
+
+- [datemilliseconddifference](./datemilliseconddifference.md) - Difference in milliseconds
+- [dateminutedifference](./dateminutedifference.md) - Difference in minutes
+- [dateaddseconds](./dateaddseconds.md) - Add seconds to a date
+
+## Notes
+
+- Uses ISO 8601 date format
+- Result can be negative
+- Uses the Dates service internally

package/user-documentation/solverfunctions/dateweekdifference.md

@@ -0,0 +1,65 @@
+# dateweekdifference
+
+Calculates the difference between two dates in weeks.
+
+## Syntax
+
+```
+dateweekdifference(startDate, endDate)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `startDate` | String | Start date (ISO 8601 format) |
+| `endDate` | String | End date (ISO 8601 format) |
+
+## Returns
+
+String - The number of weeks between the two dates.
+
+## Description
+
+The `dateweekdifference` function calculates how many weeks have elapsed between two dates. The result is positive when endDate is after startDate, and negative otherwise.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = DATEWEEKDIFFERENCE("2025-01-01T00:00:00.000Z", "2025-01-15T00:00:00.000Z")
+// Result: "2"
+```
+
+### Sprint Tracking
+
+```expression
+SprintsCompleted = DATEWEEKDIFFERENCE(ProjectStart, Today) / 2
+```
+
+### Weeks Until Deadline
+
+```expression
+WeeksRemaining = DATEWEEKDIFFERENCE(Today, Deadline)
+```
+
+## Use Cases
+
+- **Sprint planning**: Track sprint weeks
+- **Project management**: Weekly progress
+- **Scheduling**: Week-based planning
+- **Reporting**: Weekly reports
+
+## Related Functions
+
+- [datedaydifference](./datedaydifference.md) - Difference in days
+- [datemonthdifference](./datemonthdifference.md) - Difference in months
+- [dateaddweeks](./dateaddweeks.md) - Add weeks to a date
+
+## Notes
+
+- Uses ISO 8601 date format
+- One week equals 7 days
+- Result can be negative
+- Uses the Dates service internally

package/user-documentation/solverfunctions/dateyeardifference.md

@@ -0,0 +1,64 @@
+# dateyeardifference
+
+Calculates the difference between two dates in years.
+
+## Syntax
+
+```
+dateyeardifference(startDate, endDate)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `startDate` | String | Start date (ISO 8601 format) |
+| `endDate` | String | End date (ISO 8601 format) |
+
+## Returns
+
+String - The number of years between the two dates.
+
+## Description
+
+The `dateyeardifference` function calculates how many years have elapsed between two dates. The result is positive when endDate is after startDate, and negative otherwise.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = DATEYEARDIFFERENCE("2020-01-01T00:00:00.000Z", "2025-01-01T00:00:00.000Z")
+// Result: "5"
+```
+
+### Age Calculation
+
+```expression
+Age = DATEYEARDIFFERENCE(BirthDate, Today)
+```
+
+### Contract Duration
+
+```expression
+ContractYears = DATEYEARDIFFERENCE(StartDate, EndDate)
+```
+
+## Use Cases
+
+- **Age calculation**: Calculate age in years
+- **Anniversary**: Years since event
+- **Contracts**: Multi-year contract terms
+- **Experience**: Years of service
+
+## Related Functions
+
+- [datedaydifference](./datedaydifference.md) - Difference in days
+- [datemonthdifference](./datemonthdifference.md) - Difference in months
+- [dateaddyears](./dateaddyears.md) - Add years to a date
+
+## Notes
+
+- Uses ISO 8601 date format
+- Result can be negative
+- Uses the Dates service internally

package/user-documentation/solverfunctions/differencearrays.md

@@ -0,0 +1,59 @@
+# differencearrays
+
+Returns values in the first array that are not in the second array (set difference).
+
+## Syntax
+
+```
+differencearrays(array1, array2)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `array1` | Array | The array to filter |
+| `array2` | Array | The array of values to exclude |
+
+## Returns
+
+A new array containing only the values from `array1` that do not appear in `array2`.
+
+## Description
+
+The `differencearrays` function performs a set difference operation. It returns a new array containing every element from the first array that is not present in the second array. This is useful for finding items that exist in one list but not another, such as identifying incomplete tasks or missing items.
+
+## Examples
+
+### Finding incomplete items
+
+```expression
+OnlyInA = differencearrays(AllItems, CompletedItems)
+// If AllItems is ["A", "B", "C", "D"] and CompletedItems is ["B", "D"],
+// OnlyInA is ["A", "C"]
+```
+
+### Filtering out excluded options
+
+```expression
+Available = differencearrays(AllOptions, ExcludedOptions)
+// Returns only the options that have not been excluded
+```
+
+## Use Cases
+
+- **Tracking incomplete work**: Find items in a full list that are not in a completed list
+- **Filtering exclusions**: Remove specific entries from a list based on another list
+- **Identifying missing data**: Determine which expected values are absent from a dataset
+
+## Related Functions
+
+- [unionarrays](./unionarrays.md) - Returns all unique values from both arrays
+- [uniquearray](./uniquearray.md) - Removes duplicates from a single array
+- [sortarray](./sortarray.md) - Returns a sorted copy of an array
+
+## Notes
+
+- Both parameters must be arrays
+- The operation is directional: `differencearrays(A, B)` is not the same as `differencearrays(B, A)`
+- Duplicate values in `array1` that are not in `array2` may still appear in the result

package/user-documentation/solverfunctions/disablesolverordinal.md

@@ -0,0 +1,58 @@
+# disablesolverordinal
+
+Disables all solvers with the specified ordinal number so they will not execute.
+
+## Syntax
+
+```
+disablesolverordinal(ordinal)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `ordinal` | Integer | The ordinal number of the solver group to disable |
+
+## Returns
+
+Void. This function does not return a value.
+
+## Description
+
+The `disablesolverordinal` function disables all solvers assigned to a specific ordinal number, preventing them from executing during subsequent solver runs. This is a convenience function equivalent to calling `setsolverordinalenabled(ordinal, false)`. Disabled solvers are skipped entirely, which can improve performance and prevent unwanted calculations.
+
+## Examples
+
+### Disabling ordinal 3 solvers
+
+```expression
+disablesolverordinal(3)
+// All solvers with ordinal 3 will now be skipped during solver runs
+```
+
+### Disabling advanced calculations
+
+```expression
+disablesolverordinal(5)
+// Prevents ordinal 5 solvers from running
+```
+
+## Use Cases
+
+- **Skipping irrelevant calculations**: Disable solver groups that are not needed for the current form state
+- **Performance optimization**: Prevent unnecessary solver execution to improve responsiveness
+- **Mode switching**: Disable solver groups when switching between form modes
+
+## Related Functions
+
+- [setsolverordinalenabled](./setsolverordinalenabled.md) - Enables or disables solvers with a boolean
+- [enablesolverordinal](./enablesolverordinal.md) - Enables all solvers with the specified ordinal
+- [runsolvers](./runsolvers.md) - Triggers re-execution of all solver expressions
+
+## Notes
+
+- Equivalent to `setsolverordinalenabled(ordinal, false)`
+- The ordinal number must correspond to an ordinal defined in the solver configuration
+- Disabled solvers retain their configuration and can be re-enabled at any time
+- Changes take effect on the next solver run

package/user-documentation/solverfunctions/distributionhistogram.md

@@ -0,0 +1,96 @@
+# distributionhistogram
+
+Generates a histogram counting occurrences of each unique value.
+
+## Syntax
+
+```
+distributionhistogram(dataPath, keyProperty)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `dataPath` | String | Path to the data array (quoted string) |
+| `keyProperty` | String | Property name to count occurrences of |
+
+## Returns
+
+Object - A histogram object with unique values and their counts.
+
+## Description
+
+The `distributionhistogram` function creates a histogram by counting how many times each unique value appears in a dataset. This is useful for understanding the distribution of categorical data.
+
+## Examples
+
+### Basic Usage
+
+```expression
+// Given city data with a 'state' property
+DistributionResult = distributionhistogram("AppData.Cities", "state")
+
+// Result: {
+//   'Alabama': 12,
+//   'Colorado': 21,
+//   'Florida': 73,
+//   'Georgia': 18,
+//   // ... etc
+// }
+```
+
+### Counting Categories
+
+```expression
+// Count orders by status
+StatusCounts = distributionhistogram("AppData.Orders", "status")
+// Result: { 'pending': 45, 'shipped': 123, 'delivered': 89 }
+```
+
+### With Verification
+
+```expression
+// Verify distribution counts match data
+DistributionResult = distributionhistogram("AppData.Cities", "state")
+// DistributionResult.Alabama should equal 12
+// DistributionResult.Colorado should equal 21
+```
+
+## Use Cases
+
+- **Demographic analysis**: Count people by category
+- **Survey results**: Tally responses
+- **Quality metrics**: Distribution of defect types
+- **Inventory**: Count items by category
+- **Geographic analysis**: Records per region
+
+## Difference from aggregationhistogram
+
+| distributionhistogram | aggregationhistogram |
+|----------------------|---------------------|
+| Counts occurrences | Sums values |
+| One property (key) | Two properties (key, value) |
+| Result: counts | Result: sums |
+
+```expression
+// Distribution: How many cities per state?
+distributionhistogram("AppData.Cities", "state")
+// { 'California': 73, 'Texas': 51, ... }
+
+// Aggregation: Total population per state?
+aggregationhistogram("AppData.Cities", "state", "population")
+// { 'California': '39538223', 'Texas': '29145505', ... }
+```
+
+## Related Functions
+
+- [distributionhistogrambyobject](./distributionhistogrambyobject.md) - Takes object directly
+- [aggregationhistogram](./aggregationhistogram.md) - Sum values instead of count
+- [count](./count.md) - Simple count of elements
+
+## Notes
+
+- The data path must be a quoted string
+- Returns integer counts for each unique value
+- Works with the Math service's `histogramDistributionByExactValueFromInternalState` method

package/user-documentation/solverfunctions/distributionhistogrambyobject.md

@@ -0,0 +1,64 @@
+# distributionhistogrambyobject
+
+Generates a distribution histogram from an object directly.
+
+## Syntax
+
+```
+distributionhistogrambyobject(object, keyProperty)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `object` | Array | Array of objects to count |
+| `keyProperty` | String | Property name to count occurrences of |
+
+## Returns
+
+Object - A histogram object with unique values and their counts.
+
+## Description
+
+The `distributionhistogrambyobject` function is similar to `distributionhistogram` but takes an object/array directly instead of a data path string. This is useful when working with data that's already in a variable.
+
+## Examples
+
+### Basic Usage
+
+```expression
+// Given array of order data
+Orders = [
+  { id: 1, status: 'pending' },
+  { id: 2, status: 'shipped' },
+  { id: 3, status: 'pending' },
+  { id: 4, status: 'delivered' }
+]
+
+Result = DISTRIBUTIONHISTOGRAMBYOBJECT(Orders, "status")
+// Result: { 'pending': 2, 'shipped': 1, 'delivered': 1 }
+```
+
+### With Filtered Data
+
+```expression
+CategoryCounts = DISTRIBUTIONHISTOGRAMBYOBJECT(FilteredProducts, "category")
+```
+
+## Use Cases
+
+- **Dynamic data**: Count data already in variables
+- **Filtered data**: Count after filtering
+- **Chained operations**: Use in expression chains
+
+## Related Functions
+
+- [distributionhistogram](./distributionhistogram.md) - Uses data path string
+- [aggregationhistogrambyobject](./aggregationhistogrambyobject.md) - Sum by object
+- [count](./count.md) - Simple count
+
+## Notes
+
+- Takes array directly, not path string
+- Uses the Math service's `histogramDistributionByExactValue` method

package/user-documentation/solverfunctions/enablesolverordinal.md

@@ -0,0 +1,57 @@
+# enablesolverordinal
+
+Enables all solvers with the specified ordinal number so they will execute.
+
+## Syntax
+
+```
+enablesolverordinal(ordinal)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `ordinal` | Integer | The ordinal number of the solver group to enable |
+
+## Returns
+
+Void. This function does not return a value.
+
+## Description
+
+The `enablesolverordinal` function enables all solvers assigned to a specific ordinal number, ensuring they will execute during subsequent solver runs. This is a convenience function equivalent to calling `setsolverordinalenabled(ordinal, true)`. It is typically used to re-enable a group of solvers that was previously disabled.
+
+## Examples
+
+### Enabling ordinal 3 solvers
+
+```expression
+enablesolverordinal(3)
+// All solvers with ordinal 3 will now execute during solver runs
+```
+
+### Re-enabling solvers after a condition is met
+
+```expression
+enablesolverordinal(2)
+// Re-enables ordinal 2 solvers that were previously disabled
+```
+
+## Use Cases
+
+- **Re-enabling solvers**: Turn on a group of solvers that was previously disabled
+- **Workflow progression**: Enable additional solver groups as the user progresses through a form
+- **Conditional activation**: Enable solver groups when specific conditions are met
+
+## Related Functions
+
+- [setsolverordinalenabled](./setsolverordinalenabled.md) - Enables or disables solvers with a boolean
+- [disablesolverordinal](./disablesolverordinal.md) - Disables all solvers with the specified ordinal
+- [runsolvers](./runsolvers.md) - Triggers re-execution of all solver expressions
+
+## Notes
+
+- Equivalent to `setsolverordinalenabled(ordinal, true)`
+- The ordinal number must correspond to an ordinal defined in the solver configuration
+- Changes take effect on the next solver run

package/user-documentation/solverfunctions/entryinset.md

@@ -0,0 +1,72 @@
+# entryinset
+
+Checks if a value exists in a set/array.
+
+## Syntax
+
+```
+entryinset(value, set)
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `value` | Any | The value to search for |
+| `set` | Array | The array to search in |
+
+## Returns
+
+Boolean - True if the value exists in the set, false otherwise.
+
+## Description
+
+The `entryinset` function checks whether a specific value exists within an array or set. This is useful for membership testing and validation.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = ENTRYINSET(3, [1, 2, 3, 4, 5])
+// Result: true
+```
+
+### Not Found
+
+```expression
+Result = ENTRYINSET(10, [1, 2, 3, 4, 5])
+// Result: false
+```
+
+### With Variables
+
+```expression
+IsValidStatus = ENTRYINSET(OrderStatus, ["pending", "shipped", "delivered"])
+```
+
+### Validation
+
+```expression
+IsAllowedCategory = ENTRYINSET(Category, AllowedCategories)
+```
+
+## Use Cases
+
+- **Validation**: Check if value is allowed
+- **Filtering**: Conditional processing
+- **Membership**: Check set membership
+- **Logic**: Conditional branching
+
+## Related Functions
+
+- [findfirstvaluebyexactmatch](./findfirstvaluebyexactmatch.md) - Find value in array
+- [if](./if.md) - Use with conditional logic
+- [when](./when.md) - Conditional expression
+
+## Notes
+
+- Returns boolean (true/false)
+- Uses exact matching
+- Case-sensitive for strings
+- Uses the Math service's `entryInSet` method

package/user-documentation/solverfunctions/euler.md

@@ -0,0 +1,77 @@
+# euler
+
+Returns Euler's number (e) with high precision.
+
+## Syntax
+
+```
+euler()
+```
+
+## Parameters
+
+None.
+
+## Returns
+
+String - Euler's number (e) to 100 decimal places.
+
+## Description
+
+The `euler` function returns Euler's number (e ≈ 2.71828...), which is the base of natural logarithms. It's one of the most important constants in mathematics and appears in many areas including calculus, probability, and physics.
+
+## Examples
+
+### Basic Usage
+
+```expression
+Result = euler()
+// Result: "2.7182818284590452353602874713526624977572470936999595749669676277240766303535475945713821785251664274..."
+```
+
+### Exponential Growth
+
+```expression
+// Compound interest with continuous compounding
+// A = P * e^(rt)
+FinalAmount = Principal * euler()^(Rate * Time)
+```
+
+### Natural Logarithm Calculations
+
+```expression
+// e^x where x = 1
+Result = euler()^1
+// Result: e ≈ 2.71828...
+
+// From unit tests:
+Result = 2.71828182845905 ^ -0.282444
+```
+
+### In Complex Formulas
+
+```expression
+// Environmental calculation from unit tests
+EGS = ROUND(ROUND(0.0172834*2.71828182845905^(-0.0117685*Temp),5)*SQRT(ROUND(16.294-0.163*HR,1)/60),4)
+```
+
+## Use Cases
+
+- **Exponential growth/decay**: Population growth, radioactive decay
+- **Finance**: Continuous compound interest
+- **Probability**: Normal distribution calculations
+- **Calculus**: Natural logarithm and exponential functions
+- **Physics**: Decay processes, thermodynamics
+
+## Related Functions
+
+- [pi](./pi.md) - Pi constant
+- [exp](./exp.md) - e raised to a power
+- [log](./log.md) - Logarithm
+
+## Notes
+
+- Returns the full precision value stored in the Math service
+- Uses arbitrary precision arithmetic
+- Also known as Napier's constant
+- Approximately equal to 2.71828182845904523536...