-When you are mapping values like a username, focus on primary accounts from a -particular source or accounts that are not service accounts. +When you are mapping values like a username, focus on primary accounts from a particular source or accounts that are not service accounts. -- `sourceName` is "Active Directory" because that is the source this data is - coming from. -- `attributeName` is "sAMAccountName" because you are mapping the username of - the user. -- `accountFilter` is an expression filtering the accounts to make sure they are - not service accounts. +- `sourceName` is "Active Directory" because that is the source this data is coming from. +- `attributeName` is "sAMAccountName" because you are mapping the username of the user. +- `accountFilter` is an expression filtering the accounts to make sure they are not service accounts. :::info diff --git a/products/idn/docs/identity-now/transforms/operations/base64-decode.md b/products/idn/docs/identity-now/transforms/operations/base64-decode.md index 0e1025e95..0fad59749 100644 --- a/products/idn/docs/identity-now/transforms/operations/base64-decode.md +++ b/products/idn/docs/identity-now/transforms/operations/base64-decode.md @@ -4,27 +4,21 @@ title: Base64 Decode pagination_label: Base64 Decode sidebar_label: Base64 Decode sidebar_class_name: base64Decode -keywords: ["transforms", "operations", "base64", "decode"] +keywords: ['transforms', 'operations', 'base64', 'decode'] description: Render base64 data in its original binary format. slug: /docs/transforms/operations/base64-decode -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Base64 is mostly used to encode binary data like images so that the data can be -represented as a string within HTML, email, or other text documents. Base64 is -also commonly used to encode data that can be unsupported or damaged during -transfer, storage, or output. +Base64 is mostly used to encode binary data like images so that the data can be represented as a string within HTML, email, or other text documents. Base64 is also commonly used to encode data that can be unsupported or damaged during transfer, storage, or output. -The base64 decode transform allows you to take incoming data that has been -encoded using a Base64-based text encoding scheme and render the data in its -original binary format. +The base64 decode transform allows you to take incoming data that has been encoded using a Base64-based text encoding scheme and render the data in its original binary format. :::note Other Considerations -- If the input to the Base64 decode transform is null, the transform returns a - null value. +- If the input to the Base64 decode transform is null, the transform returns a null value. ::: @@ -43,18 +37,13 @@ The base64 decode transform only requires the `type` and `name` attributes: - **Required Attributes** - **type** - This must be set to `base64Decode`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. ## Examples -This example takes the incoming attribute configured in the identity profile -attribute UI, assumes it is a Base64 encoded string, and returns its original -binary value. +This example takes the incoming attribute configured in the identity profile attribute UI, assumes it is a Base64 encoded string, and returns its original binary value. Input: @@ -81,8 +70,7 @@ Output:
-This example takes the incoming attribute configured in the identity profile -attribute UI, assumes it is a Base64 encoded string, and returns it as an image. +This example takes the incoming attribute configured in the identity profile attribute UI, assumes it is a Base64 encoded string, and returns it as an image. Input: diff --git a/products/idn/docs/identity-now/transforms/operations/base64-encode.md b/products/idn/docs/identity-now/transforms/operations/base64-encode.md index a6e8d5f4b..4e5a91153 100644 --- a/products/idn/docs/identity-now/transforms/operations/base64-encode.md +++ b/products/idn/docs/identity-now/transforms/operations/base64-encode.md @@ -4,27 +4,21 @@ title: Base64 Encode pagination_label: Base64 Encode sidebar_label: Base64 Encode sidebar_class_name: base64Encode -keywords: ["transforms", "operations", "base64", "encode"] +keywords: ['transforms', 'operations', 'base64', 'encode'] description: Encode data with a Base64-based text encoding scheme. slug: /docs/transforms/operations/base64-encode -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Base64 is mostly used to encode binary data like images so that the data can be -represented as a string within HTML, email or other text documents. Base64 is -also commonly used to encode data that can be unsupported or damaged during -transfer, storage, or output. +Base64 is mostly used to encode binary data like images so that the data can be represented as a string within HTML, email or other text documents. Base64 is also commonly used to encode data that can be unsupported or damaged during transfer, storage, or output. -The base64 encode transform allows you to take incoming data and encode it using -a Base64-based text encoding scheme. The output of the transform is a string -comprising 64 basic ASCII characters. +The base64 encode transform allows you to take incoming data and encode it using a Base64-based text encoding scheme. The output of the transform is a string comprising 64 basic ASCII characters. :::note Other Considerations -- If the input to the Base64 encode transform is null, the transform returns a - null value. +- If the input to the Base64 encode transform is null, the transform returns a null value. ::: @@ -43,17 +37,13 @@ The Base64 encode transform only requires the `type` and `name` attributes: - **Required Attributes** - **type** - This must be set to `base64Encode`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. ## Examples -This example takes the incoming attribute configured in the identity profile -attribute UI and returns it as a Base64 encoded string. +This example takes the incoming attribute configured in the identity profile attribute UI and returns it as a Base64 encoded string. Input: @@ -80,8 +70,7 @@ MTIzNA==
-This example takes a binary image as in input and returns it as a Base64 encoded -string. +This example takes a binary image as in input and returns it as a Base64 encoded string. Input: diff --git a/products/idn/docs/identity-now/transforms/operations/concatenation.md b/products/idn/docs/identity-now/transforms/operations/concatenation.md index bc50d30ab..126f1d388 100644 --- a/products/idn/docs/identity-now/transforms/operations/concatenation.md +++ b/products/idn/docs/identity-now/transforms/operations/concatenation.md @@ -4,23 +4,19 @@ title: Concatenation pagination_label: Concatenation sidebar_label: Concatenation sidebar_class_name: concatenation -keywords: ["transforms", "operations", "concatenation"] +keywords: ['transforms', 'operations', 'concatenation'] description: Join two or more string values into a combined output. slug: /docs/transforms/operations/concatenation -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the concatenation transform to join two or more string values into a -combined output. The concatenation transform often joins elements such as first -and last name into a full display name, but it has many other uses. +Use the concatenation transform to join two or more string values into a combined output. The concatenation transform often joins elements such as first and last name into a full display name, but it has many other uses. ## Transform Structure -The concatenation transform requires an array list of `values` that need to be -joined. These values can be static strings or the return values of other nested -transforms. +The concatenation transform requires an array list of `values` that need to be joined. These values can be static strings or the return values of other nested transforms. ```json { @@ -36,19 +32,14 @@ transforms. - **Required Attributes** - **type** - This must always be set to `concat`. - - **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. + - **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. - **values** - This is the array of items to join. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. ## Examples -This transform joins the user's first name from the "HR Source" with his/her -last name, adds a space between them, and then adds a parenthetical note that -the user is a contractor at the end. +This transform joins the user's first name from the "HR Source" with his/her last name, adds a space between them, and then adds a parenthetical note that the user is a contractor at the end. **Transform Request Body**: @@ -83,8 +74,7 @@ the user is a contractor at the end.
-This transform joins the user's job title with his/her job code value and adds a -hyphen between those two pieces of data. +This transform joins the user's job title with his/her job code value and adds a hyphen between those two pieces of data. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/conditional.md b/products/idn/docs/identity-now/transforms/operations/conditional.md index 50d5c9730..e33525575 100644 --- a/products/idn/docs/identity-now/transforms/operations/conditional.md +++ b/products/idn/docs/identity-now/transforms/operations/conditional.md @@ -4,36 +4,27 @@ title: Conditional pagination_label: Conditional sidebar_label: Conditional sidebar_class_name: conditional -keywords: ["transforms", "operations", "conditional"] +keywords: ['transforms', 'operations', 'conditional'] description: Output different values depending on simple conditional logic. slug: /docs/transforms/operations/conditional -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the conditional transform to output different values depending on simple -conditional logic. This is a convenient transform - the same capability can be -implemented with a "static" transform, but this transform has greater simplicity -and null-safe error checking. +Use the conditional transform to output different values depending on simple conditional logic. This is a convenient transform - the same capability can be implemented with a "static" transform, but this transform has greater simplicity and null-safe error checking. :::note Other Considerations -- The two operands within the transform cannot be null; if they are, an - IllegalArgumentException is thrown. -- The `expression` attribute must be "eq," or the transform will throw an - IllegalArgumentException. -- All attribute string values are case-sensitive, so differently cased strings - (e.g., "engineering" and "Engineering") will not return as matched. +- The two operands within the transform cannot be null; if they are, an IllegalArgumentException is thrown. +- The `expression` attribute must be "eq," or the transform will throw an IllegalArgumentException. +- All attribute string values are case-sensitive, so differently cased strings (e.g., "engineering" and "Engineering") will not return as matched. ::: ## Transform Structure -In addition to the `type` and `name` attributes, the conditional transform -requires an `expression`, a `positiveCondition`, and a `negativeCondition`. If -the expression evaluates to false, the transform returns the negative condition; -otherwise it returns the positive condition. +In addition to the `type` and `name` attributes, the conditional transform requires an `expression`, a `positiveCondition`, and a `negativeCondition`. If the expression evaluates to false, the transform returns the negative condition; otherwise it returns the positive condition. ```json { @@ -51,25 +42,16 @@ otherwise it returns the positive condition. - **Required Attributes** - **type** - This must always be set to `conditional`. - - **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** - This comparison statement follows the structure of - `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs - of other transforms; the `eq` operator is the only valid comparison. - - **positiveCondition** - This is the output of the transform if the - expression evaluates to true. - - **negativeCondition** - This is the output of the transform if the - expression evaluates to false. + - **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** - This comparison statement follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms; the `eq` operator is the only valid comparison. + - **positiveCondition** - This is the output of the transform if the expression evaluates to true. + - **negativeCondition** - This is the output of the transform if the expression evaluates to false. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. ## Examples -This transform takes the user's HR-defined department attribute and compares it -to the value of "Science". If this is the user's department, the transform -returns `true`. Otherwise, it returns `false`. +This transform takes the user's HR-defined department attribute and compares it to the value of "Science". If this is the user's department, the transform returns `true`. Otherwise, it returns `false`. **Transform Request Body**: @@ -96,10 +78,7 @@ returns `true`. Otherwise, it returns `false`.
-This transform extends the previous one by returning the output of another -Seaspray transform depending on the result of the expression. You can assign -Seaspray transforms' outputs to variables and then reference them within the -`positiveCondition` and `negativeCondition` attributes. +This transform extends the previous one by returning the output of another Seaspray transform depending on the result of the expression. You can assign Seaspray transforms' outputs to variables and then reference them within the `positiveCondition` and `negativeCondition` attributes. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/date-compare.md b/products/idn/docs/identity-now/transforms/operations/date-compare.md index 26db26730..ed26a06f5 100644 --- a/products/idn/docs/identity-now/transforms/operations/date-compare.md +++ b/products/idn/docs/identity-now/transforms/operations/date-compare.md @@ -4,39 +4,26 @@ title: Date Compare pagination_label: Date Compare sidebar_label: Date Compares sidebar_class_name: dateCompare -keywords: ["transforms", "operations", "date", "compare"] +keywords: ['transforms', 'operations', 'date', 'compare'] description: Compare two dates and return a calculated value. slug: /docs/transforms/operations/date-compare -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the date compare transform to compare two dates and, depending on the -comparison result, return one value if one date is after the other or return a -different value if it is before the other. A common use case is to calculate -lifecycle states (e.g., the user is "active" if the current date is greater than -or equal to the user's hire date, etc.). +Use the date compare transform to compare two dates and, depending on the comparison result, return one value if one date is after the other or return a different value if it is before the other. A common use case is to calculate lifecycle states (e.g., the user is "active" if the current date is greater than or equal to the user's hire date, etc.). :::note Other Considerations -- In addition to explicit date values, the transform recognizes the "now" - keyword that always evaluates to the exact date and time when the transform is - evaluating. -- All dates **must** be in - [ISO8601 format](https://en.wikipedia.org/wiki/ISO_8601) in order for the date - compare transform to evaluate properly. +- In addition to explicit date values, the transform recognizes the "now" keyword that always evaluates to the exact date and time when the transform is evaluating. +- All dates **must** be in [ISO8601 format](https://en.wikipedia.org/wiki/ISO_8601) in order for the date compare transform to evaluate properly. ::: ## Transform Structure -The date compare transform takes as an input the two dates to compare, denoted -as `firstDate` and `secondDate`. The transform also requires an `operator` -designation so it knows which condition to evaluate for. Lastly, the transform -requires both a `positiveCondition` and a `negativeCondition` -- the former -returns if the comparison evaluates to `true`; the latter returns if the -comparison evaluates to `false`. +The date compare transform takes as an input the two dates to compare, denoted as `firstDate` and `secondDate`. The transform also requires an `operator` designation so it knows which condition to evaluate for. Lastly, the transform requires both a `positiveCondition` and a `negativeCondition` -- the former returns if the comparison evaluates to `true`; the latter returns if the comparison evaluates to `false`. ```json { @@ -62,33 +49,22 @@ comparison evaluates to `false`. - **Required Attributes** - **type** - This must always be set to `dateCompare`. - - **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. - - **firstDate** - This is the first date to consider (i.e., the date that - would be on the left hand side of the comparison operation). - - **secondDate** - This is the second date to consider (i.e., the date that - would be on the right hand side of the comparison operation). - - **operator** - This is the comparison to perform. The following values are - valid: + - **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. + - **firstDate** - This is the first date to consider (i.e., the date that would be on the left hand side of the comparison operation). + - **secondDate** - This is the second date to consider (i.e., the date that would be on the right hand side of the comparison operation). + - **operator** - This is the comparison to perform. The following values are valid: - **LT**: Strictly less than: firstDate < secondDate - **LTE**: Less than or equal to: firstDate <= secondDate - **GT**: Strictly greater than: firstDate > secondDate - **GTE**: Greater than or equal to: firstDate >= secondDate - - **positiveCondition** - This is the value to return if the comparison is - true. - - **negativeCondition** - This is the value to return if the comparison is - false. + - **positiveCondition** - This is the value to return if the comparison is true. + - **negativeCondition** - This is the value to return if the comparison is false. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. The default value is `false`. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. The default value is `false`. ## Examples -This transform accomplishes a basic lifecycle state calculation. It compares the -user's termination date with his/her HR record. If the current datetime (denoted -by `now`) is less than that date, the transform returns "active". If the current -datetime is greater than that date, the transform returns "terminated". +This transform accomplishes a basic lifecycle state calculation. It compares the user's termination date with his/her HR record. If the current datetime (denoted by `now`) is less than that date, the transform returns "active". If the current datetime is greater than that date, the transform returns "terminated". **Transform Request Body**: @@ -116,9 +92,7 @@ datetime is greater than that date, the transform returns "terminated".
-This transform compares the user's hire date to a fixed date in the past. If the -user was hired prior to January 1, 1996, the transform returns "legacy". If the -user was hired later than January 1, 1996, it returns "regular". +This transform compares the user's hire date to a fixed date in the past. If the user was hired prior to January 1, 1996, the transform returns "legacy". If the user was hired later than January 1, 1996, it returns "regular". **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/date-format.md b/products/idn/docs/identity-now/transforms/operations/date-format.md index 09fe65bcc..075c874a9 100644 --- a/products/idn/docs/identity-now/transforms/operations/date-format.md +++ b/products/idn/docs/identity-now/transforms/operations/date-format.md @@ -4,43 +4,32 @@ title: Date Format pagination_label: Date Format sidebar_label: Date Format sidebar_class_name: dateFormat -keywords: ["transforms", "operations", "date", "format"] +keywords: ['transforms', 'operations', 'date', 'format'] description: Convert datetime strings from one format to another. slug: /docs/transforms/operations/date-format -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the date format transform to convert datetime strings from one format to -another. This is often useful when you are syncing data from one system to -another, where each application uses a different format for date and time data. +Use the date format transform to convert datetime strings from one format to another. This is often useful when you are syncing data from one system to another, where each application uses a different format for date and time data. -This transform leverages the Java SimpleDateFormat syntax; see the -[References](#references) section for more information on this standard. +This transform leverages the Java SimpleDateFormat syntax; see the [References](#references) section for more information on this standard. :::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. - - **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. +- 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. + - **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. ::: ## 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 { @@ -57,30 +46,18 @@ desired `outputFormat`. - **Required Attributes** - **type** - This must always be set to `dateFormat`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **inputFormat** - This string value indicates either the explicit - SimpleDateFormat or the built-in named format of the incoming data. - - 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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **inputFormat** - This string value indicates either the explicit SimpleDateFormat or the built-in named format of the incoming data. + - 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. ## Examples -This transform takes the incoming Java epoch-based timestamp and formats it as -an ISO8601 compatible string. +This transform takes the incoming Java epoch-based timestamp and formats it as an ISO8601 compatible string. ```bash Input: 144642632190 @@ -104,8 +81,7 @@ Output: 1974-08-02T02:30:32.190-00
-This transform takes the incoming date, formatted as a common US date string, -and formats it to match the date structure of most database systems. +This transform takes the incoming date, formatted as a common US date string, and formats it to match the date structure of most database systems. ```bash Input: 4/1/1975 diff --git a/products/idn/docs/identity-now/transforms/operations/date-math.md b/products/idn/docs/identity-now/transforms/operations/date-math.md index 45ad3bb02..46eb29658 100644 --- a/products/idn/docs/identity-now/transforms/operations/date-math.md +++ b/products/idn/docs/identity-now/transforms/operations/date-math.md @@ -4,53 +4,35 @@ title: Date Math pagination_label: Date Math sidebar_label: Date Math sidebar_class_name: dateMath -keywords: ["transforms", "operations", "date", "math"] +keywords: ['transforms', 'operations', 'date', 'math'] description: Add, subtract, and round components of a timestamp's incoming value. slug: /docs/transforms/operations/date-math -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -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. +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. :::note Other Considerations -- The input datetime value must always be in - [ISO8601 format](https://en.wikipedia.org/wiki/ISO_8601), in UTC time zone: +- 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 - 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 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. ::: ## Transform Structure -The date math transform takes the input value and executes addition, subtraction -and/or rounding operations to that value based on an `expression` configuration -value. As indicated earlier, the input datetime must be in -[ISO8601 format](https://en.wikipedia.org/wiki/ISO_8601). The `expression` value -leverages the following abbreviations to indicate which date or time component -to evaluate: +The date math transform takes the input value and executes addition, subtraction and/or rounding operations to that value based on an `expression` configuration value. As indicated earlier, the input datetime must be in [ISO8601 format](https://en.wikipedia.org/wiki/ISO_8601). The `expression` value leverages the following abbreviations to indicate which date or time component to evaluate: > - "y" - year > - "M" - month @@ -70,14 +52,10 @@ Also, the operational logic is defined by usage of one of the following symbols: Some examples of expressions are: > - `"expression": "now"` returns the current date and time. -> - `"expression": "now/h"` returns the current date and time, rounded to the -> hour. +> - `"expression": "now/h"` returns the current date and time, rounded to the hour. > - `"expression": "now+1w"` returns one week from the current date and time. -> - `"expression": "now+1y+1M+2d-4h+1m-3s/s"` returns the current date and time -> plus one year, one month, two days, minus four hours, plus one minute and -> minus three seconds, rounded to the second. -> - `"expression": "+3M"` returns the date and time that would be three months -> more than the value provided as an input to the transform. +> - `"expression": "now+1y+1M+2d-4h+1m-3s/s"` returns the current date and time plus one year, one month, two days, minus four hours, plus one minute and minus three seconds, rounded to the second. +> - `"expression": "+3M"` returns the date and time that would be three months more than the value provided as an input to the transform. ```json { @@ -102,34 +80,21 @@ Some examples of expressions are: - **Required Attributes** - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **roundUp** - This `true` or `false` value indicates whether the transform - rounds up or down when the `expression` defines a rounding ("/") operation. - If this value is not provided, the transform defaults to `false`. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **roundUp** - This `true` or `false` value indicates whether the transform rounds up or down when the `expression` defines a rounding ("/") operation. If this value is not provided, the transform defaults to `false`. - - `true` indicates the transform rounds up (i.e., truncate the fractional - date/time component indicated and then add one unit of that component). - - `false` indicates the transform rounds down (i.e., truncate the fractional - date/time component indicated). - - `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. + - `true` indicates the transform rounds up (i.e., truncate the fractional date/time component indicated and then add one unit of that component). + - `false` indicates the transform rounds down (i.e., truncate the fractional date/time component indicated). + - `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. ## Examples -This transform takes the current date, subtracts five days from it, and rounds -down to the lowest day. +This transform takes the current date, subtracts five days from it, and rounds down to the lowest day. **Transform Request Body**: @@ -148,10 +113,7 @@ down to the lowest day.
-This transform takes the `startDate` attribute from a user's record in the "HR -Source," converts it from its native format to an -[ISO8601-formatted](https://en.wikipedia.org/wiki/ISO_8601) string, and then -adds twelve hours to it. The final value is then rounded up to the next second. +This transform takes the `startDate` attribute from a user's record in the "HR Source," converts it from its native format to an [ISO8601-formatted](https://en.wikipedia.org/wiki/ISO_8601) string, and then adds twelve hours to it. The final value is then rounded up to the next second. **Transform Request Body**: @@ -184,12 +146,7 @@ adds twelve hours to it. The final value is then rounded up to the next second.
-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**: diff --git a/products/idn/docs/identity-now/transforms/operations/decompose-diacritical-marks.md b/products/idn/docs/identity-now/transforms/operations/decompose-diacritical-marks.md index e1f22418e..f14ea6e3c 100644 --- a/products/idn/docs/identity-now/transforms/operations/decompose-diacritical-marks.md +++ b/products/idn/docs/identity-now/transforms/operations/decompose-diacritical-marks.md @@ -4,18 +4,15 @@ title: Decompose Diacritial Marks pagination_label: Decompose Diacritial Marks sidebar_label: Decompose Diacritial Marks sidebar_class_name: decomposeDiacriticalMarks -keywords: ["transforms", "operations", "decompose", "diacritical", "marks"] +keywords: ['transforms', 'operations', 'decompose', 'diacritical', 'marks'] description: Clean or standardize symbols used within language. slug: /docs/transforms/operations/decompose-diacritical-marks -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the decompose diacritical marks transform to clean or standardize symbols -used within language to inform the reader how to say or pronounce a letter. -These symbols are often incompatible with downstream applications and must be -standardized to another character set such as ASCII. +Use the decompose diacritical marks transform to clean or standardize symbols used within language to inform the reader how to say or pronounce a letter. These symbols are often incompatible with downstream applications and must be standardized to another character set such as ASCII. The following are examples of diacritical marks: @@ -26,8 +23,7 @@ The following are examples of diacritical marks: ## Transform Structure -The transform for decompose diacritical marks requires only the transform's -`type` and `name` attributes: +The transform for decompose diacritical marks requires only the transform's `type` and `name` attributes: ```json { @@ -41,18 +37,12 @@ The transform for decompose diacritical marks requires only the transform's - **Required Attributes** - **type** - This must always be set to `decomposeDiacriticalMarks`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples @@ -74,8 +64,7 @@ Output: "Aric"
-This transform takes the user's "LastName" attribute from the "HR Source" and -replaces any diacritical marks with ASCII-compatible values. +This transform takes the user's "LastName" attribute from the "HR Source" and replaces any diacritical marks with ASCII-compatible values. ```bash Input: "Dubçek" diff --git a/products/idn/docs/identity-now/transforms/operations/e164-phone.md b/products/idn/docs/identity-now/transforms/operations/e164-phone.md index 130041620..0f64e1944 100644 --- a/products/idn/docs/identity-now/transforms/operations/e164-phone.md +++ b/products/idn/docs/identity-now/transforms/operations/e164-phone.md @@ -4,28 +4,25 @@ title: E.164 Phone pagination_label: E.164 Phone sidebar_label: E.164 Phone sidebar_class_name: e164Phone -keywords: ["transforms", "operations", "e164", "phone"] +keywords: ['transforms', 'operations', 'e164', 'phone'] description: Convert a phone number string into an E.164-compatible number. slug: /docs/transforms/operations/e164-phone -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the E.164 phone transform to convert an incoming phone number string into an -E.164-compatible number. +Use the E.164 phone transform to convert an incoming phone number string into an E.164-compatible number. :::note Other Considerations -- If the input string to the transform does not represent a valid phone number, - the transform returns null. +- If the input string to the transform does not represent a valid phone number, the transform returns null. ::: ## Transform Structure -The E.164 phone transform only requires the transform's `type` and `name` -attributes: +The E.164 phone transform only requires the transform's `type` and `name` attributes: ```json { @@ -39,26 +36,16 @@ attributes: - **Required Attributes** - **type** - This must always be set to `E.164phone.` - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. - - **defaultRegion** - This is an optional attribute used to define the phone - number region to format into. If no defaultRegion is provided, the transform - takes US as the default country. The format of the country code must be in - [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. + - **defaultRegion** - This is an optional attribute used to define the phone number region to format into. If no defaultRegion is provided, the transform takes US as the default country. The format of the country code must be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). ## Examples -This transform transforms a phone number seperated by `-` into the E.164 Phone -format. +This transform transforms a phone number seperated by `-` into the E.164 Phone format. ```bash Input: "512-777-2222" @@ -86,8 +73,7 @@ Output: "+1512459222"
-This transform transforms a phone number seperated by `.` into the E.164 Phone -format. +This transform transforms a phone number seperated by `.` into the E.164 Phone format. ```bash Input: "779.284.2727" @@ -115,8 +101,7 @@ Output: "+17792842727"
-This transform transforms a phone number and country region code into the E.164 -Phone format. +This transform transforms a phone number and country region code into the E.164 Phone format. ```bash Input: "0412345678" diff --git a/products/idn/docs/identity-now/transforms/operations/first-valid.md b/products/idn/docs/identity-now/transforms/operations/first-valid.md index a32c99e37..5c4cd70ee 100644 --- a/products/idn/docs/identity-now/transforms/operations/first-valid.md +++ b/products/idn/docs/identity-now/transforms/operations/first-valid.md @@ -4,31 +4,19 @@ title: First Valid pagination_label: First Valid sidebar_label: First Valid sidebar_class_name: firstValid -keywords: ["transforms", "operations", "first", "valid"] +keywords: ['transforms', 'operations', 'first', 'valid'] description: Return the first piece of data that is not null. slug: /docs/transforms/operations/first-valid -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the first valid transform to perform if/then/else operations on multiple -different data points to return the first piece of data that is not null. This -is often useful for the SailPoint username (uid) attribute in which case each -identity requires a value, but the desired information is not available yet -(e.g., Active Directory username). In these cases, you can use a first valid -transform to populate the uid attribute with the user's linked Active Directory -(AD) account information if the uid attribute is not null. If the attribute is -null, use a different attribute from a source that the user does have, like -his/her employee number. +Use the first valid transform to perform if/then/else operations on multiple different data points to return the first piece of data that is not null. This is often useful for the SailPoint username (uid) attribute in which case each identity requires a value, but the desired information is not available yet (e.g., Active Directory username). In these cases, you can use a first valid transform to populate the uid attribute with the user's linked Active Directory (AD) account information if the uid attribute is not null. If the attribute is null, use a different attribute from a source that the user does have, like his/her employee number. ## Transform Structure -The first valid transform requires an array list of `values` that you must -consider. These can be static strings or other nested transforms' return values. -Remember that the transform returns the first entry in the array that evaluates -to a non-null value, so you are recommended to provide the entries in the array -in descending order of preference. +The first valid transform requires an array list of `values` that you must consider. These can be static strings or other nested transforms' return values. Remember that the transform returns the first entry in the array that evaluates to a non-null value, so you are recommended to provide the entries in the array in descending order of preference. ```json { @@ -66,22 +54,15 @@ in descending order of preference. - **Required Attributes** - **type** - This must always be set to `firstValid`. - - **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. + - **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. - **values** - This is an array of attributes to evaluate for existence. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **ignoreErrors** - This `true` or `false` value indicates whether to proceed - to the next option if an error (like an NPE) occurs. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **ignoreErrors** - This `true` or `false` value indicates whether to proceed to the next option if an error (like an NPE) occurs. ## Examples -This transform first attempts to return the user's `sAMAccountName` from his/her -AD account. In the event that the user does not have an AD account, the -transform then attempts to return the user's Okta login. If the Okta login is -also blank, the transform returns the user's employee ID from his/her HR record. +This transform first attempts to return the user's `sAMAccountName` from his/her AD account. In the event that the user does not have an AD account, the transform then attempts to return the user's Okta login. If the Okta login is also blank, the transform returns the user's employee ID from his/her HR record. **Transform Request Body**: @@ -121,12 +102,7 @@ also blank, the transform returns the user's employee ID from his/her HR record.
-This transform is often useful for populating the work email identity attribute. -Since the work email attribute is a required field for a valid identity, it -cannot be blank. However, often new hires do not have an AD account and/or email -provisioned until after the user has been provisioned. A common practice in this -situation is to return a static string of "none" to ensure that this required -attribute does not remain empty. +This transform is often useful for populating the work email identity attribute. Since the work email attribute is a required field for a valid identity, it cannot be blank. However, often new hires do not have an AD account and/or email provisioned until after the user has been provisioned. A common practice in this situation is to return a static string of "none" to ensure that this required attribute does not remain empty. **Transform Request Body**: @@ -158,16 +134,7 @@ attribute does not remain empty.
-This transform is often useful for populating an attribute called "Manager DN". -It pulls the manager of the identity and then gets the identity attribute -"Network DN" for the manager. "Network DN" pulls directly from -`distinguishedName` in AD. With this transform, you can set a user's manager's -DN as an identity attribute to allow for attribute sync down to AD. Without -`ignoreErrors` set to `true`, this transform throws a null pointer exception -(NPE) for any user without a manager. With `ignoreErrors` set to true, the first -value in the `firstValid` throws an error for users without managers, but the -error is ignored, and the transform selects the empty string to set the "Manager -DN" identity attribute to. +This transform is often useful for populating an attribute called "Manager DN". It pulls the manager of the identity and then gets the identity attribute "Network DN" for the manager. "Network DN" pulls directly from `distinguishedName` in AD. With this transform, you can set a user's manager's DN as an identity attribute to allow for attribute sync down to AD. Without `ignoreErrors` set to `true`, this transform throws a null pointer exception (NPE) for any user without a manager. With `ignoreErrors` set to true, the first value in the `firstValid` throws an error for users without managers, but the error is ignored, and the transform selects the empty string to set the "Manager DN" identity attribute to. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/generate-random-string.md b/products/idn/docs/identity-now/transforms/operations/generate-random-string.md index 2cb5f41bc..84bb94c8f 100644 --- a/products/idn/docs/identity-now/transforms/operations/generate-random-string.md +++ b/products/idn/docs/identity-now/transforms/operations/generate-random-string.md @@ -4,39 +4,25 @@ title: Generate Random String pagination_label: Generate Random String sidebar_label: Generate Random String sidebar_class_name: generateRandomString -keywords: ["transforms", "operations", "generate", "random", "string"] +keywords: ['transforms', 'operations', 'generate', 'random', 'string'] description: Generate a random string of any length. slug: /docs/transforms/operations/generate-random-string -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the generate random string transform as an out-of-the-box rule transform -provided through SailPoint's Cloud Services Utility rule. The transform allows -you to generate a random string of any length, using true/false flags to denote -whether the stringe includes numbers and/or special characters. +Use the generate random string transform as an out-of-the-box rule transform provided through SailPoint's Cloud Services Utility rule. The transform allows you to generate a random string of any length, using true/false flags to denote whether the stringe includes numbers and/or special characters. :::note Other Considerations -- The generate random string transform shares some common features with two - other transforms: [random numeric](./random-numeric.md) and - [random alphanumeric](./random-alphanumeric.md). In most cases, either of - these other two out-of-the-box transforms are recommended. However, the one - advantage of the generate random string transform is its support for special - characters, so a common use for this transform is generating random passwords - that meet basic complexity requirements. +- The generate random string transform shares some common features with two other transforms: [random numeric](./random-numeric.md) and [random alphanumeric](./random-alphanumeric.md). In most cases, either of these other two out-of-the-box transforms are recommended. However, the one advantage of the generate random string transform is its support for special characters, so a common use for this transform is generating random passwords that meet basic complexity requirements. ::: ## Transform Structure -The structure of a generate random string transform requires the `name` of the -referenced rule to be the "Cloud Services Deployment Utility" rule built by -SailPoint. You must also must set `operation` to `generateRandomString`, provide -a `length`, and provide the true/false attributes for `includeNumbers` and -`includeSpecialChars`. Last, you must include the `type` and `name` attributes -required for all transforms: +The structure of a generate random string transform requires the `name` of the referenced rule to be the "Cloud Services Deployment Utility" rule built by SailPoint. You must also must set `operation` to `generateRandomString`, provide a `length`, and provide the true/false attributes for `includeNumbers` and `includeSpecialChars`. Last, you must include the `type` and `name` attributes required for all transforms: ```json { @@ -56,16 +42,11 @@ required for all transforms: - **Required Attributes** - **type** - This must always be set to `rule`. - - **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. - - **attributes.name** - This must always be set to - `Cloud Services Deployment Utility`. + - **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. + - **attributes.name** - This must always be set to `Cloud Services Deployment Utility`. - **operation** - This must always be set to `generateRandomString`. - - **includeNumbers** - You must set this value to `true` or `false` to - indicate whether the generator logic includes numbers. - - **includeSpecialChars** - You must set this value to `true` or `false` to - indicate whether the generator logic includes the followin special - characters: + - **includeNumbers** - You must set this value to `true` or `false` to indicate whether the generator logic includes numbers. + - **includeSpecialChars** - You must set this value to `true` or `false` to indicate whether the generator logic includes the followin special characters: - ! - @ - \# @@ -80,17 +61,13 @@ required for all transforms: - \> - ? - **length** - This is the required length ofthe randomly generated string. - > **Note** Due to identity attribute data constraints, the maximum allowable - > value is 450 characters. + > **Note** Due to identity attribute data constraints, the maximum allowable value is 450 characters. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. ## Examples -This transform generates a 16-character random string containing letters, -numbers and special characters. +This transform generates a 16-character random string containing letters, numbers and special characters. **Transform Request Body**: @@ -112,8 +89,7 @@ numbers and special characters.
-This transform generates an 8-character random string containing only letters -and numbers. +This transform generates an 8-character random string containing only letters and numbers. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/get-end-of-string.md b/products/idn/docs/identity-now/transforms/operations/get-end-of-string.md index 6ca6196c1..59f4dfb0b 100644 --- a/products/idn/docs/identity-now/transforms/operations/get-end-of-string.md +++ b/products/idn/docs/identity-now/transforms/operations/get-end-of-string.md @@ -4,25 +4,19 @@ title: Get End of String pagination_label: Get End of String sidebar_label: Get End of String sidebar_class_name: getEndOfString -keywords: ["transforms", "operations", "get", "end", "string"] +keywords: ['transforms', 'operations', 'get', 'end', 'string'] description: Get the rightmost N characters of a string. slug: /docs/transforms/operations/get-end-of-string -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the get end of string transform as an out-of-the-box rule transform provided -through SailPoint's Cloud Services Deployment Utility rule. The transform allows -you to get the rightmost N characters of a string. +Use the get end of string transform as an out-of-the-box rule transform provided through SailPoint's Cloud Services Deployment Utility rule. The transform allows you to get the rightmost N characters of a string. ## Transform Structure -The structure of a get end of string transform requires the `name` of the -referenced rule to be the `Cloud Services Deployment Utility` rule built by -SailPoint. You must also set `operation` to `getEndOfString,` and provide a -`numChars` value. Last, you must include the `type` and `name` attributes -required for all transforms: +The structure of a get end of string transform requires the `name` of the referenced rule to be the `Cloud Services Deployment Utility` rule built by SailPoint. You must also set `operation` to `getEndOfString,` and provide a `numChars` value. Last, you must include the `type` and `name` attributes required for all transforms: ```json { @@ -41,23 +35,14 @@ required for all transforms: - **Required Attributes** - **type** - This must always be set to `rule`. - - **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. - - **attributes.name** - This must always be set to - `Cloud Services Deployment Utility`. + - **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. + - **attributes.name** - This must always be set to `Cloud Services Deployment Utility`. - **operation** - This must always be set to `getEndOfString`. - - **numChars** - This specifies how many of the rightmost characters within - the incoming string the transform returns. If the value of numChars is - greater than the string length, the transform returns null. + - **numChars** - This specifies how many of the rightmost characters within the incoming string the transform returns. If the value of numChars is greater than the string length, the transform returns null. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples @@ -86,8 +71,7 @@ Output: "1234"
-This transform returns a null value because the incoming string length is only -15 characters long, but the transform requests the rightmost 16 characters. +This transform returns a null value because the incoming string length is only 15 characters long, but the transform requests the rightmost 16 characters. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/get-reference-identity-attribute.md b/products/idn/docs/identity-now/transforms/operations/get-reference-identity-attribute.md index cd0115488..024ae9360 100644 --- a/products/idn/docs/identity-now/transforms/operations/get-reference-identity-attribute.md +++ b/products/idn/docs/identity-now/transforms/operations/get-reference-identity-attribute.md @@ -5,28 +5,19 @@ pagination_label: Get Reference Identity Attribute sidebar_label: Get Reference Identity Attribute sidebar_class_name: getReferenceIdentityAttribute keywords: - ["transforms", "operations", "get", "reference", "identity", "attribute"] + ['transforms', 'operations', 'get', 'reference', 'identity', 'attribute'] description: Get another user's identity attribute. slug: /docs/transforms/operations/get-reference-identity-attribute -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the get reference identity attribute transform as an out-of-the-box rule -provided through SailPoint's Cloud Services Deployment Utility rule. The -transform allows you to get the identity attribute of another user from within a -given identity's calculation. For your convenience, the transform allows you to -use "manager" as a referential lookup to the target identity. +Use the get reference identity attribute transform as an out-of-the-box rule provided through SailPoint's Cloud Services Deployment Utility rule. The transform allows you to get the identity attribute of another user from within a given identity's calculation. For your convenience, the transform allows you to use "manager" as a referential lookup to the target identity. ## Transform Structure -The structure of a get reference identity transform requires the `name` of the -referenced rule to be the `Cloud Services Deployment Utility` rule built by -SailPoint. Additionally, you must set the `operation` to -`getReferenceIdentityAttribute` and specify a `uid` attribute that correlates to -the identity whose attribute is desired. Last, you must include the `type` and -`name` attributes required for all transforms: +The structure of a get reference identity transform requires the `name` of the referenced rule to be the `Cloud Services Deployment Utility` rule built by SailPoint. Additionally, you must set the `operation` to `getReferenceIdentityAttribute` and specify a `uid` attribute that correlates to the identity whose attribute is desired. Last, you must include the `type` and `name` attributes required for all transforms: ```json { @@ -46,20 +37,14 @@ the identity whose attribute is desired. Last, you must include the `type` and - **Required Attributes** - **type** - This must always be set to `rule`. - - **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. - - **attributes.name** - This must always be set to - `Cloud Services Deployment Utility`. + - **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. + - **attributes.name** - This must always be set to `Cloud Services Deployment Utility`. - **operation** - This must always be set to `getReferenceIdentityAttribute`. - - **uid** - This is the SailPoint User Name (uid) value of the identity whose - attribute is desired. - - For your convenience, you can use the "manager" keyword to look up the - user's manager and then get that manager's identity attribute. + - **uid** - This is the SailPoint User Name (uid) value of the identity whose attribute is desired. + - For your convenience, you can use the "manager" keyword to look up the user's manager and then get that manager's identity attribute. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. ## Examples @@ -84,8 +69,7 @@ This transform gets the user's manager's email address.
-This transform gets the alternate phone number for the user identified as -"corporate.admin". +This transform gets the alternate phone number for the user identified as "corporate.admin". **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/identity-attribute.md b/products/idn/docs/identity-now/transforms/operations/identity-attribute.md index aa9a1f987..5229b58c1 100644 --- a/products/idn/docs/identity-now/transforms/operations/identity-attribute.md +++ b/products/idn/docs/identity-now/transforms/operations/identity-attribute.md @@ -4,33 +4,25 @@ title: Identity Attribute pagination_label: Identity Attribute sidebar_label: Identity Attribute sidebar_class_name: identityAttribute -keywords: ["transforms", "operations", "identity", "attribute"] +keywords: ['transforms', 'operations', 'identity', 'attribute'] description: Get a user's identity attribute's value. slug: /docs/transforms/operations/identity-attribute -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the identity attribute transform to get the value of a user's identity -attribute. This transform is often useful within a source's account create or -disable profile. +Use the identity attribute transform to get the value of a user's identity attribute. This transform is often useful within a source's account create or disable profile. :::note Other Considerations -- This transform is **not** intended for use within an another identity profile - attribute's calculation. Identity attribute calculations are multi-threaded - processes, and there is no guarantee that a specific attribute has current - data, or even exists, at the time of calculation within any given transform. - _Referencing identity attributes within another identity attribute's - calculation can lead to identity exceptions._ +- This transform is **not** intended for use within an another identity profile attribute's calculation. Identity attribute calculations are multi-threaded processes, and there is no guarantee that a specific attribute has current data, or even exists, at the time of calculation within any given transform. _Referencing identity attributes within another identity attribute's calculation can lead to identity exceptions._ ::: ## Transform Structure -The transform for identity attributes requires the desired identity attribute's -system `name,` along with the `type` and `name` attributes: +The transform for identity attributes requires the desired identity attribute's system `name,` along with the `type` and `name` attributes: ```json { @@ -47,19 +39,12 @@ system `name,` along with the `type` and `name` attributes: - **Required Attributes** - **type** - This must always be set to `identityAttribute`. - - **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. - - **attributes.name** - The system (camel-cased) name of the identity - attribute to bring in. + - **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. + - **attributes.name** - The system (camel-cased) name of the identity attribute to bring in. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples diff --git a/products/idn/docs/identity-now/transforms/operations/index-of.md b/products/idn/docs/identity-now/transforms/operations/index-of.md index 3420dd58b..df3e67c59 100644 --- a/products/idn/docs/identity-now/transforms/operations/index-of.md +++ b/products/idn/docs/identity-now/transforms/operations/index-of.md @@ -4,34 +4,25 @@ title: Index Of pagination_label: Index Of sidebar_label: Index Of sidebar_class_name: indexOf -keywords: ["transforms", "operations", "index", "of"] +keywords: ['transforms', 'operations', 'index', 'of'] description: Get the location of a specific substring within a value. slug: /docs/transforms/operations/index-of -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the index of transform to get the location of a specific substring within an -incoming value. This transform is often useful in conjunction with the substring -transform for getting parts of strings that can be dynamic in length or -composition. If the substring you are searching for does not occur within the -data, the transform returns -1. +Use the index of transform to get the location of a specific substring within an incoming value. This transform is often useful in conjunction with the substring transform for getting parts of strings that can be dynamic in length or composition. If the substring you are searching for does not occur within the data, the transform returns -1. :::note Other Considerations -- If the substring you are searching for occurs multiple times within the - incoming data, the transform returns the location of the first occurrence. If - you want the last occurrence of a substring, use the - [Last Index Of](./last-index-of.md) transform. If you want an occurrence that - is neither first nor last, use the [Substring](./substring.md) transform. +- If the substring you are searching for occurs multiple times within the incoming data, the transform returns the location of the first occurrence. If you want the last occurrence of a substring, use the [Last Index Of](./last-index-of.md) transform. If you want an occurrence that is neither first nor last, use the [Substring](./substring.md) transform. ::: ## Transform Structure -The indexOf transform requires only the substring which you want to search for, -along with the `type` and `name` attributes: +The indexOf transform requires only the substring which you want to search for, along with the `type` and `name` attributes: ```json { @@ -48,24 +39,16 @@ along with the `type` and `name` attributes: - **Required Attributes** - **type** - This must always be set to `indexOf`. - - **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. - - **substring** - This is the string whose beginning location within the - incoming data you want to find. + - **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. + - **substring** - This is the string whose beginning location within the incoming data you want to find. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples -The "admin\_" substring occurs at the very beginning of the input string, so -this transform returns 0. +The "admin\_" substring occurs at the very beginning of the input string, so this transform returns 0. ```bash Input: "admin_jsmith" @@ -88,9 +71,7 @@ Output: "0"
-Though the letter "b" occurs multiple times throughout the input string, the -first time it occurs is within the index location 1, so the transform returns -that value. +Though the letter "b" occurs multiple times throughout the input string, the first time it occurs is within the index location 1, so the transform returns that value. ```bash Input: "abcabcabc" diff --git a/products/idn/docs/identity-now/transforms/operations/index.md b/products/idn/docs/identity-now/transforms/operations/index.md index 5ee32714f..b99188de6 100644 --- a/products/idn/docs/identity-now/transforms/operations/index.md +++ b/products/idn/docs/identity-now/transforms/operations/index.md @@ -4,20 +4,17 @@ title: Operations pagination_label: Operations sidebar_label: Operations sidebar_class_name: operations -keywords: ["transforms", "operations"] +keywords: ['transforms', 'operations'] description: A list of transform operations. slug: /docs/transforms/operations -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- -This document lists each type of operation you can perform in a transform. -Sometimes you will hear these transforms referred to as **Seaspray**, the -codename for transforms. +This document lists each type of operation you can perform in a transform. Sometimes you will hear these transforms referred to as **Seaspray**, the codename for transforms. ## Transform Operations -Seaspray ships out of the box with a number of primitive operations. The -following sections describe the operations. +Seaspray ships out of the box with a number of primitive operations. The following sections describe the operations. ```mdx-code-block import DocCardList from '@theme/DocCardList'; diff --git a/products/idn/docs/identity-now/transforms/operations/iso-3166.md b/products/idn/docs/identity-now/transforms/operations/iso-3166.md index d6c76c8ce..d30a2eeba 100644 --- a/products/idn/docs/identity-now/transforms/operations/iso-3166.md +++ b/products/idn/docs/identity-now/transforms/operations/iso-3166.md @@ -4,17 +4,15 @@ title: ISO3166 pagination_label: ISO3166 sidebar_label: ISO3166 sidebar_class_name: iso3166 -keywords: ["transforms", "operations", "iso3166"] +keywords: ['transforms', 'operations', 'iso3166'] description: Convert a string into an ISO 3166 country code value. slug: /docs/transforms/operations/iso-3166 -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the ISO3166 transform to convert an incoming string into an -[ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) country code value. The -incoming data must be either a recognized country name or country code: +Use the ISO3166 transform to convert an incoming string into an [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) country code value. The incoming data must be either a recognized country name or country code: - The alpha2 country code (e.g. "ES") - The alpha3 country code (e.g. "ESP) @@ -30,15 +28,13 @@ The output value can be any of these three values: :::note Other Considerations -If the input string to the transform does not represent a valid country code or -country name, the transform returns null. +If the input string to the transform does not represent a valid country code or country name, the transform returns null. ::: ## Transform Structure -The transform for iso3166 only requires the transform's `type` and `name` -attributes: +The transform for iso3166 only requires the transform's `type` and `name` attributes: ```json { @@ -52,28 +48,19 @@ attributes: - **Required Attributes** - **type** - This must always be set to `iso3166`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **format** - Use this optional value to denote which ISO 3166 format to - return. The following values are valid: - - `alpha2` - Two-character country code (e.g., "US"). This is the default - value if you do not provide a format. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **format** - Use this optional value to denote which ISO 3166 format to return. The following values are valid: + - `alpha2` - Two-character country code (e.g., "US"). This is the default value if you do not provide a format. - `alpha3` - Three-character country code (e.g., "USA") - `numeric` - The numeric country code (e.g., "840") - - **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. ## Examples -Because no specific format is provided, this transform defaults to the alpha2 -output and returns "US". +Because no specific format is provided, this transform defaults to the alpha2 output and returns "US". ```bash Input: "United States of America" @@ -93,8 +80,7 @@ Output: "US"
-Because the desired format is specified as numeric, the output of this transform -returns "724". +Because the desired format is specified as numeric, the output of this transform returns "724". ```bash Input: "ES" diff --git a/products/idn/docs/identity-now/transforms/operations/last-index-of.md b/products/idn/docs/identity-now/transforms/operations/last-index-of.md index 6f5d7914c..8404ed268 100644 --- a/products/idn/docs/identity-now/transforms/operations/last-index-of.md +++ b/products/idn/docs/identity-now/transforms/operations/last-index-of.md @@ -4,34 +4,25 @@ title: Last Index Of pagination_label: Last Index Of sidebar_label: Last Index Of sidebar_class_name: lastIndexOf -keywords: ["transforms", "operations", "last", "index", "of"] +keywords: ['transforms', 'operations', 'last', 'index', 'of'] description: Convert a string into an ISO 3166 country code value. slug: /docs/transforms/operations/last-index-of -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the last index of transform to get the last location of a specific substring -within an incoming value. This transform is often useful in conjunction with the -substring transform for getting parts of strings that can be dynamic in length -or composition. If the substring you are searching for does not occur within the -data, the transform returns -1. +Use the last index of transform to get the last location of a specific substring within an incoming value. This transform is often useful in conjunction with the substring transform for getting parts of strings that can be dynamic in length or composition. If the substring you are searching for does not occur within the data, the transform returns -1. :::note Other Considerations -If the substring you are searching for occurs multiple times within the incoming -data, the transform returns the location of the last occurrence. If you want the -first occurrence of a substring, use the [Index Of](./index-of.md) transform. If -you want an occurrence that is neither first nor last, use the -[Substring](./substring.md) transform. +If the substring you are searching for occurs multiple times within the incoming data, the transform returns the location of the last occurrence. If you want the first occurrence of a substring, use the [Index Of](./index-of.md) transform. If you want an occurrence that is neither first nor last, use the [Substring](./substring.md) transform. ::: ## Transform Structure -The lastIndexOf transform requires only the substring you want to search for, -along with the transform's `type` and `name` attributes: +The lastIndexOf transform requires only the substring you want to search for, along with the transform's `type` and `name` attributes: ```json { @@ -48,24 +39,16 @@ along with the transform's `type` and `name` attributes: - **Required Attributes** - **type** - This must always be set to `lastIndexOf`. - - **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. - - **substring** - This is the string whose beginning location within the - incoming data you want to find. + - **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. + - **substring** - This is the string whose beginning location within the incoming data you want to find. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples -The "admin\_" substring only occurs once at the very beginning of the input -string, so this transform returns 0. +The "admin\_" substring only occurs once at the very beginning of the input string, so this transform returns 0. ```bash Input: "admin_jsmith" @@ -88,8 +71,7 @@ Output: "0"
-While the letter "b" occurs multiple times throughout the input string, the last -time it occurs is within index location 7, so this transform returns that value. +While the letter "b" occurs multiple times throughout the input string, the last time it occurs is within index location 7, so this transform returns that value. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/left-pad.md b/products/idn/docs/identity-now/transforms/operations/left-pad.md index 1df2a4ea9..a786c655f 100644 --- a/products/idn/docs/identity-now/transforms/operations/left-pad.md +++ b/products/idn/docs/identity-now/transforms/operations/left-pad.md @@ -4,31 +4,25 @@ title: Left Pad pagination_label: Left Pad sidebar_label: Left Pad sidebar_class_name: leftPad -keywords: ["transforms", "operations", "left", "pad"] +keywords: ['transforms', 'operations', 'left', 'pad'] description: Convert a string into an ISO 3166 country code value. slug: /docs/transforms/operations/left-pad -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the left pad transform to pad an incoming string with a user-supplied -character out to a specific number of characters. This transform is often useful -for data normalization situations in which data such as employee IDs are not -uniform in length but need to be for downstream systems. +Use the left pad transform to pad an incoming string with a user-supplied character out to a specific number of characters. This transform is often useful for data normalization situations in which data such as employee IDs are not uniform in length but need to be for downstream systems. :::note Other Considerations -- If the input to the left pad transform is null, the transform returns a null - value. +- If the input to the left pad transform is null, the transform returns a null value. ::: ## Transform Structure -In addition to the standard `type` and `name` attributes, the left pad transform -requires the `length` attribute, which tells the transform how many characters -to pad the incoming string to. +In addition to the standard `type` and `name` attributes, the left pad transform requires the `length` attribute, which tells the transform how many characters to pad the incoming string to. ```json { @@ -46,29 +40,18 @@ to pad the incoming string to. - **Required Attributes** - **type** - This must always be set to `leftPad`. - - **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. - - **length** - This is an integer value for the final output string's desired - length. + - **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. + - **length** - This is an integer value for the final output string's desired length. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **padding** - This string value represents the character the transform will - pad the incoming data to to get to the desired length. - - If no padding value is provided, the transform defaults to a single space - (" ") character for padding. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **padding** - This string value represents the character the transform will pad the incoming data to to get to the desired length. + - If no padding value is provided, the transform defaults to a single space (" ") character for padding. + - **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. ## Examples -This transform takes the incoming attribute configured in the identity profile -attribute UI and ensures it is padded out to 8 characters in length by adding -"0"s to the left. +This transform takes the incoming attribute configured in the identity profile attribute UI and ensures it is padded out to 8 characters in length by adding "0"s to the left. ```bash Input: "1234" @@ -92,8 +75,7 @@ Output: "00001234"
-This transform takes the user's `employeeID` attribute from the HR source and -ensures it is padded out to 7 characters in length by adding "x"s to the left. +This transform takes the user's `employeeID` attribute from the HR source and ensures it is padded out to 7 characters in length by adding "x"s to the left. ```bash Input: "1234" diff --git a/products/idn/docs/identity-now/transforms/operations/lookup.md b/products/idn/docs/identity-now/transforms/operations/lookup.md index 00460ecfe..3a89e6632 100644 --- a/products/idn/docs/identity-now/transforms/operations/lookup.md +++ b/products/idn/docs/identity-now/transforms/operations/lookup.md @@ -4,31 +4,25 @@ title: Lookup pagination_label: Lookup sidebar_label: Lookup sidebar_class_name: lookup -keywords: ["transforms", "operations", "lookup"] +keywords: ['transforms', 'operations', 'lookup'] description: Look up and return a key's matching value. slug: /docs/transforms/operations/lookup -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the lookup transform to take in an incoming string value and compare it to a -list of key-value pairs to determine which output to return. If the incoming -data matches a key, the transform returns the corresponding value. If the -incoming key does not match a key, the transform returns the table's optional -default value. +Use the lookup transform to take in an incoming string value and compare it to a list of key-value pairs to determine which output to return. If the incoming data matches a key, the transform returns the corresponding value. If the incoming key does not match a key, the transform returns the table's optional default value. :::note Other Considerations -- If the input does not match any key value within the table and no default - value is provided, the transform will return an error. +- If the input does not match any key value within the table and no default value is provided, the transform will return an error. ::: ## Transform Structure -In addition to the `type` and `name` attributes, the structure of a lookup -transform involves a `table` entry of key-value pairs: +In addition to the `type` and `name` attributes, the structure of a lookup transform involves a `table` entry of key-value pairs: ```json { @@ -50,25 +44,14 @@ transform involves a `table` entry of key-value pairs: - **Required Attributes** - **type** - This must always be set to `lookup`. - - **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. - - **table** - This is a JSON object of key-value pairs. The key is the string - the transform tries to match to the input, and the value is the output - string the transform returns if it matches the key. + - **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. + - **table** - This is a JSON object of key-value pairs. The key is the string the transform tries to match to the input, and the value is the output string the transform returns if it matches the key. - :::tip - A default key must be specified. Otherwise, an error will be returned - if there are no matching values in your table. - ::: + :::tip A default key must be specified. Otherwise, an error will be returned if there are no matching values in your table. ::: - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples @@ -96,9 +79,7 @@ This transform tries to map a telephone area code to a city in Texas. If there i
-This transform extends the previous one to show how multiple key values can be -mapped to the same output value. However, duplicate key values are not allowed, -so this will throw an error. +This transform extends the previous one to show how multiple key values can be mapped to the same output value. However, duplicate key values are not allowed, so this will throw an error. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/lower.md b/products/idn/docs/identity-now/transforms/operations/lower.md index a9faefc51..2e6ede5c9 100644 --- a/products/idn/docs/identity-now/transforms/operations/lower.md +++ b/products/idn/docs/identity-now/transforms/operations/lower.md @@ -4,10 +4,10 @@ title: Lower pagination_label: Lower sidebar_label: Lower sidebar_class_name: lower -keywords: ["transforms", "operations", "lower"] +keywords: ['transforms', 'operations', 'lower'] description: Convert an input string into all lowercase letters. slug: /docs/transforms/operations/lower -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview @@ -29,16 +29,10 @@ The lower transform only requires the transform's `type` and `name` attributes: - **Required Attributes** - **type** - This must always be set to `lower`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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.  @@ -72,8 +66,7 @@ Output:"active"
-This transform takes in the input "All-Access" and produces "all-access" as the -output. +This transform takes in the input "All-Access" and produces "all-access" as the output. ```bash Input:"All-Access" diff --git a/products/idn/docs/identity-now/transforms/operations/name-normalizer.md b/products/idn/docs/identity-now/transforms/operations/name-normalizer.md index c52ce2bef..5bec80d10 100644 --- a/products/idn/docs/identity-now/transforms/operations/name-normalizer.md +++ b/products/idn/docs/identity-now/transforms/operations/name-normalizer.md @@ -4,44 +4,34 @@ title: Name Normalizer pagination_label: Name Normalizer sidebar_label: Name Normalizer sidebar_class_name: nameNormalizer -keywords: ["transforms", "operations", "name normalizer"] +keywords: ['transforms', 'operations', 'name normalizer'] description: Clean or standardize the spelling of strings coming in from source systems. slug: /docs/transforms/operations/name-normalizer -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the name normalizer transform to clean or standardize the spelling of -strings coming in from source systems. The most common use for this transform is -for names and other proper nouns, but the transform is not necessarily limited -to those data elements. +Use the name normalizer transform to clean or standardize the spelling of strings coming in from source systems. The most common use for this transform is for names and other proper nouns, but the transform is not necessarily limited to those data elements. The normalization logic within the transform handles a wide range of use cases: - Proper casing/capitalization of names - - Any string containing either a space, a hyphen or an apostrophe - the - transform splits these by that character and capitalizes the first character - of each resulting substring. -- Special replacements of patterns that include "MC" and "MAC" (or case-based - variations of those two strings) - - The transform automatically converts "MC" to "Mc" and "MAC" to "Mac" when - they are part of a patronymic last name. -- Consistent capitalization of strings that are part of a toponymic surname or a - generational suffix: + - Any string containing either a space, a hyphen or an apostrophe - the transform splits these by that character and capitalizes the first character of each resulting substring. +- Special replacements of patterns that include "MC" and "MAC" (or case-based variations of those two strings) + - The transform automatically converts "MC" to "Mc" and "MAC" to "Mac" when they are part of a patronymic last name. +- Consistent capitalization of strings that are part of a toponymic surname or a generational suffix: - Convert "VON" to "von" - Convert "DEL" to "del" - Convert "OF" to "of" - Convert "DE" to "de" - Convert "LA" to "la" - Convert "Y" to "y" - - Convert Roman numeral suffixes to all capitalized letters (e.g., "iii" - becomes "III") + - Convert Roman numeral suffixes to all capitalized letters (e.g., "iii" becomes "III") ## Transform Structure -The name normalizer transform only requires the transform's `type` and `name` -attributes: +The name normalizer transform only requires the transform's `type` and `name` attributes: ```json { @@ -55,17 +45,11 @@ attributes: - **Required Attributes** - **type** - This must always be set to `normalizeNames`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples @@ -95,8 +79,7 @@ Output: "John von Smith"
-This transform takes the user's "LastName" attribute from the "HR Source" and -normalizes the name to a consistent format. +This transform takes the user's "LastName" attribute from the "HR Source" and normalizes the name to a consistent format. ```bash Input: "Dr. JOHN D. O'BRIEN" diff --git a/products/idn/docs/identity-now/transforms/operations/random-alphanumeric.md b/products/idn/docs/identity-now/transforms/operations/random-alphanumeric.md index b3bfd4a43..56ac89130 100644 --- a/products/idn/docs/identity-now/transforms/operations/random-alphanumeric.md +++ b/products/idn/docs/identity-now/transforms/operations/random-alphanumeric.md @@ -4,21 +4,19 @@ title: Random Alphanumeric pagination_label: Random Alphanumeric sidebar_label: Random Alphanumeric sidebar_class_name: randomAlphanumeric -keywords: ["transforms", "operations", "random alphanumeric"] +keywords: ['transforms', 'operations', 'random alphanumeric'] description: Generate a random string of any length. slug: /docs/transforms/operations/random-alphanumeric -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the random alphanumeric transform to generate a random string of any length, -comprising both numbers and letters (both lowercase and uppercase). +Use the random alphanumeric transform to generate a random string of any length, comprising both numbers and letters (both lowercase and uppercase). ## Transform Structure -The random alphanumeric transform only requires the standard `type` and `name` -attributes: +The random alphanumeric transform only requires the standard `type` and `name` attributes: ```json { @@ -32,24 +30,18 @@ attributes: - **Required Attributes** - **type** - This must always be set to `randomAlphaNumeric`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **length** - This is the integer value specifying the required size/number - of characters the random string must contain. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **length** - This is the integer value specifying the required size/number of characters the random string must contain. - This value must be a positive number and cannot be blank. - If no length is provided, the transform defaults to a value of 32. - - Due to identity attribute data constraints, the maximum allowable value is - 450 characters. + - Due to identity attribute data constraints, the maximum allowable value is 450 characters. ## Examples -Since no explicit length is provided, this transform generates a 32-character -random string, such as "VtPeE9WL56lMTlvfjr02KXqS3KtgDSuk". +Since no explicit length is provided, this transform generates a 32-character random string, such as "VtPeE9WL56lMTlvfjr02KXqS3KtgDSuk". **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/random-numeric.md b/products/idn/docs/identity-now/transforms/operations/random-numeric.md index ebb270ffe..5a3756226 100644 --- a/products/idn/docs/identity-now/transforms/operations/random-numeric.md +++ b/products/idn/docs/identity-now/transforms/operations/random-numeric.md @@ -4,10 +4,10 @@ title: Random Numeric pagination_label: Random Numeric sidebar_label: Random Numeric sidebar_class_name: randomNumeric -keywords: ["transforms", "operations", "random numeric"] +keywords: ['transforms', 'operations', 'random numeric'] description: Generate a random number of any length. slug: /docs/transforms/operations/random-numeric -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview @@ -16,8 +16,7 @@ Use the random numeric transform to generate a random number of any length. ## Transform Structure -The random numeric transform only requires the standard `type` and `name` -attributes: +The random numeric transform only requires the standard `type` and `name` attributes: ```json { @@ -31,24 +30,18 @@ attributes: - **Required Attributes** - **type** - This must always be set to `randomNumeric`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **length** - This is the integer value specifying the required size/number - of digits the random number must contain. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **length** - This is the integer value specifying the required size/number of digits the random number must contain. - This value must be a positive number and cannot be blank. - If no length is provided, the transform defaults to a value of 10. - - Due to identity attribute data constraints, the maximum allowable value is - 450 characters. + - Due to identity attribute data constraints, the maximum allowable value is 450 characters. ## Examples -No explicit length is provided, so this transform generates a 10-digit random -integer, such as "2334776774". +No explicit length is provided, so this transform generates a 10-digit random integer, such as "2334776774". **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/reference.md b/products/idn/docs/identity-now/transforms/operations/reference.md index 2f6ca75b6..f924d1bbc 100644 --- a/products/idn/docs/identity-now/transforms/operations/reference.md +++ b/products/idn/docs/identity-now/transforms/operations/reference.md @@ -4,24 +4,19 @@ title: Reference pagination_label: Reference sidebar_label: Reference sidebar_class_name: reference -keywords: ["transforms", "operations", "reference"] +keywords: ['transforms', 'operations', 'reference'] description: Reuse a transform that has already been written. slug: /docs/transforms/operations/reference -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the reference transform to reuse a transform that has already been written -within another transform. This transform is often useful when you want to repeat -the same logic multiple times within other transforms. This transform allows you -to maintain only one transform and have it propagate through to other -implementations of that logic. +Use the reference transform to reuse a transform that has already been written within another transform. This transform is often useful when you want to repeat the same logic multiple times within other transforms. This transform allows you to maintain only one transform and have it propagate through to other implementations of that logic. ## Transform Structure -In addition to the standard `type` and `name` attributes, the structure of a -reference transform requires the `id` of the transform you want to reference: +In addition to the standard `type` and `name` attributes, the structure of a reference transform requires the `id` of the transform you want to reference: ```json { @@ -38,26 +33,16 @@ reference transform requires the `id` of the transform you want to reference: - **Required Attributes** - **type** - This must always be set to `reference`. - - **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. - - **id** - This ID specifies the name of the pre-existing transform you want - to use within your current transform. + - **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. + - **id** - This ID specifies the name of the pre-existing transform you want to use within your current transform. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples -If you had a "Get Worker Type" transform that evaluated multiple pieces of data -to determine whether a user is an employee or a contractor, this transform would -output the result of that transform just as if the logic were contained directly -within this transform. +If you had a "Get Worker Type" transform that evaluated multiple pieces of data to determine whether a user is an employee or a contractor, this transform would output the result of that transform just as if the logic were contained directly within this transform. **Transform Request Body**: @@ -75,9 +60,7 @@ within this transform.
-This transform builds the user's display name, adds a hyphen to the end, and -then adds the evaluated worker type from the earlier transform to build a string -that would look something like "John Smith - Employee". +This transform builds the user's display name, adds a hyphen to the end, and then adds the evaluated worker type from the earlier transform to build a string that would look something like "John Smith - Employee". **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/replace-all.md b/products/idn/docs/identity-now/transforms/operations/replace-all.md index 50d7fcbf2..24df71e09 100644 --- a/products/idn/docs/identity-now/transforms/operations/replace-all.md +++ b/products/idn/docs/identity-now/transforms/operations/replace-all.md @@ -4,27 +4,19 @@ title: Replace All pagination_label: Replace All sidebar_label: Replace All sidebar_class_name: replaceAll -keywords: ["transforms", "operations", "replace all"] +keywords: ['transforms', 'operations', 'replace all'] description: Find and replace all instances of all patterns. slug: /docs/transforms/operations/replace-all -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -The replace all transform works like the replace transform, except that it can -perform multiple replace operations on the incoming data instead of just one -pattern. Use the replace all transform to find multiple patterns of characters -within incoming data and replace all instances of those patterns with alternate -values. The transform recognizes standard regex syntax. See the -[References](#references) section for more information about regex. +The replace all transform works like the replace transform, except that it can perform multiple replace operations on the incoming data instead of just one pattern. Use the replace all transform to find multiple patterns of characters within incoming data and replace all instances of those patterns with alternate values. The transform recognizes standard regex syntax. See the [References](#references) section for more information about regex. ## Transform Structure -The replace transform takes a `table` attribute of key-value pairs as an -argument. Each pair identifies the pattern to search for as its key and the -replacement string as its value. The transform also requires the standard `type` -and `name` attributes: +The replace transform takes a `table` attribute of key-value pairs as an argument. Each pair identifies the pattern to search for as its key and the replacement string as its value. The transform also requires the standard `type` and `name` attributes: ```json { @@ -45,25 +37,17 @@ and `name` attributes: - **Required Attributes** - **type** - This must always be set to `replaceAll`. - - **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. + - **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. - **regex** - This is the pattern you want to replace. - - **replacement** - This is the replacement string that replaces the pattern - wherever it occurs. + - **replacement** - This is the replacement string that replaces the pattern wherever it occurs. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples -This transform makes a simple set of special character replacements, exchanging -a space for a hyphen and removing the Spanish tilde from the "n." +This transform makes a simple set of special character replacements, exchanging a space for a hyphen and removing the Spanish tilde from the "n." ```bash Input: "Enrique Jose-Piñon" @@ -90,8 +74,7 @@ Output: "Enrique Jose Pinon"
-This example uses more complex regex patterns to remove any alphabet characters -from the input string and replace periods with hyphens. +This example uses more complex regex patterns to remove any alphabet characters from the input string and replace periods with hyphens. ```bash Input: "ad512.777.1234" diff --git a/products/idn/docs/identity-now/transforms/operations/replace.md b/products/idn/docs/identity-now/transforms/operations/replace.md index 4640592bb..30b83d5ef 100644 --- a/products/idn/docs/identity-now/transforms/operations/replace.md +++ b/products/idn/docs/identity-now/transforms/operations/replace.md @@ -4,25 +4,19 @@ title: Replace pagination_label: Replace sidebar_label: Replace sidebar_class_name: replace -keywords: ["transforms", "operations", "replace"] +keywords: ['transforms', 'operations', 'replace'] description: Find and replace all instances of a single string. slug: /docs/transforms/operations/replace -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the replace transform to find a given pattern of characters within incoming -data and replace all instances of that pattern with alternate values. The -transform recognizes standard regex syntax. See the [References](#references) -section for more information about regex. +Use the replace transform to find a given pattern of characters within incoming data and replace all instances of that pattern with alternate values. The transform recognizes standard regex syntax. See the [References](#references) section for more information about regex. ## Transform Structure -The replace transform takes a `regex` attribute as an argument to identify which -pattern to replace and a `replacement` attribute for the characters to replace -the pattern with. The transform also requires the standard `type` and `name` -attributes: +The replace transform takes a `regex` attribute as an argument to identify which pattern to replace and a `replacement` attribute for the characters to replace the pattern with. The transform also requires the standard `type` and `name` attributes: ```json { @@ -40,25 +34,17 @@ attributes: - **Required Attributes** - **type** - This must always be set to `replace`. - - **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. + - **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. - **regex** - This is the pattern you want to replace. - - **replacement** - This is the replacement string that replaces the pattern - wherever it occurs. + - **replacement** - This is the replacement string that replaces the pattern wherever it occurs. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples -This transform makes a simple word replacement, exchanging "IIQ" for -"IdentityNow". +This transform makes a simple word replacement, exchanging "IIQ" for "IdentityNow". ```bash Input: "Working with IIQ is fun" @@ -82,8 +68,7 @@ Output: "Working with IdentityNow is fun"
-This example uses a more complex regex pattern to remove any non-alphabet -characters from the input string. +This example uses a more complex regex pattern to remove any non-alphabet characters from the input string. ```bash Input: "The quick brown fox jumped over 10 lazy dogs" diff --git a/products/idn/docs/identity-now/transforms/operations/right-pad.md b/products/idn/docs/identity-now/transforms/operations/right-pad.md index b0e0068cc..11efdb291 100644 --- a/products/idn/docs/identity-now/transforms/operations/right-pad.md +++ b/products/idn/docs/identity-now/transforms/operations/right-pad.md @@ -4,31 +4,25 @@ title: Right Pad pagination_label: Right Pad sidebar_label: Right Pad sidebar_class_name: rightPad -keywords: ["transforms", "operations", "right pad"] +keywords: ['transforms', 'operations', 'right pad'] description: Add padding to the right of an incoming string. slug: /docs/transforms/operations/right-pad -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the right pad transform to pad an incoming string with a user-supplied -character out to a specific number of characters. This transform is often useful -for data normalization situations in which data such as employee IDs are not -uniform in length but need to be for downstream systems. +Use the right pad transform to pad an incoming string with a user-supplied character out to a specific number of characters. This transform is often useful for data normalization situations in which data such as employee IDs are not uniform in length but need to be for downstream systems. :::note Other Considerations -- If the input to the right pad transform is null, the transform returns a null - value. +- If the input to the right pad transform is null, the transform returns a null value. ::: ## Transform Structure -In addition to the standard `type` and `name` attributes, the right pad -transform requires the `length` attribute, which tells the transform how many -characters to pad the incoming string to. +In addition to the standard `type` and `name` attributes, the right pad transform requires the `length` attribute, which tells the transform how many characters to pad the incoming string to. ```json { @@ -46,25 +40,17 @@ characters to pad the incoming string to. - **Required Attributes** - **type** - This must always be set to `rightPad`. - - **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. - - **length** - This is an integer value for the final output string's desired - length. + - **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. + - **length** - This is an integer value for the final output string's desired length. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **padding** - This string value represents the character the transform will - pad the incoming data to to get to the desired length. - - If no padding value is provided, the transform defaults to a single space - (" ") character for padding. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **padding** - This string value represents the character the transform will pad the incoming data to to get to the desired length. + - If no padding value is provided, the transform defaults to a single space (" ") character for padding. ## Examples -This transform takes the incoming attribute configured in the Identity Profile -attribute UI and ensures it is padded out to 8 characters in length by adding -"0"s to the right. +This transform takes the incoming attribute configured in the Identity Profile attribute UI and ensures it is padded out to 8 characters in length by adding "0"s to the right. ```bash Input: "1234" @@ -88,8 +74,7 @@ Output: "12340000"
-This example takes the user's employeeID attribute from the HR source and -ensures it is padded out to 7 characters in length by adding "x"s to the right. +This example takes the user's employeeID attribute from the HR source and ensures it is padded out to 7 characters in length by adding "x"s to the right. ```bash Input: "1234" diff --git a/products/idn/docs/identity-now/transforms/operations/rule.md b/products/idn/docs/identity-now/transforms/operations/rule.md index a3b76962a..3fa3448ab 100644 --- a/products/idn/docs/identity-now/transforms/operations/rule.md +++ b/products/idn/docs/identity-now/transforms/operations/rule.md @@ -4,23 +4,19 @@ title: Rule pagination_label: Rule sidebar_label: Rule sidebar_class_name: rule -keywords: ["transforms", "operations", "rule"] +keywords: ['transforms', 'operations', 'rule'] description: Reuse rule logic that has already been written for a previous use case. slug: /docs/transforms/operations/rule -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Like the reference transform, the rule transform allows you to reuse logic that -has already been written for a previous use case. However, you can use the rule -transform to reuse code contained within a Generic rule that either is not -possible through only transforms or is too complex to maintain with Seaspray. +Like the reference transform, the rule transform allows you to reuse logic that has already been written for a previous use case. However, you can use the rule transform to reuse code contained within a Generic rule that either is not possible through only transforms or is too complex to maintain with Seaspray. ## Transform Structure -In addition to the standard `type` and `name` attributes, the structure of a -rule transform requires the `name` of the rule you want to reference: +In addition to the standard `type` and `name` attributes, the structure of a rule transform requires the `name` of the rule you want to reference: ```json { @@ -37,25 +33,16 @@ rule transform requires the `name` of the rule you want to reference: - **Required Attributes** - **type** - This must always be set to `rule`. - - **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. - - **attributes.name** - This is the name of the Generic rule the transform - must invoke. + - **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. + - **attributes.name** - This is the name of the Generic rule the transform must invoke. - **Optional Attributes** - - The rule transform can implement variables within the attributes list. These - variables can be defined as static string values or even as the results of - other transforms. Any variables defined here are passed to the Generic rule - and are available for calculation within that code. - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. + - The rule transform can implement variables within the attributes list. These variables can be defined as static string values or even as the results of other transforms. Any variables defined here are passed to the Generic rule and are available for calculation within that code. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. ## Examples -If you had a "Generate Random Number" rule that produced a random integer value, -this transform would invoke that rule and return the output of the code -contained within it. +If you had a "Generate Random Number" rule that produced a random integer value, this transform would invoke that rule and return the output of the code contained within it. **Transform Request Body**: @@ -73,13 +60,7 @@ contained within it.
-This transform shows a more complex use case in which you have a Generic rule -written to perform various string manipulation tasks. If the manner the rule -code uses to determine which task to run is passed to it by the `operation` -variable and the operation is intended to get the last n characters of a string, -n can be provided to the rule via the `numChars` variable. This transform -invokes rule code to get the last three characters of the string passed to it -with the UI configuration. +This transform shows a more complex use case in which you have a Generic rule written to perform various string manipulation tasks. If the manner the rule code uses to determine which task to run is passed to it by the `operation` variable and the operation is intended to get the last n characters of a string, n can be provided to the rule via the `numChars` variable. This transform invokes rule code to get the last three characters of the string passed to it with the UI configuration. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/split.md b/products/idn/docs/identity-now/transforms/operations/split.md index 6fefb9d9a..badd81816 100644 --- a/products/idn/docs/identity-now/transforms/operations/split.md +++ b/products/idn/docs/identity-now/transforms/operations/split.md @@ -4,26 +4,19 @@ title: Split pagination_label: Split sidebar_label: Split sidebar_class_name: split -keywords: ["transforms", "operations", "split"] +keywords: ['transforms', 'operations', 'split'] description: Return the Nth element of a split array. slug: /docs/transforms/operations/split -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the split transform to use a specific character or regex string as a -delimiter and convert a single incoming string into an array of values. This -transform then returns the Nth element of that array. This transform is often -useful when you want to split combined names into their constituent parts or -when you want to simplify an ordered list of values into a single attribute. +Use the split transform to use a specific character or regex string as a delimiter and convert a single incoming string into an array of values. This transform then returns the Nth element of that array. This transform is often useful when you want to split combined names into their constituent parts or when you want to simplify an ordered list of values into a single attribute. ## Transform Structure -In addition to the standard `type` and `name` attributes, the split transform -requires the `delimiter` and `index` attributes. These parameters, respectively, -tell the transform what to use as the pattern to split the string with and which -entry in the resulting array of values you want it to return. +In addition to the standard `type` and `name` attributes, the split transform requires the `delimiter` and `index` attributes. These parameters, respectively, tell the transform what to use as the pattern to split the string with and which entry in the resulting array of values you want it to return. ```json { @@ -41,34 +34,20 @@ entry in the resulting array of values you want it to return. - **Required Attributes** - **type** - This must always be set to `split`. - - **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. - - **delimiter** - This can be either a single character or a regex expression. - Transforms use it identify the break point between two substrings in the - incoming data. - - **index** - This is the integer value for the desired array element after - the incoming data has been split into a list. The array is a 0-based object, - so the first array element would be index 0, the second element would be - index 1, etc. + - **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. + - **delimiter** - This can be either a single character or a regex expression. Transforms use it identify the break point between two substrings in the incoming data. + - **index** - This is the integer value for the desired array element after the incoming data has been split into a list. The array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **throws** - This boolean (true/false) value indicates whether an exception - is thrown and returned as an output when an index is out of bounds with the - resulting array (i.e., the provided `index` value is larger than the size of - the array). + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **throws** - This boolean (true/false) value indicates whether an exception is thrown and returned as an output when an index is out of bounds with the resulting array (i.e., the provided `index` value is larger than the size of the array). - true - The transform returns "IndexOutOfBoundsException". - false - The transform returns null. - - If no throws value is provided, the transform default to false and returns - a null. + - If no throws value is provided, the transform default to false and returns a null. ## Examples -This transform takes the incoming attribute configured in the Identity Profile -attribute UI, splits it based on the colon `:` character, and returns the second -array element (array index 1). +This transform takes the incoming attribute configured in the Identity Profile attribute UI, splits it based on the colon `:` character, and returns the second array element (array index 1). ```bash Input: "abc:123" @@ -92,8 +71,7 @@ Output: "123"
-This transform takes the explicit string provided, splits it based on the space -(" ") character, and returns the fourth word (array index 3). +This transform takes the explicit string provided, splits it based on the space (" ") character, and returns the fourth word (array index 3). ```bash Input: "The quick brown fox jumped over 10 lazy dogs" diff --git a/products/idn/docs/identity-now/transforms/operations/static.md b/products/idn/docs/identity-now/transforms/operations/static.md index a5f7038b5..b6d2c893a 100644 --- a/products/idn/docs/identity-now/transforms/operations/static.md +++ b/products/idn/docs/identity-now/transforms/operations/static.md @@ -4,42 +4,28 @@ title: Static pagination_label: Static sidebar_label: Static sidebar_class_name: static -keywords: ["transforms", "operations", "static"] +keywords: ['transforms', 'operations', 'static'] description: Return a fixed string value. slug: /docs/transforms/operations/static -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the static transform to return a fixed string value, or more commonly, to -evaluate -[Velocity Template Language](https://velocity.apache.org/engine/1.7/user-guide.html). -The latter implementation is often useful when you are using if/then/else logic -or iterating through a for loop. The static transform can also take other -dynamically provided variables as inputs into the `value` attribute. +Use the static transform to return a fixed string value, or more commonly, to evaluate [Velocity Template Language](https://velocity.apache.org/engine/1.7/user-guide.html). The latter implementation is often useful when you are using if/then/else logic or iterating through a for loop. The static transform can also take other dynamically provided variables as inputs into the `value` attribute. :::note Other Considerations -- When you are using static transforms within the create profile for a source, - you can enter the value directly in the input field if the user selects Static - as the attribute type. -- Because IdentityNow supports the ability to order attributes in a create - profile, you can use the Velocity template of an attribute higher in the list - to generate a static value for an attribute that is lower in the list. For - example, if you wanted to generate an email address based on a display name, - you would need to do the follwing: - - Move the "displayName" attribute higher in the list so that it is created - before the email address. - - In the "mail" attribute, select Static for the attribute type. In the Static - Value field, enter `$displayName@yourdomain.com`. +- When you are using static transforms within the create profile for a source, you can enter the value directly in the input field if the user selects Static as the attribute type. +- Because IdentityNow supports the ability to order attributes in a create profile, you can use the Velocity template of an attribute higher in the list to generate a static value for an attribute that is lower in the list. For example, if you wanted to generate an email address based on a display name, you would need to do the follwing: + - Move the "displayName" attribute higher in the list so that it is created before the email address. + - In the "mail" attribute, select Static for the attribute type. In the Static Value field, enter `$displayName@yourdomain.com`. ::: ## Transform Structure -In addition to the standard `type` and `name` attributes, the static transform -requires a value attribute to be specified: +In addition to the standard `type` and `name` attributes, the static transform requires a value attribute to be specified: ```json { @@ -56,25 +42,16 @@ requires a value attribute to be specified: - **Required Attributes** - **type** - This must always be set to `static.` - - **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. - - **value** - This must evaluate to a JSON string either through a fixed value - or through conditional logic using Velocity Template Language. + - **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. + - **value** - This must evaluate to a JSON string either through a fixed value or through conditional logic using Velocity Template Language. - **Optional Attributes** - - The static transform can implement variables within the `value` expression. - These variables can be defined as optional attributes within the transform - and can themselves be the results of other transforms. - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. + - The static transform can implement variables within the `value` expression. These variables can be defined as optional attributes within the transform and can themselves be the results of other transforms. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. ## Examples -This transform uses a dynamic variable called `workerType`, which is set to the -value of the user's HR record's empType value. The static transform then returns -that value through the use of Velocity variable notation (i.e., -`$
-This transform extends the previous one to show how you can use if/else logic to -return data based on contingent logic. +This transform extends the previous one to show how you can use if/else logic to return data based on contingent logic. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/substring.md b/products/idn/docs/identity-now/transforms/operations/substring.md index a0312445e..6cf135736 100644 --- a/products/idn/docs/identity-now/transforms/operations/substring.md +++ b/products/idn/docs/identity-now/transforms/operations/substring.md @@ -4,31 +4,25 @@ title: Substring pagination_label: Substring sidebar_label: Substring sidebar_class_name: substring -keywords: ["transforms", "operations", "substring"] +keywords: ['transforms', 'operations', 'substring'] description: Get the inner portion of a string passed into the transform. slug: /docs/transforms/operations/substring -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the substring transform to get the inner portion of a string passed into the -transform. You can use the substring transform to get the first n characters or -get a set number of characters within the middle of a string. +Use the substring transform to get the inner portion of a string passed into the transform. You can use the substring transform to get the first n characters or get a set number of characters within the middle of a string. :::note Other Considerations -- The substring transform does not currently provide an easy way to get the last - n characters of a string. To do so, use the - [Get End of String](./get-end-of-string.md) transform. +- The substring transform does not currently provide an easy way to get the last n characters of a string. To do so, use the [Get End of String](./get-end-of-string.md) transform. ::: ## Transform Structure -In addition to the standard `type` and `name` attributes, the substring -transform requires you to provide the beginning location of the input, which -indicates the start of the desired substring output: +In addition to the standard `type` and `name` attributes, the substring transform requires you to provide the beginning location of the input, which indicates the start of the desired substring output: ```json { @@ -45,39 +39,21 @@ indicates the start of the desired substring output: - **Required Attributes** - **type** - This must always be set to `substring.` - - **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. - - **begin** - This is the integer value for the location within the input data - that contains the first character of the substring you want to return. - - If `begin` is set to -1, the transform begins at character 0 of the input - data. + - **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. + - **begin** - This is the integer value for the location within the input data that contains the first character of the substring you want to return. + - If `begin` is set to -1, the transform begins at character 0 of the input data. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **beginOffset** - This integer value is the number of characters to add to - the `begin` attribute when the transform returns a substring. The transform - only uses this attribute if `begin` is not -1. - - **end** - This is the integer value for the location within the input data - that no longer contains the substring you want to return. - - If `end` is -1 or not provided at all, the substring transform returns - everything up to the end of the input string. - - **endOffset** - This integer value is the number of characters to add to the - `end` attribute when the transform returns a substring. The transform only - uses this attribute if `end` is provided and is not -1. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **beginOffset** - This integer value is the number of characters to add to the `begin` attribute when the transform returns a substring. The transform only uses this attribute if `begin` is not -1. + - **end** - This is the integer value for the location within the input data that no longer contains the substring you want to return. + - If `end` is -1 or not provided at all, the substring transform returns everything up to the end of the input string. + - **endOffset** - This integer value is the number of characters to add to the `end` attribute when the transform returns a substring. The transform only uses this attribute if `end` is provided and is not -1. + - **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. ## Examples -This transform uses a zero-based array to determine that the letter "c" is the -begin index of the substring it will return because "c" is in index location 2. -Index location 4 contains the letter "e," so the transform will return a -substring consisting of anything between the letters "c" and "e," including "c" -but excluding "e". +This transform uses a zero-based array to determine that the letter "c" is the begin index of the substring it will return because "c" is in index location 2. Index location 4 contains the letter "e," so the transform will return a substring consisting of anything between the letters "c" and "e," including "c" but excluding "e". ```bash Input: "abcdef" @@ -101,13 +77,7 @@ Output: "cd"
-This transform uses a zero-based array to determine that the substring transform -must begin with the letter "c" because even though the letter "b' is in index -location 1, the beginOffset value indicates one additional character must be -skipped. Index location 3 contains the letter "d," so the transform would -normally end at the character preceding "d." However, with the endOffset value -set to 2, the transform must include an additional two characters, "d" and "e". -Thus, the transform returns "cde". +This transform uses a zero-based array to determine that the substring transform must begin with the letter "c" because even though the letter "b' is in index location 1, the beginOffset value indicates one additional character must be skipped. Index location 3 contains the letter "d," so the transform would normally end at the character preceding "d." However, with the endOffset value set to 2, the transform must include an additional two characters, "d" and "e". Thus, the transform returns "cde". ```bash Input: "abcdef" diff --git a/products/idn/docs/identity-now/transforms/operations/trim.md b/products/idn/docs/identity-now/transforms/operations/trim.md index 9d358bef9..e34f33e60 100644 --- a/products/idn/docs/identity-now/transforms/operations/trim.md +++ b/products/idn/docs/identity-now/transforms/operations/trim.md @@ -4,16 +4,15 @@ title: Trim pagination_label: Trim sidebar_label: Trim sidebar_class_name: trim -keywords: ["transforms", "operations", "trim"] +keywords: ['transforms', 'operations', 'trim'] description: Trim whitespaces from both the beginning and ending of input strings. slug: /docs/transforms/operations/trim -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the trim transform to trim whitespaces from both the beginning and ending of -input strings. +Use the trim transform to trim whitespaces from both the beginning and ending of input strings. ## Transform Structure @@ -31,17 +30,11 @@ The trim transform only requires the transform's `type` and `name` attributes: - **Required Attributes** - **type** - This must always be set to `trim`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples diff --git a/products/idn/docs/identity-now/transforms/operations/upper.md b/products/idn/docs/identity-now/transforms/operations/upper.md index 697980108..e7453c40e 100644 --- a/products/idn/docs/identity-now/transforms/operations/upper.md +++ b/products/idn/docs/identity-now/transforms/operations/upper.md @@ -4,10 +4,10 @@ title: Upper pagination_label: Upper sidebar_label: Upper sidebar_class_name: upper -keywords: ["transforms", "operations", "upper"] +keywords: ['transforms', 'operations', 'upper'] description: Convert an input string into all uppercase letters. slug: /docs/transforms/operations/upper -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview @@ -30,17 +30,11 @@ The upper transform only requires the transform's `type` and `name` attributes: - **Required Attributes** - **type** - This must always be set to `upper`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. - - **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. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. + - **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. ## Examples diff --git a/products/idn/docs/identity-now/transforms/operations/username-generator.md b/products/idn/docs/identity-now/transforms/operations/username-generator.md index 6747d3879..0a2ca42e6 100644 --- a/products/idn/docs/identity-now/transforms/operations/username-generator.md +++ b/products/idn/docs/identity-now/transforms/operations/username-generator.md @@ -4,55 +4,30 @@ title: Username Generator pagination_label: Username Generator sidebar_label: Username Generator sidebar_class_name: usernameGenerator -keywords: ["transforms", "operations", "username", "generator"] +keywords: ['transforms', 'operations', 'username', 'generator'] description: Derive a unique value for an attribute in an account create profile. slug: /docs/transforms/operations/username-generator -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the username generator transform to specify logic to use when it derives a -unique value for an attribute in an account create profile. The generator's -logic can be as simple as a combination of parts of a user's name and/or HR data -(e.g., firstName.lastName), but sometimes generator logic such as a uniqueness -counter can be necessary to find a unique value in the target system (e.g., -firstName.lastName1 if firstName.lastName is already taken). +Use the username generator transform to specify logic to use when it derives a unique value for an attribute in an account create profile. The generator's logic can be as simple as a combination of parts of a user's name and/or HR data (e.g., firstName.lastName), but sometimes generator logic such as a uniqueness counter can be necessary to find a unique value in the target system (e.g., firstName.lastName1 if firstName.lastName is already taken). :::note Other Considerations -- The transform allows you to use "uniqueCounter" as a reserved variable for - numerically trying the next iteration of the pattern. Once the generator is - active on a pattern with the "uniqueCounter," it will keep incrementing until - it either has found a unique username candidate, or it exhausts the - "cloudMaxUniqueChecks" value. This means that the generator does not process - any patterns after one containing "uniqueCounter." The "uniqueCounter" **must - always be last** in the pattern list. -- Within the account attribute definition structure, there is a field for - "cloudMaxUniqueChecks" that identifies how many times the generator must - invoke the uniqueness check logic before it stops executing. The maximum - allowed value for this field is 50. +- The transform allows you to use "uniqueCounter" as a reserved variable for numerically trying the next iteration of the pattern. Once the generator is active on a pattern with the "uniqueCounter," it will keep incrementing until it either has found a unique username candidate, or it exhausts the "cloudMaxUniqueChecks" value. This means that the generator does not process any patterns after one containing "uniqueCounter." The "uniqueCounter" **must always be last** in the pattern list. +- Within the account attribute definition structure, there is a field for "cloudMaxUniqueChecks" that identifies how many times the generator must invoke the uniqueness check logic before it stops executing. The maximum allowed value for this field is 50. ::: ## Transform Structure -The username generator transform is intended for use as a configuration within -the account create profile for a source. Thus, this transform's structure is -more extensive than a typical Seaspray implementation -- it must be assigned to -a create profile attribute (designated by `name`) and provide certain uniqueness -check attributes such as `cloudMaxSize`, `cloudMaxUniqueChecks`, and -`cloudRequired`. +The username generator transform is intended for use as a configuration within the account create profile for a source. Thus, this transform's structure is more extensive than a typical Seaspray implementation -- it must be assigned to a create profile attribute (designated by `name`) and provide certain uniqueness check attributes such as `cloudMaxSize`, `cloudMaxUniqueChecks`, and `cloudRequired`. -The `cloudMaxSize` attribute denotes the maximum length of generated data -allowable as a result of the generator logic. The transform truncates any -characters over the `cloudMaxSize`. The `cloudMaxUniqueChecks` attribute -determines the maximum number of iterations the generator must attempt before -failing to generate a value. The `cloudRequired` attribute is an internal flag -required for the IdentityNow platform - leave it as `true`. +The `cloudMaxSize` attribute denotes the maximum length of generated data allowable as a result of the generator logic. The transform truncates any characters over the `cloudMaxSize`. The `cloudMaxUniqueChecks` attribute determines the maximum number of iterations the generator must attempt before failing to generate a value. The `cloudRequired` attribute is an internal flag required for the IdentityNow platform - leave it as `true`. -Provide the username generator transform itself in the create profile attribute -entry's `transform` parameter. +Provide the username generator transform itself in the create profile attribute entry's `transform` parameter. ```json { @@ -122,37 +97,19 @@ entry's `transform` parameter. - **Required Attributes** - **type** - This must always be set to `usernameGenerator`. - - **patterns** - This is a JSON array of patterns for the generator to - evaluate for uniqueness, in sequential order. - > **Note** that you can leverage `$uniqueCounter` here to automatically - > increment a counter if the generated value is not available and you want - > to try appending numeric values (i.e., 1, 2, 3, etc.) instead of - > progressing beyond the current pattern. + - **patterns** - This is a JSON array of patterns for the generator to evaluate for uniqueness, in sequential order. + > **Note** that you can leverage `$uniqueCounter` here to automatically increment a counter if the generated value is not available and you want to try appending numeric values (i.e., 1, 2, 3, etc.) instead of progressing beyond the current pattern. - **Optional Attributes** - - **sourceCheck** - This boolean value (true/false) indicates whether the - generator must check only the IdentityNow database's representation of - accounts for uniqueness, or whether it must query the target system - directly. If no value is provided, the attribute defaults to `false`. - - `true` indicates the generator must check the target system directly. The - generator only respects this setting if the system supports the - `getObject` functionality. For systems that lack the ability to query for - single account objects, the generator ignores this setting and defaults to - `false`. The generator only checks the attribute identified in the account - schema as the `accountID`. - - `false` indicates the generator must check only the IdentityNow database - of accounts. The generator only checks the `accountID`. + - **sourceCheck** - This boolean value (true/false) indicates whether the generator must check only the IdentityNow database's representation of accounts for uniqueness, or whether it must query the target system directly. If no value is provided, the attribute defaults to `false`. + - `true` indicates the generator must check the target system directly. The generator only respects this setting if the system supports the `getObject` functionality. For systems that lack the ability to query for single account objects, the generator ignores this setting and defaults to `false`. The generator only checks the attribute identified in the account schema as the `accountID`. + - `false` indicates the generator must check only the IdentityNow database of accounts. The generator only checks the `accountID`. ## Examples -This generator takes the user's first initial, appends the user's full last -name, and then leverages a uniqueness counter to generate a unique value for -userId. For example, if the user's name were John Doe, the username generator -would first try `jdoe.` If that were not unique, it would progress to `jdoe1`, -then `jdoe2`, until `jdoe25`. +This generator takes the user's first initial, appends the user's full last name, and then leverages a uniqueness counter to generate a unique value for userId. For example, if the user's name were John Doe, the username generator would first try `jdoe.` If that were not unique, it would progress to `jdoe1`, then `jdoe2`, until `jdoe25`. -If the generator does not find a unique value within the first 25 tries, it -returns an IllegalStateException. +If the generator does not find a unique value within the first 25 tries, it returns an IllegalStateException. **Transform Request Body**: @@ -200,14 +157,9 @@ returns an IllegalStateException.
-This generator takes the user's first name, appends a period and then the user's -full last name, and then adds a uniqueness counter to generate a unique value -for accountId. For example, if the user's name were Adam Smith, the username -generator would first try "adam.smith". If that were not unique, it would -progress to "adam.smith1", then "adam.smith2", until "adam.smith10". +This generator takes the user's first name, appends a period and then the user's full last name, and then adds a uniqueness counter to generate a unique value for accountId. For example, if the user's name were Adam Smith, the username generator would first try "adam.smith". If that were not unique, it would progress to "adam.smith1", then "adam.smith2", until "adam.smith10". -If the generator does not find a unique value within the first 10 tries, it -returns an IllegalStateException. +If the generator does not find a unique value within the first 10 tries, it returns an IllegalStateException. **Transform Request Body**: diff --git a/products/idn/docs/identity-now/transforms/operations/uuid-generator.md b/products/idn/docs/identity-now/transforms/operations/uuid-generator.md index 388e06a73..1d8d5d59b 100644 --- a/products/idn/docs/identity-now/transforms/operations/uuid-generator.md +++ b/products/idn/docs/identity-now/transforms/operations/uuid-generator.md @@ -4,30 +4,25 @@ title: UUID Generator pagination_label: UUID Generator sidebar_label: UUID Generator sidebar_class_name: uuidGenerator -keywords: ["transforms", "operations", "uuid", "generator"] +keywords: ['transforms', 'operations', 'uuid', 'generator'] description: Create a universal unique ID (UUID). slug: /docs/transforms/operations/uuid-generator -tags: ["Transforms", "Transform Operations"] +tags: ['Transforms', 'Transform Operations'] --- ## Overview -Use the UUID generator transform to create a universal unique ID (UUID) in the -form of a 36-character string. +Use the UUID generator transform to create a universal unique ID (UUID) in the form of a 36-character string. :::note Other Considerations -There is no uniqueness checking in this transform - the underlying code is -written to provide a 1 in 68,719,476,736 chance of creating a string that -actually collides with another string within the tenant, so the generated UUID's -uniqueness is very likely, but it is not guaranteed. +There is no uniqueness checking in this transform - the underlying code is written to provide a 1 in 68,719,476,736 chance of creating a string that actually collides with another string within the tenant, so the generated UUID's uniqueness is very likely, but it is not guaranteed. ::: ## Transform Structure -The UUID generator transform only requires the transform's `type` and `name` -attributes: +The UUID generator transform only requires the transform's `type` and `name` attributes: ```json { @@ -41,13 +36,10 @@ attributes: - **Required Attributes** - **type** - This must always be set to `uuid`. - - **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. + - **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. - **Optional Attributes** - - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether - the transform logic should be reevaluated every evening as part of the - identity refresh process. + - **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process. ## Examples diff --git a/products/idn/sidebar.js b/products/idn/sidebar.js index 0434a1f12..4b9c45253 100644 --- a/products/idn/sidebar.js +++ b/products/idn/sidebar.js @@ -1,59 +1,59 @@ const sidebars = { openApiSidebar: [ { - type: "category", - label: "IdentityNow", + type: 'category', + label: 'IdentityNow', collapsible: false, items: [ { - type: "doc", - id: "api/getting-started", + type: 'doc', + id: 'api/getting-started', }, { - type: "doc", - id: "api/authentication", + type: 'doc', + id: 'api/authentication', }, { - type: "doc", - id: "api/standard-collection-parameters", + type: 'doc', + id: 'api/standard-collection-parameters', }, { - type: "doc", - id: "api/rate-limit", + type: 'doc', + id: 'api/rate-limit', }, { - type: "category", - label: "V3 APIs", + type: 'category', + label: 'V3 APIs', link: { - type: "generated-index", - title: "V3 APIs", + type: 'generated-index', + title: 'V3 APIs', description: - "Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.", - slug: "/api/v3", + 'Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.', + slug: '/api/v3', }, // @ts-ignore - items: require("./api/v3/sidebar.js"), + items: require('./api/v3/sidebar.js'), }, { - type: "category", - label: "Beta APIs", + type: 'category', + label: 'Beta APIs', link: { - type: "generated-index", - title: "Beta APIs", + type: 'generated-index', + title: 'Beta APIs', description: - "TUse these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.", - slug: "/api/beta", + 'TUse these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.', + slug: '/api/beta', }, // @ts-ignore - items: require("./api/beta/sidebar.js"), + items: require('./api/beta/sidebar.js'), }, ], }, ], idnDocs: [ { - type: "autogenerated", - dirName: "docs", + type: 'autogenerated', + dirName: 'docs', }, ], }; diff --git a/products/iiq/sidebar.js b/products/iiq/sidebar.js index 9d1de5634..a55c482d2 100644 --- a/products/iiq/sidebar.js +++ b/products/iiq/sidebar.js @@ -1,17 +1,17 @@ const sidebars = { iiqOpenApiSidebar: [ { - type: "category", - label: "IdentityIQ API", + type: 'category', + label: 'IdentityIQ API', link: { - type: "generated-index", - title: "IdentityIQ API", + type: 'generated-index', + title: 'IdentityIQ API', description: "These are the SCIM APIs for SailPoint's on-premise service, IdentityIQ. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.", - slug: "/api", + slug: '/api', }, // @ts-ignore - items: require("./api/sidebar.js"), + items: require('./api/sidebar.js'), }, ], }; diff --git a/src/components/conference/FAQ/index.js b/src/components/conference/FAQ/index.js index f3c7619e4..23b8bcc5b 100644 --- a/src/components/conference/FAQ/index.js +++ b/src/components/conference/FAQ/index.js @@ -1,7 +1,7 @@ -import React from "react"; -import clsx from "clsx"; -import styles from "./styles.module.css"; -import Link from "@docusaurus/Link"; +import React from 'react'; +import clsx from 'clsx'; +import styles from './styles.module.css'; +import Link from '@docusaurus/Link'; export default function FAQ() { return ; } diff --git a/src/components/conference/Hero/index.js b/src/components/conference/Hero/index.js index 324bb39e1..77a8f8973 100644 --- a/src/components/conference/Hero/index.js +++ b/src/components/conference/Hero/index.js @@ -1,11 +1,11 @@ -import React from "react"; -import styles from "./styles.module.css"; -import useBaseUrl from "@docusaurus/useBaseUrl"; -import ThemedImage from "@theme/ThemedImage"; -import { addDarkToFileName } from "../../../util/util"; -import { SliderButton } from "@typeform/embed-react"; +import React from 'react'; +import styles from './styles.module.css'; +import useBaseUrl from '@docusaurus/useBaseUrl'; +import ThemedImage from '@theme/ThemedImage'; +import {addDarkToFileName} from '../../../util/util'; +import {SliderButton} from '@typeform/embed-react'; export default function ConferenceHero() { - const communication = "/conf/codey-surfing-small.png"; + const communication = '/conf/codey-surfing-small.png'; return (
![]({useBaseUrl("/homepage/edit.png")})
+ src={useBaseUrl('/homepage/edit.png')}>
);
let linkText = ![]({useBaseUrl("/homepage/liked.png")})
+ src={useBaseUrl('/homepage/liked.png')}>
{solved}
Our docs and API specifications have recently moved—checkout the
navbar at the top of this page to find their new home. If you
- can't find the document you're looking for,{" "}
+ can't find the document you're looking for,{' '}
+ rel="noopener noreferrer">
let us know
.
@@ -37,10 +35,9 @@ export default function NotFound() {