Skip navigation links

oracle.bpel.services.workflow.runtimeconfig
Interface IRuntimeConfigService

public interface IRuntimeConfigService

The RuntimeConfigService is used to query and update metadata specific to the runtime operation of the Workflow Service. It is used for querying and setting flexfield mappings, for querying the what Dynamic Assignment Functions are available, and for querying and setting the URIs used to display task details.

An instance of IRuntimeConfigService can be created by calling IWorkflowServiceClient.getRuntimeConfigService(). An instance of IWorkflowServiceClient can be created using the WorkflowServiceClientFactory.

All the RuntimeConfigService methods take IWorkflowContext as their first parameter. The IWorkflowContext object allows the RuntimeConfigService to validate that the method is being called by an authenticated user, and that the user has the necessary authority to perform the action being requested. The IWorkflowContext object also contains information on the user's timezone and locale. An IWorkflowContext object can be obtained by calling ITaskQueryService.authenticate(java.lang.String, java.lang.String, java.lang.String, java.lang.String) or ITaskQueryService.createContext(javax.servlet.http.HttpServletRequest).

In most cases, any authenticated user can use the query methods, but only a user with administrator privileges can use methods that update data.

Many of the parameters and return types of the methods are JAXB model objects from the package oracle.bpel.services.workflow.runtimeconfig.model. These objects do not have public constructors. To create new instances of these objects you should use the appropriate methods on oracle.bpel.services.workflow.runtimeconfig.model.ObjectFactory.

Since:

10.1.3.1.0

Method Summary

AttributeLabel	createAttributeLabel(IWorkflowContext ctx, AttributeLabel label) Creates a new label for a Task flexfield attribute from the supplied AttributeLabel object.
PayloadMapping	createPayloadMapping(IWorkflowContext ctx, PayloadMapping mapping) Creates a mapping between a payload attribute for a specific task defintion, and a task flexfield attribute, using an attribute label.
void	deleteAttributeLabel(IWorkflowContext ctx, java.lang.String labelId) Deletes the attribute label with the suppled labelId.
void	deletePayloadMapping(IWorkflowContext ctx, PayloadMapping mapping) Deletes the payload mapping described by the supplied PayloadMapping object.
AttributeLabelUsageList	getAttributeLabelUsages(IWorkflowContext ctx, java.lang.String attributeType) Gets a list of attribute labels and their usages by payload mappings.
DynamicAssignFunctionList	getGroupDynamicAssignmentFunctions(IWorkflowContext ctx) Gets the currently registered list of the dynamic assignment functions that select a group for assignment as a DynamicAssignFunctionList object.
DynamicAssignFunctionList	getUserDynamicAssignmentFunctions(IWorkflowContext ctx) Gets the currently registered list of the dynamic assignment functions that select a user for assignment as a DynamicAssignFunctionList object.
PayloadMappingsList	getWorkflowPayloadMappings(IWorkflowContext ctx, java.lang.String workflowId) Gets a list of payload mappings that have been defined for the specified task type, in the form of a PayloadMappingsList object.
AttributeLabel	updateAttributeLabel(IWorkflowContext ctx, AttributeLabel label) Updates an existing attribute label using the supplied AttributeLabel object.

Method Detail

getWorkflowPayloadMappings

public PayloadMappingsList getWorkflowPayloadMappings(IWorkflowContext ctx,
                                                      java.lang.String workflowId)
                                               throws WorkflowException

Gets a list of payload mappings that have been defined for the specified task type, in the form of a PayloadMappingsList object. A payload mapping defines a mapping between a Task payload attribute and a flexfield attribute column on the WFTASK table (such as TextAttribute1), via an AttributeLabel. The PayloadMappingsList contains a List of PayloadMapping objects. PayloadMapping has the following properties:

• workflowId String the TaskDefintionId of the task type the mapping is for.
• label AttributeLabelType the attribute label being mapped to. See createAttributeLabel(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.AttributeLabel) for a description.
• payloadAttribute String the name of the payload attribute being mapped.

