Syed Hussim - Software development

php-sapb1 Library Documentation v1 16 August 2019 - 1 views

A simple and easy to use PHP library for SAP Business One Service Layer API.

Installation

Download or clone the php-sapb1 repository from https://github.com/syedhussim/php-sapb1.

git clone https://github.com/syedhussim/php-sapb1.git
Alternatively you can download the sapb1.phar

Usage

Create an array to store your SAP Business One Service Layer configuration details.

Listing 1

$config = [
    "https" => true,
    "host" => "IP or Hostname",
    "port" => 50000,
    "sslOptions" => [
        "cafile" => "path/to/certificate.crt",
        "verify_peer" => true,
        "verify_peer_name" => true,
    ],
    "version" => 2
];

Create a new Service Layer session by called the static createSession() method of the SAPClient class.

Listing 2

include "sapb1.phar";

use SAPb1\SAPClient;

$sap = SAPClient::createSession($config, "SAP UserName", "SAP Password", "Company");

The static createSession() method will return a new instance of SAPClient. The SAPClient object provides a service($name) method which returns a new instance of SAPb1\Service with the specified name. Using this Service object you can perform CRUD actions.

Querying A Service

The queryBuilder() method of the Service class returns a new instance of SAPb1\Query. The Query class allows you to use method chaining to filter the requested service.

The following code sample shows how to filter Sales Orders using the Orders service.

Listing 3

$sap = SAPClient::createSession($config, "SAP UserName", "SAP Password", "Company");
$orders = $sap->getService("Orders");

$result = $orders->queryBuilder()
    ->select("DocEntry,DocNum")
    ->orderBy("DocNum", "asc")
    ->limit(5)
    ->findAll();

The findAll() method will return a collection of records that match the search criteria. To return a specific record using an id use the find($id) method.

Listing 4

...
$orders = $sap->getService("Orders");

$result = $orders->queryBuilder()
    ->select("DocEntry,DocNum")
    ->find(123456); 
    // DocEntry value

Depending on the service, $id may be a numeric value or a string. If you want to know which field is used as the id for a service, call the getMetaData() method on the Service object as shown below.

Listing 5

...
$meta = $orders->getMetaData();

You can filter results based on conditions using Filter classes. The following code sample shows how to return Sales Orders for a particular business partner using the Equal filter class.

Listing 6

use SAPb1\Filters\Equal;
...
$orders = $sap->getService("Orders");

$result = $orders->queryBuilder()
    ->select("DocEntry,DocNum,CardCode")
    ->orderBy("DocNum", "asc")
    ->where(new Equal("CardCode", "BP Card Code"))
    ->limit(5)
    ->findAll();

You can use the where() method to add additional filters to further refine the search results.

Listing 7

use SAPb1\Filters\Equal;
use SAPb1\Filters\LessThan;
...
$orders = $sap->getService("Orders");

$result = $orders->queryBuilder()
    ->select("DocEntry,DocNum,CardCode")
    ->orderBy("DocNum", "asc")
    ->where(new Equal("CardCode", "BP Card Code"))
    ->where(new LessThan("DocEntry", 1000))
    ->limit(5)
    ->findAll();

Creating A Service

The following code sample shows how to create a new Sales Order using the create() method of the Service object.

Listing 8

...
$orders = $sap->getService("Orders");

$result = $orders->create([
    "CardCode"=> "BP Card Code",
    "DocDueDate"=> "Doc due date",
    "DocumentLines"=> [
        [
            "ItemCode" => "Item Code",
            "Quantity" => 100,
        ]
    ]
]);

You must provide any User Defined Fields that are required to create a Sales Order. If successful, the newly created Sales Order will be returned as an object.

Updating A Service

The following code sample demonstrates how to update a service using the update() method of the Service object.

Listing 9

...
$orders = $sap->getService("Orders");

$result = $orders->update(19925, [
    "Comments"=> "Comment added here"

]);

