Bulk Updates User Guide
Bulk Updates User Guide
Bulk Updates
Bulk Updates 4
Setup Requirements 4
Additional Information 4
Configuration 25
Configuration 28
Workflow: Reassign 62
Configuration 62
Prerequisites 72
Prerequisites 78
The Bulk Update wizard guides a user through the process, and ensures all necessary settings and data is provided to run the update.
Setup Requirements
Setting up and using a bulk update involves the following steps:
1. Determine the method required to start the Bulk Update wizard as described in Creating a Bulk Update.
2. In the wizard, choose a previously saved configuration or create a new one as described in Bulk Update Configuration.
3. In the wizard, choose one or more operations that will run during the update as described in Bulk Update Operations.
4. In the wizard, supply the required parameters as described in Bulk Update Parameters.
5. In the wizard, review the expected results of the update as described in Bulk Update Preview.
6. In the wizard, set the required options and run the bulk update as described in Bulk Update Advanced.
Additional Information
The following information is useful once a bulk update is created or run:
1. Monitor a bulk update through a background process as described in Monitoring Bulk Updates.
2. Schedule a bulk update as described in Scheduling Bulk Updates for Collections.
3. Export a bulk update definition as comments and submit to an external source control system for comparison purposes as described in Configuration Management
documentation.
2. Use one of the following methods to select data to be updated and launch the Bulk Update wizard.
Run on all objects in a single collection or multiple collections: In Tree, select one or more collections,
right-click and choose Run Bulk Update.
Run on a single or multiple selected objects in Tree or System Setup: Select one or more of the objects
defined in the following table, then from the menu choose File > Bulk Update > Run Bulk Update.
Note: To run a saved bulk update configuration (which loads the operations and settings) first start the wizard, and then choose
the existing configuration on the Configuration step shown below.
Run on search results: Perform a search, and click the Bulk Update button ( ).
For more on the Advanced Search tab in the workbench, refer to the Advanced Search topic in the Getting Started documentation.
Bulk Update Configuration allows you to choose a previously saved configuration or create a new one.
Bulk Update Operations allows you to choose one or more operations that will run during the update.
Bulk Update Preview allows you to review the expected results of the update.
Bulk Update Advanced allows you to set the required options and start the background process that runs the
bulk update.
Click the 'Use Existing Configuration' radio button to use a saved bulk update configuration, then click the
ellipsis button ( ) to display the configuration selection dialog. Use the Browse or Search tab to select the
Click the 'Create New Configuration' radio button to create a new configuration.
2. Click the Next button to display the Bulk Update Operations step.
For a new configuration, the default 'Merge Attribute Values' operation is displayed. Select the desired
operation from the dropdown as defined in the individual topics that follow this topic.
Click the 'Add Operation' link to configure an additional operation.
Click the delete button ( ) to remove an operation.
Click the up and down arrow buttons ( ) to change the order of the operations applied to the update.
Important: Ensure that the operations are listed in the order that they need to be performed—from the top down. This means that
when multiple operations are included, those run first can be overwritten by operations that run later. If one operation fails for an
object (for example, due to validation base type mismatch), all changes to the object will be rolled back and the object will be left
as it was prior to applying the Bulk Update.
2. Click the Next button to display the Bulk Update Parameters step.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Select Clear Value (found under 'Attribute values') from the dropdown.
2. For the Attribute parameter, click the ellipsis button ( ) and make an attribute selection using standard Browse / Search node picker functionality within the Select Attribute
dialog.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can be started from System Setup by selecting an attribute, then right-click and select Merge Attribute Values. For details
about verifying the attributes before performing this operation, refer to the Merging Attribute Values section of the System Setup doc-
umentation.
This operation can also be run via the business rules functionality, as described in the Business Action: Merge Attribute Values topic in
the Business Rules documentation.
Note: The Merge Attribute Values operation does not delete any attributes, it can only update values. If desired, manually delete the
source attribute once you confirm the merged data.
Prerequisites
Before using this operation:
1. Ensure the source and target attributes are valid for all of the same object types, and for the object on which the business action will be run.
2. Ensure the source and target attributes are valid for all of the same product links and classification links.
3. Ensure the source and target attributes are valid for all of the same reference types.
4. Ensure the source and target attributes have the same dimension dependencies.
Configuration
1. Select Merge Attribute Values from the dropdown.
2. For the Merge parameter, click the selector button ( ) to display the Select Attribute dialog, choose the attribute to copy values from, and click the
Select button.
3. For the into parameter, click the selector button ( ) to display the Select Attribute dialog, choose the attribute to copy values to, and click the Select
button.
4. For the Source Workspace parameter, use the dropdown to select the workspace that holds the values to be copied. Values are always pasted into the
Main workspace.
Overwrite existing values means the source value overwrites the target value, except when the source
attribute is blank. If the source attribute is blank, the target value is not changed.
Keep Original values means the source value is only copied to the target attribute when the target attribute
is blank. If the target attribute contains a value, the target value is not changed.
6. For Merge Link Attributes, use the dropdown to select one of the following options. If the selected attributes are both used as an attribute on a
reference, a product classification link, or an attribute link, merging of those values are based on the Yes or No set in this parameter, as well as the other
parameters on the operation. This option is not relevant when values do not exist on references for the selected attributes.
Merge Results
As indicated in the following table, the source attribute value, target attribute values, and the overwrite setting together determine the end
result of this action.
Source Attribute Value Target Attribute Value Overwrite Setting Target After Merge
Examples
Consider the following example data, and assume that Overwrite existing values is selected (as described above). Selecting the Source
Workspace = Main will result in writing the T-shirt Size value of S, while selecting Source Workspace = Approved will write the XS value.
Consider the following data and the effects of the options as shown in the Preview images below. 'T-shirt Size' is the source attribute and
'Size' is the target attribute:
Notice that two values changed in this scenario: object 18210 M B had its value overwritten since a value existed for the source, and object 18212 L B
was overwritten since the source object had a value and the target value was blank. Objects 18213 M O and 18216 L O both had blank source values, so
the target values were not overwritten.
Consider the following values for the attributes 'Qty of Next Lower Package' and 'Qty of Next Higher Package' on the Case to Child ref-
erence.
For more information about attributes on references, refer to the Product Attribute Link Type section of the System Setup documentation.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation is similar to one in the business rules functionality, as described in the Business Action: Set Attribute Value topic in the
Business Rules documentation.
Configuration
1. Select Set Value from the dropdown.
2. For the first parameter, click the manual ( ) button or the function ( ) button and then click the ellipsis button ( ).
Note: The selected object dictates the label on the manual button. If the selected object requires a text value, the label is 'abc.' If
the selected object is numeric, '123' is displayed, and so on for each validation base type.
For manual selection, the Select Attribute dialog is displayed, select an attribute, and click Select.
For function selection, click the ellipsis button ( ) displayed near the text field to display the Function Editor
dialog. Add a function and evaluate, the click OK. Refer to the Using Function Editor topic within the
Resource Materials online help documentation for more information on writing functions.
3. For the second parameter (=), click the manual ( ) button or the function ( ) button.
For manual selection, type the value required for the selected attribute into the text field.
For function selection, click the ellipsis button ( ) displayed near the text field to display the Function Editor
dialog. Add a function and evaluate, the click OK. Refer to the Using Function Editor topic within the
Resource Materials online help documentation for more information on writing functions.
This operation allows users to run business actions on selected data container objects. When executing this operation, users can filter
which data container objects to work with by specifying a business condition and/or data container type, before running the specified busi-
ness action on those objects.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Select Update Data Containers from the dropdown.
2. In the Data Container Type parameter, (optional) click the ellipsis button ( ), select the data container type this operation should apply to, and click
Select.
3. In the Business Condition parameter, (optional) click the ellipsis button ( ), select the data container type this operation should apply to, and click
Select.
4. In the Business Action parameter, (required) click the ellipsis button ( ), select the data container type this operation should apply to, and click
Select.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Generate Match Codes topic in
the Business Rules documentation.
Prerequisites
Before using this operation. ensure match code objects exist as defined in the Match Codes topic of the Matching, Linking, and Merging
documentation.
Configuration
1. Select Generate Match Codes from the dropdown.
2. For Match Code, click the ellipsis button ( ) to display the Select a Match Code dialog, and the relevant match code.
Note: Collection objects should match to the match code object type and category.
This operation applies the selected matching algorithm on selected objects for the bulk update. This includes generating a list of possible
duplicates and a score that indicates how identical the objects are. And if a golden record matching algorithm is used it will also update
golden record links and re-apply survivorship rules.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Select Match Duplicates (apply matching algorithm) from the dropdown.
2. For the Matching Algorithm parameter, click the ellipsis button ( ), select the algorithm to use, and click Select.
Standardize Address bulk update operations are valid for execution on entities with flat attributes, e.g., Address object types and address
Data Containers (Data Containers with address attributes).
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Standardize Address topic in the
Business Rules documentation.
Prerequisites
Before a Standardize Address bulk update operation can be run, the following conditions must be met:
Users must be connected to a Loqate server, either through a cloud API or local API.
The Address Component Model must already be configured. It is strongly recommended to configure this component model using the 'Easy setup of
Address Component Model' wizard. For more information, refer to the Address Component Model section of the Data Integration documentation.
Be connected to Loqate through a local API (CASS components will not work with a Loqate Cloud API)
Configure the CASS Address Component Model. For more information, refer to the CASS Address
Component Model topic in the Data Integration documentation.
Configuration
This documentation topic describes the options available when configuring a Standardize Address bulk update operation. For more
detailed information on the overall Loqate and CASS solutions, refer to the Loqate Integration section of the Data Integration doc-
umentation.
Overwrite Existing Standardized Address: Overwrites an existing standardized address by making a call to Loqate, which returns the latest
standardized address and overwrites the existing one.
Generate Hash Value Only: When this option is chosen, the business action will recalculate the 'Validation Hash' value without making a call to Loqate.
The hash value is based on the address input fields only and is calculated and maintained by STEP.
This option is used in cases when pre-standardized addresses, which are known to be correct, are imported. Because the addresses
are new, no hash value is present. When the 'Generate Hash Value only' action is run, STEP generates a hash value and places it
into the 'Validation Hash' field. The hash value lets STEP know that the addresses are new, ensuring that they are not picked up and
restandardized by STEP shortly after they are imported. For users of the Loqate Cloud API solution, this saves money by avoiding
unnecessary calls to Loqate, since users are charged a fee for every call made to Loqate.
Disable Address Standardization: This option is primarily useful for users who import addresses in bulk, either manually or by using an inbound
integration. If a business rule is in place that runs a Standardize Address bulk update on import, then selecting 'Disable Address Standardization' is a
simple way to temporarily turn off automatic address validation on import. This allows users to validate the addresses later.
Important: For users of the Loqate Cloud installation, care should be exercised when using this functionality. Since all addresses
older than the specified time period will be revalidated, each additional validation will make a chargeable call to Loqate.
Turn on CASS validation for US addresses: If checked, all addresses are sent for standardization to the Loqate Local server
integration and also validated against CASS data.
CASS Certification Report Event Processor: If you would also like a CASS certification report generated after using CASS
validation on an address, click the ellipsis button ( ) and select the relevant CASS certification report event processor from the
This operation allows you to merge potential duplicates in a Clerical Review workflow from within the workbench.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. From the Operations dropdown, select Merge Golden Records and then Merge Clerical Review Tasks.
Current State - Select that state of the selected Clerical Review workflow
This operation allows Source Record Data for all sources or per source system to be purged for records with a current source system /
record ID reference to the Golden Records.
Important: Source data is purged for Golden Records that are not in the collection if they are or were previously associated with the
same source records as the Golden Records in the collection. This consideration applies for Golden Records and Source Records
that were part of a merge or unmerge.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. From the Operations dropdown, select Merge Golden Records and then Purge Source Data.
Purge source data for specific source systems - also select the desired source systems from the dropdown.
This operation allows you to reject potential duplicates in a Clerical Review workflow from within the workbench.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. From the Operations dropdown, select Merge Golden Records and then Reject Clerical Review Tasks.
Current State - Select that state of the selected Clerical Review workflow
This operation checks all actual pages saved to the selected publication / section to determine if updates are needed.
Checking documents for updates from within STEP Workbench is primarily useful for Print AutoPage and Print Flatplanner publications.
Since near-identical functionality can be accessed from other locations in the workbench (including right-clicking on a publication or sec-
tion object in the Tree and clicking 'Check for update needed...'), the use cases and applications for checking documents for updates are
detailed in the following publishing-specific topics instead:
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Select Check Publication Document for Needs Update from the dropdown.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Select Remove Flatplans from STEP Workflow from the dropdown.
2. For the Process Note parameter, type a name to be used by the background process.
Note: If only using one Flatplanner workflow, this removes all planned pages from the workflow.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Select Start Flatplans in STEP Workflow from the dropdown.
2. In the Workflow parameter, select the desired workflow from the dropdown.
Note: Only workflows valid for planned pages are displayed. Flatplans that are already in a workflow are not affected.
3. In the Process Note parameter, type a name for the background process.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Select Update Publication Document from the dropdown.
Update all contents of section: This updates all information on all actual pages saved to the selected publication, section, or DTP document.
Update only the following items of the selection: Choosing this allows for the selection of specific items to be updated on the actual pages, such as
attributes, image references, and table types.
If the attribute is on an object, it can be viewed on the References tab on the object, under the 'Linked Attributes from Product Hierarchy' flipper.
If the attribute does not have an editable field (or link) to store data, this option adds a link and allows data to be stored.
For more information on linked attributes refer to the Attribute Links topic in the System Setup documentation.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Add Attribute Link topic in the
Business Rules documentation.
Prerequisites
Before using this operation:
1. Ensure the product attribute link type is set up. For more information, refer to the Product Attribute Link Type topic in the System Setup documentation.
2. Ensure the selected attribute is valid on the product object type being linked.
Configuration
1. Select Add Attribute Link from the dropdown.
2. In the Attribute parameter, click the ellipsis button ( ) to display the Select Attribute dialog, select a reference type, and click the Select button.
Example
The following images show before and after the 'BatteryType' Add Attribute Link bulk update is run.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Add Reference topic and the
Business Action: Add Referenced By topic in the Business Rules documentation.
Prerequisite
Before using this operation, ensure a valid reference type with the necessary source object exists, and that the source object is valid for
the target object. For more information, refer to the Reference and Link Types topic in the System Setup documentation.
Configuration
1. Select Add Reference or Add Referenced By from the dropdown.
2. For the Type parameter, click the ellipsis button ( ), select the reference type, and click Select.
3. For the Target or Source parameter, use one of these methods to select the relevant target or source.
Note: The selected object dictates the label on the manual button. If the selected object requires a text value, the label is 'abc.' If
the selected object is numeric, '123' is displayed, and so on for each validation base type.
For manual selection, click the 'abc' button ( ), click the ellipsis button ( ) to display the Select Reference
Target or Select Reference Source dialog. Select a Target or Source object that is in accordance with the
selected link type, and click Select.
For function selection, click the function button ( ), click the ellipsis button ( ) to display the Function
Editor dialog. Add a function and evaluate, then click OK. For more information, refer to the Using Function
Editor topic in the Resource Materials online help documentation.
Examples
An example using Add Reference is below:
editor.
Again, an example using Add Reference is below though it works the same way for Add Referenced By:
After selecting the 'Type' of reference, a user opens the function editor and types in the function needed. In this case there is an attribute
on the item called 'Product Image' that holds the ID of an image asset.
When the bulk update is run, it uses the ID in the attribute to call forth which asset to put on the Primary Product Image reference.
The Automatic Classification functionality is controlled by a component model. For more information, refer to the Automatic Classification
documentation.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Automatic Classification topic in
the Business Rules documentation.
Prerequisites
Before using this operation:
Configuration
1. Select Automatic Classification from the dropdown.
2. For the Rule Set parameter, click the selector button ( ), and select the rule set to be executed.
3. For the Use Approved Rule Set parameter, check the checkbox to use the approved version of the rule set.
4. For the Evaluation Context parameter, select the context where the action should occur.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Run a search for any products that need their classification links updated to a newer eCl@ss, ETIM, or UNSPSC classification hierarchy, and run the
bulk update wizard.
2. Select Industry Classification Synchronization from the dropdown.
3. In the Industry standard matcher parameter, select the relevant industry standard from the dropdown list.
4. In the Source classification root parameter, click the ellipsis button ( ), select the classification root node for the original industry classification
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Select the assets that need to be linked, and run the bulk update wizard.
3. In the Classification parameter, use one of these methods to select the relevant classification.
Note: The selected object dictates the label on the manual button. If the selected object requires a text value, the label is 'abc.' If
the selected object is numeric, '123' is displayed, and so on for each validation base type.
For manual selection, click the 'abc' button ( ), and click the ellipsis button ( ) to display the Select
dialog. Add a function and evaluate, then click OK. For more information, refer to the Using Function Editor
topic in the Resource Materials online help documentation.
Once the bulk update runs, assets appear under designated classification folder.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Remove Attribute Link topic in
the Business Rules documentation.
Prerequisite
Before using this operation, ensure the valid attribute is linked to the product. For more information, refer to the Product Attribute Link
Type topic in the System Setup documentation.
Configuration
1. Select Remove Attribute Link from the dropdown.
2. For the Attribute parameter, click the ellipsis button ( ) to display the Select Attribute dialog, choose the attribute that should be removed and click
Example
The following images show before and after the 'BatteryType' Remove Attribute Link bulk update is run.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Remove Reference topic in the
Business Rules documentation.
Configuration
1. Select Remove Reference from the dropdown.
2. For the Type parameter, click the selector button ( ) to display the Select Reference Type dialog, choose the reference type that should be removed
Click the 'abc' button ( ), click the selector button ( ) to display the Select Reference Target picker, select
to select a valid target, and click the Select button. For more information, refer to the Using Function Editor
topic in the Resource Materials online help documentation.
4. For the Remove all targets parameter, set the checkbox as follows:
Unchecked means references of the specified type are removed from the modified objects.
Checked with a blank Target parameter means all references of the specified type are removed from the
modified objects.
When the bulk update runs, it uses function to determine the value of the attribute, to find which reference to remove from the Product
Image type.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Set Product to Classification Link
Type topic in the Business Rules documentation.
Prerequisites
1. Ensure a valid Classification Link Type and the Target Classification Object Type exists. For more information, refer to the Reference and Link Types
topic in the System Setup documentation.
2. Ensure a valid classification object type should be linked to the same parent classification of the object type being changed to.
3. Classification Link Type should have the object type valid.
Configuration
1. Select Set Product to Classification Link Type from the dropdown.
2. In the New Object Type parameter, click the selector button ( ) to display the Select Object Type dialog, select the classification, and click the
Select button.
3. In the New Link Type parameter, click the selector button ( ) to display the Select Product to Classification Link Type dialog, select the link type, and
click the Select button. The target must comply with the selected type. If the link type does not match the object type selected, an error message
displays.
Example
In the following example data, Website1 object type is valid for the 'WebHierarchyRoot', but will be changed to be valid for 'Mer-
chandisingHierarchyRoot.'
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Select Unlink Asset from Classification from the dropdown.
2. For the Classification parameter, use one of these methods to select the relevant classification.
Note: The selected object dictates the label on the manual button. If the selected object requires a text value, the label is 'abc.' If
the selected object is numeric, '123' is displayed, and so on for each validation base type.
For manual selection, click the 'abc' button ( ), and click the ellipsis button ( ) to display the Select
Classification dialog. Select a classification object where the assets will be unlinked and click Select.
For function selection, click the 'fx' button ( ), click the ellipsis button ( ) to display the Function Editor
dialog. Add a function and evaluate, then click OK. For more information, refer to the Using Function Editor
topic in the Resource Materials online help documentation.
Examples
Using the setting displayed in the image above, the operation is run on the data shown below. The preview shows that the Illus-
trationRoot classification reference will be removed.
The Prodval("Asset Keywords") function is used to remove the classification link by getting the value of the attribute that holds the ID of
the link to be removed.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Configuration
1. Select Run Business Rule from the dropdown.
2. For the 'Business Rule Condition' parameter, if a condition should be run, click the ellipsis button ( ), select the condition, and click Select. If the
should be selected.
For more on republishing, refer to the Event-Based OIEP Event Actions topic in the Data Exchange documentation.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Send Republish Event topic in
the Business Rules documentation.
Prerequisite
Before using this operation, ensure the event queue is enabled and set to Read Events as defined in the Maintaining Event Queues topic
of the Business Rules documentation.
Configuration
1. Select Send Republish Event from the dropdown.
2. For the Receiving Processor parameter, click the selector button ( ) to display the Select Processor for Events dialog, choose an OIEP or Event
Processor that has an event queue, or choose an actual event queue object. Click the Select button.
This can be an event processor, outbound integration endpoint with an event queue, or an event queue directly.
Example
For example, in the images below, the 'Item Attribute Change' OIEP is selected as the receiving processor. It has no events ready to pro-
cess. Running this bulk update operation adds an event to the OIEP.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Set Name topic in the Business
Rules documentation.
Configuration
1. Select Set Name from the dropdown.
2. In the Name parameter, use one of these methods to set the relevant name.
For manual selection, click the 'abc' button ( ), type in a constant value that will be used to update the
name.
For function selection, click the 'fx' button ( ), then click the ellipsis button ( ) to display the Function
Editor dialog. Write a function to set a name and click the Select button. For more information, refer to the
Using Function Editor topic in the Resource Materials online help documentation.
Example
To create a name using the function editor, often attribute values on an item are concatenated. In the image below, the 'Primary Color'
and 'Brand Name' attributes will be combined to create the name of this flashlight.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Set Object Type topic in the Busi-
ness Rules documentation.
Prerequisite
Before using this operation, ensure the objects being modified are valid for the new object type.
Configuration
1. Select Set Object Type from the dropdown.
2. In the Object Type parameter, use one of these methods to set the relevant object type.
For manual selection, click the dropdown to display the available object types in your system. Choose an
item from the dropdown.
When available, you can choose the Other... option to display the Choose Object Type dialog. Then use the Browse or Search
tabs to select an object type and click the Select button.
For function selection, click the 'fx' button ( ), then click the ellipsis button ( ) to display the Function
Editor dialog and write a calculation to select an object type. Click the OK button to save the function. For
more information, refer to the Using Function Editor topic in the Resource Materials online help
documentation.
Example
The example below, 'Attribute C' on the item holds the ID of an object type.
For more information on claiming bulk updates in workflows refer to the Bulk Update Operations for Workflows topic in the Workflows doc-
umentation.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Claim topic in the Business
Rules documentation.
Configuration
1. Select Claim from the dropdown.
2. For the STEP Workflow parameter, select the relevant workflow from the dropdown.
3. For the Current State parameter, from the dropdown, select from the available states for the workflow.
When the bulk update runs, all tasks in the selected workflow with the selected state are claimed for the user.
For more information on initiating items in a STEP Workflow via bulk updates refer to the Bulk Update Operations for Workflows topic in
the Workflows documentation.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Prerequisite
Before using this operation, ensure the workflow exists, and the object is valid for the workflow.
Configuration
1. From the dropdown, select the Workflow group and then select the Initiate Items in STEP Workflow option.
2. For the Choose a Workflow parameter, select a workflow from the dropdown.
3. For the Process Note parameter, type a note for the background process.
For more on triggering STEP Workflow events, the Bulk Update Operations for Workflows topic in the Workflows documentation.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
Prerequisites
Before using this operation:
Configuration
STEP Workflow - From the dropdown select the relevant workflow with tasks to be reassigned.
Current State - From the dropdown select the relevant state. All tasks in the selected state on the specified workflow will be reassigned to the user or
group chosen below.
User/Group - Click the ellipsis button ( ) ) or type an ID to display a list of suggested matches and select the desired user / user group.
For more on how to remove items from STEP Workflows using bulk updates, refer to the Remove Objects from Workflows topic in the
Workflows documentation.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation is similar to one in the business rules functionality, as described in the Business Action: Remove Object from STEP Work-
flow topic in the Business Rules documentation.
Configuration
1. Select Remove Items from STEP Workflow from the dropdown.
2. For the Choose a Workflow parameter, select the workflow from the dropdown.
3. For the Process Note parameter, type a note for the background process.
For more on triggering STEP Workflow events, the Bulk Update Operations for Workflows topic in the Workflows documentation.
For more information on the Bulk Update wizard, refer to the Creating a Bulk Update topic.
This operation can also be run via the business rules functionality, as described in the Business Action: Trigger STEP Workflow Event
topic in the Business Rules documentation.
Prerequisites
Before using this operation:
Configuration
1. From the dropdown, select the Workflow group and then the Trigger STEP Workflow Event option.
2. In the STEP Workflow parameter, from the dropdown select the relevant workflow.
3. In the Current State parameter, from the dropdown select the state that the workflow object must be in when the action is applied.
4. In the Event parameter, from the dropdown select the event that the action triggers.
5. In the Process Note parameter, enter a comment to be written in the state log when the event is triggered.
For more information, refer to the Parameterized Business Actions in Web UI topic in the Web User Interfaces documentation.
1. Hover over a warning or error icon to review potential problems with the bulk update
2. Click the Back button to resolve warnings and errors by modifying an operation or parameter.
3. Click the Next button to display Bulk Update Advanced step.
Do not run now runs the bulk update later, and not immediately when the wizard is finished. This allows a user to save the configuration. When check, the Auto Approve
and Pre-flight parameters are disabled.
Auto Approve approves only updates made by the bulk update and displays them in the approved workspace when the update succeeds. Only a partial approval is
performed.
Note: Auto Approve is not supported when the Run Business Rule Operation is used for the Bulk Update.
For example, if the bulk update runs on a product attribute and the value is updated, but other changes have been made to the product that were not done by the bulk
update, then the partial approval is applied only to the bulk-updated value, not to the entire product. However, if the only change(s) on the product are made by the bulk
update, since the bulk update changes are auto approved, the partial approval actually results in a full approval.
Pre-flight performs a test run of the update. When the user clicks 'Finish', the test runs in a background process. Selected operations are applied and then rolled back. An
execution report and an impact report is generated. Temporary collections are created for the objects where the operations were successfully applied, and for the ones
were errors were generated. The availability of this option depends on the user's system setup.
Important: There is no 'undo functionality for bulk updates. It is recommended to run a Pre-flight and/or to apply operations to a small set of objects before updating
a large number of objects.
Save configuration defines a location and name for the saved configuration so that it can be used again. Click the ellipsis button ( ) to display the 'Save Operation
Configuration' dialog. To name a new configuration, select a folder and type a name in the Name parameter, and click Create. To overwrite an existing configuration,
select the configuration and click Select.
Available for object types limits the object types and nodes affected by the bulk update operations. First select an object type from the dropdown, then click the ellipsis
button ( ) to select the nodes to update.
Click Finish to complete the bulk update configuration and start the operation(s) in a background process.
Monitor the bulk update as defined in the Monitoring Bulk Updates topic.
Click the Go to Process button to display the BG Processes tab for additional information about the process.
Note: If one operation on an object or the auto approval of the object fails, changes made by other operations are rolled back, and
the object is left as it was prior to the bulk update.
For details on the states of a background process, refer to the BGP States and Quarantine Status topic in the System Setup doc-
umentation.
Click Save to keep a copy of the execution report. This can be saved locally.
Click Truncate if not all lines in the execution report are needed. Upon selecting Truncate, a dialog will appear allowing users to select which lines to
delete, and how many lines to retain.
Click Save Failed Objects to save the objects for which the bulk update failed as a new collection. Note that this option is only available if there were
failed objects.
Click Impact Report to view a report of the errors that occurred during the bulk update process. This option is only available if objects failed during the
bulk update.
Prerequisites
All of the configuration steps provided in this topic assume the user has knowledge of configuring collections, bulk updates, business
actions, and workflows.
For more information on collections, refer to the Collections topic in the Getting Started documentation.
For more information on bulk updates, refer to the Bulk Updates topic in the in Bulk Updates documentation.
For more information on business actions, refer to the Business Actions topic in the Business Rules documentation.
For a full JavaScript code example, refer to the online version of this topic.
3. Create a bulk update configuration that runs the business action just created, as shown in the screenshot below. Schedule the bulk update to run with the collection that was
defined using the business action.
5. Navigate to and select the saved collection created earlier with only one object in it. From the File menu, select Bulk Update and Schedule Bulk Update.
7. When complete, an email is sent to the user listing the tasks they are responsible for in the designated workflow(s) and their state(s).
Important: Consider the time zone of the application server compared to that of the workbench (the client) where the schedule is cre-
ated or viewed. When scheduling a job, the local time zone is displayed in the workbench, but the time zone of the server is used to
run the background process. Once the process has been scheduled, the Schedule field will always show the server time zone
regardless of which time zone the user who scheduled the process is in. And, the Next Run field will show the local time zone.
For information on how to schedule bulk updates for collections in Web UI, refer to the Scheduling a Collection Refresh in Web UI topic.
Prerequisites
The following tasks must be completed before a collection is scheduled to run a bulk update.
1. Create a collection. More on creating a collection can be found in the Creating Collections topic in the Getting Started documentation.
2. Create a bulk update configuration. Refer to Creating a Bulk Update topic for more on how to configure a bulk update.
2. On Setup, for the Collection parameter, click the selector button ( ) to locate and select the relevant collection. This option is not valid if the collection is created from the
3. For the Configuration parameter, click the selector button ( ) to locate and select the relevant configuration.
For the Auto approve changes parameter, check this option to place the updated objects in the approved workspace immediately after the update.
4. Click Next to display the Preview and review the example results of the update.
Click Close to display the workbench while the background process runs.
On the left side of the image above, under the Scheduled Processes node, a bulk update that is scheduled to run at a later time is displayed under the
'Queued processes' node.
On the right side of the image above, in the Properties section, the schedule is displayed and the process shows a Status of 'waiting.'
The Bulk Update Actions section allows users to make an adjustment to the scheduled bulk update. Click the 'Edit Schedule' button to reopen the
'Schedule Bulk Update' wizard on the 'Schedule Process' step. Users can then amend the schedule as needed, and the changes will be applied to the
bulk update.
For details on the states of a background process, Refer to the BGP States and Quarantine Status topic in the System Setup doc-
umentation.
For more information on status selectors, refer to the Status Selector Homepage Widget topic in the Web User Interfaces documentation.
Important: Consider the time zone of the application server compared to that of the workbench (the client) where the schedule is cre-
ated or viewed. When scheduling a job, the local time zone is displayed in the workbench, but the time zone of the server is used to
run the background process. Although displayed, the time zone of the client is not included in the instructions to the server to run the
job. This can cause confusion about when the job will run since the scheduled time is not automatically converted to accommodate
potential differences in time zones.
1. Create a new bulk update configuration. In the example below, a collection is created by right-clicking on the desired collection in the workbench and
selecting Run Bulk Update.
2. In the Bulk Update dialog, select Create New Configuration, and click Next.
Once complete, this will trigger the update, but it does not actually execute any changes. You may view the background process, or
close the dialog prompt.
5. Next, navigate to File > Bulk Update > Schedule Bulk Update.
6. Select the relevant collection, check the refresh option, and select the bulk update configuration that you just created in the previous steps.
If the schedule for the Bulk Update must be amended, users can click on the scheduled bulk update on the BGProcesses tab, and then
click the 'Edit Schedule' button (shown at the bottom of the screenshot below). This will reopen the 'Schedule Bulk Update' wizard on the
'Schedule Process' step from which users can then amend the schedule as needed. The changes will be applied to the scheduled bulk
update.