Documentation - enhancements:sage100:modules:sde:application

Application Setup

Anonymous (anonymous@undisclosed.example.com) — 2021-11-29T13:11:02+00:00

Application Setup

In order for SDE to work it needs to know where the Sage 100 data files are located. This panel is where the path to Sage 100 exists. To access the Application Setup go to SDE Application | Setup | Application Setup. The path to Sage 100 is required before SDE will work with Sage 100.

	The Cancel button will cancel all changes and close the Application Setup program.
	The Save button will save changes and close the Application Setup program.

Buttons

There are three buttons on the User Maintenance Screen.

	The Print button will print the setup information.
	The Purge button will clear the table used to transfer data to Sage 100. When clicked it will prompt to “Clear the Data Transfer table?”
	When YES is chosen it will clear the table and allow it to recreate the table with current values. This would be done if the path, user or default company is changed and unexpected results are returned. Clicking No will return to the Application Setup screen.

	The PVX Plus Web Service button is a drop-list button. Clicking the button itself launches the SDE Web Service. Clicking the drop-list arrow reveals the three selections to the right.
	The first, Launch Web Service, is the same as pressing the button.
	Configure Web Service launches the PVX Plus Web Configurations program. Add / Remove Windows Service checks to see if the SDE Web Service is installed as a Windows Service. If it's not installed, a prompt asks if you want to add it. If it's not installed, a prompt asks if you want to remove it.

Information! When the application is installed as a service, it means it will run in the background. If the server is ever restarted, the application will be started when the system is back online. Otherwise, a user must log in and keep the application running to have access to SDE.

Information! When the service is installed, it will be called Pvx Web Server. It will default to manual startup type, which will need to be changed if it is desired to have the service automatically start when the server is restarted.

Warning! Service must have correct permissions to the Sage path. The default “Log On As” is set to Local System. This would normally be changed to a domain user that has the correct permissions to run on this server as well as have the correct permissions to the Sage Path.

Fields

The following are the fields available on the Application Setup Screen.

Sage 100 ERP Path

Enter here the path to the Sage 100 system. It can be UNC or use a drive letter. Click on the browse (folder icon) button to navigate to the folder and click OK when done or enter the path manually.

Warning! Permissions must be set to allow Read and Write to the path indicated.

Sage User

Enter the Sage user login that will be used to communicate to Sage 100. This user will need to have permissions in Sage 100 for the functions that will be used by SDE. Use Role Maintenance in Sage 100 to set the appropriate permissions. (SDE takes up a Sage 100 license for posting data to Sage 100, and for some setup functions.)

Password

Enter the password for the Sage User that is indicated. If the Sage User and Password is correct, the system will display a check box to the right. Otherwise, if the user and password is incorrect, path to Sage 100 is incorrect, or the permissions to Sage 100 are wrong, a warning icon will display.

Default Sage Company

The JSON or XML document posted to SDE can include the Sage 100 Company Code, but it is not required. If Company Code is not included, it will default to the Company Code set in User Maintenance. If the Company Code is not set in User Maintenance, the Company Code in Application Setup is used. If the Company Code is not provided anywhere, the post will fail.

SDE Application

Anonymous (anonymous@undisclosed.example.com) — 2020-05-06T15:30:40+00:00

SDE Application

- - Setup
- Application Setup
- User Maintenance
- - Utilities
- Request Log
- Error Log
- - Developers

Category Maintenance

Anonymous (anonymous@undisclosed.example.com) — 2018-08-31T17:56:03+00:00

Category Maintenance

A Category is a grouping of products. Sage 100, Inventory Maintenance has four user defined categories that allow a grouping of products. The Sage e-Business Manager module introduced Category Maintenance and Category Tree Maintenance. This allowed the website to have the ability to group products in multiple categories. A single item could be in one or many different categories. Sage Data Exchange can import this information if it exists from an install of e-Business or it can be entered in to the Sage Data Exchange Category Maintenance. To access the the maintenance field go to Application | Setup | Category Maintenance.

