Package com.appiancorp.suiteapi.process

Interface ProcessAdministrationService

All Superinterfaces:
com.appiancorp.services.ContextSensitiveService, Service
public interface ProcessAdministrationService extends com.appiancorp.services.ContextSensitiveService

ProcessAdministrationService is used to create and modify properties of the overall process application.

A Palette holds a collection of nodes that can be dropped onto a canvas in the designer to create a process. Each node is represented as a PaletteItem. A PaletteCategory is an entity that holds palettes and/or other palette categories in a hierarchy.

When a system administrator adds a new activity to the system (also known as registering), an instance of this class is used to represent that activity. When a process designer puts a node in a process model, he or she is using an ActivityClass, which has a reference to this schema. The schema specifies what the parameters of an activity are and some of the restrictions on those parameters that constrain the designer's behavior.

  • Field Details

    • registerActivityClassSchema$UPDATES

      @Deprecated(forRemoval=true) static final boolean registerActivityClassSchema$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • registerActivityClassSchemas$UPDATES

      @Deprecated(forRemoval=true) static final boolean registerActivityClassSchemas$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • unregisterActivityClassSchema$UPDATES

      @Deprecated(forRemoval=true) static final boolean unregisterActivityClassSchema$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • unregisterActivityClassSchemas$UPDATES

      @Deprecated(forRemoval=true) static final boolean unregisterActivityClassSchemas$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getApplicationName$UPDATES

      @Deprecated(forRemoval=true) static final boolean getApplicationName$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getWorkspace$UPDATES

      @Deprecated(forRemoval=true) static final boolean getWorkspace$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • registerPriorities$UPDATES

      @Deprecated(forRemoval=true) static final boolean registerPriorities$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getJmsUsername$UPDATES

      @Deprecated(forRemoval=true) static final boolean getJmsUsername$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setJmsUsername$UPDATES

      @Deprecated(forRemoval=true) static final boolean setJmsUsername$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getJmsPassword$UPDATES

      @Deprecated(forRemoval=true) static final boolean getJmsPassword$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setJmsPassword$UPDATES

      @Deprecated(forRemoval=true) static final boolean setJmsPassword$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

  • Method Details

    • registerActivityClassSchema

      @Write(K_PROCESS_DESIGN) void registerActivityClassSchema(ActivityClassSchema schema_) throws IllegalArgumentException, InvalidUserException
      Registers the given activity class schema. If a schema with the given localId already exists, that schema will be updated. If no schema with the given localId exists, a schema will be created. Required fields: Either function or javaClassName, and also: executionEnvironmentId, type, unattended and localId
      Parameters:
      schema_ - the schema to register
      Throws:
      IllegalArgumentException - if any of the properties of the schema is invalid, or if any required fields are missing. See ActivityClassSchema for valid property values.
      InvalidUserException - if the username specified in the Schema does not exist, i.e, the default value for an ACP or ARV of type user or people.

    • registerActivityClassSchemas

      @Write(K_PROCESS_DESIGN) void registerActivityClassSchemas(ActivityClassSchema[] schemas_) throws IllegalArgumentException, DuplicateIdException, InvalidUserException
      Registers the given activity class schemas. If any schema with a given localId already exists, that schema will be updated. If no schema with a given localId exists, a schema will be created. Required fields: Either function or javaClassName, and also: executionEnvironmentId, type, unattended and localId
      Parameters:
      schemas_ - the schemas to register
      Throws:
      IllegalArgumentException - the any of the properties of the schema is invalid, or if any required fields are missing. See ActivityClassSchema for valid property values.
      DuplicateIdException - if any schema, or activity class parameter schema, or activity return variable has the same localId as another in the list. Note that localIds for ACPs and ARVs may be reused in other activity class schemas, but not within the same activity class schema
      InvalidUserException - if the username specifed in the Schema does not exists, i.e, the default value for an ACP or ARV of type user or people.
      ServiceException - if any system-level error occurs

    • unregisterActivityClassSchema

      @Write(K_PROCESS_DESIGN) void unregisterActivityClassSchema(String activityClassSchemaLocalId_) throws InvalidActivityClassSchemaException, InvalidOperationException
      Unregisters the given schema.
      Parameters:
      activityClassSchemaLocalId_ - the local Id of the schema to unregister
      Throws:
      InvalidActivityClassSchemaException - if the activity class schema does not exist
      InvalidOperationException - if the schema is currently in use (that is, if there exist palette items or nodes in process models that use the activity class schema)
      ServiceException - if any system-level error occurs

    • unregisterActivityClassSchemas

      @Write(K_PROCESS_DESIGN) void unregisterActivityClassSchemas(String[] activityClassSchemaLocalIds_) throws InvalidActivityClassSchemaException, InvalidOperationException
      Unregisters the given schemas.
      Parameters:
      activityClassSchemaLocalIds_ - the local Ids of the schemas to unregister
      Throws:
      InvalidActivityClassSchemaException - if any activity class schema does not exist
      InvalidOperationException - if any schema is currently in use (that is, if there exist palette items or nodes in process models that use the activity class schema)
      ServiceException - if any system-level error occurs

    • getApplicationName

      @Read(K_PROCESS_DESIGN) String getApplicationName()
      Gets the name of the application on which this service is running.
      Returns:
      the name of the application
      Throws:
      ServiceException - if any system-level error occurs

    • getWorkspace

      @Read(K_PROCESS_DESIGN) String[] getWorkspace()
      Gets the current memory profile for the workspace.
      Returns:
      array of Strings of length 4 describing memory usage:
      • [0]Used - Memory Used by the Server so far for storage
      • [1]Allocated - Memory allocated for use. Often if a large data item was allocated by a server and subsequently freed, this value will be large compared to "Used". If nearly all memory allocated is in use, this value will be close to (but always higher than) "Used"
      • [2]Mapped - is the space used by memory-mapped files
      • [3]Available - is the total available memory for the Server process
      Note: All usage statistics are in Bytes.
      Throws:
      ServiceException - if any system-level error occurs

    • registerPriorities

      @Write(K_PROCESS_DESIGN) PriorityRegistration[] registerPriorities(PriorityRegistration[] priorities_) throws IllegalArgumentException
      Registers the application's priorities. If more than one of the priorities have default set to true, the last one registered will be set as the default priority. The id, name, description, isDefault and iconId fields in the PriorityRegistration bean are required.
      Parameters:
      priorities_ - The priorities to register.
      Returns:
      The registered priorities.
      Throws:
      IllegalArgumentException - If:
      • Entries of priorities_ have any incorrect required fields.
      • Trying to register two or more duplicated priorities.
      • None of the priorities have the default property set to true.
      NullPointerException - if any required field of the entries in priorities_ is null, or any of the entry in priorities_ itself is null.

    • getJmsUsername

      @Deprecated @Read(K_PROCESS_DESIGN) String getJmsUsername()
      Deprecated.
      See jms.properties createConnectionUsername. This method is no longer used.
      Gets the username that the product will use to connect to JMS Provider.
      Returns:
      the username to connect to JMS Provider.

    • setJmsUsername

      @Deprecated @Write(K_PROCESS_DESIGN) void setJmsUsername(String jmsUsername_)
      Deprecated.
      See jms.properties createConnectionUsername. This method is no longer used.
      Sets the username that the product will use to connect to JMS Provider.
      Parameters:
      jmsUsername_ - the username to connect to JMS Provider.

    • getJmsPassword

      @Deprecated @Read(K_PROCESS_DESIGN) String getJmsPassword()
      Deprecated.
      See jms.properties createConnectionPassword. This method is no longer used.
      Gets the password that the product will use to connect to JMS Provider.
      Returns:
      the password to connect to JMS Provider.

    • setJmsPassword

      @Deprecated @Write(K_PROCESS_DESIGN) void setJmsPassword(String jmsPassword_)
      Deprecated.
      See jms.properties createConnectionPassword. This method is no longer used.
      Sets the password that the product will use to connect to JMS Provider.
      Parameters:
      jmsPassword_ - the password to connect to JMS Provider.