MACROS SCRIPTCASE

A macro sc_actionbar_clicked_state() possibilita que o desenvolvedor recupere o estado atual do botão no momento do clique no botão ajax da barra de ação.

Desta forma é possível validar o estado atual do botão e alterá-lo de acordo com sua regra de negócio.

Esta macro é exclusiva para utilização do evento ajax do botão da barra de ação.

Exemplos

Exemplo: Identificação do estado atual do botão no evento ajax, para alteração do estado ao clicar.

// Recupera o estado do botão clicado.
// No código abaixo estamos validando se o estado atual do campo é pendente

if (sc_actionbar_clicked_state() == 'pendente') {

    sc_actionbar_state('ajax_btn', 'enviado');

} else {

    sc_actionbar_state('ajax_btn', 'pendente');

}

Exemplo: Recuperando o estado do botão ajax criado na barra de ação e exibindo o resultado.

echo sc_actionbar_clicked_state();

Desabilita o botão da barra de ação, tornando indisponível para o click.

Esta macro pode ser utilizada para qualquer tipo de botão (link ou ajax) da barra de ações.

Definição do parâmetro

Exemplos

Exemplo 1: Utilização básica da macro

sc_actionbar_disable("link_detalhe");

Exemplo 2: Desabilitando o botão de link para o detalhe do pedido caso não haja itens no pedido.

// Exemplo criado no evento onRecord da consulta utilizando a tabela order e orderdetail
// Caso não exista itens no pedido o botão será desabilitado

$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_disable
    sc_actionbar_disable("nome_do_botao");

} else { 

    sc_actionbar_enable("nome_do_botao");
 
}

Habilita o botão da barra de ação, tornando disponível para o click.

Esta macro pode ser utilizada para qualquer tipo de botão (link ou ajax) da barra de ações.

Definição do parâmetro

Exemplos

Exemplo 1: Utilização básica da macro

sc_actionbar_enable("link_detalhe");

Exemplo 2: Habilitando o botão de link para o detalhe do pedido caso haja algum registro para ser exibido.

// Exemplo criado no evento onRecord da consulta utilizando a tabela order e orderdetail
// Caso não exista pedidos itens no medido, o botão será desabilitado

$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_enable("link_detalhe");

} else {

    sc_actionbar_disable("link_detalhe");

}

Esta macro esconde o botão criado na barra de ação, podendo ser exibido novamente com a macro sc_actionbar_show.

Esta macro pode ser utilizada com qualquer tipo de botão (link ou ajax) criado na barra de ações.

Definição do parâmetro

Exemplos

Exemplo 1: Utilização básica da macro

sc_actionbar_hide("nome_do_botao");

Exemplo 2: Exibindo o botão de link para o detalhe do pedido caso haja algum registro para ser exibido.

// Exemplo criado no evento onRecord da consulta utilizando a tabela order e orderdetail
// Caso não exista itens no pedido o botão de link para o detalhe será escondido.

$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_hide
    sc_actionbar_hide("nome_do_botao");

} else {

    sc_actionbar_show("nome_do_botao");

}

Esta macro exibe o botão da barra de ação, escondido utilizando a macro sc_actionbar_hide

Esta macro pode ser utilizada para qualquer tipo de botão (link ou ajax) da barra de ações.

Definição do parâmetro

Exemplos

Exemplo 1: Utilização básica da macro

sc_actionbar_show("nome_do_botao");

Exemplo 2: Exibindo o botão de link para o detalhe do pedido caso haja algum registro para ser exibido.

// Exemplo criado no evento onRecord da consulta utilizando a tabela order e orderdetail
// Caso não exista itens no pedido o botão não será exibido

$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_show("nome_do_botao");

} else {

    sc_actionbar_hide("nome_do_botao");

}

Esta macro permite alterar o estado atual do botão da barra de ação através.

Para utilização do evento ajax do botão, recomendamos a utilização desta macro em conjunto com a sc_actionbar_clicked_state(); que possibilita recuperar o estado atual do botão.

Definição dos Parâmetros

Exemplos

Exemplo 1 - Alterando o estado do botão ajax_btn entre pendente e enviado no evento onclick do botão.

if (sc_actionbar_clicked_state() == 'pendente') {

        sc_actionbar_state('ajax_btn', 'enviado');

} else {

        sc_actionbar_state('ajax_btn', 'pendente');

}

Exemplo 2 - Alterando estado do botão ajax_btn entre pendente e enviado, e armazenada alteração na base no campo status_envio

if (sc_actionbar_clicked_state() == 'pendente') {

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

} else {

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

}

Exemplo 3 - Exibição do estado do botão de acordo com o valor armazenado no botão status_envio no evento onRecord da consulta

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

	sc_actionbar_state('ajax_btn', 'enviado');

} else {

    sc_actionbar_state('ajax_btn', 'pendente');

}

