Array Sets (Redwood)

Array Control Attributes can be used to set the size of an array set. Number and Menu type attributes can be designated as an Array Control Attribute. A single Array Control Attribute can be associated with multiple array sets.

Array Control Attribute Behavior

The Array Control Attribute for array sets is optional. If the Array Control Attribute is not defined, the size of the array set is controlled by create and delete actions. This behavior is intentionally different from Configuration, where the array set size is always "1" when the Array Control attribute is not defined.

The following conditions exist when an Array Control Attribute is defined:

• When an Array Control Attribute is an number attribute, the validation of attribute is changed to Check Range, with the minimum set to 0. The minimum and maximum values can be modified.
• When an Array Control Attribute is a Menu attribute, it must be Single-Select Menu.
  The variable names of the menu items must be non-negative integers.
• The add and delete actions are dynamically enabled and disabled as described below:
  • When the Array Control Attribute is set to read-only or hidden by workflow steps, Add and Delete buttons are disabled.
  • When an array set reaches the maximum size, add is disabled.
  • When an array set reaches the minimum size, delete is disabled.
  • When the Array Control Attribute is a Menu attribute, add and delete buttons are disabled.
  • When the Array Control Attribute controls more than one array set, add and delete buttons are disabled.

Administrators can use transaction array set attributes in the Commerce Access Rules. Array attributes can be used in both simple and advanced modes for the Condition and for the Components to Hide/Read-only sections of the access rules. Transaction array hiding behaviors are similar to Configuration array set behaviors.

Transaction array attribute hiding behaviors are as follows:

• If an array attribute is used as a simple condition and the components to hide only uses document attributes, the result is that the document attributes are hidden if any array row meets the condition.
• If an array attribute is used as a simple condition and the components to hide also use array attributes, the result is cell-level hiding as determined on a row-by-row basis.
• If a simple condition exists without referencing an array attribute and the components to hide uses array attributes, the result is that the entire array column is hidden.
• If an advanced condition is used either with or without array attributes and the components to hide uses array attributes, the result is that the entire array column is hidden.
• If a condition is "Always True" and the components to hide uses array attributes, the result is that the entire array column is hidden.
  
  

The Attributes tab provides access to main document or sub-document level array sets.

• To access Commerce arrays set, navigate to:  Admin Home > Quotes > Process > Manage Transaction or Manage Transaction Line > Attributes, then click on the applicable array set.

Perform the following steps to create an array set with array attributes:

1. Navigate  Admin Home > Quotes > Process > Manage Transaction or Manage Transaction Line > Attributes

2. To edit an array, click on the Name of the applicable array.

3. To add an array, click + Attribute, then select or enter the following information:

   1. Type:Array Set

   2. What is the name of the attribute? Enter the name of the array.

   3. Enter the Variable Name.

      The Variable Name field populates automatically. You can change the entry before saving. After saving, the value is read-only. Variable names can only contain alpha-numeric characters and underscores.

   4. Click Create.

4. Enter the Basic Information options.

   1. If applicable, enter a Description.

   2. If applicable, select an Array Control Attribute from the Size Attribute menu.

      Notes:

      • If Access Rules are used to hide a transaction array, administrators should designate an Array Controller Attribute for the transaction array and set the minimum value to one or more.
      • If there are no Array Control Attributes listed refer to Designate an Attribute as an Array Control Attribute.
      • When an Array Control Attribute is an Integer attribute, the validation of attribute is changed to Check Range, with the minimum set to 0. The minimum and maximum values can be modified.
      • When an Array Control Attribute is a Menu attribute, it must be Single-Select Menu.
        
        The variable names of the menu items must be non-negative integers.
      • The add and delete actions are dynamically enabled and disabled as described below:
        • When the Array Control Attribute is set to read-only or hidden by workflow steps, Add and Delete buttons are disabled.
        • When an array set reaches the maximum size, add is disabled.
        • When an array set reaches the minimum size, delete is disabled.
        • When the Array Control Attribute is a Menu attribute, add and delete buttons are disabled.
        • When the Array Control Attribute controls more than one array set, add and delete buttons are disabled.
5. Add array attributes in the Array Attribute List section.

   1. Click + Attribute.

   2. Select the attribute Type, then enter the Name and Variable Name.

   3. Click Create, then define the applicable settings. Refer to Commerce Attributes (Redwood) for more information.

   4. Click Save & Close.

   5. Repeat this step to add additional attributes.

6. To reorder attributes:

   1. Click on the Reorder icon.

   2. Drag and drop the attributes into the desired order.

   3. Click Save.

7. Click the Translations icon to add translations.

8. Select one of the following:

   • Click Save to save changes and remain on the current page.

   • Click Save & Close to save changes and return to the attributes list page.

   • Click Cancel to return to the attributes list page without saving changes.

Perform the following steps to create an array set with array attributes:

1. Navigate  Admin Home > Quotes > Process > Manage Transaction or Manage Transaction Line > Attributes

2. To edit an array, click on the Name of the applicable array.

