SCRIPTCASE MACROS

The sc_actionbar_clicked_state() macro allows the developer to retrieve the current state of an action bar button at the moment it is clicked.
This enables validation of the button's current state and allows changes based on the system's business rules.

This macro is exclusive to AJAX events for action bar buttons.

Examples

Example 1: Identifying the current state of the button in an AJAX event to toggle its state when clicked.

if (sc_actionbar_clicked_state() == 'pending') {
    sc_actionbar_state('ajax_btn', 'sent');
} else {
    sc_actionbar_state('ajax_btn', 'pending');
}

Example 2: Displaying the current state of the button.

echo sc_actionbar_clicked_state();

The sc_actionbar_disable() macro disables an action bar button, preventing it from being clicked.

This macro can be used for any type of button (link or AJAX) on the action bar.

Parameter Definition

Examples

Example 1: Basic macro usage

sc_actionbar_disable("link_detalhe");

Example 2: Disabling the link button to the order detail if there are no items in the order.

// Example created in the onRecord event of the Grid using the "order" and "orderdetail" tables
// If no items are in the order, the button will be disabled.

$query = "SELECT count(*) FROM OrderDetails WHERE OrderID = " . {OrderID};
sc_lookup(ds, $query);

if ({ds[0][0]} == 0) {
    // Example of using the sc_actionbar_disable macro
    sc_actionbar_disable("button_name");
} else {
    sc_actionbar_enable("button_name");
}

Enables the action bar button, making it available for clicking.

This macro can be used for any type of button (link or ajax) on the action bar.

Parameter definition

Examples

Example 1: Basic macro usage

sc_actionbar_enable("button_name");

Example 2: Enabling the link button to the order detail if there is any record to be displayed.

// Example created in the onRecord event of the grid using the order table and orderdetail table
// If there are no items ordered in the measurement, the button will be disabled

$query = "SELECT count(*) FROM OrderDetails WHERE OrderID =" . {OrderID};
sc_lookup(ds, $query);

if ({ds[0][0]} <> 0) {

    //Example of using the sc_actionbar_enable macro
    sc_actionbar_enable("button_name");

} else {

    sc_actionbar_disable("button_name");

}

This macro hides the button created on the action bar, which can be displayed again with the sc_actionbar_show macro.

This macro can be used with any type of button (link or ajax) created in the action bar.

Parameter definition

Exemplos

Example 1: Basic macro usage

sc_actionbar_show("button_name");

Example 2: Showing the order detail link button if there are any records to show.

// Example created in the onRecord event of the query using the order and orderdetail table
// If there are no items in the order, the detail link button will be hidden.

$query = "SELECT count(*) FROM OrderDetails WHERE OrderID =" . {OrderID};
sc_lookup(ds, $query);

if ({ds[0][0]} == 0) {

     //Example of using the macro sc_actionbar_hide
     sc_actionbar_hide("button_name");

} else {

     sc_actionbar_show("button_name");

}

This macro displays the action bar button, hidden using the sc_actionbar_hide macro

This macro can be used for any type of button (link or ajax) on the action bar.

Parameter definition

Exemplos

Example 1: Basic macro usage

sc_actionbar_show("button_name");

Example 2: Showing the order detail link button if there are any records to show.

// Example created in the onRecord event of the query using the order and orderdetail table
// If there are no items in the order, the button will not be displayed

$query = "SELECT count(*) FROM OrderDetails WHERE OrderID =" . {OrderID};
sc_lookup(ds, $query);

if ({ds[0][0]} <> 0) {

    //Exemplo de utilização da macro sc_actionbar_enable
    sc_actionbar_show("button_name");

} else {

    sc_actionbar_hide("button_name");

}

This macro allows you to change the current state of the action bar button through.

To use the button's, ajax event, we recommend using this macro together with sc_actionbar_clicked_state(); that makes it possible to recover the current state of the button.

Definition of Parameters

Examples

Example - Changing the ajax_btn button state between pending and sent in the button's onclick event.

if (sc_actionbar_clicked_state() == 'pending') {

        sc_actionbar_state('ajax_btn', 'sent');

} else {

        sc_actionbar_state('ajax_btn', 'pending');

}

Example - Changing the state of the ajax_btn button between pending and sent, and storing the change in the base in the email_sent field.

if (sc_actionbar_clicked_state() == 'pending') {

	$update = "update orders set email_sent = 'S' WHERE orderid =". {orderid};
	sc_exec_sql($update);
        sc_actionbar_state('ajax_btn', 'sent');

} else {

	$update = "update orders set email_sent = 'N' WHERE orderid =". {orderid};
	sc_exec_sql($update);
        sc_actionbar_state('ajax_btn', 'pending');

}

Example - Display of the state of the ajax_btn button according to the value stored in the email_sent ield in the onRecord event of the Grid application.

if ({email_sent} == 'S') {

    sc_actionbar_state('ajax_btn', 'sent');

} else {

    sc_actionbar_state('ajax_btn', 'pending');

}

Watch a tutorial

This macro allows the execution of JavaScript methods called from some events from form, control, and calendar applications.

To use this macro you need to create a javascript method in the Programming settings.

This macro receives two parameters:

The firs parameter (required) receive the javascript method name.
The second (optional) receive an array with the method parameters on it.


Examples:

Ex. 1: Method javascript without parameters:
sc_ajax_javascript('method_name');
sc_ajax_javascript('sum');

Ex. 2: Method javascript with a parameter:
sc_ajax_javascript('method_name', array("parameter"));


Ex. 3: Method javascript with two parameters:
sc_ajax_javascript('method_name', array("param1","param2"));

Example using global variables:
sc_ajax_javascript('sum', array([num1],[num2]));

Watch a tutorial

This macro allows the application to show customizable messages. Its use is restricted to AJAX events of Form/Control applications.

