mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-06 04:19:31 +00:00
Merge pull request #228 from sailpoint-oss/fix/docs-transforms-dateformat-datemath
Edited dateformat, datemath transform docs.
This commit is contained in:
@@ -19,9 +19,9 @@ This transform leverages the Java SimpleDateFormat syntax; see the [References](
|
||||
:::note Other Considerations
|
||||
|
||||
- In addition to explicit SimpleDateFormat syntax, the date format transform also recognizes several built-in "named" constructs:
|
||||
- **ISO8601:** This is the date format corresponding to the ISO8601 standard. The exact format is expressed as yyyy-MM-dd'T'HH:mm:ss.SSSX.
|
||||
- **LDAP:** This is the date format corresponding to the LDAP date format standard, also expressed as yyyyMMddHHmmss.Z.
|
||||
- **PEOPLE_SOFT:** This is the date format format used by People Soft, also expressed as MM/dd/yyyy.
|
||||
- **ISO8601:** This is the date format corresponding to the ISO8601 standard. The exact format is expressed as "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
|
||||
- **LDAP:** This is the date format corresponding to the LDAP date format standard, also expressed as "yyyyMMddHHmmss.Z".
|
||||
- **PEOPLE_SOFT:** This is the date format format used by People Soft, also expressed as "MM/dd/yyyy".
|
||||
- **EPOCH_TIME_JAVA:** This represents the incoming date value as the elapsed time in milliseconds from midnight, January 1st, 1970.
|
||||
- **EPOCH_TIME_WIN32:** This represents the incoming date value as the elapsed time in 100-nanosecond intervals from midnight, January 1st, 1601.
|
||||
|
||||
@@ -29,7 +29,7 @@ This transform leverages the Java SimpleDateFormat syntax; see the [References](
|
||||
|
||||
## Transform Structure
|
||||
|
||||
The date format transform takes whatever value provided as the input, parses the datetime based on the `inputFormat` provided, and then reformats it into the desired `outputFormat`.
|
||||
The date format transform takes whatever value provided as the input, parses the datetime based on the `inputFormat` provided, and then reformats it into the desired `outputFormat`.
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -53,7 +53,11 @@ The date format transform takes whatever value provided as the input, parses the
|
||||
- If no inputFormat is provided, the transform assumes that it is in [ISO8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
||||
- **outputFormat** - This string value indicates either the explicit SimpleDateFormat or the built-in named format that the data is formatted into.
|
||||
- If no outputFormat is provided, the transform assumes that it is in [ISO8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
||||
- **input** - This is an optional attribute that can explicitly define the input data passed into the transform logic. If no input is provided, the transform takes its input from the source and attribute combination configured with the UI.
|
||||
- **input** - This is an optional attribute that can explicitly define the input data passed into the transform logic. If no input is provided, the transform takes its input from the source and attribute combination configured with the UI.
|
||||
|
||||
:::note Important
|
||||
This transform does not currently support the "now" keyword as an input value.
|
||||
:::
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -14,19 +14,19 @@ tags: ['Transforms', 'Transform Operations']
|
||||
|
||||
Use the date math transform to add, subtract, and round components of a timestamp's incoming value. It also allows you to work with a referential value of "now" to run operations against the current date and time instead of a fixed value.
|
||||
|
||||
The output format for the DateMath transform is "yyyy-MM-dd'T'HH:mm." When you use this transform inside another transform (e.g., [dateCompare](./date-compare.md)), make sure to convert to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) first.
|
||||
The output format for the DateMath transform is "yyyy-MM-dd'T'HH:mm". When you use this transform inside another transform (e.g., [dateCompare](./date-compare.md)), make sure to convert to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) first.ADFJKL|:
|
||||
|
||||
|
||||
:::note Other Considerations
|
||||
|
||||
- The input datetime value must always be in [ISO8601 format](https://en.wikipedia.org/wiki/ISO_8601), in UTC time zone:
|
||||
|
||||
- yyyy-MM-ddThh:mm:ss:nnnZ
|
||||
- 2020-10-28T12:00:00.000Z, as an example
|
||||
- Use this format: "yyyy-MM-dd'T'HH:mm:ss.SSSZ", i.e., "2020-10-28T12:00:00.000Z".
|
||||
- The dateFormat transform can help get data into this format.
|
||||
|
||||
- The industry standard for rounding is actually date/time truncation. When rounding down, the fractional value is truncated from the incoming data. When rounding up, the fractional value is truncated and the next unit of time is added. Refer to the Transform Structure section below for examples.
|
||||
- When you are rounding, the "week" unit of time is not supported as a metric, and attempting to round up or down a week will result in an error.
|
||||
- If you are using the "now" keyword and an input date is also applied as the implicitly or explicitly definted input parameter, the transform prefers using "now" and ignores the data in the `input` attribute.
|
||||
- The industry standard for rounding is actually date/time truncation. When the transform is rounding down, it truncates the the fractional value from the incoming data. When the transform is rounding up, it truncates the fractional value and adds the next unit of time. For examples, refer to the [Transform Structure](#transform-structure).
|
||||
- The "week" unit of time is not supported as a metric when you are rounding. Rounding up or down a week will result in an error.
|
||||
- If you are using the "now" keyword and you have also applied an input date as the implicitly or explicitly definted input parameter, the transform prefers using "now" and ignores the data in the `input` attribute.
|
||||
|
||||
:::
|
||||
|
||||
@@ -79,7 +79,7 @@ Some examples of expressions are:
|
||||
|
||||
- **Required Attributes**
|
||||
|
||||
- **type** - This must always be set to `dateMath.`
|
||||
- **type** - This must always be set to `dateMath`.
|
||||
- **name** - This is a required attribute for all transforms. It represents the name of the transform as it will appear in the UI's dropdown menus.
|
||||
- **expression** - A string value of the date and time components to operate on, along with the math operations to execute. Multiple operations on multiple components are supported.
|
||||
|
||||
@@ -146,7 +146,7 @@ This transform takes the `startDate` attribute from a user's record in the "HR S
|
||||
|
||||
<p> </p>
|
||||
|
||||
This transform take the `HIREDATE` from Workday and converts it to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) to be used in the Date Math transform. The Date Math transform then creates a new Date of `HIREDATE + 1`. Since that is then outputted in the format "yyyy-MM-dd'T'HH:mm," you can then use it in a [dateFormat](/idn/docs/transforms/operations/date-format) transform to give a WIN32 formatted date.
|
||||
This transform take the `HIREDATE` from Workday and converts it to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) to be used in the Date Math transform. The Date Math transform then creates a new Date of `HIREDATE + 1`. Since that is then outputted in the format "yyyy-MM-dd'T'HH:mm", you can then use it in a [dateFormat](/idn/docs/transforms/operations/date-format) transform to give a WIN32 formatted date.
|
||||
|
||||
**Transform Request Body**:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user