Assista um video

Esta macro permite que métodos javascript chamados em determinados eventos sejam executados nas aplicações de formulário, controle e calendário

Para utilizar esta macro é necessário criar o método javascript na aplicação na opção de Programação.

A macro recebe dois parâmetros:

O primeiro (parâmetro obrigatório) é uma string contendo o nome do método javascript.
O segundo (parâmetro opcional) um array com os parâmetros desse método.

Exemplos de chamadas de métodos javascript:

Ex. 1: Método javascript sem parâmetros:
sc_ajax_javascript('nome_do_metodo');
sc_ajax_javascript('soma');

Ex. 2: Método javascript que contem um parâmetro:
sc_ajax_javascript('nome_do_metodo', array("parâmetro"));

Ex. 3: Método javascript que contém dois paramentros:
sc_ajax_javascript('nome_do_metodo', array("param1","param2"));

Exemplo com variáveis globais como parâmetros:
sc_ajax_javascript('soma', array([num1],[num2]));

Esta macro permite que a aplicação exiba mensagens customizáveis, com seu uso restrito aos eventos do formulário/controle quando se faz uso no eventos AJAX.

Esta macro só é valida em aplicações com suporte a AJAX.

Tabela2: String de Parâmetros da mensagem

Exemplo 01

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

Exemplo 02: Utilizando o Toast

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

Obs

Para a exibição da mensagem utilizando o Toast é necessário que esta opção esteja habilitada na interface da aplicação.

Esta macro é especialmente utilizada em eventos Ajax da Consulta com o objetivo de recarregar os dados da Grid (refresh).

Ex:

sc_ajax_refresh();

Assista um video

Esta macro envia uma mensagem no estilo de alerta de Javascript (Sweetalert) ou Sweetalert2.

Obs
Para a exibição da mensagem utilizando a biblioteca sweetalert2, é necessário que a opção Usar SweetAlert esteja ativada na aplicação onde a macro será utilizada.
Esta opção pode ser habilitada no menu Aplicação > Configuração no bloco Configurações de notificações

Confira abaixo os parâmetros suportados pela macro:

• Mensagem: Parâmetro obrigatório que contém a mensagem que será exibida.
• $array: Este parâmetro é opcional na utilização da macro, mas obrigatório quando desejamos utilizar o Sweetalert2.
  Quando utilizado, espera receber um array com as configurações do Sweetalert2.

Confira a lista de configurações aceitas pelo Sweetalert2 nesta macro:

Confira abaixo os exemplos de utilização da macro:

Exemplo: Mensagem utilizando o Sweetalert
sc_alert("Esta é uma mensagem de alerta!!");

Exemplo: Message using Sweetalert2

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

sc_alert("Inserido com sucesso!", $params);

Essa macro é utilizada para fazer o download dos arquivos armazenados nos serviços de Storage disponíveis no Scriptcase, são eles: Google Drive, DropBox e Amazon S3.

Antes de mais nada, é necessário a criação das chaves de utilização destas APIs, seja para utilização com a macro ou através da interface da ferramenta.

Veja abaixo como obter as credenciais de cada uma delas.

• Clique aqui para saber como obter as credenciais do Google Drive
• Clique aqui para saber como obter as credenciais do DropBox
• Clique aqui para saber como obter as credenciais do Amazon S3

Veja a baixo os parâmetros em detalhes.

Como visto acima, o parâmetro settings recebe um o array com as credenciais de acesso referentes API utilizada.

Este parâmetro deve ser utilizado apenas quando não definimos um perfil no menu Ferramentas > API

Cada API possui suas próprias configurações para o parâmetro settings, veja abaixo como cada uma deve ser configurada.

Utilizando a macro com profile

A utilização da macro com um perfil, pede a criação prévia do mesmo.
Clique aqui, para ver como criar um perfil em cada uma das APIs de armazenamento disponíveis.

O perfil ou profile, contém os dados para utilização da API desejada, desta forma, ao utilizar um perfil na macro não se faz necessário utilizar o parâmetro settings.

O parâmetro profile aceita apenas o nome do perfil criado, para a utilização dinâmica da macro, será necessário utilizar o parâmetros settings.

Exemplo de uso da macro com o profile.

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

Utilizando a macro com parâmetro settings

O array com as credenciais de acesso que deve ser passado na parâmetro settings varia de acordo com a API utilizada.

Veja abaixo como utilizar este parâmetro de acordo com cada uma das APIs disponíveis.

Ao utilizar o parâmetro settings na configuração na macro, não é necessário informar um profile.

Exemplo utilizando o parâmetro settings - API Google Drive

Primeiramente, devemos ter em mãos as credenciais para a utilização da API do Google Drive, clique aqui para saber como obtê-las.

Após a configuração das credenciais, veja abaixo todos os valores do array que devem ser passados no parâmetro settings utilizando a API do Google Drive.