This macro is only available in applications with AJAX support.

Table2: Message Parameters String

Example 01

sc_ajax_message ("Message", "Title", "timeout=0");

Example 02: Using Toast

sc_ajax_message ("Client", "Title", "toast=Y&toasto_pos=center-start&type=success");

To display the message using Toast, this option must be enabled in the application interface.

The sc_ajax_refresh() macro is used to reload the data in a grid application without the need to refresh the entire page.

Its use is exclusive to AJAX events in the grid, whether in the onClick event of a field or in the action bar.

Example of use

$upd = "UPDATE order SET status = 'completed' WHERE id =". {orderid};
sc_exec_sql($upd);
// Now the macro will be used to refresh the application's data.
sc_ajax_refresh();

Watch a tutorial

This macro sends a message in the alert style of Javascript (Sweetalert) or Sweetalert2.

Ps  

To display the message using a sweetalert2 library, the Use SweetAlert option must be enabled in the application where the macro will be used.  

This option can be enabled in the application's configuration menu. To access the click on: Application> Configuration the option is in the Notification Settings block

Check below the parameters supported by the macro:

• Message: Mandatory parameter that contains the message that will be displayed.
• $array: This parameter is optional when using the macro, more mandatory when we want to use Sweetalert2.
  When used, it expects to receive an array with Sweetalert2's settings.

Check the list of configurations accepted by Sweetalert2 in this macro:

Check below the examples of use of the macro:

E.g.: Message using Sweetalert
sc_alert("This is an alert message!!");

E.g.: Message using Sweetalert2

$params = array(
'title' => 'Title',
'type' => 'success',
'timer' => '2000',
'showConfirmButton' => false,
'position' => 'bottom-end',
'toast' => true
);

sc_alert("Inserted successfully!", $params);

This macro is used to download the files stored in the Storage services available in Scriptcase, they are: Google Drive, DropBox and Amazon S3.

First of all, it is necessary to create the keys to use these APIs, either for use with the macro or through the tool interface.

See below for how to obtain the credentials for each of them.

• Click here to learn how to get Google Drive credentials
• Click here to learn how to get DropBox credentials
• Click here to learn how to get Amazon S3 credentials

Parameters

Using the macro with profile

The use of the macro with a profile requires the prior creation of the same.

Click here to see how to create a profile on each of the available storage APIs.

The profile contains the data to use the desired API, thus, when using a profile in the macro, it is not necessary to use the settings parameter.

The profile parameter accepts only the name of the profile created, for the dynamic use of the macro, it will be necessary to use the settings parameters.

Example of using the macro with the profile.

sc_api_download([
  'profile' => 'myApi',
  'file' => {file}, 
  'destination' => {destination},
]);

Using the macro with settings parameter

The array with the access credentials that must be passed in the settings parameter varies according to the API used.

See below how to use this parameter according to each of the available APIs.

When using the settings parameter in the configuration in the macro, it is not necessary to inform a profile.

Using The Macro With Settings - Google Drive API

First, we must have the credentials for using the Google Drive API in hand, click here to learn how to obtain them.

After configuring the credentials, see below all the values of the array that must be passed in the settings parameter using the Google Drive API.

All values below are mandatory when using the settings parameter

Examples when using the macro in Google Drive implementing the parameter settings 

sc_api_download([
  'settings' => [
    'app_name' => {appname},
    'gateway' => 'google_drive',
    'json_oauth' => {jsonoauth},
    'auth_code' => {authcode},
    'token_code' => {tokencode},
  ],
'file' => {files},
'destination' => {destination},
]);

Using A Macro With Settings - Dropbox

First, we must have the credentials for using the Google Drive API in hand, click here to learn how to obtain them.

After configuring the credentials, see below all the values of the array that must be passed in the settings parameter using the Dropbox API.

All values below are mandatory when using the settings parameter

Examples when using the macro in Dropbox implementing the parameter settings 

sc_api_download([
  'settings' => [
    'gateway' => 'dropbox',
    'api_key' => {apikey},
    'api_secret' => {apisecret},
    'access_token' => {accesstoken},
  ],
'file' => {file},
'destination' => {destination},
]);

Using The Macro With Settings - Amazon S3

First, we must have the credentials for using the Amazon S3 STORAGE API in hand, click here to learn how to obtain them.

After configuring the credentials, see below all the values of the array that must be passed in the settings parameter using the Amazon S3 API.

All values below are mandatory when using the settings parameter]

Examples when using the macro in Amazon S3 implementing the parameter settings 

sc_api_download([
'settings' => [
'app_name' => 'scriptcase',
    'gateway' => 'S3',
    'api_key' => {apikey},
    'api_secret' => {apisecret},
    'region' => {api_region},
    'bucket' => {api_bucket},
  ],
'file' => {file},
'destination' => {destination},
]);

1. app_name - Receive the app_name, available in your api configuration. This parameter accepts strings or variable.
2. json_oauth - Receive the content of the json file, this file is available for download in your api settings. This parameter accepts strings or variable.

For more usage and example information visit our knowledge base article: How to generate the auth code and token code

The macro sc_api_storage_delete is used to delete files stored on the storage services available in Scriptcase: Google Drive, Amazon, and Dropbox.

To use the macro, you need to configure the APIs; see the documentation below.

• Google Drive API Configuration
• Dropbox API Configuration
• Amazon S3 API Configuration

Parameter List

Example

sc_api_storage_delete([
    'profile' => 'my_profile',
    'file' => {file_name},
    'parents' => 'storage_directory',
]);

This macro is used to upload files to the cloud using the Google, Amazon and DropBox Storage APIs.

First of all, it is necessary to create the keys for using the API, either with the macro or in the fields interface.

• Click here to learn how to get Google Drive credentials
• Click here to learn how to get DropBox credentials
• Click here to learn how to get Amazon S3 credentials