The screen has four primary buttons. There is a directional button that has arrows pointing up, down, left and right. The up arrow will go to the first record in the table. The down arrow will go to the last record in the table. The left arrow will go to the previous record while the right arrow will go to the next record in the table. In the middle is a Plus sign and when that is clicked, the Category value can be modified.

Other buttons on the screen are Delete, to delete the current record.

The cancel button which will not save the changes to the current record and will take you back to a blank Category Maintenance screen with no Category value entered.

The Save button which will save the changes to the current record and will take you back to a blank Category Maintenance screen with no Category value entered.

Buttons

There are three buttons on the Category Maintenance Screen. One is the Print button that will print a list of the Category information from the screen.

The next button is to Import Sage 100 e-Business Categories.

When the button is clicked a message box will appear warning that the import function will completely remove any Categories that exist in Sage Data Exchange.

Click OK to import Categories from the existing e-Business setup or click *Cancel* to close out of the import function without any changes to the Sage Data Exchange Categories.

When done it will return to the Category Maintenance screen.

The import Sage 100 e-Business Categories button will only be available if there is no value in the Category field. If a Category is selected the icon will be disabled.

The last button is the Assign Properties. The properties button will display a list of fields that are set to be a Property field in Return Maintenance for the specific Resource set to Products. When a Product Resource has a Column Name checked to be a Property, the Column Name or Alias is shown in the list of Properties.

How to use Properties

Properties is a way to have a sub grouping value. This can refer to the custom categories group in Item Maintenance. When a property field is identified, the system will read through all the items to create a list of the properties values that are available. Using the Property screen, the category can now determine which properties would be used to list the values for the items. See the API Resource - Categories

To enable the property to return the values available for a Category, click on the box in the Enabled column. The list of enabled Properties will be returned in the order shown on the Properties screen.

To move the row up by one row, select the row to move and click on the Move Up button.
To move the row down by one row, select the row to move and click on the Move Down button.

To Add or Remove available properties, use Return Maintenance and check or uncheck the fields that will be listed as a property.

Each Property that is returned for the Category will also have an array of values found for that Column Name. This list can be seen and the order of what is returned is maintained by highlighting the row of the Property to view and click on the Properties Values button.

To move the row up by one row, select the row to move and click on the Move Up button.
To move the row down by one row, select the row to move and click on the Move Down button.

Fields

The following are the fields available on the Category Maintenance Screen.

Description

This is the description of the Category that has been selected. It is possible to enter HTML code in the description of the category. There is a short description which is displayed here that allows for 64 characters. There is also a short description that is 2k and a long description that is 4k in size.

Category Image

This is the full path to the image associated with the Category. The path can be looked up by clicking on the File Path button. Navigate to the path that the image is saved and double click or select and click on open to copy the image to the images folder and make it available to Sage Data Exchange.

The path to the images folder is ../SageDataExchange/application/data/images. Images in this folder will need to be synced to the client website that uses Sage Data Exchange. Only the image name is passed back to the client.

To view the image that is selected, click on the Image icon. This will take you to the preview of the image. Click the X in the upper right to close the preview window.

Only .JPG, .BMP and .PNG will be displayed in this preview.

Main Navigation

This is a check box that will indicate that this Category is a Category that should be listed as the top level.

Enabled

This check box will enable or disable the Category from being used.

Secondary Grid

The secondary grid is where the list of products associated to this Category is entered. Rows will be added as item codes are entered in.

Fields

The following are the fields available on the secondary grid of the Category Maintenance Screen.

Item Code

This is the item code that will be associated with this Category. Each Category can have one or more Item Codes listed. The Item Code can be manually entered or can be looked up by clicking on the lookup button.

When the lookup button is clicked the Item Query will display. From the Item Query, users can view all existing Items along with their description. Highlight the Item to be used and click select or double click on the Item to be used. The query screen will be closed and the value will be placed in the Item Code field.

Item Query can be used to print a list of Item Codes or export a list of Item Codes and their descriptions

