You are not looking at the latest version of the documentation. Check it out there.
You are looking at draft pre-release documentation for the next release of Flows for APEX. Product features documented here may not be released or may have different behavior to that documented here. You should not make any purchase decisions based on this draft documentation..

FLOWS FOR APEX ADMIN API

Package flow_admin_api

The flow_admin_api package gives you access to the Flows for APEX engine admin procedures, and allows you to perform the following from the PL/SQL API:

  • Maintenance, Archiving and Purging of the Flows for APEX log files
  • Maintenance, Archiving, and Purging of the Flows for APEX performance statistics all_summaries
  • Maintenance of Flows for APEX instance configuration parameters
  • Release of Diagrams (useful when introducing a new model into a production system).

Function instance_summary

Function instance_summary This function returns a JSON summary of the process instance execution, including all the steps, gateways, and subflows that have been executed. Contents of the instance summary depend on the level of logging enabled for the process instance. Contents can include:

  • Process instance details
  • Details of process models and versions used, including for any Call Activity calls
  • Details of all steps executed, including the step type, step name, and step status
  • Details of all gateways executed, including the gateway type, gateway name, and gateway status
  • Details of all subflows executed, including the subflow name, subflow status, and subflow steps
  • Details of all process variables set during the process instance execution.

Available in Flows for APEX Community Edition and Flows for APEX Enterprise Edition.

SIGNATURE

function instance_summary
( p_process_id in flow_processes.prcs_id%type
) return clob;

Procedure archive_completed_instances

Procedure archive_completed_instances This procedure archives all completed process instances that were completed before the specified date. The procedure moves the process instance data from the live tables to the archive location specified in the configuration data. Archive location can be a database table or to OCI Object Storage. See documentation on configuring the archive location.

Available in Flows for APEX Community Edition and Flows for APEX Enterprise Edition.

EXAMPLE

This example will archive all completed process instances before the current date.

begin
   flow_admin_api.archive_completed_instances(
        p_completed_before => trunc(sysdate)
   );
end;
;

SIGNATURE

procedure archive_completed_instances
( p_completed_before in date default trunc(sysdate)
);

Procedure purge_instance_logs

This procedure purges the process instance log records for instances which completed before the the specified retention period.

Available in Flows for APEX Community Edition and Flows for APEX Enterprise Edition.

EXAMPLE

This example will purge instance logs older than 30 days.

begin
   flow_admin_api.purge_instance_logs(
        p_retention_period_days => 30
   );
end;

SIGNATURE

procedure purge_instance_logs
( p_retention_period_days in number default null
);

Procedure run_daily_stats

This procedure runs the daily statistics summarization process. It is typically run as a scheduled job. Running the daily statistics summarization process creates daily summary records for all process instances that completed the previous day. If the daily statistics summarization process was not run for several days, running it will create daily summaries for each day since it was last run.

Available in Flows for APEX Community Edition and Flows for APEX Enterprise Edition.

EXAMPLE

This example will run the daily statistics.

begin
   flow_admin_api.run_daily_stats;
end;

SIGNATURE

procedure run_daily_stats;

Procedure purge_statistics

This procedure purges the performance statistics summary records that are older than the configured retention period. Statistics summary records are created by the daily statistics summarization process. Statistics retention periods are configured in the configuration data.

Available in Flows for APEX Community Edition and Flows for APEX Enterprise Edition.

EXAMPLE

This example will run the daily statistics.

begin
   flow_admin_api.purge_statistics;
end;

SIGNATURE

procedure purge_statistics;

Procedure set_config_value

This procedure sets a configuration parameter value in the Flows for APEX configuration data. If the configuration parameter does not exist, it is created. If the configuration parameter exists and the p_update_if_set parameter is true, the value is updated.

Available in Flows for APEX Community Edition and Flows for APEX Enterprise Edition.

SIGNATURE

  procedure set_config_value
  ( p_config_key        in flow_configuration.cfig_key%type,
    p_value             in flow_configuration.cfig_value%type,
    p_update_if_set     in boolean default true
  );

Function get_config_value

This function returns the value of a configuration parameter from the Flows for APEX configuration data. If the configuration parameter does not exist, the value in p_default_value is returned.

Available in Flows for APEX Community Edition and Flows for APEX Enterprise Edition.

SIGNATURE

  function get_config_value
  ( p_config_key        in flow_configuration.cfig_key%type
  , p_default_value     in flow_configuration.cfig_value%type
  ) return flow_configuration.cfig_value%type;

Procedure release_diagram

This procedure releases a diagram, making it available for use in new process instances. The procedure sets the diagram status to ‘released`. If a version of this diagram already exists in ‘released’ status, the previous version is set to ‘deprecated’.

This procedure is useful for deploying new diagrams into a production environment in a scripted manner. You can install the new diagram into the production environment having exported it in SQL format, then release it when you are ready to start using it.

Available in Flows for APEX Community Edition and Flows for APEX Enterprise Edition.

SIGNATURE

  procedure release_diagram
  ( pi_dgrm_name    in flow_diagrams.dgrm_name%type,
    pi_dgrm_version in flow_diagrams.dgrm_version%type default '0'
  );