Define Detailed Properties for a Field

Use the Properties page in the Field Properties window to define the following detailed properties for a Field:

• Whether the Field is required and/or read-only.
• Values: Default and calculated values, as well as values to set before a Business Object is saved.
• Options based on lifecycle state: Behaviors and values based on the Business Object's lifecycle state. Options based on lifecycle state are only displayed if the Business Object has defined lifecycle states.

  Note: The Field Properties window is available in the Business Object Editor (accessed from within a Blueprint in CSM Administrator).

To define detailed properties for a Field:

1. Open the Field Properties window:
   1. In the CSM Administrator main window, click the Blueprints category, and then click the Create a New Blueprint task.

      Note: If working on a saved Blueprint, open the existing Blueprint.

      The Blueprint Editor opens, displaying the Object Manager in its Main Pane. The Object Manager lists the existing Business Objects.

   2. In the Object Manager, click a Business Object in the Object tree, and then click the Edit Business Object task in the Structure area.

      The Business Object Editor opens.

      Tip: You can also click the Edit Business Object button on the Blueprint Editor Toolbar to open the Business Object Editor.

   3. Click a new or existing Field, and then click the Field Properties button.

      The Field Properties window opens.

2. Click the Properties page.

   

3. Define general behaviors for the Field:
   • Required for Save: Select this check box to always require the Field to contain a value before the Business Object can be saved. Or, click the down arrow to expand the section and select another option.

     

     • Always required for save: Select this radio button to always require the Field to contain a value before the Business Object can be saved. This is the same as selecting Required for Save.
     • Never required for save: Select this radio button to never require the Field to contain a value before the Business Object can be saved.
     • Field: Select this radio button to use a logical Field to determine whether the Field is required before the Business Object can be saved. Then, select a Field in the drop-down.
     • Function: Select this radio button to use a System Function to determine whether the Field is required before the Business Object can be saved. Then, select a System Function in the drop-down.
     • Stored Value: Select this radio button to use a Stored Value to determine whether the Field is required before the Business Object can be saved. Then, select a most recently used (MRU) Stored Value in the drop-down, or click the Ellipses button to open the Stored Value Manager, where you can select an existing Stored Value or create a new one.
     • Expression: Select this radio button to use an Expression to determine whether the Field is required before the Business Object can be saved. You can use either:
       • Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
       • Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.
   • Read-only: Select this check box to make the Field always read-only (Users cannot provide data in the Field). Or, click the down arrow to expand the section and define additional read-only options.

     

     • Always read-only: Select this radio button to make the Field always read-only. This is the same as selecting Always Read-only.
     • Never read-only: Select this radio button to never make the Field read-only.
     • Field: Select this radio button to use a logical Field to determine whether the Field is read-only. Then, select a Field in the drop-down.
     • Function: Select this radio button to use a System Function to determine whether the Field is read-only. Then, select a System Function in the drop-down.
     • Stored Value: Select this radio button to use a Stored Value to determine whether the Field is read-only. Then, select a most recently used (MRU) Stored Value in the drop-down, or click the Ellipses button to open the Stored Value Manager, where you can select an existing Stored Value or create a new one.
     • Expression: Select this radio button to use an Expression to determine whether the Field is read-only. You can use either:
       • Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
       • Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.
     • Property changes based on lifecycle: Select this check box to make the Field read-only when the Business Object is in a selected lifecycle state. Then, select a lifecycle state in the drop-down.

       Note: Options based on lifecycle state only appear if the Business Object has defined lifecycle states.

       • Use default setting: Select this check box to use the (default) options for the selected lifecycle state. Clear the check box to select another option for determining whether the Field is read-only when the Business Object is in the selected lifecycle state.
   • Default Value: Provide a value to use as the initial value of the Field until a User changes the value. Or, define a default value using one of the following options:
     • Click the Legal Values button to open the Quick Selector for the Field and select a valid value to use as the default.

       Note: The Legal Values button is only activated if the Field is validated. For more information about validating Fields, see Define Validation/Auto-Population Properties for a Field.

     • Click the down arrow to expand the section and select an additional option.

       

       • Value: Select this radio button to define your own default value. If the Field is validated, the Legal Values button is activated. Select it to open the Quick Selector for the Field and select a valid value to use as the default value.
       • Function: Select this radio button to use a System Function to determine the Field's default value. Then, select a System Function in the drop-down.
       • Stored Value: Select this radio button to use a Stored Value to determine the Field's default value. Then, select a most recently used (MRU) Stored Value in the drop-down, or click the Ellipses button to open the Stored Value Manager, where you can select an existing Stored Value or create a new one.
       • Expression: Select this radio button to use an Expression to determine the Field's default value. You can use either:
         • Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
         • Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.
       • Property changes based on lifecycle: Select this check box to use the default value when the Business Object is in a selected lifecycle state. Then, select a lifecycle state in the drop-down.

         Note: Options based on lifecycle state only appear if the Business Object has defined lifecycle states.

         • Use default setting: Select this check box to use the (default) options for the selected lifecycle state. Clear the check box to select another option for determining the Field's default value when the Business Object is in the selected lifecycle state.
   • Calculated Value: Select this check box to use an Expression to calculate a value for the Field. Then, click the Ellipses button to open the Expression Manager, where you can select an existing stored Expression or create a new stored Expression to calculate the Field's value.

     Note: You can also click the down arrow to expand the section and select an option for defining a calculated value.

     

     • None: Select this radio button to not use a calculated value for the Field. Selecting this radio button will clear the Calculated Value box.
     • Expression: Select this radio button to use an Expression to calculate a value for the Field. You can use either:
       • Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
       • Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.
     • Property changes based on lifecycle: Select this check box to have the Field's value calculated when the Business Object is in a selected lifecycle state. Then, select a lifecycle state in the drop-down.

       Note: Options based on lifecycle state only appear if the Business Object has defined lifecycle states.

       • Use default setting: Select this check box to use the (default) options for the selected lifecycle state. Clear the check box to select another option for calculating the Field's value when the Business Object is in the selected lifecycle state.
   • Value to set before save: Provide a value to set in the Field before the Business Object is saved. Or, define a default value using one of the following options:
     • Click the Legal Values button to open the Quick Selector for the Field and select a valid value to use.

       Note: The Legal Values button is only activated if the Field is validated. For more information about validating Fields, see Define Validation/Auto-Population Properties for a Field.

     • Click the down arrow to expand the section and select an additional option.

       

       • Set to blank: Select this radio button to clear the Field of any values when the Business Object is saved.
       • Value: Select this radio button to define a value to set for the Field when the Business Object enters its final state. Then, type a value.

         Note: If you provided a value in the section heading (next to Value to set before save), this radio button is automatically selected and the value you provided is displayed here.

       • Field: Select this radio button to set the value with another Field's value. Then, select a Field in the drop-down.
       • Function: Select this radio button to use a System Function to determine the Field's value. Then, select a System Function in the drop-down.
       • Stored Value: Select this radio button to use a Stored Value to determine the Field's value. Then, select a most recently used (MRU) Stored Value in the drop-down, or click the Ellipses button to open the Stored Value Manager, where you can select an existing Stored Value or create a new one.
       • Expression: Select this radio button to use an Expression to determine the Field's value. You can use either:
         • Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
         • Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.