Description

After an item is entered in the secondary grid, the Description field becomes available. It will default with the description from the inventory maintenance and it can be modified here for Sage Data Exchange's list of Items related to the Category.

Buttons

The list of Item Codes that belong to a Category can be adjusted with the use of the buttons to the right of the Secondary Grid.

To insert a row, select the row you wish to insert to and click on the Insert Row button
To remove a row, select the row to be removed and click on the Delete Row button
To move the row up by one row, select the row to move and click on the Move Up button
To move the row down by one row, select the row to move and click on the Move Down button

Category Tree Maintenance

Anonymous (anonymous@undisclosed.example.com) — 2018-11-06T22:39:09+00:00

Category Tree Maintenance

Category Tree represents a hierarchical view of Categories. Items can belong in one or more Categories. Categories can be in one or more Category Trees. This allows for a listing by product type, Manufacture, Product Use, etc.

Other buttons on the screen are Delete, to delete the current record.

The cancel button which will not save the changes to the current record and will take you back to a blank Category Tree Maintenance screen with no Category Tree value entered.

The Save button which will save the changes to the current record and will take you back to a blank Category Tree Maintenance screen with no Category Tree value entered.

Buttons

There are two buttons on the Category Tree Maintenance Screen. One is the Print button . The Print Button will print a list of the Category Tree information.

The Next button will be hidden until a Category Tree is selected. This button is the import Category Tree button . This will import from Sage eBusiness the existing Category Tree so that you do not have to recreate it in Sage Data Exchange.

When the button is clicked a message box will appear warning that the import function will completely remove the selected Category Tree that exist in Sage Data Exchange and import the Category Tree from Sage e-Business Manager.

Click OK to import the Category Tree from the existing e-Business setup or click *Cancel* to close out of the import function without any changes to the Sage Data Exchange Categories.

When done it will return to the Category Tree Maintenance screen.

The import Sage 100 e-Business Category Tree button will only be available if there is a value selected for the Category Tree.

Fields

The following are the fields available on the Category Tree Maintenance Screen.

Category Tree

This is the Category Tree name. This would be the unique name given to the grouping of Categories. Use the Lookup button to view a list of existing Category Trees. The Lookup button is only available if the field Category Tree is blank.

From the Category Tree Query, users can view all existing Category Trees along with their description. Highlight the Category Tree to be used and click select or double click on the Category Tree to be used. The query screen will be closed and the value will be placed in the Category Tree field.

Category Tree Query can be used to print a list of Categories or export a list of Categories.

Description

This is the description of the Category Tree that has been selected.

Default Category Tree

This checkbox will select which Category Tree is to be returned when a Tree is not specified.

Secondary Grid

The secondary grid is where the tree view of the Category Tree that has been selected is displayed.

Buttons

The list of Categories that belong to a Category Tree can be adjusted with the use of the buttons to the right of the Secondary Grid.

To insert a Category, select the row you wish to insert to and click on the Insert Row button . This will then display the Category Query. Highlight the Category to be inserted to the tree and click select.

To remove a Category, select the row to be removed and click on the Delete Row button
To move the Category up by one row, select the row to move and click on the Move Up button
To move the Category down by one row, select the row to move and click on the Move Down button

Default Maintenance

Anonymous (anonymous@undisclosed.example.com) — 2021-11-03T19:08:14+00:00

Default Maintenance

When posting JSON or XML documents, the fields Sage 100 requires must be passed in the document. If you are reporting commission, for example, you cannot create a new customer without a salesperson. If your posts are always going to use Salesperson 0100, you can default the field in Default Maintenance. This can save on the size and time required to transport your document. Default maintenance is found in SDE Application | Developers | Default Maintenance.

Warning! The Defaults will be applied every time you post to associated Resource. In the Customer example, creating a customer with a default salesperson worked well. During an update, a year later, the default salesperson will be posted again. Create different Resources to handle different situations.

	The Plus rocker button moves the record pointer to the first (top) of the table, last (bottom) of the table, and previous (left) or next (right) from the current position.
	The Delete button deletes the current record.
	The Cancel button does not save changes and clears the fields on the screen.
	The Save button saves the current record and clears the fields on the screen.