After obtaining the credentials, proceed with the macro configuration.

See the list of parameters below.

As seen above, the settings parameter receives an array with the access credentials for the API used.

This parameter should be used only when we have not defined a profile in the Tools> API menu

Each API has its own settings for the settings parameter, see below how each should be configured. 

Using the macro with profile

The use of the macro with a profile requires the prior creation of the same.

Click here to see how to create a profile on each of the available storage APIs.

The profile contains the data to use the desired API, thus, when using a profile in the macro, it is not necessary to use the settings parameter.

The profile parameter accepts only the name of the profile created, for the dynamic use of the macro, it will be necessary to use the settings parameters.

Example of using the macro with the profile.

sc_api_upload([
   'profile' => 'profile_name',
   'file' => {file},
   'parents' => 'folder_name',
]);

Using the macro with settings parameter

The array with the access credentials that must be passed in the settings parameter varies according to the API used.

See below how to use this parameter according to each of the available APIs.

When using the settings parameter in the configuration in the macro, it is not necessary to inform a profile.

Using the macro with settings - Google Drive API

First, we must have the credentials for using the Google Drive API in hand, click here to learn how to obtain them.

After configuring the credentials, see below all the values of the array that must be passed in the settings parameter using the Google Drive API.

All values below are mandatory when using the settings parameter

Examples when using the macro in Google Drive implementing the parameter settings 

sc_api_upload([
   'settings' => [
       'app_name' => 'scriptcase',
       'gateway' => 'google_drive',
       'json_oauth' => '',
       'auth_code' => '',
       'token_code' => '',
   ],
   'file' => {file},
   'parents' => '',
]);

Using a macro with settings - Dropbox

First, we must have the credentials for using the Google Drive API in hand, click here to learn how to obtain them.

After configuring the credentials, see below all the values of the array that must be passed in the settings parameter using the Dropbox API.

All values below are mandatory when using the settings parameter

Examples when using the macro in Dropbox implementing the parameter settings 

sc_api_upload([
   'settings' => [
       'app_name' => 'scriptcase',
       'gateway' => 'dropbox',
       'api_key' => '',
       'api_secret' => '',
       'access_token' => '',
   ],
   'file' => {file},
   'parents' => '',
]);

Using the macro with settings - Amazon S3

First, we must have the credentials for using the Amazon S3 STORAGE API in hand, click here to learn how to obtain them.

After configuring the credentials, see below all the values of the array that must be passed in the settings parameter using the Amazon S3 API.

All values below are mandatory when using the settings parameter

Examples when using the macro in Amazon S3 implementing the parameter settings 

sc_api_upload([
   'settings' => [
       'app_name' => 'scriptcase',
       'gateway'  => 'S3',
       'api_key' => '',
       'api_secret' => '',
       'region' => '',
       'bucket' => '',
   ],
   'file' => {file},
   'parents' => '',
]);

Watch a tutorial

The sc_apl_conf() macro allows one application to dynamically modify execution properties of another application. For example, it can force a Form to start in insert mode, make a Grid start with the Search screen, define the number of rows or columns, or enable/disable toolbar buttons.

Note: This macro must be used from one application to modify the behavior of another.

Form Application Properties

Grid Application Properties

Common Property (All Applications)

Examples

// Example 1: Start "my_form" in insert mode
sc_apl_conf("my_form", "start", "new");

// Example 2: Disable record insertion in "my_form"
sc_apl_conf("my_form", "insert", "off");

// Example 3: Make "my_field" in "my_form" read-only
sc_apl_conf("my_form", "field_readonly", "my_field");

// Example 4: Show "my_field" dynamically in "my_form"
sc_apl_conf("my_form", "field_display_on", "my_field");

// Example 5: Start "my_grid" using the Search screen
sc_apl_conf("my_grid", "start", "filter");

// Example 6: Set "my_grid" to show 20 rows
sc_apl_conf("my_grid", "rows", "20");

// Example 7: Hide "my_field" dynamically in "my_form"
sc_apl_conf("my_form", "field_display_off", "my_field");

// Example 8: Trigger configuration via toolbar menu button
if ({sc_menu_item} == "btn_1") {
  sc_apl_conf("form_customer", "start", "new");
}

Watch a tutorial

The sc_apl_default() macro allows you to define, in the initial application, what should happen when the user session is lost.

Parameters

• apl: Specifies the application to which the user will be redirected after the session is lost.
• type: Defines the redirect type. Accepted values:
  • R: Redirects immediately to the specified application.
  • M: Displays a message before redirecting.

Example

In a login application set as the initial application, we can define that the user should be redirected to the same login screen after session loss:

sc_apl_default("app_login", "R");

Watch a tutorial

The sc_apl_status() macro is used to control application access. It dynamically enables or disables applications based on user permissions or custom logic.

Parameters

• application: The name of the application, or a variable containing the name, to be enabled or disabled.
• status: The value or variable that defines the application's status. Accepted values:
  • "on": Enables the application.
  • "off": Disables the application.

Examples

// Example 1: Disable a specific application
sc_apl_status("atu_cad", "off");

// Example 2: Dynamic control using variables
sc_apl_status({var_name_appl}, {var_status});

Watch a tutorial

The sc_appmenu_add_item macro dynamically adds items to the menu application initialized by the sc_appmenu_create macro.

It is important to note that to create a dynamic menu using macros, the application must not contain any items created in the Menu Items interface.

Syntax

// Initializes the dynamic menu. This call is required before using sc_appmenu_add_item
sc_appmenu_create("menu_app_name");

// Adds an item to the already initialized dynamic menu
sc_appmenu_add_item(
  "menu_app_name",
  "id_item",
  "id_item_parent",
  "label",
  "application",
  "parameters",
  "icon",
  "hint",
  "target",
  "megamenu"
);