Todos os valores abaixo são obrigatórios ao utilizarmos o parâmetro settings

Exemplos de utilização da macro com o Google Drive, utilizando o parâmetro settings

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

Utilizando A Macro Com Settings - Dropbox

Primeiramente, devemos ter em mãos as credenciais para a utilização da API do Dropbox, clique aqui para saber como obtê-las.

Após a configuração das credenciais, veja abaixo todos os valores do array que devem ser passados no parâmetro settings utilizando a API do Dropbox.

Todos os valores abaixo são obrigatórios ao utilizarmos o parâmetro settings

Exemplos de utilização da macro com o Dropbox, utilizando o parâmetro settings

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

Utilizando A Macro Com Settings - Amazon S3

Devemos ter em mãos as credenciais para a utilização da API de armazenamento do Amazon S3, clique aqui para saber como obtê-las.

Após a configuração das credenciais, veja abaixo todos os valores do array que devem ser passados no parâmetro settings utilizando a API da Amazon S3.

Todos os valores abaixo são obrigatórios ao utilizarmos o parâmetro settings

Exemplos de utilização da macro com o Amazon S3, utilizando o parâmetro settings

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

1. app_name - Recebe o app_name, disponível na configuração da sua api. Este parâmetro aceita strings ou variável.
2. json_oauth - Recebe o conteúdo do arquivo json, este arquivo está disponível para download nas configurações da sua api. Este parâmetro aceita strings ou variável

Para mais informações de utilização e exemplo acesse o nosso artigo na base de conhecimento: Como gerar o auth code e o token code

Essa macro é utilizada para fazer o upload de arquivos na nuvem utilizando as APIs de Storage do Google, Amazon e DropBox.

Antes de mais nada, é necessário a criação das chaves de utilização da API, seja com a macro ou na interface dos campos.

• Clique aqui para saber como obter as credenciais do Google Drive
• Clique aqui para saber como obter as credenciais do DropBox
• Clique aqui para saber como obter as credenciais do Amazon S3

Após obter as credenciais, siga com a configuração da macro. 

Veja abaixo a lista de parâmetros.

Como visto acima, o parâmetro settings recebe um o array com as credenciais de acesso referentes API utilizada.

Este parâmetro deve ser utilizado apenas quando não definimos um perfil no menu Ferramentas > API

Cada API possui suas próprias configurações para o parâmetro settings, veja abaixo como cada uma deve ser configurada.

Utilizando a macro com profile

A utilização da macro com um perfil, pede a criação prévia do mesmo.
Clique aqui, para ver como criar um perfil em cada uma das APIs de armazenamento disponíveis.

O perfil ou profile, contém os dados para utilização da API desejada, desta forma, ao utilizar um perfil na macro não se faz necessário utilizar o parâmetro settings.

O parâmetro profile aceita apenas o nome do perfil criado, para a utilização dinâmica da macro, será necessário utilizar o parâmetros settings.

Exemplo de uso da macro com o profile.

sc_api_upload([
    'profile' => 'minha_api',
    'file' => {arquivo},
    'parents' => 'pasta_no_drive',
]);

Utilizando a macro com parâmetro settings

O array com as credenciais de acesso que deve ser passado na parâmetro settings varia de acordo com a API utilizada.

Veja abaixo como utilizar este parâmetro de acordo com cada uma das APIs disponíveis.

Ao utilizar o parâmetro settings na configuração na macro, não é necessário informar um profile.

Utilizando a macro com settings - API Google Drive

Primeiramente, devemos ter em mãos as credenciais para a utilização da API do Google Drive, clique aqui para saber como obtê-las.

Após a configuração das credenciais, veja abaixo todos os valores do array que devem ser passados no parâmetro settings utilizando a API do Google Drive.

Todos os valores abaixo são obrigatórios ao utilizarmos o parâmetro settings

Exemplos de utilização da macro com o Google Drive, utilizando o parâmetro settings

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

Utilizando a macro com settings - Dropbox

Primeiramente, devemos ter em mãos as credenciais para a utilização da API do Dropbox, clique aqui para saber como obtê-las.

Após a configuração das credenciais, veja abaixo todos os valores do array que devem ser passados no parâmetro settings utilizando a API do Dropbox.

Todos os valores abaixo são obrigatórios ao utilizarmos o parâmetro settings

Exemplos de utilização da macro com o Dropbox, utilizando o parâmetro settings

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

Utilizando a macro com settings - Amazon S3

Devemos ter em mãos as credenciais para a utilização da API de armazenamento do Amazon S3, clique aqui para saber como obtê-las.

Após a configuração das credenciais, veja abaixo todos os valores do array que devem ser passados no parâmetro settings utilizando a API da Amazon S3.

Todos os valores abaixo são obrigatórios ao utilizarmos o parâmetro settings