Buttons

There are two buttons on the Default Maintenance screen.

	The Print button will print the Default information.
	The Insert Row button will insert a new row at the current position.
	The Delete Row button will delete the current row.
	The Move Up Row button will move the current row up one row.
	The Move Down Row button will move the current row down one row.

Fields

The following are the fields available on the Resource Maintenance Screen.

Resource

Select the Resource for this Default.

Sage Business Object

The documents posted to SDE use the business object to post data.

Default Grid

Data Source

The only Data Sources allowed in Default Maintenance are Main and Detail, the two writeable Data Sources in Resource Maintenance.

Column Name

Select the Column you want to Default.

Expression

Enter the string or numeric expression for the column defaulted.

Column Type

Column is either a String or Numeric. (Read Only)

Table Name

Table name associated with the Data Source. (Read Only)

Error Log

Anonymous (anonymous@undisclosed.example.com) — 2021-11-29T13:25:40+00:00

Error Log

This is where SDE will display error messages. It will display the following information about the error:

Date - The Date that the error happened. This uses the date on the Operating System to log the date of the error. The format will be in Month/Day/Year
Time - This is the Time that the error happened. This uses the time on the Operating System to log the time of the error. It will be in 24 hour format.
User - This is the User from Application | Main | User Maintenance that was referenced when the error was happened.
Resource - When connecting to Sage Data Exchange a Resource from Application | Developers | Resource Maintenance is used to indicate what data is to be returned.
Message - This is the error message that will provide more detail about the error.

Buttons

There are two buttons on the Error Log screen.

	The Print button will print the errors.
	The Purge button will clear the ErrorLog table. When clicked it will prompt to “Clear the Error Log?”. When YES is chosen it will clear the table and allow it to recreate the table with current values.

FTP Images

Anonymous (anonymous@undisclosed.example.com) — 2018-11-06T23:14:03+00:00

FTP Images

In Sage Data Exchange there are a few places that reference images. Only the image name is provided. This utility has been created to upload the images to the website for display.

Buttons

There are two buttons on the FTP Images screen. The first button is to refresh list of images . The second one is to save the selection of images to the FTP location.

Request Log

Anonymous (anonymous@undisclosed.example.com) — 2020-05-06T19:14:05+00:00

Request Log

All SDE Requests are stored as a text file in the _logs\requests folder.

Buttons

There are five buttons on the Error Log screen.

	The Print button will print the errors.
	The Purge button will clear the Requests made more than 30 days ago. When clicked it will prompt to “Purge Requests more than 30 days old?”. When YES is chosen it will clear the folder of the old Requests and re-display the current ones.
	The Search button will prompt for search criteria.
	The Textbox button will pop up a window to view the Request.
	The Repost button will repost the Request.

Request Maintenance

Anonymous (anonymous@undisclosed.example.com) — 2022-11-13T15:31:13+00:00

Request Maintenance

SDE Resources are linked to Sage 100 Business Objects. Reads (GETs) and writes (POSTs) to SDE contain the Resource as part of the JSON or XML document. Request maintenance is found in SDE Application | Developers | Request Maintenance.

	The Plus rocker button moves the record pointer to the first (top) of the table, last (bottom) of the table, and previous (left) or next (right) from the current position.
	The Delete button deletes the current record.
	The Cancel button does not save changes and clears the fields on the screen.
	The Save button saves the current record and clears the fields on the screen.

Buttons

There is seven buttons on the Request Maintenance screen.

	The Print button will print the Request information.
	The Copy button copies another Request into the List Box.
	While not quite a button, you can drop a text file of your JSON or XML document into the middle of the button and it will be displayed in the List Box.
	The Insert Row button will insert a new row at the current position. The row can contain a child or sibling of the currently highlighted row.
	The Delete Row button will delete the current row.
	The Expand Tree button will expand the tree in the Tree View List Box.