Note that the first argument to the update() method is the id of the entity to update. In the case of a Sales Order the id is the DocEntry field. If the update is successful a boolean true value is returned.

node-sapb1 Library Documentation v1 01 August 2019 - 23 views

A simple and easy to use Node.js library for SAP Business One Service Layer API.

Installation

npm install node-sapb1

SAPb1 Class

Methods
resource(name) Gets a Resource object using the specified name.
session() Gets the SAP B1 Session data.
query(query, join, success, error) Querys SAP B1 Service Layer with oData query lanaguage.

Resource Class

Methods
create(data, success, error) Posts data to the resource to be created.
update(id, data, success, error) Posts data to the resource to be updated using the specified id.
delete(id, success, error) Deletes an entity from the resource using the specified id.
action(id, action, success, error) Executes an action on the resource using the specified id.
queryBuilder() Returns a new instance of Query.

Query Class

Methods
select(fields) The entity fields to return. Returns the current Query instance.
where(filter) Adds a Filter to the filter collection. This method performs an AND operation. Returns the current Query instance.
orWhere(filter) Adds a Filter to the filter collection. This method performs an OR operation. Returns the current Query instance.
limit(top, skip) Limits the results. Returns the current Query instance.
inlineCount() Includes the count of matched entities in the result. Returns the current Query instance.
orderBy(field, direction) Orders the results by the specified field and order direction. Returns the current Query instance.
count(success, error) Returns a count of entities. Returns the current Query instance.
findAll(success, error) Returns all matches.
find(id, success, error) Returns a single match using the specified id.

Filters

Name
Filter(field, value) Abstract Filter class.
Equal(field, value) This filter checks if the specified field is equal to the specified value.
NotEqual(field, value) This filter checks if the specified field is NOT equal to the specified value.
LessThan(field, value) This filter checks if the specified field is less than the specified value.
LessThanEqual(field, value) This filter checks if the specified field is less than or equal to the specified value.
MoreThan(field, value) This filter checks if the specified field is more than the specified value.
MoreThanEqual(field, value) This filter checks if the specified field is more than or equal to the specified value.
StartsWith(field, value) This filter checks if the specified field starts with the specified value.
EndsWith(field, value) This filter checks if the specified field ends with the specified value.
Contains(field, value) This filter checks if the specified field contains the specified value.
InArray(field, collection) This filter checks if the specified field contains one or more of the values in the specified collection.
NotInArray(field, collection) This filter checks if the specified field does NOT contain one or more of the values in the specified collection.

Usage

Create an object to store your SAP Business One Service Layer configuration details. If you are using an https connection, you can attach the certificate by specifying the ca property of the configuration object as shown below.

Listing 1

var config = {
    host : 'http(s): ip or hostname',
    port : 50000,
    version : 2,
    username : 'SAP usernmae',
    password : 'SAP password',
    company : 'Company name',
    ca : fs.readFileSync('/path/to/certificate.crt')
}

Listing 2

const SAPb1 = require('node-sapb1');

SAPb1.createSession(config, sap => {
    // Success 
}, (error, type) => {
    // Error
    // type = 1, Connection errors
    // type = 2, SAP response errors.
});

If the connection is successful, the success callback function is called and passed a new instance of SAPb1 as the callback argument. The SAPb1 object provides a resource(name) method which returns a new instance of Resource with the specified name. Using this Resource object you can perform CRUD actions.

Querying A Service

The following code sample demonstrates how to query a Sales Order service and return a JSON object with multiple entries using the queryBuilder() method. The queryBuilder() method returns a new instance of Query.

Listing 3

SAPb1.createSession(config ,  sap => {
    sap.resource("Orders")
        .queryBuilder()
        .select("DocNum, DocEntry, CardCode, DocumentLines")
        .orderBy("DocNum", "asc")
        .findAll(data => {
            console.log(data);
        }, (error, type) => {
            console.log(error, type);
        });
}, (error, type) =>{
    console.log(error, type);
});