Exemplos de utilização da macro com o Amazon S3, utilizando o parâmetro settings

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

Assista um video

Esta macro permite alterar as propriedades de execução das aplicações, mudando sua forma de execução em relação ao inicialmente previsto. Desta forma, podemos forçar que um formulário inicie no modo de inclusão, ou uma consulta inicie pelo filtro, etc.

Esta macro deve ser utilizada, por uma aplicação, para modificar as propriedades de uma outra aplicação.

Propriedades para aplicações de Formulário

Propriedades para aplicações de Consulta

Propriedades para todas as aplicações

Ex. 1: Forçar a aplicação "meu_formulario" a iniciar no modo de inclusão.
sc_apl_conf("meu_formulario", "start", "new");

Ex. 2: Não permite que a aplicação "meu_formulario" faça inclusão de novos registros.
sc_apl_conf("meu_formulario", "insert", "off");

Ex. 3: Exibe "meu_campo", da aplicação "meu_formulario", dinamicamente.
sc_apl_conf("meu_formulario", "field_display_off", "meu_campo");

Ex. 4: Forçar a aplicação "minha_consulta" a iniciar pelo filtro.
sc_apl_conf("minha_consulta", "start", "filter");

Ex. 5: Forçar a aplicação "minha_consulta" a exibir 20 linhas.
sc_apl_conf("minha_consulta", "rows", "20");

Ex. 6: Forçar a saida da aplicação "minha_consulta" para a aplicação "outra_consulta".
sc_apl_conf("minha_consulta", "exit", "outra_consulta");

Ex. 7: Uso do botão da barra de ferramentas do menu.
if ({sc_menu_item} == "btn_1")
{
sc_apl_conf("form_customer", "start", "new");
}

Essa macro tem como objetivo permitir que o desenvolvedor defina o que ocorrerá quando a aplicação perder a sessão.

A macro possui os seguintes parâmetros:

Apl: Aqui é necessário informar para qual aplicação a macro irá redirecionar após perder a sessão.

Tipo: Aqui iremos informar o tipo de redirecionamento que irá ocorrer, há dois tipos:

• R: A aplicação irá apenas redirecionar para a aplicação inicial.
• M: Será mostrada uma mensagem antes do redirecionamento.

Ex: Em uma aplicação de login, definida como aplicação inicial, podemos definir que essa aplicação será para a qual iremos redirecionar.
sc_apl_default("app_login","R")

Esta macro tem por objetivo proteger ou liberar a utilização das aplicações, quando utilizado o modulo de segurança. Assim, em função do "Login" do usuário, podem ser determinadas as aplicações que o mesmo pode ou não acessar.

Aplicação: É o nome ou a variável que contenha o nome da aplicação a ser ativada/desativada.
Status: É o valor ou a variável que contenha o valor a ser atribuído à aplicação. Os valores são: "on" para ativar e "off" para desativar.

Ex. 1:
sc_apl_status ('atu_cad', 'off');

Ex. 2:
sc_apl_status ({var_nome_apl}, {var_status});

Adiciona um item dinamicamente a uma aplicação de menu.

Só é possível utilizar esta macro quando já existe um array gerado com a macro sc_appmenu_create antes.

Ex. 1: Cria um menu com nome de menu_main.
sc_appmenu_create('menu_main');


Ex. 2: Adiciona ao menu 'menu_main' no lugar do item 1, o submenu Categoria.
sc_appmenu_add_item('menu_main','item_1','','Categoria','');


Ex. 3: Addiciona ao menu_main de ID item_1, o form_categoria com o nome de Catergoria passando alguns parâmetros
sc_appmenu_add_item('menu_main','item_2','item_1','Categoria','form_categoria','param1=valor;param2=valor');

Esta macro inicia o array para montagem dinâmica de uma aplicação de menu. Deve ser informado o nome da aplicação de menu como parâmetro.

Esta macro deve ser usada em eventos do controle ou no evento onload do menu.

Ex. 1:
sc_appmenu_create('menu_main');

Verifica se um item do menu existe e retorna um valor true ou false.

Ex. 1:

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');

}

Remove dinamicamente um item do menu.

Para utilizar esta macro é necessário que a macro sc_appmenu_create seja executa antes da mesma.

Ex. 1:
sc_appmenu_remove_item('menu_main','item_2');

Esta macro limpa o array para montagem dinâmica de uma aplicação menu.

Deve ser informado o nome da aplicação de menu como parâmetro.

Ex. 1:
sc_appmenu_reset('menu_main');

Atualiza um item dinâmicamente a uma aplicação de menu.

Só é possível utilizar esta macro quando já existe um array gerado com a macro sc_appmenu_create antes.

Só é possível utilizar esta macro nos itens que tenham sido criados com a macro sc_appmenu_add_item antes.

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

Assista um video

Essa macro inicia um conjunto de transações no banco de dados.

