Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Administrative Services API Calls >

ProcessAdministrationUpsert

Updates existing process administration data or inserts new process administration data.

Usage

Use the ProcessAdministrationUpsert method to insert process administration data or update existing process administration data. The Process Administration privilege is required.

NOTE:  The ProcessAdministrationUpsert method does not insert or update the field setup and related access control configuration data for transition states.

The apdata:Process argument contains the following elements containing process administration data:

• RecordType. The record type (required).
• ProcessName. The name of the process (required).
• PrimaryField. The field that is used as a filter to restrict the process to certain records of the record type (read-only). Only the Activity record type supports the use of a primary field.
• TransitionField. The field in the record type that determines the transition of records from one transition state to another (read-only). The Status field is used as the transition field for all supported record types.
• Description. A description of the process.
• Order. The order of the process within the record type (read-only).
• Default. Whether the process is the default process within the record type (read-only).
• ListOfPrimaryValues. The primary values for the process, which are contained in <Value> child elements of <PrimaryValues>.
• ListOfTransitionStates. The transition states for the process, contained in the following child elements of <TransitionState>.
  • State. The transition state (required). Possible values depend on the record type. For upsert operations, the value in the <State> element must match an existing picklist value in the Status field for the record type.
  • Category. The sales category with which the transition state is associated.
  • Description. A description of the transition state.
  • Created. The user who created the transition state data, with the date and time of creation (read-only).
  • Modified. The user who modified the transition state data, with the date and time of modification (read-only).
  • Condition. An expression that determines whether a record can move to the transition state. You cannot use any calculated fields in the expression.
  • ErrorMessage. The error message that appears if the condition set for the transition state is not met when a user tries to move a record of the record type specified in the process to the transition state.
  • DisableUpdate. Whether records can be updated (false) or not (true) when they are in the transition state.
  • DisableDeleteOrRemove. Whether records can be deleted (false) or not (true) when they are in the transition state.

For upsert operations <RecordType> is a user key. For transition states, the user key is <State>.

For more information about process administration, see Oracle CRM On Demand Online Help.

Arguments

Table 156 describes the arguments taken by the ProcessAdministrationUpsert method.

Return Value of the Call

The status is returned.