Bookshelf v7.5.2: Understanding Script Processing

Product Administration Guide > Customizable Product Scripts >

Understanding Script Processing

Several events control script processing:

The Cfg_InstInitialize event occurs when the user begins a configuration session and an instance of the customizable product is created. This occurs when the user clicks Customize in the Quote interface or when the user selects a customizable product for configuration in a Web page. This event is called once at the beginning of the session. Scripts associated with this event are processed after the declarative portion of the product is instantiated but before it is displayed to the user.

The Cfg_ChildItemChanged event occurs each time the user selects or removes an item during the configuration session. Scripts associated with this event are processed after the new solution is created but before it is displayed to the user. If you insert a method to add or remove items in this event, this causes another solution to be generated.

The Cfg_ItemChanged event occurs each time the user selects or removes an item during the configuration session. Scripts associated with this event are processed after the new solution is created but before it is displayed to the user. If you insert a method to add or remove items in this event, this causes a second solution to be generated. The script associated with this event must be associated with a component customizable product.

The Cfig_AttributeChanged event occurs each time the user selects or changes an attribute value during the configuration session. Scripts associated with this event are processed after the new solution is created but before it is displayed to the user. If you insert a method to add or remove items in this event, this causes a second solution to be generated.

The Cfg_OnConflict event occurs when a conflict happens during the processing of a user request. You can resolve the conflict by undoing the last request or by keeping the last request and removing previous requests that conflict with it. Use this event to resolve conflicts without prompting the user for action. This event is called after the new solution is created but before calling Cfg_ChildItemChanged or Cfig_AttributeChanged. If you insert a method to add or remove items in this event, this causes a second solution to be generated.

The Cfg_InstPostSynchronize event occurs when you select Save or Done to end the configuration section. This event is called once at the end of the configuration session.

To write a script, you open the Script Designer and select a customizable product. You then either choose whether to write an event script, or a declarations script. Scripts in the declarations area contain methods that can be called by event-scripts and other declarations-scripts.

A script instance is created at the beginning of the associated event and destroyed at the end of the script execution. Variables defined in the declarations section of the script are meaningful only during script execution and do not persist after the script exits. For example, if a script is called because an item has changed, its variable values do not persist. The next time an item changes and the script runs again, the values of variables from the first script execution are not available.

Figure 16 shows when each event occurs during a configuration session. The Cfg_Instinitialize event occurs at the beginning of the configuration session. When the user picks an item, a new solution is generated and new baselines are set. Then the Cfg_On_Conflict event is called if there is conflict. Otherwise the Cfg_ChildItemChanged, Cfg_ItemChanged, and Cfg_AttributeChanged events are called. When the user clicks Save, Done, or updates the quote, the Cfg_InstPostSynchronize event is called.

Figure 16. Order of Event Processing