• Parameters:

  ctx - an authenticated IWorkflowContext

  workflowId - String the TaskDefinitionId of the task type to query mappings for.

  Returns:

  PayloadMappingsList contains a List of PayloadMapping objects.

  Throws:

  WorkflowException - if some error condition occurs.

  createAttributeLabel

  public AttributeLabel createAttributeLabel(IWorkflowContext ctx,
                                             AttributeLabel label)
                                      throws WorkflowException
  

  Creates a new label for a Task flexfield attribute from the supplied AttributeLabel object. Only users with admin privileges can create attribute labels. An AttributeLabel is associated with a particular Task flexfield. (Flexfield columns are the general purpose columns named TextAttribute1...10, NumberAttribute1...5, DateAttribute1...5 and so on). An AttributeLabel allows a more meaningful name to be assigned to a flexfield column (for example, a label named "CustomerName" is more meaningful than "TextAttribute1"). PayloadMappings map task payload attributes to AttributeLabels - a single AttributeLabel can be associated with more than one PayloadMapping. This allows payload attributes from different tasks that share the same semantic meaning to be mapped to a common label. For example, a number of task types may contain payload attributes that contain a customer name - all of them can be mapped to a single "CustomerName" label.

  The label name can be used when displaying mapped flexfield columns for tasks of a particular type or types. The method ITaskMetadataService.getTaskAttributesForTaskDefinition(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String) will return a list of task attributes including any flexfield attributes that have been mapped for that task defintion. The flexfield attributes in the list will have a display name derived from the appropriate AttributeLabel name. It is possible to provide internationalization support for AttributeLabel names, by adding entries to the WorkflowLabels.properties file. See the Workflow Services chapter of the BPEL Process Manager Developer's Guide for more details.

  The AttributeLabel object contains the following properties:

  • id String Unique identifier for AttributeLabel. Automatically populated by API during create operation.
  • dataType String The type of flexfield column this label is for. Automatically maintained by API, will be populated with one of the following values after create operation:
    • "Text"
    • "Form"
    • "Url"
    • "Date"
    • "Number"
  • labelName String The name for the label.
  • taskAttribute String The name of the flexfield attribute column the label is for. Should be one of the following values:
    • TextAttribute1..10
    • FormAttribute1..5
    • UrlAttribute1..5
    • DateAttribute1..5
    • NumberAttribute1..5
  • active Not used.
  • workflowType Not used. Always set to IWorkflowConstants.WF_TYPE by API.
  • createdDate Calendar Date attribute label was created. Automatically maintained by API.

  • Parameters:

    ctx - an authenticated IWorkflowContext

    label - AttributeLabel object defining attribute label to create.

    Returns:

    the created AttributeLabel, with API maintained properties populated.

    Throws:

    WorkflowException - if a non-admin user attempts to create an attribute label, or some other error condition occurs.

    updateAttributeLabel

    public AttributeLabel updateAttributeLabel(IWorkflowContext ctx,
                                               AttributeLabel label)
                                        throws WorkflowException
    

    Updates an existing attribute label using the supplied AttributeLabel object. Only users with admin privileges can update attribute labels. See createAttributeLabel(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.AttributeLabel) for a description ofthe AttributeLabel object.

    Parameters:

    ctx - an authenticated IWorkflowContext

    label - AttributeLabel to update.

    Returns:

    the updated AttributeLabel.

    Throws:

    WorkflowException - if a non-admin user attempts to update an attribute label, or some other error condition occurs.

    deleteAttributeLabel

    public void deleteAttributeLabel(IWorkflowContext ctx,
                                     java.lang.String labelId)
                              throws WorkflowException
    

    Deletes the attribute label with the suppled labelId. Only users with admin privileges can delete attribute labels. When an attribute label is deleted, any payload mappings that use that label are also deleted.

    Parameters:

    ctx - an authenticated IWorkflowContext

    labelId - String unique identifier for attribute label.

    Throws:

    WorkflowException - if a non-admin user attempts to delete an attribute label, or some other error condition occurs.

    getAttributeLabelUsages

    public AttributeLabelUsageList getAttributeLabelUsages(IWorkflowContext ctx,
                                                           java.lang.String attributeType)
                                                    throws WorkflowException
    

    Gets a list of attribute labels and their usages by payload mappings. All attribute labels can be queried, or the query can be restricted to attribute labels for a specific flexfield type, by passing the appropriate value to the attributeType parameter:

    • null - if attributeType is null, all attribute labels will be returned
    • "Text" - attribute labels for flexfields TextAttribute1..10 will be returned
    • "Form" - attribute labels for flexfields FormAttribute1..5 will be returned
    • "Url" - attribute labels for flexfields UrlAttribute1..5 will be returned
    • "Date" - attribute labels for flexfields DateAttribute1..5 will be returned
    • "Number" - attribute labels for flexfields NumberAttribute1..5 will be returned

    The returned AttributeLabelUsageList object contains a List of LabelUsages objects. Each LabelUsages contains information about a particular label, and all its usages in payload mappings. A LabelUsages object contains the following properties:

    • label AttributeLabelType describing the attribute label. See createAttributeLabel(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.AttributeLabel) for a description.
    • usages List of LabelUsageType objects. Each LabelUsageType object describes a usage of the attribute label in a payload mapping, and has the following properties:
      • workflowId String TaskDefinitionId of the task definition whose payload is being mapped.
      • workflowName String name of the task definition whose payload is being mappied.
      • payloadAttribute String name of the payload attribute being mapped.
      • createdDate Calendar date the mapping was created.

    • Parameters:

      ctx - an authenticated IWorkflowContext.

      attributeType - String null if all attributes are required, otherwise, which type of attributes should be queried.

      Returns:

      AttributeLabelUsageList containing list of attribute labels and their usages in payload mappings.

      Throws:

      WorkflowException - if some error condition occurs.

      createPayloadMapping

      public PayloadMapping createPayloadMapping(IWorkflowContext ctx,
                                                 PayloadMapping mapping)
                                          throws WorkflowException
      

      Creates a mapping between a payload attribute for a specific task defintion, and a task flexfield attribute, using an attribute label. Only a user with administrator privileges can create a payload mapping.

      A payload mapping defines a mapping between a payload attribute of a Task of a particular task defintion, and a flexfield attribute column on the WFTASK table (such as TaskAttribute1). When payload mapping exists for a particular Task type, the value of the Task payload attribute is written to the mapped flexfield column, allowing queries, views and rules to be defined using the mapped value.

      Payload mappings are actually made between the payload attribute of a task and an AttributeLabel. An AttributeLabel allows a more meaningful name to be assigned to a flexfield column, and allows different task types to map payload attributes to a common label.

      The mapping to be created is defined by the PayloadMapping object supplied to the method. The attribute label being mapped to must already exist before creating the mapping. PayloadMapping has the following properties:

      • workflowId String the TaskDefintionId of the task type the mapping is being created for.
      • label AttributeLabelType the attribute label being mapped to. Must already exist. See createAttributeLabel(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.AttributeLabel) for a description. When creating (or deleting) a payload mapping, only the id property needs to be set on the AttributeLabelType object.
      • payloadAttribute String the name of the payload attribute being mapped.

      • Parameters:

        ctx - an authenticated IWorkflowContext.

        mapping - PayloadMapping object describing the mapping to create.

        Throws:

        WorkflowException - if a non-admin user attempts to create a payload mapping, or some other error condition occurs.

        deletePayloadMapping

        public void deletePayloadMapping(IWorkflowContext ctx,
                                         PayloadMapping mapping)
                                  throws WorkflowException
        

        Deletes the payload mapping described by the supplied PayloadMapping object. Only a user with administrator privileges can delete a payload mapping. See createPayloadMapping(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.runtimeconfig.model.PayloadMapping) for a description of the PayloadMapping object.

        Parameters:

        ctx - an authenticated IWorkflowContext.

        mapping - PayloadMapping object describing the mapping to delete.

        Throws:

        WorkflowException - if a non-admin user attempts to delete a payload mapping, or some other error condition occurs.

        getUserDynamicAssignmentFunctions

        public DynamicAssignFunctionList getUserDynamicAssignmentFunctions(IWorkflowContext ctx)
                                                                    throws WorkflowException
        

        Gets the currently registered list of the dynamic assignment functions that select a user for assignment as a DynamicAssignFunctionList object. DynamicAssignFunctionList contains a List of DynamicAssignFunctionType objects.

        DynamicAssignFunctionType has the following properties:

        • name String name of dynamic assignment function.
        • label String human-readable label for dynamic assignment function.

        • Parameters:

          ctx - an authenticated IWorkflowContext. used to determine appropraite Locale for user-readable labels.

          Returns:

          DynamicAssignFunctionList contains a List of DynamicAssignFunctionType objects.

          Throws:

          WorkflowException - if some error condition occurs.

          getGroupDynamicAssignmentFunctions

          public DynamicAssignFunctionList getGroupDynamicAssignmentFunctions(IWorkflowContext ctx)
                                                                       throws WorkflowException
          

          Gets the currently registered list of the dynamic assignment functions that select a group for assignment as a DynamicAssignFunctionList object. DynamicAssignFunctionList contains a List of DynamicAssignFunctionType objects.

          DynamicAssignFunctionType has the following properties:

          • name String name of dynamic assignment function.
          • label String human-readable label for dynamic assignment function.

          • Parameters:

            ctx - an authenticated IWorkflowContext. used to determine appropraite Locale for user-readable labels.

            Returns:

            DynamicAssignFunctionList contains a List of DynamicAssignFunctionType objects.

            Throws:

            WorkflowException - if some error condition occurs.