Fields

The following are the fields available on the Request Maintenance Screen.

Resource

Select the Resource for this Request.

Request Tree View List Box

The information in the list box is read only.

Element Grid

Select an XML or JSON Element from the Request Tree View List Box, then define the element handling.

Entity

Is the row a User, Password, Main, Line, Tier, Payment, or Package.

Selection<html>  </html>	Description
User<html>  </html>	Element returns the SDE User.
Password<html>  </html>	Element returns the SDE Password.
Main<html>  </html>	Identifies the element that contains for one or more Sage 100 entities,
<html>  </html>	like Customers or Sales Orders.
Line<html>  </html>	Identifies the element that contains the lines or detail for the Sage 100
<html>  </html>	entity identified in Main.
Tier<html>  </html>	Identifies the element that contains the tiers for the Line identified above.
Payment<html>  </html>	Identifies the element that contains the payments for the Main entity.
Package<html>  </html>	Identifies the element that contains the packages for the Main entity.

Table Type

Is this a Header, Detail, Tier or Payment table.

Column Name

Enter the Sage 100 Column Name.

Column Type

Is the data coming in a number or a string?

Expression

Enter an expression to modify the incoming data.

Resource Maintenance

Anonymous (anonymous@undisclosed.example.com) — 2022-11-13T15:30:43+00:00

Resource Maintenance

SDE Resources are linked to Sage 100 Business Objects. Reads (GETs) and writes (POSTs) to SDE contain the Resource as part of the JSON or XML document. Resource maintenance is found in SDE Application | Developers | Resource Maintenance.

	The Plus rocker button moves the record pointer to the first (top) of the table, last (bottom) of the table, and previous (left) or next (right) from the current position.
	The Delete button deletes the current record.
	The Cancel button does not save changes and clears the fields on the screen.
	The Save button saves the current record and clears the fields on the screen.

Buttons

There is one button on the Resource Maintenance screen.

	The right arrow button to the right of the Sage Business Object changes the entry to User Defined Table (UDT). UDT's all use the same business object, so you would only enter the table name. Change back to Business Object by hitting the arrow again. <html><a href=“http://sagedataexchange.com/videos/default.asp?video=Sage User Defined Tables&YouTube=Wx3eTkNEGHw” target=_blank>[video]</a></html>
	The Print button will print the Resource information.

Fields

The following are the fields available on the Resource Maintenance Screen.

Resource

The endpoint of any Sage Data Exchange installation is sde. (i.e. “<yourDomain>:<yourPort>/sde”) The JSON or XML document posted to SDE must contain the Resource.

Sage Business Object

The documents posted to SDE use the business object to post data.

Maintain Case

By default, the column names in the response for any Resource are returned in lower case. If you wish to retain the case entered in Return Maintenance, select Maintain Case. If you want to change the default capitalization for a Sage column, just enter an Alias with the desired capitalization. <html><a href=“http://sagedataexchange.com/videos/default.asp?video=XML Case Sensitivity&YouTube=11GlhGh9xOE” target=_blank>[video]</a></html>

Resource Grid

The information in the grid is read only.

Data Source

Data Sources are pulled from the business objects' child collection.

Table Name

The table name of the Data Source.

Type

The Type can be Main or Detail. For example, Main would be the SO_SalesOrder_BUS, and Detail would be the SO_SalesOrderDetail_BUS.

RO?

Checked if the Data Source is Read Only.

Key Reference

Key Reference for the Main, Detail and Child Collection. The Main and Detail Key References have the length of each segment included in the Key Reference.

Detail

Shows Yes if the Data Source is part of the Detail

Description

Description of the Data Source.

Return Maintenance

Anonymous (anonymous@undisclosed.example.com) — 2022-11-13T15:31:57+00:00

Return Maintenance