Para a utilização dessa macro é necessário o uso de um banco de dados transacional.

Nas aplicações de fomulário, os eventos (onAfterInsert, onAfterUpdate, onAfterDelete, onBeforeInsert, onBeforeUpdate or onBeforeDelete) são automaticamente protegidos por um controle de transação, desde que a conexão seja a mesma da aplicação.

Em outros casos, caso o usuário deseja fazer um controle de transação, ele precisa iniciar o código com a macro e após a finalização utilizar a macro sc_commit_trans() para confirmar a atualização ou o sc_rollback_trans() para cancelar a transação.

O parâmetro "conexão" é opcional, necessário apenas se o comando é executado em uma base diferente da utilizada na aplicação.

Permite, dinamicamente, exibir ou não os campos de um determinado bloco.

Em princípio, todos os blocos são exibidos (condição "on").

Ex 1:
if ({tipo_cliente} == "fisica")
{
sc_block_display(juridica, off);
}
else
{
sc_block_display(fisica, off);
}

Ex 2: Utilizando variável local como segundo parâmetro

$var = "off";

sc_block_display(juridica, $var);

Obs: No caso de consultas, esta macro só funciona para a orientação "slide".

Assista um video

Quando o botão "Copiar" é clicado, esta macro é disponibilizada, podendo ser testado e utilizado dentro dos eventos, permitindo a tomada de decisões em tempo real de execução.

Ex. 1:

if (sc_btn_copy)

{

sc_error_message("Registro foi copiado com sucesso");

}

Quando um dos botões da barra de ferramentas de um formulário (novo, atualizar, excluir ou incluir) são clicados, esta macro é disponibilizada, podendo ser testado e utilizado dentro dos eventos, permitindo a tomada de decisões em tempo real de execução.


Ex. 1:
if (sc_btn_delete)
{
sc_error_message("Impossivel excluir este registro");
}

Esta macro é utilizada para desabilitar ou habilitar botões da aplicação de Menu.

Ex:

sc_btn_disable('btn_2', 'off');

Assista um video

Esta macro tem o objetivo de habilitar ou desabilitar, dinamicamente, um botão da barra de ferramentas.

Ela possui dois parâmetro obrigatórios:

Clique aqui e veja exemplos de utilização da macro.

Nome dos botões da consulta

Nome dos botões das aplicações de Calendário e Formulário

Nome dos botões do Controle

Exemplo: Habilitando botão delete apenas para o usuário admin com aspas.

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

    sc_btn_disabled('delete', 'on');

} else {

    sc_btn_disabled('delete', 'off');

}

Exemplo: Utilizando variáveis.

Obs: Podem ser utilizadas variáveis globais ou locais.

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

    sc_btn_disabled([btn_name], [status]);

} else {

    sc_btn_disabled([btn_name], [status]);

}

Usado dentro dos eventos, podem ser ativados ou desativados os botões da barra de ferramentas.

Nome_botao: É o nome ou a variável que contenha o nome do botão a ser ativado/desativado.

Nome dos botões (consulta):

Nome dos botões (Formulário):

Nome dos botões (Controle):

OBS. Os nomes dos botões devem estar todo em minusculo.

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

Ex. 2: Usando variável local como segundo parâmetro

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

Ex. 3: Ao passarmos variáveis ou campos ({campo} ou [variavel_global]) como parâmetros não se faz necessário o uso de aspas duplas ou simples antes e depois da variável.
sc_btn_display ({variavel_botao}, 'off');

Quando o botão "Inserir" é clicado, esta macro é disponibilizada, podendo ser testado e utilizado dentro dos eventos, permitindo a tomada de decisões em tempo real de execução.

Ex. 1:
if (sc_btn_insert)
{
sc_error_message("Registro incluido com sucesso");
}

Assista um video

Esta macro serve para alterar dinamicamente a label dos botões, sejam eles criados pelo desenvolvedor ou próprios do Scriptcase.

Para isso, é necessário informar dois parâmetros obrigatórios, 'btn_name' e 'new_label'.

Clique aqui e veja exemplos de utilização da macro.

Nome dos botões da Consulta e do Gráfico

Nome dos botões do Formulário e do Calendário

Nome dos botões da Controle

Exemplo: Parâmetro com string

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

Exemplo: Parâmetro com lang

sc_btn_label("update", {lang_btn_label});

Exemplo: Parâmetro com variável Global

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

Exemplo: Parâmetro com variável local

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

Quando o botão "Novo" é clicados, esta macro é disponibilizada, podendo ser testado e utilizado dentro dos eventos, permitindo a tomada de decisões em tempo real de execução.

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

Quando o botão "Alterar" é clicado, esta macro é disponibilizada, podendo ser testada e utilizada dentro dos eventos, permitindo a tomada de decisões em tempo real de execução.

