SCRIPTCASE MACROS

Esta variable devuelve una cadena con un mensaje de error de base de datos, que ocurre al tratar de excluir un registro.

Se usa cuando hay una necesidad de tratar estos mensajes. < br />
Como por ejemplo, en caso de validaciones de bases de datos a través de desencadenantes o procedimientos que devuelvan mensajes.

Ej. 1: contenido de la variable {sc_error_delete} , que devuelve un mensaje de error generado por el activador de la base de datos usando

MsSQL. "[Microsoft] [Controlador ODBC SQL Server] [SQL Server] No puede borrar este registro."

Nota: Para acceder al error de devolución de la base de datos, ve la macro " sc_error_continue ".

El uso de esta macro da como resultado la interrupción de la aplicación.
De esta manera, se interrumpirá cualquier procesamiento que se ejecutará después del uso del marco o se está ejecutando en el momento.
Aquí puedes ver un ejemplo del uso de la macro.

Esta macro debe usarse después de la macro
sc_error_message ();

Esta macro se puede utilizar de dos maneras: sin parámetros sc_error_exit (); eso solo interrumpe la aplicación o informa a una URL / aplicación que el usuario será redirigido cuando se muestre el error.

Cuando informamos a una aplicación o URL de destino y no se informa al parámetro Target, se utilizará _self como predeterminado.

Ex. 1: Muestra solo un mensaje de error.

sc_error_message('¡Mensaje de error!');
sc_error_exit();

Ex. 2: Muestra un mensaje de error y un botón "OK" para redireccionar a la URL informada.