When requesting data from SDE, you can return data from any Data Source in Resource Maintenance as the column name or as an alias. You can also return expressions. Return Maintenance is found in SDE Application | Developers | Return Maintenance.

	The Plus rocker button moves the record pointer to the first (top) of the table, last (bottom) of the table, and previous (left) or next (right) from the current position.
	The Delete button deletes the current record.
	The Cancel button does not save changes and clears the fields on the screen.
	The Save button saves the current record and clears the fields on the screen.

Buttons

There are six buttons on the Return Maintenance screen.

	The Print button will print the Return information.
	The Copy button copy another Returns' definitions to this Return.
	The Insert Row button will insert a new row at the current position.
	The Delete Row button will delete the current row.
	The Move Up Row button will move the current row up one row.
	The Move Down Row button will move the current row down one row.

Fields

The following are the fields available on the Return Maintenance Screen.

Resource

Select any Data Source available from the Resources' Business Object.

Sage Business Object

The documents posted to SDE use the business object to post data.

Return Grid

Data Source

Select any Data Source available from the Resources' Business Object.

Return Type

There are four selections for Return Type:

Selection	<html>  </html>Description
Column<html>  </html>	Return a column from the Data Source
Expression<html>  </html>	Return the results of a string or numeric expression using columns from the Data Source
<html>  </html>	<html><span style=“color: #5e87bb;”>An expression could be an invoice balance, totaling the Taxable and Non-Taxable Sales,<br>the Freight and Sales Tax on an invoice.</span></html>
Skip Conditional<html>  </html>	Skips the current record based on the binary result of the Expression
<html>  </html>	<html><span style=“color: #5e87bb;”>You may not want to return Component Items on a Sales Order.</span></html>
Running Total<html>  </html>	Returns the total of a numeric Expression based on columns in the Detail Data Source
<html>  </html>	<html><span style=“color: #5e87bb;”>You may need the total quantity of all the items on the Sales Order.</span></html>

Column Name

Select the Column you want to return. If you are returning an expression, Column Name will be locked.

Alias

Enter an Alas if you want to return the value of the column as an alias. For example, a User Defined Field in your system, “UDF_LEAD_TIME”, can be returned as “leadtime”. Expressions require an Alias.

If you selected Maintain Case in Resource Maintenance, you might use Alias to change the case of a column name to match your requirements on the return. (i.e. Change “CustomerNo” to “customerNo”.) <html><a href=“http://sagedataexchange.com/videos/default.asp?video=XML Case Sensitivity&YouTube=11GlhGh9xOE” target=_blank>[video]</a></html>

Table Name

Name of the table associated with Main. (read-only)

Column Type

Is the column entered a String or Numeric?

Detail Only

Return this field only if requesting a single entity. (Like one Sales Order, versus list of Sales Orders.)

Expression

Expressions are used for three Return Types; Expression, Skip Conditional, and Running Total. If returning an Expression, enter a string or numeric expression. The Skip Conditional Expression must return a numeric 0 or 1. The Running Total must return a numeric Expression. All the expressions must be valid PxPlus expressions.

Skip Conditional

Skip Conditional lines can added for the MAIN and DETAIL Data Sources. When more than one Skip Conditional is added to a given Data Source, the record will be skipped if any of the Expressions are true.

Larger Image

The image above shows a Skip Conditional entry for the Sales Order DETAIL Data Source. Note that the Column Name and Alias cells are locked. Column Type should be set to Numeric.

The Expression contains a PxPlus expression that evaluates to a 1 (true) or 0 (false). If the Expression is true, the record is skipped. In this case, only those Item Types set to “1” are returned, the rest are skipped.

Running Total

Running Totals are set up in the DETAIL Data Source, but returned in the MAIN section of the XML or JSON. Running Totals require an Alias and are assumed to be numeric.

Larger Image

The Expression contains a PxPlus expression that evaluates to a numeric. You can enter multiple Running Totals.

SDE

Anonymous (anonymous@undisclosed.example.com) — 2021-12-27T18:02:13+00:00

100 Catalog

- Enhancements