Ex. 1:
if (sc_btn_update)
{
sc_error_message("Registro alterado com sucesso!");
}

Assista um video

Esta macro tem por objetivo o cálculo de dígitos verificadores.

Ex. 1:
sc_calc_dv({meu_dig}, {meu_resto}, 1234567, 11, 98765432, 1);
Calculo parcelas: 7x2= 14 ; 6x3=18 ; 5x4=20 ; 4x5=20 ; 3x6=18 ; 2x7=14 ; 1x8=8
Soma parcelas : 14+18+20+20+18+14+8 = 112
Resto da divisao de 112 / 11 = 2
Dígito : 11 - 2 = 9

Ex. 2:
sc_calc_dv({meu_dig}, {meu_resto}, 1234567, 10, 12, 2);
Calculo parcelas: 7x2= 14 ; 6x1=6 ; 5x2=10 ; 4x1=4 ; 3x2=6 ; 2x1=2 ; 1x2=2
Soma parcelas : 1+ 4+6+1+0+4+6+2+2 = 26
Resto da divisao de 26 / 10 = 6
Dígito : 10 - 6 = 4

Esta macro possibilita a utilização das APIs integradas ao Scriptcase nos eventos das aplicações.

Ela pode ser utilizada com um Perfil de API criado na interface ou informando as credenciais da API no evento.

Confira abaixo os parâmetros da macro:

Detalhe dos Parâmetros

APIs

Esta macro pode ser utilizada com todas as APIs disponíveis no Scriptcase.

Confira abaixo a lista de APIs disponíveis.

Exemplos

Confira abaixo alguns exemplos de utilização da macro com o parâmetro settings. 

Exemplo de utilização básica da macro com o Mandrill

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

Exemplo 2 - Envio de e-mail utilizando o 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);

Exemplo 3 - Enviando SMS utilizando clickatell.

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

sc_send_sms($var_config);

Exemplo 4 - Usando a macro com PagSeguro

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

Exemplo 5 - Usando a macro com PayPal

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

Controla dinamicamente a exibição ou não do captcha/recaptcha configurado na aplicação.

Para o uso da macro é necessário que a aplicação esteja previamente configurada com o recurso.

Exemplo

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

    sc_captcha_display("on");

} else {

    sc_captcha_display("off");

}

Assista um video

Esta macro tem por objetivo verificar se houve alteração em determinado campo do formulário.

Ex. 1:
if (sc_changed({Nome_Campo}))
{
Echo "O campo foi modificado";
}

Assista um video

Esta macro troca dinamicamente as conexões das aplicações

Ex. 1: Trocar as conexões :

sc_change_connection("Conexão_Antiga01", "Conexão_Nova01" ; "Conexão_Antiga02", "Conexão_Nova02");

É possível alterar mais de uma conexão com o mesmo comando, usando o separador ";".

Ex. 2: Utilizando variáveis:

sc_change_connection([Conexão_Global], [Nova_Conexão]);

As trocas só têm efeito nas aplicações seguintes.

Ex. 3: Alterando a conexão principal da aplicação:

sc_change_connection({Senha}, [Teste] ; "Minha_Conexão", [Global_Conexão]);

As trocas só têm efeito nas aplicações seguintes.

Ex. 4: Para apagar as trocas feitas:

Para retornar as configurações realizadas com a macro utilize sc_reset_change_connection();

Esta macro permite manipular propriedades CSS dos campos e linhas da consulta.

Desta forma é possível alterar o visual da aplicação dinamicamente e com muito mais opções de alteração.

Lista de Parâmetros

Exemplos

Exemplo de alteração da cor da fonte e utilização do atributo sc_badge

switch({taskstatus}) {
	case 'COMPLETED':
		sc_change_css('sc_badge', 'green', 'taskstatus');
		break;
		
	case 'IN-PROGRESS':
		sc_change_css('sc_badge', 'blue', 'taskstatus');
		break;
		
	case 'NOT-STARTED':
		sc_change_css('sc_badge', 'red', 'taskstatus');
		break;
}

Exemplo de utilização da macro com atributos css

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;
}

Assista um video

O objetivo da macro é efetivar uma série de transações na base de dados.

Nas aplicações de formulário, existem eventos que realizam transações com a base de dados (Ex: onAfterInsert, onAfterUpdate, onAfterDelete, onBeforeInsert, onBeforeUpdate, onBeforeDelete, etc...).
O controle de transações desses eventos é feito pelo próprio Scriptcase, desde que a conexão seja a mesma da aplicação.
Contudo, caso o usuário precise realizar qualquer tipo de redirecionamento nesses eventos, é necessário o uso da macro sc_commit_trans antes da realização do mesmo, para garantir as transações efetuadas anteriormente.

Ex: onAfterUpdate - Usando redirecionamento após atualização de registro:

sc_commit_trans();


sc_redir('grid_main');