To return a single entry, use the find(id, success, error) method as shown below.

Listing 4

SAPb1.createSession(config ,  sap => {
    sap.resource("Orders")
        .queryBuilder()
        .select("DocNum, DocEntry, CardCode, DocumentLines")
        .orderBy("DocNum", "asc")
        .find(1474, data => {
            console.log(data);
        }, (error, type) => {
            console.log(error, type);
        });
}, (error, type) =>{
    console.log(error, type);
});

Depending on the service, id may be a numeric value or a string.

Creating A Service

The following code sample shows how to create a new Sales Order using the create() method of the Resource object.

Listing 5

SAPb1.createSession(config ,  sap => {
    sap.resource("Orders").create({
        CardCode: "BP Card Code",
        DocDueDate: "Doc due date",
        DocumentLines: [
            {
                ItemCode: "Item Code",
                Quantity: "200",
            }
        ]
    }, (data) => {
        console.log(data);
    }, (error, type) => {
        console.log(error, type);
    });
}, (error, type) =>{
    console.log(error, type);
});

You must provide any User Defined Fields that are required in the create object. If successful, the newly created Sales Order will be returned as a JSON object.

Updating A Service

The following code sample demonstrates how to update a service using the update() method of the Resource object.

Listing 6

SAPb1.createSession(config ,  sap => {
    sap.resource('Orders').update(19165, {
        Comments: "This is a comment",
    }, (data) => {
        console.log(data);
    }, (error, type) => {
        console.log(error, type);
    });
}, (error, type) =>{
    console.log(error, type);
});

Note that the first argument to the update() method is the id of the entity to update. In the case of a Sales Order the id is the DocEntry field. If the update is successful and empty JSON object is returned.

Reading From Console 16 July 2019 - 25 views

Node.Js provides several ways to read user input from the terminal. This article explains how to use the process object to read user input. The process object is a global object which is available without the need to include it using the require() method.

To read user input, you need to access the stdin property, which returns a Stream. Since all streams are an instance of EventEmitter, we can use the on() method to monitor the data event as shown in listing 1 below.

Listing 1

process.stdin.setEncoding("utf8");
process.stdin.on("data", (data) => {
    console.log("You typed", data.trim());
});

When a user presses the enter button, the data event triggers the callback function, passing in the data that was entered. The data includes the new line character, which is why the trim() function is used to remove it. So now you know how to read your input, let's take a look at a simple program that asks the user a series of questions and stores the answers in an array.

Listing 2

const questions = [];
questions.push("What is your first name?");
questions.push("What is your last name?");
questions.push("What is your age?");

const answers = [];

printQuestion();

process.stdin.setEncoding("utf8");
process.stdin.on("data", (data) => {

    let input = data.trim();

    if(input !== ""){
        answers.push(input);
    }

    printQuestion();
});

function printQuestion(){
    if(answers.length == questions.length){
        printSummary();
    }else{
        console.log(questions[answers.length]);
    }
}

function printSummary(){
    questions.forEach((question, index) => {
        console.log(question, answers[index]);
    });
}

The code in listing 2 above creates two arrays (questions and answers). When the user enters data, the data event is triggered and checks if the user input is not empty. If the input is not empty, it is added to the answers array, which increases the array length. The printQuestion() function is then called. This function uses the length of the answers array to determine if it is equal to the length of the questions array. If it is, the printSummary() function is called. If it isn't, then the next question is shown by using the length of the answers array as the index position for the questions array.

An alternative to using the process object is to use the readline module, which is part of the default NodeJs installation.

Bonus

The code in listing 3 below, shows a complete program for a simple Hangman game. The game initializes with a random word selected from a list of predefined words. You have 10 attempts to guess the word or you lose and a new game is generated.

Listing 3