Parameters

Examples

1. Static menu with direct values

sc_appmenu_create("menu");

// Main fixed item
sc_appmenu_add_item("menu", "item_0", "", "Home", "app_home", "", "fa fa-home", "Home page", "_self", "");

// Group: Records
sc_appmenu_add_item("menu", "item_1", "", "Records", "", "", "fa fa-folder", "", "", "");
sc_appmenu_add_item("menu", "item_2", "item_1", "Clients", "app_clients", "", "fa fa-users", "", "_self", "");
sc_appmenu_add_item("menu", "item_3", "item_1", "Suppliers", "app_suppliers", "", "fa fa-truck", "", "_self", "");
sc_appmenu_add_item("menu", "item_4", "item_1", "Products", "app_products", "", "fa fa-box", "", "_self", "");

// Group: Reports
sc_appmenu_add_item("menu", "item_5", "", "Reports", "", "", "fa fa-file", "", "", "");
sc_appmenu_add_item("menu", "item_6", "item_5", "Billing", "app_rel_billing", "", "fa fa-chart-line", "", "_self", "");
sc_appmenu_add_item("menu", "item_7", "item_5", "Stock", "app_rel_stock", "", "fa fa-warehouse", "", "_self", "");
sc_appmenu_add_item("menu", "item_8", "item_5", "Clients", "app_rel_clients", "", "fa fa-address-book", "", "_self", "");

2. Using array and foreach

sc_appmenu_create("menu");

// Home
sc_appmenu_add_item("menu", "item_0", "", "Home", "app_home", "", "fa fa-home", "Home page", "_self", "");

$groups = array(
  array(
    "id"     => "item_1",
    "label"  => "Records",
    "icon"   => "fa fa-folder",
    "items"  => array(
      array("label" => "Clients",     "app" => "app_clients",     "icon" => "fa fa-users"),
      array("label" => "Suppliers",   "app" => "app_suppliers",   "icon" => "fa fa-truck"),
      array("label" => "Products",    "app" => "app_products",    "icon" => "fa fa-box")
    )
  ),
  array(
    "id"     => "item_5",
    "label"  => "Reports",
    "icon"   => "fa fa-file",
    "items"  => array(
      array("label" => "Billing",     "app" => "app_rel_billing",   "icon" => "fa fa-chart-line"),
      array("label" => "Stock",       "app" => "app_rel_stock",     "icon" => "fa fa-warehouse"),
      array("label" => "Clients",     "app" => "app_rel_clients",   "icon" => "fa fa-address-book")
    )
  )
);

$id_counter = 2;

foreach ($groups as $group) {
  sc_appmenu_add_item("menu", $group["id"], "", $group["label"], "", "", $group["icon"], "", "", "");

  foreach ($group["items"] as $item) {
    $id = "item_" . $id_counter++;
    sc_appmenu_add_item("menu", $id, $group["id"], $item["label"], $item["app"], "", $item["icon"], "", "_self", "");
  }
}

3. Using foreach with database lookup

sc_appmenu_create("menu");

// Home
sc_appmenu_add_item("menu", "item_0", "", "Home", "app_home", "", "fa fa-home", "Home page", "_self", "");

