Open topic with navigation

TIBCO iProcess® Engine 11.10.0

# DEF_SCHEMA_PROCS_FORMAT

Procedure Configuration

Note: The `DEF_SCHEMA_PROCS_FORMAT` process attribute is only applicable to SQL Server (Windows environment) and Oracle database version of the iProcess Engine.

## Summary

This attribute allows you to override the default format of the stored procedure name when defining or editing the EAIDB step.

## Applies To

This attribute can be set for the `RPC_POOL` process.

## Permissible Values

`0`, `1`, or `2`

## Default Value

This attribute is not defined automatically when you install or upgrade iProcess Engine. In this case, the default value is:

Machine ID | Process | Instance | Value
0 | ALL | 0 | 0

The attribute only appears in the output of the `SHOW_ALL_ATTRIBUTES` command if you have explicitly assigned a value to it using the `SET_ATTRIBUTE` command. The default setting is not displayed.

## Notes

EAIDB Step for SQL Server:

Defining the Database Stored Procedure to call on 'Process Step' or 'Withdraw Step' can be categorized into below with respect to displaying the Stored Procedure dropdown.

- With Server and Database name or with only Database Name in input

  The Stored Procedure dropdown is displayed with the list of Stored Procedures fetched from the given details and in the following format.
  `<SCHEMA>.<StoredProcedure>`
  All the procedures from the given database and that are accessible to the Foreground User are displayed with the schema name. The behavior is the same for New EAIDB step or an Edit.

- Without Server and Database name in input

  The Stored Procedure dropdown for a new step displays with the list of stored procedures fetched from the iProcess Engine’s database. The formatted lists are as follows:

  1. `<SCHEMA>.<StoredProcedure>`
     Stored procedures from the non-default schema of the Foreground User (basically all other schemas from the iProcess Engine database, other than the user’s default schema), are displayed with the schema name.

  2. `<StoredProcedure>`
     Stored procedures from the default schema of the Foreground User, are displayed without the schema name. We do have a Process Attribute to suppress this behavior. For example, in the event when a user wants to see the procedures from the default schema with the schema name.

     The `DEF_SCHEMA_PROCS_FORMAT` process attribute controls the display format of the stored procedures from the default schema. This attribute has no effect on 'point a'.

  The valid values are `0`, `1` and `2`:

  `1` - displays the stored procedures from the default schema in `<StoredProcedure>` format.

  `2` - displays the stored procedures from the default schema in `<SCHEMA>.<StoredProcedure>` format.

  `0` or `not set` - behaves the same as 1.

  Edit behaves a bit different occasionally, as the dropdown can be populated in the following two ways.

  1. When the dialog is loaded after you click Edit step.
     The dropdown list format matches with the already configured Procedure Name. This is mainly to retain the designed format and respect the original intention of the user. The process attribute `DEF_SCHEMA_PROCS_FORMAT` has no effect on step initial load.

  2. When you click Refresh.
     The dropdown list format matches with the already configured Procedure Name. Here, the user has an option to override this behavior by setting a process attribute `DEF_SCHEMA_PROCS_FORMAT.`

  The role or behavior of `DEF_SCHEMA_PROCS_FORMAT` process attribute value is described as follows:

  `1` - displays the stored procedures from the default schema in `<StoredProcedure>` format.

  `2` - displays the stored procedures from the default schema in `<SCHEMA>.<StoredProcedure>` format.

  `0` or `not set` - displays the stored procedures in the format of the already configured Procedure Name.

  Note: Overriding the behavior may result into Procedure Name mismatch errors that was configured earlier and is expected if the user is intending to modify the Procedure Name or the parameters associated.

EAIDB Step for Oracle:

The Stored Procedure dropdown for EAIDB step is displayed with the list of Stored Procedures fetched from iProcess Engine schemas, `SWUSER` and `SWPRO` and from the list of schemas configured in `EAIDB_PROCS_SCHEMAS` process attribute.

The stored procedure names are displayed in the following formats:

| — | `<PackageName>.<Stored Procedure>`: stored procedures from all packages. The Stored Procedure name is prefixed with the Package name when displayed in the dropdown. The `DEF_SCHEMA_PROCS_FORMAT` process attribute has no effect on this display.

| — | `<Stored Procedure>`: all stored procedures from the given schemas. The Procedure name does not display the owner name in the dropdown unless the behavior is modified by the `DEF_SCHEMA_PROCS_FORMAT` process attribute.

Defining the Database Stored Procedure to call a `Process Step` or a `Withdraw Step` can be categorized as follows:

| 1. | New Step: The `DEF_SCHEMA_PROCS_FORMAT` process attribute can override the behavior of the procedure dropdown as follows: `1` - displays the stored procedures in `<StoredProcedure>` format. `2` - displays the stored procedures in `<Owner>.<StoredProcedure>` format. `0` or `not set` - behaves the same as 1.

| 2. | Edit Step: The `DEF_SCHEMA_PROCS_FORMAT` process attribute can override the behavior of the procedure dropdown as follows: When the dialog is loaded after you click Edit step. The dropdown list format matches with the already configured Procedure Name. This is mainly to retain the designed format and respect the original intention of the user. The process attribute `'DEF_SCHEMA_PROCS_FORMAT'` has no effect on step initial load. When you click Refresh. The dropdown list format matches with the already configured Procedure Name. Here, the user has an option to override this behavior by setting a process attribute `'DEF_SCHEMA_PROCS_FORMAT'.` The `'DEF_SCHEMA_PROCS_FORMAT'` process attribute can override the behavior of the Stored Procedure dropdown as follows: `1` - displays the stored procedures in `<StoredProcedure>` format. `2` - displays the stored procedures in `<Owner>.<StoredProcedure>` format. `0` or `not set` - displays the stored procedures in the format of the already configured procedure name.

Note: The `DEF_SCHEMA_PROCS_FORMAT` process attribute gives the flexibility of overriding the default format of the Procedure Name dropdown, which is needed for backward compatibility with the existing iProcess Procedures. However, it is recommended to use it cautiously. Otherwise, it may lead to design-time and/or run-time failures.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO iProcess® Engine

Copyright © 1994-2025. Cloud Software Group, Inc. All Rights Reserved.