// List of playing words.
const words = [
    "house",
    "train",
    "hotel",
    "window",
    "computer",
    "laptop",
    "forest",
    "telephone",
    "apple",
    "orange",
    "banana"

];

// Contains an array of characters from the selected word.
var wordArray;
// Contains an array of correct characters entered by user.
var inputArray;
var attempts;

start();
showWordBar();

process.stdin.setEncoding("utf8");
process.stdin.on("data", (data) => {

    let input = data.trim();

    // Check input, only one character allowed.
    if(input == "" || input.length > 1){
        console.log("Please enter a single character.");
    }else{
        // Does input char exist in selected word array?
        if(wordArray.includes(input)){
            // Find all input chars.
            findAll(input);
        }else{
            // Increment failed attempt.
            attempts +=1 ;

            // 10 failed attempts? I guess you lost.
            if(attempts === 10){
                console.log("Opps, you lost.");
                // Start a new word game.
                start();
            }else{
                // Not many attempts left. Yikes.
                console.log("Incorrect. You have", (10 - attempts), "attempts left.");
            }
        }
    }
    // Show the ----- bar
    showWordBar();

    // Does the input character array contain "-" (dash).
    // No dashes? Well I guess you won.
    if(!inputArray.includes("-")){
        console.log("You win. Well done.");
        start();
        showWordBar();
    }
});

function start(){
    console.log("Generating a new word.");
    wordArray = getWordArray();
    inputArray = getInputArray();
    attempts = 0; 
}

function getWordArray(){
    let rand = parseInt(Math.random() * words.length);
    return words[rand].split("");
}

function getInputArray(){
    return "-".repeat(wordArray.length).split("");
}

function findAll(input){
    wordArray.forEach((v, i) => {
        if(input === v){
            inputArray[i] = input;
        }
    });
}

function showWordBar(){
    console.log(inputArray.join(""));
}

Difference Between const, let And var 12 July 2019 - 32 views
Understanding the difference between const, let and var can help you write better code and avoid errors. In this quick tutorial, I will explain the differences between each of the keywords with examples. Let's first take a lot at the const keyword.
const

A variable declared as a const implies two things. First that a variable can not be re-declared and second that it's value is a one time assignment, that is its value cannot be changed. To demonstrate this, let's take a look at a sample code.

Listing 1
```
const pi = 3.14;

var pi = 3.14;

// throws SyntaxError, Identifier 'pi' has already been declared
```
If you run the code in listing 1, Nodejs will throw a SyntaxError with the error Identifier 'pi' has already been declared. This clears up the fact that a variable declared as const cannot be re-declared. If you tried to assign a new value to pi as shown in listing 2, Nodejs will throw a TypeError with the error Assignment to constant variable..

Listing 2
```
const pi = 3.14;

pi = 3.14;

// throws TypeError, Assignment to constant variable.
```
The definition of the word constant means "something that does not change" and so in JavaScript, the value of a variable declared as a const cannot change. Or can it? Well it turns out that this is primarily true for primitive types such as strings, integers etc. But not so true when it come to complex types such as objects and arrays. Take a look at the following example.

Listing 3
```
const user = { first_name : "John", last_name : "Smith" };
user.first_name = "Will";

console.log(user.first_name, user.last_name);
```
Listing 3 above shows a const variable that has been assigned an object. The object can be modified by assigning new values or even adding new properties. The same applies to arrays as shown in listing 4.

Listing 4
```
const users = [];

users.push("John");
users.push("Suzan");

console.log(users.toString());
```
Although you can modify the data structure, you still can't assign a new value to a const variable.

let

Variables that are declared as let are block scope local variables and unlike const variables, they can be re-declared. Listing 5 below shows the x variable declared as let and assigned the value 10. Notice that it is then re-declared within the if statement block and assigned a new value. This value will only be available within the ifstatement block. This is whats called block scope. The output of the code will produce 10 and 100.