- - Paperless Office

- Modules

SDE

- Installation

- - PxPlus Web Service
- Install PxPlus
- - SDE
- Install SDE

- Application

- API Resources

Skip Conditional

Anonymous (anonymous@undisclosed.example.com) — 2020-07-22T16:29:50+00:00

Skip Conditional

Return Maintenance

Anonymous (anonymous@undisclosed.example.com) — 2020-07-22T16:34:33+00:00

Return Maintenance

Skip Conditional

User Maintenance

Anonymous (anonymous@undisclosed.example.com) — 2021-11-29T13:21:14+00:00

User Maintenance

In order to successfully post a document to SDE, you'll need to include the credentials created in User Maintenance. There are three User Types; Customer, Vendor and Administrator.

Customer Users are linked to a specific Sage 100 Customer. They can only access information related to that Customer. So they would have access to their data in Accounts Receivable and Sales Orders, and access to Inventory.

Vendor Users are linked to a specific Sage 100 Vendor. They can only access information related to that Vendor. So they would have access to their data in Accounts Payable and Purchase Orders.

Administrative Users have access to everything!

User Maintenance is found in SDE Application | Main | User Maintenance.

	The Plus rocker button moves the record pointer to the first (top) of the table, last (bottom) of the table, and previous (left) or next (right) from the current position. The white plus sign in the middle pops up a panel to allow you to change the key field.
	The Delete button deletes the current record.
	The Cancel button does not save changes and clears the fields on the screen.
	The Save button saves the current record and clears the fields on the screen.

Buttons

There are two buttons on the User Maintenance screen.

	The Print button will print the User information.
	The Purge button will clear the GUID table used relate data passed to Sage 100 as one transaction. When clicked while editing a user record, it will prompt to “Clear GUID's used by <user name>?”. Otherwise, it will prompt “Clear GUID table?”.
	When “YES” is chosen it will clear the table and allow it to recreate the table with current values. This would be done if the User Type is changed and unexpected results are returned.

Fields

The following are the fields available on the User Maintenance Screen.

User

This is a unique name in SDE. It can be changed.

User Name

This is the full name of the User. It is only used for information purposes.

Email Address

The Email Address can be used as an alternate to the User field for logging into the SDE API. Like the User field, it must be unique between all users in SDE.

Password

Password is a required field, it cannot be left blank. The Password must be at least eight characters long and contain at least one digit, one uppercase character, on lowercase character and one special character. (“~!@#$^*”)

User Sage Company

By default, SDE retrieves and posts data from the Sage Company Code in Setup Maintenance. Override that setting by entering a User Sage Company. (Note: The final authority would be a Sage Company Code added to the XML or JSON post.)

User Type

This will determine the type of user that is accessing the SDE API. There are three types of Users; Administrator, Customer, and Vendor. Based on the type of user, access to the Sage 100 data can be restricted.

Administrator

If Administrator is selected, then access to all records through the SDE API are available.

Customer

When Customer is selected, new fields will display prompting for the Division Number and the Customer Number. This restricts all data from Sage 100 to only return that of which is related Division and Customer Number shown.

Customer
The Division and Customer number in Sage 100 that is linked to the user. This restricts data to only return this customer's data. Click on the magnify glass to lookup the list of customers.

Contact
The Customer specific contact. Entering a contact here is for informational purpose only and doesn't restrict any data. This is used to link a contact in the system with one that is outside of the system. Click on the magnify glass to lookup the list of contacts related to the customer.

Vendor

When Vendor is selected, new fields will display prompting for the Division Number and the Vendor Number. This restricts all data from Sage 100 to only return that of which is related to the Division and Vendor Number shown.

Vendor
The Division and Vendor Number in Sage 100 that is linked to the user. This restricts data to only return this vendor's data. Click on the magnify glass to lookup the list of vendors.

Status

Used to determine if the user is Active or Inactive. Active users can use the SDE PI. Users that are Inactive are not allowed access to SDE but will remain in the system as a user.