O parâmetro "conexão" é opcional, sendo necessário apenas se o comando for executado em uma base de dados diferente da especificada para a aplicação.

Assista um video

Esta macro retorna um cadeia de caracteres resultante de uma junção de dois ou mais valores. Podendo ser utilizada no lookup dos campos ou em eventos junto das macros sc_lookup() e sc_select()

Faz a formatação do concat de acordo com seu banco de dados.

Exemplo de utilização no lookup dos campos

SELECT campo1, sc_concat(campo2,' - ',campo3) FROM tabela

Exemplo de utilização em eventos na macro sc_lookup

O comando contendo a macro sc_concat deve ser inserido diretamente na macro sc_lookup para que funcione.

sc_lookup(Dataset,"SELECT campo1,sc_concat(campo2, ' - ' ,campo3) FROM tabela");

Esta macro tem o objetivo de confirmar se uma ação deverá ser realmente executada.

Esta macro atua apenas em códigos PHP, que são executados através de botões na barra de ferramentas.

Parâmetro

Esta macro possui apenas um parâmetro, que é a mensagem de confirmação que será exibida.

Exemplo

sc_confirm("Deseja realmente executar a ação ??");

Links Relacionados
Veja um exemplo prático de como utilizar a macro sc_confirm

Assista um video

A conexão editada só estará disponível na próxima aplicação.

Esta macro edita uma conexão existente em tempo de execução. ("Nome_da_Conexão", $arr_conn)

1º Parâmetro: Nome da conexão à ser editada.

2º Parâmetro: Array contendo as informações da conexão que serão editadas. Veja cada indice abaixo:

Obs:Não é obrigatória a edição de todos os indices do array, podendo ser passado apenas o indice que desejar.

Exemplo de uso da macro:

$arr_conn = array();

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

sc_connection_edit("sc_conexao", $arr_conn);

Assista um video

Quando usada, a macro cria uma nova conexão com as informações inseridas em seus parâmetros. Esta conexão fica disponível em toda a sessão atual do Scriptcase, deixando de existir somente quando a sessão for fechada.

A nova conexão só estará disponível na próxima aplicação.

1º Parâmetro: Nome da conexão à ser criada.

Obs: Se existir uma conexão criada dentro do Scriptcase com o mesmo nome, essa macro não terá nenhum efeito. Conexões criadas dentro do Scriptcase prevalecem. Caso deseje editar uma conexão já existente, veja a documentação da macro sc_connection_edit.

2º Parâmetro: Array de itens contendo as informações da conexão. Confira abaixo os indices do array:

Obs: É obrigatório que todos os itens estejam preenchidos, com exceção dos itens ['persistent'] e ['encoding'].

Veja abaixo a lista de drivers das conexões:

Exemplo de uso da macro:

$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);

Assista um video

Esta macro tem por objetivo o cálculo do incremento ou decremento de datas. Para sua utilização são necessários alguns parâmetros, conforme a seguir:

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

Ex. 2:
$nova_data = sc_date({datanasc}, "aaaa-mm-dd", "-", 15, 3, 2);

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

OBS: Para certificar-se do formato da data, antes de utilizar a função, ponha seu comando em algum evento:
echo "form_data = " . {nome do campo de data};

Assista um video

Um trabalho relativamente complexo na programação é a manipulação de datas. Para minimizar este problema o ScriptCase disponibiliza a função para conversão de datas sc_date_conv.

Confira abaixo a lista de parâmetros para esta macro e os valores aceitos.

Para mais informações sobre as strings das dadas consulte o Manual do PHP

Ex. 1: Convertendo a data do formato "dd/mm/aaaa" para o formato "aaaammdd"

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

Ex. 2: Convertendo a data do formato nativo do banco de dados para o formato "dd/mm/aaaa"

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

Ex. 3: Convertendo a data do formato "dd/mm/aaaa" para o formato nativo do Banco de dados

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

Ex. 4: Convertendo a data do formato formato nativo do Banco de dados para o formato da configuração regional

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

Ex. 5: Convertendo a data do formato "aaaa-mm-dd" para o formato da configuração regional

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

Assista um video

Esta macro calcula a diferença entre datas, em quantidade de dias.

Ex. 1:
{quantidade_dias} = sc_date_dif({data1}, "aaaa-mm-dd", {data2}, "dd/mm/aaaa");

Ex. 2:
{quantidade_dias} = sc_date_dif("2000-05-01", "aaaa-mm-dd", "21/04/2004", "dd/mm/aaaa");
{quantidade_dias} seria igual a -1451 (dias)

Obs: Embora os formatos possam ser diferentes, as datas devem ser compostas de dia, mês e ano

Assista um video

Calcula diferença entre datas, retornando a quantidade de dias, meses e anos.

O resultado será retornado em forma de array, no qual o índice 0 terá a a quantidade de dias, o índice 1 terá a quantidade de meses e o índice 2 terá a quantidade de anos.