Listing 5
```
let x = 100;

if(true){
  let x = 10;
  console.log(x);
  // outputs 10
}

console.log(x);
// outputs 100
```
We can demonstrate this further by simply removing the first initialization of the x variable as shown in listing 6.

Listing 6
```
if(true){
  let x = 10;
  console.log(x);
}

console.log(x);
```
What do you expect the output of the code above to be? If you said 10 followed by a ReferenceError, you would be correct because x is only available within the if statement block.

var

Probably the most used keyword in JavaScript (Don't quote me on that), var is what was used before const and let were introduced. Like the let keyword, var variables can be re-declared and re-assigned a value. The difference between var and let is that var variables are executed within the context they were defined. Either a function scope or a global scope. To understand this better, let's take a look at an example. Listing 7 below is similar to listing 6 above with the notable difference being that the variable x is declared as var.

Listing 7
```
if(true){
  var x = 10;
}

console.log(x);
// outputs 10
```
The code above will output 10 because the x variable is defined globally.
Reading And Writing To Files 21 June 2019 - 37 views
Reading and writing to a file is a common task most developers do. Thankfuly Node.js provides a simple to use package that can be used to read and write to a file synchronously or asynchronously.
Synchronous Reading

Let's take a quick look at reading a file synchronously and asynchronously. The first thing you need to do is require the fs (File System) package.

Listing 1
```
const fs = require("fs");
```
To read a file synchronously, the fs package provides a readFileSync() method, which takes one or two arguments. The first is the filename and the second optional arument is an options object, which when supplied, specifies the encoding to use and the read mode.

Listing 2
```
var data = fs.readFileSync("file.txt");
console.log(data);
```
Note that the readFileSync() method returns data, which is either of type string or Buffer. When no encoding option is supplied, a Buffer object is returned. We can convert the Buffer object to an encoded string using the toString() method as shown below.

Listing 3
```
var data = fs.readFileSync("test.txt");
console.log(data.toString("UTF8"));
```
The code below shows how to pass the encoding by the optional options object. The output is the same as the code above.

Listing 4
```
var data = fs.readFileSync("test.txt", { encoding : "UTF8" });
console.log(data);
```
Asynchronous Reading

Reading files synchronously will block Node.js event loop, which means if you are reading large files, the execution of your code will hault until the file has been read. Node.js provides an asynchronous method to read files, which is used when blocking Node.js event loop is not an option. The code sample below shows how to read a file asynchronously.

Listing 5
```
fs.readFile("file.txt", { encoding : "UTF8" }, (err, data) => {
    console.log(data);
});
```
Notice that the readFile() method does not return any data but rather accepts a callback function with two arguments (err and data). The callback function is executed when the file has been read or an error occured. You should check the err variable before you attempt to process the data variable.

Node.js also provides synchronous and asynchronous methods to write data to a file. The following code shows how to write data to a file synchronously.

Listing 6
```
fs.writeFileSync("myfile.txt", "Hello World", { encoding : "UTF8" });
```
To write a file asynchronously use the writeFile() method.

Listing 7
```
fs.writeFile("myfile.txt", "Hello World", { encoding : "UTF8" }, (err) => {
    // handle error here
});
```

SYEDHUSSIM.COM

Installation

Usage

Listing 1

Listing 2

Querying A Service

Listing 3

Listing 4

Listing 5

Listing 6

Listing 7

Creating A Service

Listing 8

Updating A Service

Listing 9

Installation

SAPb1 Class

Resource Class

Query Class

Filters

Usage

Listing 1

Listing 2

Querying A Service

Listing 3

Listing 4

Creating A Service

Listing 5

Updating A Service

Listing 6

Listing 1

Listing 2

Bonus

Listing 3

const

Listing 1

Listing 2

Listing 3

Listing 4

let

Listing 5

Listing 6

var

Listing 7

Synchronous Reading

Listing 1

Listing 2

Listing 3

Listing 4

Asynchronous Reading

Listing 5

Listing 6

Listing 7