3. Enter the Basic Information options.

   1. If applicable, enter a Description.

   2. If applicable, select an Array Control Attribute from the Size Attribute menu.

      Notes:

      • If Access Rules are used to hide a transaction array, administrators should designate an Array Controller Attribute for the transaction array and set the minimum value to one or more.
      • If there are no Array Control Attributes listed refer to Designate an Attribute as an Array Control Attribute.
      • When an Array Control Attribute is an Integer attribute, the validation of attribute is changed to Check Range, with the minimum set to 0. The minimum and maximum values can be modified.
      • When an Array Control Attribute is a Menu attribute, it must be Single-Select Menu.
        
        The variable names of the menu items must be non-negative integers.
      • The add and delete actions are dynamically enabled and disabled as described below:
        • When the Array Control Attribute is set to read-only or hidden by workflow steps, Add and Delete buttons are disabled.
        • When an array set reaches the maximum size, add is disabled.
        • When an array set reaches the minimum size, delete is disabled.
        • When the Array Control Attribute is a Menu attribute, add and delete buttons are disabled.
        • When the Array Control Attribute controls more than one array set, add and delete buttons are disabled.
4. Manage array attributes in the Array Attribute List section.

   1. To edit an attribute, click on the attribute Name.

   2. To add an attribute:

      1. Click + Attribute.

      2. Select the attribute Type, then enter the Name and Variable Name.

      3. Click Create, then define the applicable settings. Refer to Commerce Attributes (Redwood) for more information.

      4. Click Save & Close.

      5. Repeat this step to add additional attributes.

   3. To reorder attributes:

      1. Click on the Reorder icon.

      2. Drag and drop the attributes into the desired order.

      3. Click Save.

   4. To delete array attributes:

      1. Check the Select option next to the applicable attribute(s).
      2. Click the Delete icon.

      3. Click Delete.

5. Click the Translations icon to add translations.

6. Select one of the following:

   • Click Save to save changes and remain on the current page.

   • Click Save & Close to save changes and return to the attributes list page.

   • Click Cancel to return to the attributes list page without saving changes.

Perform the following steps to delete an array set:

1. Navigate  Admin Home > Quotes > Process > Manage Transaction or Manage Transaction Line > Attributes

2. Select Delete for the array set's ellipsis menu.

3. Click Delete.

   Notes:

   • You can only delete empty array sets, refer to Delete Array Set Attributes.

   • You can't delete standard process arrays.

Perform the following steps to delete an array set:

1. navigate to:  Admin Home > Quotes > Process > Manage Transaction or Manage Transaction Line > Attributes.

2. Click on the name of the applicable array set.

3. Check the Select option next to the applicable attribute(s).
4. Click the Delete icon.

5. Click Delete.

6. Click Save or Save and Close.

1. Create a data table (e.g. Shipping_Options Data Table).
   1. Add the applicable data table columns; e.g. Service_Level (String), Delivery_Timeframe (String), and Shipping_Cost (Float).

   2. Populate the data table data.

      

      For more detailed instructions, refer to Data Table Maintenance.

2. Create an array set (e.g. Shipping Options Transaction Array)

   The Shipping Options (shippingOptions) Commerce Array Set Attribute contains three array attributes: Service Level (serviceLevel), Delivery Timeframe (deliveryTimeframe), and Shipping Cost (shippingCost). These attributes correspond to the columns in the data table.

3. Create a Commerce Modify type action to populate the array set (e.g. populateShippingOptions)

   This example uses an Advanced Modify - Before Formula to define a function for the action.

   1. Select an attribute (e.g.Variable Name for (Transaction) tab > _transaction_document_number)

   2. Enter the BML script into the BML Editor and click Save.

      View Sample BML Script

      //  Define the String parameter that will be returned by the function.
      returnString = "";
      
      //  Define a JSON Array to hold the extracted data from the Data Table.
      shippingMethods = jsonArray();
      
      //  Perform BMQL Query of the "Shipping Options" Data Table to gather all of data rows.
      optionList = bmql("select Service_Level, Delivery_Timeframe, Shipping_Cost from Shipping_Options");
      
      //  Perform a loop over the returned Data Table rows.
      for option in optionList {
      //      Create a JSON string containing the data from the rows of the Data Table.	
              optionJson = json();
      //      Put into the optionJson string the Key:Value pairs for each column in the table.
      	jsonput(optionJson,"serviceLevel",get(option,"Service_Level"));
      	jsonput(optionJson,"deliveryTimeframe",get(option,"Delivery_Timeframe"));
      	jsonput(optionJson,"shippingCost",get(option,"Shipping_Cost"));
      
      //      Append the optionJson string to the shippingMethods JSON Array object.  Each iteration adds one row to the JSON Array.	
      	jsonarrayappend(shippingMethods, optionJson);	
      }
      
      //  Build the returnString, adding the transaction_document_number (which is required), the Array Set Commerce attribute (shippingOptions)
      //  and the JSON Reference ID of the shippingMethods JSON Array.
      returnString = returnString + _transaction_document_number + "~shippingOptions~" + jsonarrayrefid(shippingMethods) + "|";
      	
      return returnString;

4. Add the populate action and array set to the applicable layout

The bulk of back-end integration is accomplished by exchanging XML data between Oracle CPQ and other third party systems. Oracle CPQ Release supports array set data for outbound XML integrations. XML Integration is the mechanism that sends Transaction XML to a third party server when a transition rule is fired.

The following sample displays an XML fragment for the "feeArraySet"

<feeArraySet maxRowNum="4">
    <_array_set_row _row_number="1">
        <feeType>
            <![CDATA[ water ]]>
        </feeType>
        <feeAmount>
          <![CDATA[ 100.0 ]]>
        </feeAmount>
    </_array_set_row>
    <_array_set_row _row_number="3">
        <feeType>
            <![CDATA[ gas ]]>
        </feeType>
        <feeAmount>
          <![CDATA[ 200.0 ]]>
        </feeAmount>
    </_array_set_row>
</feeArraySet>