Ex. 1:
$diferencas = sc_date_dif_2 ({data1}, "aaaa-mm-dd", {data2}, "dd/mm/aaaa", 1);
{dif_dias} = $diferencas[0];
{dif_meses} = $diferencas[1];
{dif_anos } = $diferencas[2];

Ex. 2:
$diferencas = sc_date_dif_2 ("2000-05-01", "aaaa-mm-dd", "21/04/2004", "dd/mm/aaaa", 1);
$diferencas[0] seria igual a 20 (dias)
$diferencas[1] seria igual a 11 (meses)
$diferencas[2] seria igual a 3 (anos).

Ex. 3: Utilizando a opção 2.
$diferencas = sc_date_dif_2 ("2000-05-01", "aaaa-mm-dd", "21/04/2004", "dd/mm/aaaa", 2);
$diferencas[0] seria igual a 21 (dias)
$diferencas[1] seria igual a 11 (meses)
$diferencas[2] seria igual a 3 (anos).

Obs: Embora os formatos possam ser diferentes, as datas devem ser compostas de dia, mês e ano. Também é preciso saber o formato interno que está sendo retornado para que a macro funcione corretamente.

Assista um video

Esta macro verifica se um campo do tipo data está vazio.

Ex. 1:
if (sc_date_empty({data_nasc}) )
{
sc_error_message("Dados inválidos");
}

Assista um video

Esta macro retorna, o campo ou variável criptografada, à sua forma original.

Ex. 1: Descriptografando uma variável local:
{meu_campo} = sc_decode($campo_cript);

Ex. 2: Descriptografando uma variável do usuário:
$minha_var = sc_decode($campo_cript);

OBS: A Netmake não se responsabiliza pela possível quebra do algorítimo de criptografia utilizado, uma vez que o algoriíimo é fornecido com o fonte aberto.

Assista um video

Esta macro retorna, o campo ou variável, de forma criptografada.

Ex. 1: Criptografando uma variável local:
$campo_criptografado = sc_encode({meu_campo});

Ex. 2: Criptografando uma variável do usuário:
$campo_criptografado = sc_encode($minha_variavel);

OBS: A Netmake não se responsabiliza pela possível quebra do algoritimo de criptografia utilizado, uma vez que o algoritimo é fornecido com o fonte aberto.

Assista um video

Esta macro inibe o tratamento de erros de banco de dados, padrão do Scriptcase, para o evento passado como parâmetro e permite que o programador trate os erros do banco de dados.

Pode ser usada por exemplo quando no banco de dados existem triggers/procedures que fazem validações referentes aos eventos de inclusão, atualização e exclusão de registros.

É usada em conjunto com as variáveis: {sc_erro_delete},{sc_erro_insert} e/ou{sc_erro_update}

Os eventos a serem passados como parâmetro são: inserir, delete ou update.

Ex. 1: Utilizando o evento onDelete para tratamento de mensagem devolvida por uma trigger do mssql, que cancela a exclusão do registro e manda uma mensagem de erro no formato: [Microsoft][ODBC SQL Server Driver][SQL Server] Você não pode apagar este registro.

sc_error_continue("delete");
if (!empty({sc_erro_delete}))
{
$tmp = strrpos({sc_erro_delete}, "]");
if ($tmp !== false)
{
{sc_erro_delete} = substr({sc_erro_delete}, $tmp + 1);
}
sc_error_message({sc_erro_delete});
sc_erro_exit;
}

Assista um video

Esta variável retorna uma string contendo qualquer mensagem de erro do banco de dados, que ocorra ao se tentar excluir um registro. É utilizada quando precisamos tratar estas mensagens. Por exemplo, no caso validações feitas no banco de dados via triggers ou procedures que retornam mensagem.

Ex. 1: Conteúdo da variável {sc_error_delete}, retornando uma mensagem de erro gerada por uma triger do banco de dados usando MsSQL.

“[Microsoft][ODBC SQL Server Driver][SQL Server] Você não pode apagar este registro.”

OBS: Para ter acesso ao retorno do erro do banco, veja a macro "sc_error_continue".

A sc_error_exit interrompe a execução do código.

Quando utilizada sem parâmetro a macro utiliza um return, desta forma, ao utilizá-la em um método PHP apenas a execução do código no método será interrompida, retornando ao evento de origem e executando o restante do código. Neste caso, para interromper a execução do evento da aplicação, a macro precisa ser utilizada também no retorno do método.

Esta macro deve ser utilizada obrigatoriamente após a macro sc_error_message();

Parâmetros

Ela possui dois parâmetros que não são obrigatórios e o uso ou não dos parâmetros interfere no funcionamento da macro.

Exemplos

Ex. 1: Exibe apenas a mensagem de erro.

sc_error_message('Mensagem de erro');
sc_error_exit();