// Query with JOIN
sc_lookup(menu_data, "
  SELECT
    g.id AS group_id,
    g.name AS group_name,
    i.id AS item_id,
    i.name AS item_name,
    i.app AS app,
    i.icon AS icon
  FROM groups g
  JOIN items i ON i.group_id = g.id
  WHERE g.active = 'Y' AND i.active = 'Y'
  ORDER BY g.id, i.id
");

$created_groups = array();

if (isset({menu_data[0][0]})) {
  foreach ({menu_data} as $row) {
    $group_id   = "item_" . $row[0];
    $group_name = $row[1];
    $item_id    = "item_" . $row[2];
    $item_name  = $row[3];
    $item_app   = $row[4];
    $item_icon  = $row[5];

    if (!in_array($group_id, $created_groups)) {
      sc_appmenu_add_item("menu", $group_id, "", $group_name, "", "", "fa fa-folder", "", "", "");
      $created_groups[] = $group_id;
    }

    sc_appmenu_add_item("menu", $item_id, $group_id, $item_name, $item_app, "", $item_icon, "", "_self", "");
  }
}

4. Mega menu example

sc_appmenu_create("menu");

// Mega menu root
sc_appmenu_add_item("menu", "item_0", "", "Management", "", "", "fa fa-sitemap", "", "", "S");

// Mega menu groups
$groups = array(
  array(
    "id"    => "item_1",
    "label" => "Records",
    "items" => array("Clients", "Products", "Users")
  ),
  array(
    "id"    => "item_2",
    "label" => "Finance",
    "items" => array("Accounts Payable", "Revenue", "Billing")
  ),
  array(
    "id"    => "item_3",
    "label" => "Reports",
    "items" => array("Sales", "Stock", "Clients")
  )
);

$id_counter = 4;

foreach ($groups as $group) {
  sc_appmenu_add_item("menu", $group["id"], "item_0", $group["label"], "", "", "", "", "", "");

  foreach ($group["items"] as $label) {
    $id  = "item_" . $id_counter++;
    $app = "app_" . strtolower(str_replace(" ", "_", $label));
    sc_appmenu_add_item("menu", $id, $group["id"], $label, $app, "", "", "", "_self", "");
  }
}

Watch a tutorial

The sc_appmenu_create() macro initializes the array used to dynamically build a menu application. The name of the target menu must be passed as a parameter.

Note: This macro must be used in Control application events or other application types, but not in the onLoad event of the Menu application itself.

Example

// Example 1: Creates a dynamic menu structure named "menu_main"
sc_appmenu_create("menu_main");

Watch a tutorial

The sc_appmenu_exist_item() macro checks if a menu item exists in a dynamic menu structure previously created with sc_appmenu_create(). It returns a boolean value: true if the item exists, or false otherwise.

Parameters

Example

// Example: Check if item_2 exists in "menu_main"
// If it exists, update it; otherwise, add it

if (sc_appmenu_exist_item("menu_main", "item_2")) {
  sc_appmenu_update_item("menu_main", "item_2", "item_1", "Category Form", "form_category");
} else {
  sc_appmenu_add_item("menu_main", "item_2", "item_1", "Category Form", "form_category");
}

Watch a tutorial

The sc_appmenu_remove_item() macro removes a menu item dynamically from a menu previously created with sc_appmenu_create().

Parameters

Example

// Example 1: Remove item_2 from the "menu_main"
sc_appmenu_remove_item("menu_main", "item_2");

Watch a tutorial

The sc_appmenu_reset() macro resets the internal array used in the dynamic creation of a menu application. It clears all items previously added through macros like sc_appmenu_add_item().

This macro expects the name of the menu application as its only parameter.

Example

// Example 1: Resets the structure of the "menu_main" application
sc_appmenu_reset("menu_main");

Watch a tutorial

Updates an application menu item dynamically

It is only possible to use this macro when there is an array created before by the macro sc_appmenu_create.

It is only possible to use this macro on items created before by the macro sc_appmenu_add_item.

Ex. 1:
sc_appmenu_update_item('menu_main','item_2','item_1','Category Form','form_category');

Watch a tutorial

This macro starts a set of transactions in the database.

For the use of this macro you need to have a transactional database.

In form applications, the events (onAfterInsert, onAfterUpdate, onAfterDelete, onBeforeInsert, onBeforeUpdate or onBeforeDelete) are automatically protected by a transaction control, since the connection is the same of the application.

In the other cases, if the user need to make a transaction control, must begin with this macro and finish with the sc_commit_trans() macro to confirm the updates or sc_rollback_trans() to cancel the transactions.

The "connection" parameter is optional, necessary only if the command is executed in a different connection from the actual application.

Watch a tutorial

Dynamically determines the display fields of a specific block.

By default, all the blocks are displayed ("on" condition).

Ex. 1:
if ({type_customeri} == "personal")
{
sc_block_display(company, off);
}
else
{
sc_block_display(personal, off);
}

Ex 2: Using a local variable as second parameter

$var = "off";

sc_block_display(company, $var);

Obs: In grids, this macro only works with "slide" orientation.

Watch a tutorial

Available when the "Copy" button is clicked. It can be tested and used inside the ScriptCase events, allowing specific programming in run time.

Ex. 1:

if (sc_btn_copy)

{

sc_message("Record copied successfully!");

}

Watch a tutorial

Available when the "Delete" button is clicked. It can be tested and used inside the ScriptCase events, allowing specific programming in run time.

Ex. 1:
if (sc_btn_delete)
{
sc_error_message("Unable to delete this record");
}

Watch a tutorial

This macro is used to disable or enable buttons from a Menu application.

Ex:

sc_btn_disable('btn_2', 'off');

Watch a tutorial

This macro is intended to dynamically enable or disable a toolbar button.

It has two required parameters:

Name of Grid buttons

Name of Form buttons

Name of Control Buttons

Example: Enabling delete button only for admin user

if ( [user_login] == 'admin' ) {

    sc_btn_disabled('delete', 'on');

} else {

    sc_btn_disabled('delete', 'off');

}

Watch a tutorial

Activate toolbars buttons on the application in execution time.

Button_Name: Is the variable name that contains the name of the button to be activated/deactivated.

Buttons Name (Grid):

group displays the "Group By" button in the grid.

Buttons Name (Form):

Buttons Name (Control):

OBS. Remember that the button's name must be lowercase.

Ex. 1:
sc_btn_display ('new', 'off');

Ex. 2: Using a local variable as second paramenter

$var = "off";
sc_btn_display ('new', $var);

Ex. 3: If we use variables or fields ({Fields} or [Global_Variables]) as parameters its not allowed the use of the quotes or single quotes.
sc_btn_display ({variavle_button}, 'off');

Watch a tutorial

Available when the "Add" button is clicked. It can be tested and used inside the ScriptCase events, allowing specific Programmation in run time.

Ex. 1:
if (sc_btn_insert)
{
sc_message("Record inserted successfully");

}

Watch a tutorial

This macro is used to dynamically change the label of the buttons, whether they are created by the developer or Scriptcase's own.

For this, it is necessary to inform two mandatory parameters, 'btn_name' and 'new_label'.

Click here and see examples of using the macro.

Nombre de los botones de cuadrícula

Name of Form buttons

Name of Control Buttons

Exemplo: Parameter with string

sc_btn_label('update', 'Atualizar Registro');

Example: Parâmetro com lang

sc_btn_label("update", {lang_btn_label});

Example:Parameter with Global variable

[btn_name] = "update";
[label] = "update";
sc_btn_label([btn_name], [label]);

Example: Parameter with local variable

$btn_name = "update";
$label= "update";
sc_btn_label($btn_name, $label);

Watch a tutorial

Available when the "Add New" button is clicked. It can be tested and used inside the ScriptCase events, allowing specific programming in run time.

Ex. 1:
if (sc_btn_new)
{
{My_Date} = date('Y/m/d');
}

Watch a tutorial

Available when the "Save" button is clicked. It can be tested and used inside the ScriptCase events, allowing specific programming in run time.

Ex. 1:
if (sc_btn_update)
{
sc_error_message("Record updated successfully");
}

Watch a tutorial

Calculate verifier (checksum) digits.

Ex. 1:
sc_calc_dv({my_dv}, {my_rest}, 1234567, 11, 98765432, 1);
Parcels calculation: 7x2= 14 ; 6x3=18 ; 5x4=20 ; 4x5=20 ; 3x6=18 ; 2x7=14 ; 1x8=8
Parcels sum : 14 + 18 + 20 + 20 + 18 + 14 + 8 = 112
Rest of the division of 112 / 11 = 2
Digit: 11 - 2 = 9

Ex. 2:
sc_calc_dv({my_dv}, {my_rest}, 1234567, 10, 12, 2);
Parcels calculation: 7x2= 14 ; 6x1=6 ; 5x2=10 ; 4x1=4 ; 3x2=6 ; 2x1=2 ; 1x2=2
Parcels sum: 1 + 4 + 6 + 1 + 0 + 4 + 6 + 2 + 2 = 26
Rest of the division of 26 / 10 = 6
Digit: 10 - 6 = 4

It allows us to use Scriptcase built-in APIs. We currently offer integration with the Mandrill and Amazon SES APIs.

This macro has two parameters:

Example 1 - Parameter $arr_settings, array with the API information

$settings = array( 'settings' => ['gateway' => 'mandrill', 'api_key'=> {api_key}] );

$mandrill = sc_call_api('', $settings);

Example 2 - Sending email using mandrill.

$txt_no_tags = strip_tags({msg});

$arr_merge = array(
                 'name'  => '',
                 'type'  => 'to',
                 'email' => 'exemplo@exemplo.com'
             );

$var_config = array( 'settings' => ['gateway' => 'mandrill', 'api_key'=> {api_key}] );

$mandrill = sc_call_api('', $var_config);
$var_msg = array(
               'from_email'                     => {from_email},
               'from_name'                      => {from_name},
                'html'                          => {msg},
                'text'                          => $txt_no_tags,
                'to'                            => array($arr_merge),              
                'subject'                       => {subject},
                'important'                     => true,            
                'auto_text'                     => null,
                'auto_html'                     => null,
                'inline_css'                    => null,
                'metadata'                      => array('website' => 'www.scriptcase.net')
    );

$async = false;
$retorno = $mandrill->messages->send($var_msg, $async);

Example 3 - Sending SMS using clickatell.

$var_config     = array( 
  'message'     => [
    'to'      => {sms_to},
    'message'     => {sms_txt},
    ],
    'settings'    => [
    'gateway'   => {gateway},
    'auth_token'  => {auth_token},
    ] 
);

sc_send_sms($var_config);

Example 4 - Using the macro with PagSeguro

  $arr_settings = [
            'gateway' => 'pagseguro',
            'environment' => 'sandbox',
            'auth_email' => 'exemplo@gmail.com',
            'auth_token' => '72AE21503DDA4840BE1DC7945F6D1CE1'
                 ];
sc_call_api('',$arr_settings);

Example 5 - Using the macro with PayPal

  $arr_settings = [
            'gateway' => 'paypal',
            'environment' => 'sandbox',
            'auth_email' => 'exemplo@gmail.com',
            'auth_token' => '72AE21503DDA4840BE1DC7945F6D1CE1'
                 ];
sc_call_api('',$arr_settings);

Dynamically controls whether the captcha/recaptcha configured in the application is displayed.

To use the macro, the application must be previously configured with the resource.

Example

if ( $_SERVER['REMOTE_ADDR'] == '127.0.0.1' ) {

    sc_captcha_display("on");

} else {

    sc_captcha_display("off");

Watch a tutorial

This macro is used to check if the field name has been changed.

Ex. 1:
if (sc_changed({my_field}))
{
Echo "Field have been changed";
}

Watch a tutorial

This macro dynamically change the application connections

Ex. 1: To change the connections:

sc_change_connection("Old_Concection01", "New_Connection01" ; "Old_Concection02", "New_Connection02");

Allows to change more then one application/connection in one command. Multiple connections can be passed as parameters that must be separated by a ";".

Ex. 2: Using variables:

sc_change_connection([Global_Connetion], [Test_Connection]);

The changes take effect in the following applications.

Ex. 3: Changing the application main connection

sc_change_connection({Password}, [Test] ; "My_Connection", [Global_Connection]);

The changes take effect in the following applications.

Ex. 4: To delete the exchange:

To recover your previous settings you can use the sc_reset_change_connection(); macro

This macro allows changing CSS attributes of application fields.

Parameter List

Example

Example of changing the font color and using the attribute sc_badge

switch({taskstatus}) {
	case 'COMPLETED':
		sc_change_css('color', '#dcfce7', 'taskstatus');
		sc_change_css('sc_badge', 'green', 'taskstatus');
		break;
		
	case 'IN-PROGRESS':
		sc_change_css('color', '#1e40af', 'taskstatus');
		sc_change_css('sc_badge', 'blue', 'taskstatus');
		break;
		
	case 'NOT-STARTED':
		sc_change_css('color', '#991b1b', 'taskstatus');
		sc_change_css('sc_badge', 'red', 'taskstatus');
		break;
}

Example of the macro with css attribute:

switch({taskstatus}) {
	case 'COMPLETED':
		sc_change_css('color', '#166534', 'taskstatus');
		sc_change_css('background-color', '#dcfce7', 'taskstatus');
		sc_change_css('padding-right', '0.6em', 'taskstatus');
		sc_change_css('padding-left', '0.6em', 'taskstatus');
		sc_change_css('border-radius', '14px', 'taskstatus');
		sc_change_css('font-weight', 'bold', 'taskstatus');
		sc_change_css('width', 'fit-content', 'taskstatus');
		sc_change_css('display', 'block', 'taskstatus');
		sc_change_css('padding-top', '0.2em', 'taskstatus');
		sc_change_css('padding-bottom', '0.2em', 'taskstatus');
		sc_change_css('font-size', '60%', 'taskstatus');
		sc_change_css('margin', '10%', 'taskstatus');
		break;
		
	case 'IN-PROGRESS':
		sc_change_css('color', '#1e40af', 'taskstatus');
		sc_change_css('background-color', '#dbeafe', 'taskstatus');
		sc_change_css('padding-right', '0.6em', 'taskstatus');
		sc_change_css('padding-left', '0.6em', 'taskstatus');
		sc_change_css('border-radius', '14px', 'taskstatus');
		sc_change_css('font-weight', 'bold', 'taskstatus');
		sc_change_css('width', 'fit-content', 'taskstatus');
		sc_change_css('display', 'block', 'taskstatus');
		sc_change_css('padding-top', '0.2em', 'taskstatus');
		sc_change_css('padding-bottom', '0.2em', 'taskstatus');
		sc_change_css('font-size', '60%', 'taskstatus');
		sc_change_css('margin', '10%', 'taskstatus');
		break;
		
	case 'NOT-STARTED':
		sc_change_css('color', '#991b1b', 'taskstatus');
		sc_change_css('background-color', '#fee2e2', 'taskstatus');
		sc_change_css('padding-right', '0.6em', 'taskstatus');
		sc_change_css('padding-left', '0.6em', 'taskstatus');
		sc_change_css('border-radius', '14px', 'taskstatus');
		sc_change_css('font-weight', 'bold', 'taskstatus');
		sc_change_css('width', 'fit-content', 'taskstatus');
		sc_change_css('display', 'block', 'taskstatus');
		sc_change_css('padding-top', '0.2em', 'taskstatus');
		sc_change_css('padding-bottom', '0.2em', 'taskstatus');
		sc_change_css('font-size', '60%', 'taskstatus');
		sc_change_css('margin', '10%', 'taskstatus');
		break;
}

Watch a tutorial

This macro is used to confirm a transaction set in the database.

In form applications, there are events that perform transactions with the database (Ex: onAfterInsert, onAfterUpdate, onAfterDelete, onBeforeInsert, onBeforeUpdate, onBeforeDelete, etc...).
The transaction control of these events is done by Scriptcase itself if the connection provided is the same as the application.
However, if the user has to perform any type of redirection in these events, it is necessary to use the macro sc_commit_trans before the redirect to secure the transactions previously performed.

Ex: onAfterUpdate - Using redirection after update a record:

sc_commit_trans();


sc_redir('grid_main');

The "connection" parameter is optional, being necessary only if the command is executed in a different database specified to the application.

Watch a tutorial

This macro returns a string resulting from a definition of two or more values Can be used in the lookup of fields or events together with the macros sc_lookup() and sc_select()

Makes concat formatting according to your database.

Ex. 1: Use(Editing Lookup):

SELECT field1, sc_concat(field2,' - ',field3) FROM table

Ex. 2: Using the macro with sc_lookup:

sc_lookup(Dataset,"SELECT field1,sc_concat(field2, ' - ' ,field3) FROM table");

Watch a tutorial

This macro is used to confirm that the action must be really executed, preventing mistakes.

Valid only in the PHP programming code that runs when called through a toolbar button.

Parameter

This macro has only one parameter, which is the confirmation message that will be displayed.

Example:
sc_confirm("Do you really wish to execute this action??");

Related Links
See a practical example of how to use the sc_confirm macro

Watch a tutorial

The edited connection will only be available in the next application.

This macro edits an existing connection at runtime. ("Connection_Name", $arr_conn)

1st Parameter: Name of the connection to be edited.

2nd Parameter: Array containing the connection information to be edited. See each index below:

Note: It is not mandatory to edit all the array indices; you can pass only the index you want to change.

Example of macro usage:

$arr_conn = array();

$arr_conn['user'] = "admin2";
$arr_conn['password'] = "admin2pass";
$arr_conn['database'] = "sc_samples2";

sc_connection_edit("sc_conexao", $arr_conn);

Watch a tutorial

When used, the macro creates a new connection with the information inserted in its parameters. This connection is available throughout the current session Scriptcase and ceases to exist when the session is closed.

The new connection will only be available in the next application.

1º Parameter: Connection name.

Note: If there is a connection created within the Scriptcase with the same name, this macro has no effect. Connections created within the Scriptcase prevail. If you want to edit an existing connection, see the documentation for the macro sc_connection_edit.

2º Parameter: Array of items containing the connection information. Check out the indices of the array:

Note: It is required that all items are filled, with the exception of items ['persistent'] and ['encoding'].

See below the driver's list:

Example:

$arr_conn = array();

$arr_conn['drive'] = "mysqlt";
$arr_conn['server'] = "127.0.0.1";
$arr_conn['user'] = "root";
$arr_conn['password'] = "pass123";
$arr_conn['database'] = "sc_samples";
$arr_conn['persistent'] = "Y";
$arr_conn['encoding'] = "utf8";

sc_connection_new("new_conn_mysql", $arr_conn);

Watch a tutorial

This macro has the aim to calculate the increment or decrement of dates. For its use are necessary some parameters as follows:

Ex. 1:
{birthdate} = sc_date({birthdate}, "dd/mm/yyyy", "+", 30, 0, 0);

Ex. 2:
$new_date = sc_date({birthdate}, "yyyy-mm-dd", "-", 15, 3, 2);

Ex. 3:
{inclusion_dt} = sc_date(date('Ymd'), "yyyymmdd", "-", 0, 1, 1);

OBS: To be certified of the date format, before use the function, try it in any event:
echo "form_date =". {name of the field date};

Watch a tutorial

This macro converts the date field passed as a parameter with an input format to another field with an output format.

Check below the list of parameters for this macro and the accepted values.

For more information on the data strings consult the PHP Manual

Ex. 1: Converts the date from"dd/mm/yyyy" format to the "yyyymmdd" format.

{field_date} = sc_date_conv({field_date}, "dd/mm/aaaa", "aaaammdd");

Ex. 2: Converts the date from the database native format to "dd/mm/yyyy" format.

{field_date} = sc_date_conv({field_date}, "db_format", "dd/mm/aaaa");

Ex. 3: Converts the date from the "dd/mm/yyyy" format to the Database native format(db_format).

{field_date} = sc_date_conv({field_date}, "dd/mm/aaaa", "db_format");

Ex. 4: Converting the date from the database's native format (db_format) to the regional setting format (sc_format_region)

{field_date} = sc_date_conv({field_date},"db_format","sc_format_region");

Ex. 5: Converting the date from the "yyyy-mm-dd" to the regional Setting format (sc_format_region)

{field_date} = sc_date_conv({field_date},"aaaa-mm-dd","sc_format_region");

Watch a tutorial

Calculates the difference between two dates (passed as parameters) in days.

Ex. 1:
{amount_days} = sc_date_dif({date1}, "aaaa-mm-dd", {date2}, "mm/dd/aaaa");

Ex. 2:
{amount_days} = sc_date_dif("2000-05-01", "aaaa-mm-dd", "04/21/2004", "mm/dd/aaaa");
{amount_days} would be equal to -1451 (days)

Note: Formats can be different but must be in days, months and years.

Watch a tutorial

Calculates the difference between two dates (passed as parameters) returning the number of days, months, and years.

The result is returned in an array structure, where index 0 have the number of days, index 1 has the number of months and the index 2 have the number of years.

Ex. 1:
$diferences = sc_date_dif_2 ({date1}, "yyyy-mm-dd", {date2}, "mm/dd/yyyy", 1);
{dif_days} = $diferences[0];
{dif_months} = $diferences[1];
{dif_years} = $diferences[2];

Ex. 2:
$diferences = sc_date_dif_2 ("2000-05-01", "yyyy-mm-dd", "04/21/2004", "mm/dd/yyyy", 1);
$diferences[0] = 20 (days)
$diferences[1] = 11 (months)
$diferences[2] = 3 (years)

Ex. 3: Using the option 2
$diferences = sc_date_dif_2 ("2000-05-01", "yyyy-mm-dd", "04/21/2004", "mm/dd/yyyy", 2);
$diferences[0] = 21 (days)
$diferences[1] = 11 (months)
$diferences[2] = 3 (years).

Note: Formats between the two dates can be different but it must have days, months and years. You also need to know the internal format being returned for the macro to work correctly.

Watch a tutorial

This macro checks if a date field is empty.

Ex. 1:
if (sc_date_empty({my_date}) )
{
sc_error_message("Invalid Date");
}

Watch a tutorial

This macro returns the encrypted field or variable to its original value.

Ex. 1: Using a local variable:
{my_field} = sc_decode($field_crypt);

Ex. 2: Using an user variable:
$my_var = sc_decode($field_crypt);

Note: Scriptcase's owner, Netmake, isn't responsible by the cryptography algorithm integrity (it is an open-source algorithm)

Watch a tutorial

Returns the field or variable with the content encrypted.

Ex. 1: Encrypting a local variable:
$field_crypt = sc_encode({my_field});

Ex. 2: Encrypting an user variable:
$field_crypt = sc_encode($my_var);

Note: Netmake isn't responsible by the encrypting algorithm integrity, (The algorithm provided is open source).

Watch a tutorial

This variable returns a string with a database error message, which occurs by trying to exclude a record.

It is used when there is a need to treat these messages.

Like for example, in case of database validations via triggers or procedures that they return messages.

Ex. 1: Content of the variable {sc_error_delete}, returning an error message generated by database trigger using

MsSQL.“[Microsoft] [ODBC SQL Server Driver] [SQL Server] You can't erase this register.”

Note: To access the database return error, sees the macro "sc_error_continue".

Watch a tutorial

The sc_error_exit macro interrupts code execution.

When used without a parameter, the macro uses a return, so when using it in a PHP method only the execution of the code in the method will be interrupted, returning to the originating event and executing the rest of the code. In this case, to interrupt the execution of the application event, the macro must also be used when returning the method.

This macro must be used after the macro sc_error_message();

Parameters

It has two parameters that are not mandatory and the use or not of the parameters interferes with the functioning of the macro.

Examples

Ex. 1: Displays only the error message.

sc_error_message("Error message");
sc_error_exit();

Ex. 2: Displays error messages and the "OK" button to redirect to the specified URL.

sc_error_message("Error message");
sc_error_exit(http://www.meusite.com);

Ex. 3: Displays error messages and the "OK" button to redirect to the informed Application.

sc_error_message("Error message");
sc_error_exit("my_application", "_blank");

Watch a tutorial

This variable returns a string with the database error, that occurs when adding a record. It is used when is needed to treat these messages. For example, in the case of database validations via triggers or procedures that returns a message.

Ex. 1: Variable {sc_erro_insert}, returning an error message generated by database trigger the using MS SQL

“[Microsoft] [ODBC SQL Server Driver] [SQL Server] You cannot add this record.”

Note: To access the return of the database error, see the macro "sc_error_continue".

Watch a tutorial

This macro generates an error message or error messages.

In "Form and Control" applications, the messages are presented together with other error messages found in the application, except when using the "sc_error_exit" macro.

In "Grid and Menu" applications the messages only will be presented through the "sc_error_exit" macro.

Ex. 1:
if ({discount} > 0.10 && [glo_usr] == 'operator')
{
sc_error_message("Discounting of " . {discount} . " above of the allowed one");
}

In this example, if the value in the discount field is over 0.10 and the user try to add or save this record, the operation is finished and the error message is presented. The command must finish with ");" (close parentheses and semicolon) used as a delimiter for the macro interpreter.