4. Define behaviors based on lifecycle state:

   Note: Options based on lifecycle state only appear if the Business Object has defined lifecycle states.

   • Required for <final state>: Select this check box to always require the Field to contain a value before the Business Object can enter its final state (ex: Closed). Or, click the down arrow to expand the section and select another option:

     

     • Always required for <final state>: Select this radio button to always require the Field to contain a value before the Business Object can enter its final state. This is the same as selecting Required for <final state>.
     • Never required for save: Select this radio button to never require the Field to contain a value before the Business Object can enter its final state.
     • Field: Select this radio button to use a logical Field to determine whether the Field is required before the Business Object can enter its final state. Then, select a Field in the drop-down.
     • Function: Select this radio button to use a System Function to determine whether the Field is required before the Business Object can enter its final state. Then, select a System Function in the drop-down.
     • Stored Value: Select this radio button to use a Stored Value to determine whether the Field is required before the Business Object can enter its final state. Then, select a most recently used (MRU) Stored Value in the drop-down, or click the Ellipses button to open the Stored Value Manager, where you can select an existing Stored Value or create a new one.
     • Expression: Select this radio button to use an Expression to determine whether the Field is required before the Business Object can enter its final state. You can use either:
       • Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
       • Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.
   • Value to set for <final state>: Provide a value to set for the Field when the Business Object enters its final state. Or, click the down arrow to expand the section and define additional options.

     

     • Set to blank: Select this radio button to clear the Field of any values when the Business Object enters its final state.
     • Value: Select this radio button to define a value to set for the Field when the Business Object enters its final state. Then, provide a value.

       Note: If you provided a value in the section heading (next to Value to set for <final state>), this radio button is automatically selected and the value you provided appears here.

     • Field: Select this radio button to set the value with another Field's value. Then, select a Field in the drop-down.
     • Function: Select this radio button to use a System Function to determine the Field's value. Then, select a System Function in the drop-down.
     • Stored Value: Select this radio button to use a Stored Value to determine the Field's value. Then, select a most recently used (MRU) Stored Value in the drop-down, or click the Ellipses button to open the Stored Value Manager, where you can select an existing Stored Value or create a new one.
     • Expression: Select this radio button to use an Expression to determine the Field's value. You can use either:
       • Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
       • Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.

     Note: If the Field is validated, the Legal Values button is activated. Click it to open the Quick Selector for the Field and select a valid value.

   • "Required for state change" changes based on lifecycle: Click the down arrow to expand the section and select an option for requiring the Field to contain a value before the Business Object's state can be changed.

     

     • State: In the drop-down, select a lifecycle state. You can select a different option for each lifecycle state to determine whether the Field requires a value before the Business Object is changed from the selected lifecycle state.

       Note: Select (default) to define default options for requiring the Field to contain a value before the Business Object's state can be changed. These default options can be used for any (or all) selected lifecycle states.

       • Use default setting: Select this check box to use the (default) options for the selected lifecycle state.
     • Always required for state change: Select this radio button to always require the Field to contain a value before the Business Object's state can be changed.
     • Never required for save: Select this radio button to never require the Field to contain a value before the Business Object's state can be changed.
     • Field: Select this radio button to use a logical Field to determine whether the Field is required before the Business Object's state can be changed. Then, select a Field in the drop-down.
     • Function: Select this radio button to use a System Function to determine whether the Field is required before the Business Object's state can be changed. Then, select a System Function in the drop-down.
     • Stored Value: Select this radio button to use a Stored Value to determine whether the Field is required before the Business Object's state can be changed. Then, select a most recently used (MRU) Stored Value in the drop-down, or click the Ellipses button to open the Stored Value Manager, where you can select an existing Stored Value or create a new one.
     • Expression: Select this radio button to use an Expression to determine whether the Field is required before the Business Object's state can be changed. You can use either:
       • Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
       • Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.
   • "Value to set before state change" changes based on lifecycle: Click the down arrow to expand the section and define options for setting a value in the Field when the Business Object's lifecycle state changes.

     

     • State: In the drop-down, select a lifecycle state. You can select a different option for each lifecycle state to determine the Field's value before the Business Object is changed from the selected lifecycle state.

       Note: Select (default) to define default options for requiring the Field to contain a value before the Business Object's state can be changed. These default options can be used for any (or all) selected lifecycle states.

       • Use default setting: Select this check box to use the (default) options for the selected lifecycle state.
     • Set to blank: Select this radio button to clear the Field of any values when the Business Object's state changes.
     • Value: Select this radio button to define a value to set for the Field when the Business Object enters its final state. Then, provide a value.

       Note: If the Field is validated, the Legal Values button is activated. Click it to open the Quick Selector for the Field and select a valid value to use for the Field.

     • Field: Select this radio button to set the value with another Field's value. Then, select a Field in the drop-down.
     • Function: Select this radio button to use a System Function to determine the Field's value. Then, select a System Function in the drop-down.
     • Stored Value: Select this radio button to use a Stored Value to determine the Field's value. Then, select a most recently used (MRU) Stored Value in the drop-down, or click the Ellipses button to open the Stored Value Manager, where you can select an existing Stored Value or create a new one.
     • Expression: Select this radio button to use an Expression to determine the Field's value. You can use either:
       • Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
       • Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.
5. Click OK.
6. Publish the Blueprint (File>Publish Blueprint) to commit the changes, or save the Blueprint (File>Save Blueprint) to continue making other changes.