sc_error_message('¡Mensaje de error!');
sc_error_exit(http://www.mysite.com);

Ex. 3:Show an error message and an "OK" button to redirect to the application informed.

sc_error_message('¡Mensaje de error!');
sc_error_exit(my_application, "_blank");

Esta variable devuelve una cadena con el error de base de datos, que ocurre al agregar un registro. Se usa cuando es necesario tratar estos mensajes. Por ejemplo, en el caso de validaciones de bases de datos a través de desencadenantes o procedimientos que devuelven mensajes.

Ej. 1: Variable {sc_erro_insert} , al devolver un mensaje de error generado por la base de datos, se activa el uso de mssql

"[Microsoft] [Controlador ODBC SQL Server] [SQL Server ] No puede agregar este registro. "

Nota: Para acceder al error de la base de datos, consulte la macro " sc_error_continue ".

Esta macro genera un mensaje de error.

En las aplicaciones " Formularios y Control ", los mensajes se presentan junto con otros mensajes de error. encontrados en la aplicación, excepto cuando se utiliza la macro " sc_error_exit ".

En las aplicaciones " Cuadrícula y menú ", los mensajes solo se presentarán a través de la macro " sc_error_exit ".

Ej. 1:
if ({discount}> 0.10 && [glo_usr] == 'operator')
{
sc_error_message ("Descuento de". {Discount}. "Anterior de el permitido ");
}

En este ejemplo, si el valor en el campo de descuento es más de 0.10 y el usuario intenta agregar o guardar este registro, la operación finaliza y el aparece un mensaje de error. El comando debe terminar con ");" (cerrar paréntesis y punto y coma) utilizado como delimitador para el intérprete de macros.

Esta variable devuelve una cadena con un mensaje de error de base de datos que se produce al actualizar un registro. Se usa cuando existe la necesidad de tratar estos mensajes. Por ejemplo, en el caso de validaciones de bases de datos a través de disparadores o procedimientos que devuelven mensajes.

Ej. 1: Variable {sc_erro_update} , devolviendo un mensaje de error generado por un activador de base de datos usando mssql.

"[Microsoft] [Controlador ODBC SQL Server] [SQL Servidor] No puede actualizar este registro ".

Nota: Para acceder al error de devolución de la base de datos, consulte la macro " sc_error_continue ". < / span>

Esta macro permite condicionar las circunstancias en que se ejecutan los comandos SQL.

El parámetro "Conexión" es opcional. Obligatorio solo, si el comando se ejecuta en una base de datos diferente de la aplicación.

Ex. 1:
if (sc_after_delete) {
sc_exec_sql("delete from mytable where key = {key_ant}");
}

Esta macro se puede usar en los eventos de ScriptCase y en el botón creado y puede devolver valores / proceso después de la ejecución.

This option is only valid for Form and Control Applications.

Esta macro se usa para cambiar / restaurar un color de cuadrícula de forma dinámica..

Esta macro se usa para bloquear un campo y obtener los datos que se escribirán en él.

Los campos que se van a bloquear deben ir seguidos de la opción "verdadero" (predeterminado) o "falso".

El parámetro es opcional, "I" se usa solo para bloquear la adición de nuevos registros, "U" para bloquear solo la actualización, en el caso de que el parámetro no haya sido informado, el scriptcase usará ambas opciones..

Ex. 1: Blocks only one field for addition and update.
sc_field_disabled("Field_01");

Ex. 2: Unblocking a field for addtion and update.
sc_field_disabled("Field_02=false");

Ex. 3: Blocks several fields, only for update.
sc_field_disabled("Field_01; Field_02; Field_03", "U");

Ex. 4: Combination of block and unblock of several fields, for adition and update.
sc_field_disabled("Field_01=true; Field_02=false; Field_03=true");

Esta macro tiene el objetivo de bloquear el tipado en campos determinados en las líneas del formulario de Grabación múltiple, Grid editable y Visión de Grid editable.

Los campos que se supone que deben bloquearse deben aplicarse a las opciones, "verdadero" (Para bloquear) o "falso" (para desbloquear). Si no está informado, el valor predeterminado es "verdadero".

El parámetro opcional es usar la "I" para bloquear al insertar un nuevo registro y "U" para bloquear mientras se actualiza un registro. Si no se informa, Scriptcase bloqueará en ambas ocasiones de manera predeterminada.

Ex. 1: Blocking the field while including and updating.
sc_field_disabled_record(“Field_01");

Ex. 2: Unblocking the field while including and updating.
sc_field_disabled_record(“Field_02=false");

Ex. 3: Blocking the various fields only when updating.
sc_field_disabled_record(“Field_01; Field_02; Field_03", "U");

Ex. 4: Combination of blocking and unblocking various fields while including and updating.
sc_field_disabled_record("Field_01=true; Field_02=false; Field_03=true");

The macro can also work within a condition, blocking a specific field on the record line.

Example 1:
if ({Filed_01} == 1)
{
sc_field_disabled_record("Filed_03");
}

Example 2:
switch(trim([arr_apps][ {app_name} ]))
{
case 'form':
break;
case 'calendar':
sc_field_disabled_record("priv_export; priv_print");
break;
case 'cons':
sc_field_disabled_record("priv_insert; priv_delete; priv_update");
break;
default:
sc_field_disabled_record("priv_insert; priv_delete; priv_update; priv_export; priv_print");
break;
}

Esta macro muestra dinámicamente un campo específico.
Por defecto, todos los campos se muestran ("en" condición ").

Ex. 1:
if ({tp_customeri} == "personal")
{
sc_field_display({company_name}, off);
}
else
{
sc_field_display({personal_name}, off);
}

This macro is intended to inhibit the query fields on the initial load.

Fields inhibited by this macro can be enabled by using the "Columns" button.



Ex 01:

sc_field_init_off ({orderID}, {TotalValue});

Esta macro establece dinámicamente un atributo de campo de formulario en 'ReadOnly'. Use esta macro solo para hacerlo en 'runtime'. De lo contrario, active / desactive este parámetro en la interfaz del formulario. sección "Solo lectura".

El parámetro on / off es opcional, utilizado por un evento ajax para definir si un campo será de solo lectura (Activado) o de solo lectura (Desactivado).

Ej. 1: para establecer un campo como de solo lectura incluso cuando el formulario está en "Modo de adición":
if (sc_btn_new)
{
sc_field_readonly ({my_field});
}

Ej. 2: para configurar un campo como de solo lectura de forma dinámica, utilice:
sc_field_readonly ({my_field});

This macro allows to modify the grid field style dinamically.

Ex. 1:
sc_field_style({my_field}, '#33FF99', '15px', '#000000', 'Arial, sans-serif', 'bold');

This macro its used to format numerical values.

Ex. 1: Formatting an integer.
sc_format_num({my_value}, '.', '', 0, 'N', '1', '');
Input value = 001234567890
Output value = 1.234.567.890

Ex. 2: Formatting a negative value and truncating decimals.
sc_format_num({my_value}, '.', '', 0, 'N', '1', '');
Input value = 0012345678.90-
Output value = -12.345.678

Ex. 3: Formatting a value with 4 decimals and filling with zeros.
sc_format_num({my_value}, '.', ',', 4, 'S', '1', '');
Input value = 0012345678.9
Output value = 12.345.678,9000

Ex. 4: Formatting a value with 2 decimals, filling with zeros and using monetary symbol.
sc_format_num({my_value}, '.', ',', 2, 'S', '1', 'US$');
Input value = 0012345678.9
Output value = US$ 12.345.678,90

Ex. 5: Formatting a value with 2 decimals, filling with zeros.
sc_format_num({my_value}, '.', ',', 2, 'S', '1', '');
Input value = .9
Output value = 0,90

This macro has the objective to format numbers, using the regional settings

Ex. 1: Formating a value with 2 decimal spaces, inserting the zeros and the monetary value.
sc_format_num_region({my_value}, "2", "Y", "Y");
Input value = 9
Output value = R$0,90

Esta macro muestra dinámicamente o no un formulario.
Por defecto, se muestra el formulario (estado "on").

Ex. 1: Doesn't display the form.
sc_form_show = 'off';

Esta macro se usa para asignar objetos (que representan el formulario del campo) a una variable de JavaScript, lo que permite al usuario acceder a las propiedades del objeto. Esta macro se ejecutará en control y formularios en los eventos y métodos de JavaScript.

EX:

Mostrando el valor del campo "cliente" de un formulario cli_js = sc_getfield ('cliente'); alerta (cli_js.value);

Esta macro se usa para recuperar el nombre de la regla Agrupación que se está utilizando en este momento. El valor de retorno es una Cadena que contiene el nombre de la regla.

Ex:

if (sc_get_groupby_rule() == "rule1")

{

[title] = "Sales X Region";

}

Esta macro devuelve la abreviatura del lenguaje utilizado.

Ex. 1:

$my_language = sc_get_language();

Esta macro devuelve la abreviatura de la configuración regional utilizada..

Ex. 1:

$my_regional = sc_get_regional();

Esta macro devuelve el tema de aplicación utilizado.

Ex. 1:

$my_theme = sc_get_theme();

Esta Macro modifica dinámicamente la etiqueta del campo que se muestra en grupo por líneas.

Ex. 1:
sc_groupby_label('state') = "state grouping";


Ex. 2:
sc_groupby_label('balance') = "balance total";

Esta macro se usa para deshabilitar las reglas de Agrupación por en tiempo de ejecución.

This macro its used to copy images in some events or Javascript commands to load images to an application.

All images used in the applications are automatically copied to each application.

Ex. 1:
sc_image (img1.gif, img2.jpg);

Note: The images must exist in the development environment images directory (../devel/conf/sys/img/img/).

The Scriptcase allows the user to catalogue his PHP scripts to use in various applications.

To catalogue the scripts go to the ScripCase main menu at "Tools > Library" and use the "upload" option existing in the interface.

When a script is catalogued, the user has the option of the context choice where it will be stored, global level (Scriptcase), group level or user level.
- Public: All the projects will have acess.
- Project: Only the project users (the one's that will be loged at that time) will have acess.
- User: Only the user (the one's that will be loged at that time) will have acess.

The sc_include macro, the user must inform the script name that will be included and the source.
- Script Name: Script name to be included.

The Source context that the script was saved, that could be:
- Sys or Blank: Scriptcase global level.
- Prj: Group level.
- Usr: User level.

Ex. 1: Including a catalogued script to global level.
sc_include(my_script.php);

Ex. 2: Including a catalogued script to the group level.
sc_include(my_script.php, grp);

Ex. 3: Including a catalogued script to the user level.
sc_include(my_script.php, usr);

Esta macro se usa para seleccionar dinámicamente las bibliotecas de aplicaciones.

Ex. 1:

sc_include_lib ("tcpdf");
 
$pdf=new TCPDF();
$pdf->AddPage();
$pdf->SetFont('Arial','B',16);
$pdf->Cell(40,10,'Hello World!');
$pdf->Output();

Ex. 2:

?>
sc_include_lib ("jsmind");
< ?php

This macro includes a PHP file from a library in the application. You must have a library created in Scriptcase to make use of this macro. To create a library, go to "Tools -> Libraries".

Ex: Including a file from a library:
sc_include_library("prj", "phpqrcode", "qrlib.php", true, true);

Esta macro se usa para modificar dinámicamente la etiqueta del campo de formulario de Consulta.

Ex. 1: Using the field name.
sc_label("Customer") = "Cust Name";

Ex. 2: Using a variable as paramenter.
sc_label({Customer}) = "Cust Name";

Ex. 3: Using a global variable.
sc_label([global_variable]) = "Cust Name";

Esta macro devuelve el idioma y la configuración regional.

Ex. 1:

echo "Language: ".{sc_language};

$ldapConn = sc_ldap_login($server [, $domain, $user, $password, $dn, $group]);

Esta macro inicia la conexión y la vincula a las credenciales del usuario. Esta macro necesita los siguientes parámetros:

Server =
Domain =
User =
Password =
DN =
Group =

There are three possible returns:

Esta macro se usa para liberar la conexión después de usar la macro sc_ldap_login.

Ex1:

sc_ldap_logout();

Macro para realizar búsquedas en LDAP.

Ex:

$result = sc_ldap_search($filter, array('mail', 'displayname'));

This macro dynamically creates or modifies links between grid applications and other applications.

Column: Grid column field name to generate the link.
Application: Application name to establish the link.
Parameters: Parameters required by the called application.

Must be informed "=" (attribution sign) . More than one parameter must be separated by ";" (semicolon).

Hint: Observation or tip displayed when the mouse cursor passes over the link.

Target : Where the application will function call and may be:

In the case of modal target, there are two optional parameters *:

*Height: Set the height of the modal window (default 440);
*Width: Set the width of the modal window (default 630);

Note: If omitted, will be assigned the value "_self".

Ex. 1: Creates a link to the costumer.php application, on the Id field, passing the global variable [global_costumer] as and the product field (local variable) {Id} to the costumer.php application:
sc_link(Id, costumer.php, product=[global_costumer]; Id={Id}, "Client Data", "_blank");

Ex. 2: Creating a dynamic link to another application depeding on the field valor {costumer_type} and opening it in a modal.
if ({costumer_type} == "F") {
sc_link (costumer_type, type_f.php, product=[global_costumer]; Id={Id}," Personal Data ", "modal", 500, 700);
}
else{
sc_link (costumer_type, type_a.php, product=[global_costumer]; Id={Id}," Company Data ", "iframeR");
}

Ex. 3: Creating a link to an URL: in this case, "paramater and target" have no effect. It will be executed redirecting to a informed URL.
sc_link (my_field, http://www.scriptcase.com, ,"hint of the link");

Esta macro está destinada a agregar un registro a la tabla de registro, lo que hace que el mensaje y / o el nombre de la acción personalizable para el desarrollador. Los parámetros macro pueden usar variables de PHP.

Ex:

sc_log_add ("access", "Application has been accessed by the user trial");

Esta macro está destinada a proporcionar acceso a la información escrita en la última inserción en la tabla de registro, lo que permite la manipulación de los datos antes y después de la actualización de registro que lo devuelve en un modo de conjunto. La información se almacena en el campo "descripción" de la tabla de registro en el formato de cadena con delimitadores

Ex:

$arr_description = sc_log_split({description});

Input: -> keys fields Array ( [clientid] => ANTON ) [fields] => Array ( [old] => Array ( [CEP] => 50710500 [Address] => Rua Desembargador Joao Paes 657 [City] => Farol [State] => RS ) [new] => Array ( [CEP] => 53230630 [Address] => Avenida Presidente Kennedy, 1001 [City] => Peixinhos [State] => PE ) ) )

This macro allows the user to execute SQL commands and returns the result to the "dataset" variable. The "dataset" structure is an array (line/column).

The "connection" parameter is optional. Use when the command is executed in a database different from that specified for the application.
Note: The connection parameter does not accept variable. You must enter the name of the connection that the SQL command will execute.

Ex. 1:
sc_lookup(dataset, "select customer_id, customer_name, credit_limit from customers" );

To have access to the first line (Dataset), use :
{customer_id} = {dataset[0][0]};
{customer_name} = {dataset[0][1]};
{credit_limit } = {dataset[0][2]};

To have access to the second line (Dataset), use:
{customer_id} = {dataset[1][0]};
{customer_name} = {dataset[1][1]};
{credit_limit} = {dataset[1][2]};

If occurs error in the execution of the SQL command, the variable attributed to the dataset will return as "false" and the error message will be available in the "dataset_erro" variable. It is also important to verify the select returned data, to prevent access to inexistent variables, once the output array only will be created if the select command returns data.

Ex. 2:
sc_lookup(my_data, "select customer_id, customer_name, credit_limit from customers");
if ({my_data} === false)
{
echo "Access error. Message=". {my_data_erro} ;
}
elseif (empty({my_data}))
{
echo "Select command didn't return data";
}
else
{
{customer_id} = {my_data[0][0]};
{customer_name} = {my_data[0][1]};
{credit_limit} = {my_data[0][2]};
}



Ex. 3: The SQL command also can be composed of application fields (local variables) or of global variables:
sc_lookup(dataset, "select order_value from orders where clienteid = '{customer_id} ' and salesman_id = [var_glo_salesman]");

Note: The command must always finished with semicolon ";".

Note2: For a big result returned in the dataset we recomend the use of the macro sc_selec instead of this one.

Esta macro se usa para enviar correos electrónicos.

Note: To use safe connection its required to have the PHP "php_openssl" extension enable.

Ex. 1:
sc_mail_send('smtp.meuserver.com.br', 'usr', 'pw', 'from@netmake.com.br', 'to@netmake.com.br', 'Test Email Subject', 'Message', 'H', 'abc@cop.com.br;zxy@cop.com.br', 'H', '', '', 'c:/test/arq.txt');

Ex. 2: Usising variables and defining the port.
sc_mail_send([glo_smtp], [usuar], [glo_pw], {from}, {to}, {subject}, {message}, 'T', [glo_copias], 'CCC', '419', 'S', {attached});

Ex. 3: No user and password.
sc_mail_send([glo_smtp], '', '', 'from.netmake.com.br', {to}, {sunject}, {message}, 'H', '', '', '', '', [glo_att]);

The amount of emails sent will be stored at the special variable "sc_mail_count".

If any error happend when the scriptcase try to send the email, the variable "sc_mail_ok" will recieve "false" and the error message will be stored on the variavle "sc_mail_erro".

Ex.4 :

Esta macro crea una cadena que contiene un enlace a otra aplicación Scriptcase (al escribir código html).

Ex. 1: Creating a string with a link for the datacli.php application, without parameters passage.
$string_link = sc_make_link(datacli.php);

Ex. 2: Creating a string with a link for the application datacli.php, with parameters passage.
$string_link = sc_make_link(datacli, parm1={company};parm2=[glo_office]);

Actualice los datos en la aplicación principal , en tiempo real, de acuerdo con los cambios realizados en un campo determinado de la aplicación detalle .

Esta macro elimina elementos de menú pasados como parámetros. Se puede usar en aplicaciones de menú o en el menú de árbol.

Observe que los parámetros utilizados en esta macro son la "ID" de los elementos.

Si se elimina un elemento del menú y tiene "nodos", también se ocultarán.

Esta macro desactiva los elementos del menú que pasan como parámetros. Se puede usar en aplicaciones de menú o menús de árbol.

Los parámetros pasados son elementos "ID". Los elementos del menú se desactivan recursivamente (cuando un elemento del submenú está desactivado, sus "nodos" también se desactivan).

Esta macro se usa para forzar la creación de menús en dispositivos móviles.

El parámetro (verdadero o falso) es opcional. Si no se pasa ningún valor, usará el valor "verdadero" (habilite el modo móvil)

Ex1:

sc_menu_force_mobile(true);

Ex2:

sc_menu_force_mobile(false);

Esta variable solo está disponible para la aplicación de menú y tiene el objetivo de dar acceso a un ítem del menú que fue seleccionado, de esta manera el usuario puede tomar las desiciones antes de ejecutar la aplicación.

Ex. 1: To clean global variable.
if ({sc_menu_item} == "item_1")
{
sc_reset_global([global1], [global2]);
}


Ex. 2: If an application requires a global variable another application can initialize it accordingly.
if ({sc_menu_item} == "item_5" && (!isset([glo_employ]) || empty([glo_employ])))
{
sc_redir(apl_inf_emp);
}

Ex. 2: Use the button on the toolbar menu.
if ({sc_menu_item} == "btn_1")
{
sc_apl_conf("form_customer", "start", "new");
}

This macro its used to redirect the processing to other application or URL.


If the redir uses parameters, these must be passed in the following format:
1) After the name of the application, use the comma delimiter (,) then
2) = (equal sign) .
3) More than one parameter, must be separated by semicolon (;)
4) The target determine which application is opened (default=_self): _self, _parent, _blank or modal.
5) Optional parameter to set error messages redirection in the application: "F" redirects if there is error in the application (default value) and "E" does not redirect.

OBS. If your connection uses transaction control the use of this macro on the events onAfterInsert, onafterupdate, onAfterDelete, onBeforeInsert, onbeforeupdate or onBeforeDelete should come after the use of macro sc_commit_trans so this way it will save the form changes.

Esta macro no admite el uso del parámetro Modal cuando se utiliza en un botón Run.

Ex. 1: Application without parameters nor target.
if ([global_user] == "test")
{
sc_redir(application_x.php);
}

Ex. 2: Application with parameters and without target.
if ([global_user] == "test")
{
sc_redir(application_x, parm1={var_test}; parm2="xxx");
}

Ex. 3: Application without parameters and with target.
if ([global_user] == "test")
{
sc_redir(application_x, "", "_parent");
}

Ex. 4: Application with parameter and target.
if ([global_user] == "test")
{
sc_redir(application_x, parm1={var_test}; parm2="xxx", "_blank");
}

Ex. 5: URL.
if ([global_user] == "test")
{
sc_redir(http://www.my_page.com);
}