Adding a Connection to GMO MakeShop

To add a connection to GMO MakeShop:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the GMO MakeShop icon is not available, click the Add More icon to download and install the GMO MakeShop connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to GMO MakeShop

When using the CData Sync App to connect to GMO MakeShop, MembersAccessCode, OrdersAccessCode, ProductsAccessCode, and ShopId are required.

Configuring Access to GMO MakeShop

GMO MakeShop requires AccessCode for each API. To obtain MembersAccessCode, OrdersAccessCode, ProductsAccessCode, and ShopId, follow the steps below:

• Log in to the GMO MakeShop Store Manager and click Create Shop.
• Click any target connection setting from External System Connection in the left-hand navigation menu. If you cannot find it in the menu, please contact GMO Makeshop.
• Product Data Connection Settings: Click Issue to retrieve the authentication code and ProductsAccessCode.
• Order Data Connection Settings: First select Get Order Information > Change Order Information settings. Then click Issue to retrieve the authentication code and OrdersAccessCode.
• Members Data Connection Settings: Select Get/Post/Update/Delete Members Information settings. Then click Issue to retrieve the authentication code and MembersAccessCode.
• Members Authentication Connection Settings: Click Issue to retrieve the authentication code and ProductsAccessCode.

Authenticating to GMO MakeShop Account

Set the following connection properties to connect:

• ShopId: Set the GMO MakeShop Store ID of the connection destination. The GMO MakeShop Store ID is the same as the ID for login.
• OrdersAccessCode: Set the orders access code retrieved from Order Data Connection Settings. This property is required to access the Orders table.
• ProductsAccessCode: Set the products access code retrieved from Product Data Connection Settings. This property is required to access the Products table.
• MembersAccessCode: Set the members access code retrieved from Members Data Connection Settings. This property is required to access the Members table.
• MemberAuthenticationCode: Set the member authentication code retrieved from Members Authentication Connection Settings. This property is required to execute MemberAuthenticationConfirm.
• Password: Specify the password for the GMO MakeShop Store Manager login user. This property is required to execute ProductCategoryRegistrationOrModification, ProductMemberGroupPriceRegistrationOrModification, ProductOptionRegistrationOrModification, and ProductRegistrationOrModification.

This section details a selection of advanced features of the GMO MakeShop Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to GMO MakeShop and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models GMO MakeShop objects as relational tables and views. The information that comes from the server is URL encoded. We have a hidden connection property 'DecodeValues' which defaults to true and exposes decoded data. To display raw encoded data, set this to false inside the Other connection property. A GMO MakeShop object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to GMO MakeShop APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

The Sync App models the data in GMO MakeShop as a list of tables in a relational database that can be queried using standard SQL statements.

GMO MakeShop Connector for CData Sync Tables

Name	Description
Members	Retrieve and query information related to members.

Retrieve and query information related to members.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• MemberId, MemberNameKana columns support the = operator.
• JoinDate column supports the >,>=,=,<=,< operators.
• GetDeleted pseudo-column supports the = operator.

Ordering is supported for JoinDate. For example, the following queries are processed server side:

SELECT * FROM Members WHERE MemberId = 'MemberIdHere' AND JoinDate >= '2018-09-04 22:54:43+01:00' AND JoinDate <= '2018-09-04 23:54:43+01:00' ORDER BY JoinDate ASC

SELECT * FROM Members WHERE MemberNameKana = 'Firstname Lastname' AND JoinDate > '2018-09-04 22:54:43+01:00' AND JoinDate < '2018-09-04 23:54:43+01:00'  ORDER BY JoinDate DESC

SELECT * FROM Members WHERE JoinDate = '2018-09-04 23:54:43+01:00' AND GetDeleted = '1' 

Insert

All columns except JoinDate can be specified. MemberId, MemberName, MemberNameKana, Email, MemberPassword, HomePost, HomePrefecture, HomePrefectureCode, HomeAddress1, HomePhone are required for an insert.

INSERT INTO Members (MEmberId, MemberName, MemberNameKana, Email, MemberPassword, HomePost, HomePrefecture, HomePrefectureCode, HomeAddress1, HomePhone) VALUES ('mymemberid', 'the name', 'Firstname Lastname', '[email protected]', 'Passw0rd', '1508512', 'Prefecture', '13', 'Address here', '453-345') 

Update

All columns except JoinDate can be updated. MemberId is required in the criteria for an update.

UPDATE Members SET MemberName = 'updName' WHERE MemberId = 'MemberIdHere'  

Delete

A member can be deleted by specifying MemberId.

DELETE FROM Members WHERE MemberId = 'MemberIdHere'  

Columns

Name	Type	ReadOnly	Description
MemberId [KEY]	String	False	Member ID.
MemberName	String	False	Member name.
MemberNameKana	String	False	Member name phonetic.
JoinDate	Date	True	Date of registration.
GroupId	Integer	False	Member group ID.
GroupName	String	False	Member group name.
Email	String	False	Member email address.
MemberPassword	String	False	Member password - specified on an Insert.
EmailMagazineReceive	String	False	Indicator whether to receive mail magazine - Y: Wish to distribute e-mail newsletter, N: I do not wish to deliver e-mail newsletters. The allowed values are Y, N.
Sex	Integer	False	Member gender - 0: Male 1: Female. The allowed values are 0, 1.
Birthday	Date	False	Member birthday.
MemberPoint	Integer	False	Store shop points owned by members.
MemberPointExpireDate	Date	False	Owned shop point expiration date.
RecommendMemberId	String	False	Store introducer's member ID.
HomePost	String	False	Home zip code.
HomePrefectureCode	String	False	Home prefecture code.
HomePrefecture	String	False	Home prefecture name.
HomeAddress1	String	False	Home address.
HomeAddress2	String	False	Other address.
HomePhone	String	False	Home phone number.
HomeFax	String	False	Home fax number.
MobilePhone	String	False	Mobile phone number.
MobileEmail	String	False	Mobile email address.
OfficeName	String	False	Company name.
OfficeNameKana	String	False	Company name phonetic.
OfficeDepartment	String	False	Company department.
OfficePost	String	False	Company zip code.
OfficePrefectureCode	String	False	Company prefecture code.
OfficePrefecture	String	False	Company prefecture name.
OfficeAddress	String	False	Company address.
OfficePhone	String	False	Company phone number.
AdditionalOption1	String	False	Additional input item 1.
AdditionalOption2	String	False	Additional input item 2.
AdditionalOption3	String	False	Additional input item 3.
AdditionalOption4	String	False	Additional input item 4.
AdditionalOption5	String	False	Additional input item 5.
AdditionalOption6	String	False	Additional input item 6.
AdditionalOption7	String	False	Additional input item 7.
LoginEmail	String	False	Mail address authentication setting - Y: allow member login with e-mail address N: do not allow member login with e-mail address.
Memo	String	False	Member information memo. The allowed values are Y, N.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
GetDeleted	Integer	Specify this as 1 to acquire deleted members. Defaults to 0 and deleted members will not be retrieved. The allowed values are 0, 1.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

GMO MakeShop Connector for CData Sync Views

Name	Description
OrderDeliveries	Returns data regarding shipping destinations.
OrderDeliveryCarriages	Returns data regarding delivery carriage.
OrderDeliveryLineItems	Returns data regarding order delivery specific items.
OrderDeliveryNotes	Returns data regarding order delivery notes.
OrderLineItems	Returns data regarding order details.
OrderNotes	Returns data regarding order notes.
Orders	Returns information regarding orders.
ProductCategories	Returns information regarding categories for the products.
ProductMemberGroupPrices	Returns information regarding prices by member groups.
ProductNameOptionGroups	Returns information related to product naming option groups and items.
ProductOptionGroupItems	Returns data related to option groups and their items.
ProductOptionItems	Returns data related to item selection options for product.
Products	Returns information related to products.
ProductSelectOptions	Returns data related to option selections.

Returns data regarding shipping destinations.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderDeliveries WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveries WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveries WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
DeliveryId [KEY]	Integer	Id of the order delivery.
DeliveryNumber	String	Shipping slip number.
DeliveryOrder	Integer	Shipping instructions - 0: not instructed, 1: shipping instructed, 2: shipping preparation in progress
Status	Integer	Status of the order delivery.
OfficeName	String	Destination company name.
OfficeNameKana	String	Destination company name phonetic.
Department	String	Destination department name.
Name	String	Destination name.
NameKana	String	Destination name phonetic.
PhoneNumber	String	Destination phone number.
Zip	String	Destination postal code.
Area	String	Destination prefecture.
Address	String	Destination street address.
DeliveryDate	Date	Desired delivery day.
DeliveryTime	String	Desired delivery time.
ScheduledShippingDate	Date	Estimated shipping date.
ShippingDate	Datetime	Delivery completion date and time.
Carrier	String	Delivery trader code.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Canceled	Integer	Specify this as 1 to acquire canceled orders. Defaults to 0 and canceled orders will not be retrieved. The allowed values are 0, 1.

Returns data regarding delivery carriage.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderDeliveryCarriages WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryCarriages WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryCarriages WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
DeliveryId [KEY]	Integer	Id of the order delivery.
Date	Datetime	Order date.
CarriageName [KEY]	String	Shipping method name.
CarriagePrice	Integer	Shipping method price.
CarriageCost	Integer	Shipping fee.
CarriageDetail	String	Shipping details.
CarriageCommodityBrandCode	String	Commodity brandcode.
CarriageCommodityName	String	Commodity name.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Canceled	Integer	Specify this as 1 to acquire cancelled orders. Defaults to 0 and cancelled orders will not be retrieved. The allowed values are 0, 1.

Returns data regarding order delivery specific items.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderDeliveryLineItems WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryLineItems WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryLineItems WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
DeliveryId [KEY]	Integer	Id of the order delivery.
BrandCode [KEY]	String	System product code.
OriginalCode	String	Original product code.
Name	String	Product name.
Price	Integer	Selling price.
Point	Integer	Product points.
Amount	Integer	Order quantity.
ConsumptionTaxRate	Integer	Sales tax rate.
Option	String	Product option names.
OriginalOptionCode	String	Original option code.
NameOptions	String	Original option code.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Canceled	Integer	Specify this as 1 to acquire cancelled orders. Defaults to 0 and cancelled orders will not be retrieved. The allowed values are 0, 1.

Returns data regarding order delivery notes.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderDeliveryNotes WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryNotes WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryNotes WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
DeliveryId [KEY]	Integer	Delivery ID.
NoteNumber [KEY]	String	Delivery note number.
NoteTitle	String	Delivery note title.
NoteValue	String	Delivery note.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Canceled	Integer	Specify this as 1 to acquire canceled orders. Defaults to 0 and canceled orders will not be retrieved. The allowed values are 0, 1.

Returns data regarding order details.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderLineItems WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderLineItems WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderLineItems WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
BrandCode [KEY]	String	System product code.
OriginalCode	String	Original product code.
Name	String	Product name.
JanCode	String	JAN code.
DiscountRate	Integer	Discount percentage.
Price	Integer	Product price.
ShopPoints	Integer	Shop use points.
GMOPoints	Integer	GMO use points.
YahooPoints	Integer	Yahoo use points.
Amount	Integer	Order quantity.
ConsumptionTaxRate	Integer	Sales tax rate.
Option	String	Product option names.
OriginalOptionCode	String	Original option code.
NameOptions	String	Item name options.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Canceled	Integer	Specify this as 1 to acquire cancelled orders. Defaults to 0 and cancelled orders will not be retrieved. The allowed values are 0, 1.

Returns data regarding order notes.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderNotes WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderNotes WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderNotes WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
NoteNumber [KEY]	String	Order note number.
NoteTitle	String	Order note title.
NoteValue	String	Order note.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Canceled	Integer	Specify this as 1 to acquire canceled orders. Defaults to 0 and canceled orders will not be retrieved. The allowed values are 0, 1.

Returns information regarding orders.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM Orders WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM Orders WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM Orders WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
Status	Integer	Order status - 0: Canceled 1: Normal 99: Temporary order.
RepeatSaleCount	Integer	Number of subscriptions.
PaymentMethod	String	Payment method.
PaymentMethodType	String	Payment method type.
PaymentStatus	Integer	Deposit status - 0: Not received 1: Deposit complete.
OrderMemo	String	Notes in detailed order information
DetailTotalPrice	Integer	Total order price.
DetailPricePerTaxRate8	Integer	Total price of 8% tax rate.
DetailPricePerTaxRate10	Integer	Total price of 10% tax rate.
DetailCommission	Integer	Settlement fee.
DetailCommissionName	String	Settlement name fee.
DetailPoint	Integer	Order points. Displayed when the point grant (rate and amount) is set in the member group setting.
DetailDiscountPrice	Integer	Discount price. Displayed when the point grant (rate and amount) is set in the member group setting..
DetailCorrection	Integer	Amendment amount.
DetailCarriage	Integer	Shipping cost.
DetailCouponName	String	Coupon name.
DetailCouponCode	String	Coupon code.
DetailCouponDiscount	Integer	Coupon Discount Amount.
DetailBulkDiscount	Integer	Bulk Discount Amount.
ShopPoints	Integer	Shop use points.
GMOPoints	Integer	GMO use points.
YahooPoints	Integer	Yahoo use points.
BuyerId	String	Buyer ID.
BuyerOfficeName	String	Buyer company name.
BuyerOfficeNameKana	String	Buyer company name phonetic.
BuyerDepartment	String	Buyer department name.
BuyerName	String	Buyer name.
BuyerNameKana	String	Buyer name phonetic.
BuyerPhoneNumber	String	Buyer phone number.
BuyerPhoneNumber2	String	Second buyer phone number.
BuyerEmail	String	Buyer email address.
BuyerZip	String	Buyer postal code.
BuyerAddress	String	Buyer street address.
BuyerMembergroupid	Integer	Buyer member group code.
BuyerMembergroupname	String	Buyer member group name.
CombinedPaymethodType	String	Combined payment method.
CombinedPaymethod	String	Combined payment method type.
CombinedPrice	Integer	Combined payment price.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Canceled	Integer	Specify this as 1 to acquire canceled orders. Defaults to 0 and canceled orders will not be retrieved. The allowed values are 0, 1.

Returns information regarding categories for the products.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductCategories WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
CategoryCode [KEY]	String	Category Code.
CategoryPath	String	Category Path.

Returns information regarding prices by member groups.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductMemberGroupPrices WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
GroupId [KEY]	Integer	Member group ID.
GroupName	String	Member group name.
Price	Integer	Price by member group.
Point	Integer	Points by member group.
PointType	Integer	Point type - 0: Absolute value of point 1: Rate according to price.

Returns information related to product naming option groups and items.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductNameOptionGroups WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
NameOptionGroupId	Integer	Insert name group ID.
NameOptionGroupLabel	String	Insert name group name.
NameOptionGroupDescription	String	Insert name group description.
ItemId [KEY]	Integer	Item ID.
AdminItemName	String	Administrator item name.
DisplayItemName	String	Display item name.
IsRequired	String	Selection requirement - Y: Required input N: Optional input.
IsAlphabet	String	Alphabetical validation - Y: Can be input N: Can not be input.
IsNumber	String	Numerical validation - Y: Can be input N: Can not be input.
IsSymbol	String	Symbols
IsDoubleByte	String	Double byte character validation - Y: Can be input N: Can not be input.
RowMaxlength	Integer	Number of characters per line.
MaxRow	Integer	Number of lines.
MaxLength	Integer	Maximum number of characters.

Returns data related to option groups and their items.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductOptionGroupItems WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
GroupCode	String	Group code.
GroupName	String	Group name.
OptionId [KEY]	Integer	Option ID.
OptionName	String	Option name.
IsRequired	String	Indicates if the option is required - Y: Required input N: Optional input.
ItemId [KEY]	Integer	Item ID.
ItemName	String	Item name.
PriceType	Integer	Item price type - 0: Designate by amount 1: Specify at rate according to selling price.
ItemPrice	Integer	Item price.
Default	String	Indicator if item is initial selection - Y: Selected in initial display N: Not selected in initial display.

Returns data related to item selection options for product.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductOptionItems WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
OptionNumber	String	Option item number (Option item 1 or 2).
ItemId [KEY]	Integer	Selection item ID.
ItemName	String	Selection item name.
Default	String	Indicator if option item is initial selection - Y: Selected in initial display N: Not selected in initial display.

Returns information related to products.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• BrandCode, UbrandCode columns support the = operator.
• ModifiedDate column supports the >,>=,=,<=,< operators.
• CategoryCode pseudo-column supports the = operator.

Ordering is supported for one of CreatedDate, ModifiedDate, ProductName, Price. For example, the following queries are processed server side:

SELECT * FROM Products WHERE BrandCode = 'CD12345' AND ModifiedDate >= '2018-09-04 22:54:43+01:00' AND ModifiedDate <= '2018-09-04 23:54:43+01:00' ORDER BY CreatedDate ASC

SELECT * FROM Products WHERE UbrandCode = 'CD0012345' AND ModifiedDate > '2018-09-04 22:54:43+01:00' AND ModifiedDate < '2018-09-04 23:54:43+01:00' ORDER BY ProductName ASC

SELECT * FROM Products WHERE ModifiedDate = '2018-09-04 23:54:43+01:00' AND CategoryCode = 'CT001' ORDER BY Price DESC

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
UbrandCode	String	Original product code.
CreatedDate	Datetime	Date and time information of product registration.
ModifiedDate	Datetime	Date and time information of product last modification.
IsDisplayed	String	Product display availability - Y: Displayed N: Not displayed.
IsMemberOnly	String	Members only setting.Y: This is a member exclusive product N: Not a member exclusive product
IsReducedTaxRateBrand	Boolean	Boolean displaying if the brand is eligible for reduced tax rate
DisplayableMemberGroups	String	Displayable member group names. List seperated by pipeline.
BasicCategoryCode	String	Code of the lowest hierarchical node of the basic category.
BasicCategoryPath	String	Path of the lowest hierarchical node of the basic category.
ProductID	Integer	Product ID.
ProductName	String	Product name.
Weight	Integer	Product weight.
Price	Integer	Selling price.
ConsumptionTaxRate	Integer	Sales tax rate.
GroupId	Integer	.
GroupName	String	.
Point	String	Product points.
PointType	Integer	Point type - 0: Absolute value of point 1: Rate with respect to price.
FixedPrice	Integer	List price.
PurchasePrice	Integer	Purchase price.
JANcode	String	JAN code of the product.
Vendor	String	Product manufacturer.
Origin	String	Place of origin.
IsDisplayOrigin	Integer	Place of origin display flag - 0: Show Origin 1: Do not. The allowed values are 0, 1.
Stock	Integer	Product quantity.
IsDiplayStock	Integer	Quantity display flag - 0: Do not display stock number 1: Display stock number. The allowed values are 0, 1.
MinimumQuantity	Integer	Minimum order limit.
MaximumQuantity	Integer	Maximum order limit.
Collections	Integer	Display position - 0: New item 1: Special item 2: Recommended 3: Category Recommended items.
IndividualShipping	Long	Individual postage setting.
IsPublishDateFrom	Integer	Posting date designation flag - 0: Do not set posting start date 1: Set posting start date. The allowed values are 0, 1.
PublishDateFrom	Datetime	Posting start date.
IsPublishDateTo	Integer	Posting end date designation flag - 0: Do not set the posting end date 1: Set posting end date. The allowed values are 0, 1.
PublishDateTo	Datetime	Posting end date.
IsDiscountRate	Integer	Discount use flag - 0: Enable discount 1: Disable discount.
DiscountRate	Integer	Discount rate percentage.
DiscountTerm	String	Discount period interval dates.
ItemGroup	String	Product group.
SearchKeyword	String	Product search term.
Note	String	Product specific display note.
OptionName1	String	First name of the lowest product option.
OptionName2	String	Second name of the lowest product option..
OptionGroupCode	String	Option group code of the lowest set product.
OptionGroupName	String	Option group name of the lowest set product.
NameOptionGroupId	String	Insert name group ID of the lowest set name insertion group.
NameOptionGroupLabel	String	Insert name group label of the lowest set name insertion group.
NameOptionGroupDescription	String	Insert name group description of the lowest set name insertion group..
ProductPageUrl	String	Product details page URL .
ZoomImageUrl	String	URL of enlarged image. Multiple product images are not displayed.
ImageUrl	String	Regular image URL. Multiple product images are not displayed.
ThumbnailImageUrl	String	URL of thumbnail image .
MobileImageUrl	String	Mobile image URL.
SubImage1Url	String	URL of additional product image 1.
IsDisplayMobileSubImage1	Integer	Additional product image mobile display - 0: Display additional product image 1 on mobile, 1: Do not display.
SubImage1Content	String	Product image 1 description.
SubImage2Url	String	URL of additional product image 2.
IsDisplayMobileSubImage2	Integer	Additional product image mobile display - 0: Display additional product image 2 on mobile, 1: Do not display..
SubImage2Content	String	Product image 2 description.
SubImage3Url	String	URL of additional product image 3.
IsDisplayMobileSubImage3	Integer	Additional product image mobile display - 0: Display additional product image 3 on mobile, 1: Do not display..
SubImage3Content	String	Product image 3 description.
SubImageLayout	String	Layout specification - A/B/C/D.
MainContent	String	Main product description for PC.
MainContent2	String	Additional description for PC.
MobileContent	String	Mobile item description.
SmartphoneContent1	String	First product description for smartphones.
SmartphoneContent2	String	Second product description for smartphones.
IsDisplayMobileContent	String	Mobile display of first description on smartphone product - Y: Display explanatory text N: Do not display explanatory text.
ProductListContent	String	Product description for product category.
IsDisplayProductListContent	String	Possibility to display product description for product category - Y: Display explanatory text N: Do not display explanatory text.
OrderPageNote	String	Settlement screen remarks .
IsRestockNotification	String	Stock notice - Y: Restocked Notification N: Not Receiving Notification.
GoogleShoppingCondition	String	Google shopping product status flag - New/Second hand/Refurbished.
GoogleShoppingTitle	String	Google shopping product name.
GoogleShoppingDescription	String	Google shopping product details.
GoogleShoppingOptionLayoutType	String	Google shopping product option display format.
GoogleShoppingIsbnCode	String	Google shopping product ISBN code.
GoogleShoppingBrand	String	Google shopping product brand name.
GoogleShoppingMnp	String	Google shopping product manufacturer model number.
GoogleShoppingGoogleProductCategory	String	Google shopping product google category.
GoogleShoppingGender	Integer	Google shopping product gender - 1: Male 2: Female 3: Unisex.
GoogleShoppingAgeGroup	Integer	Google shopping product age group - 1: Adult 2: Child.
GoogleShoppingColor	String	Google shopping product color.
GoogleShoppingSize	String	Google shopping product size.
GoogleShoppingMaterial	String	Google shopping product material.
GoogleShoppingPattern	String	Google shopping product pattern.
GoogleShoppingItemGroupId	String	Google shopping product group ID.
GoogleShoppingAdwordsGrouping	String	Google shopping product adwords group.
GoogleShoppingAdwordsLabels	String	Google shopping product adwords label.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CategoryCode	String	Products in exactly matched categories are displayed as search results.

Returns data related to option selections.

Select

The Sync App will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductSelectOptions WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
OptionId [KEY]	String	Option id. [Option 1 node option ID]_[Option 2 node option ID].
OptionUbrandCode	String	Option-specific code.
OptionPrice	Integer	Option-specific price.
OptionStock	Integer	Option stock quantity.
OptionJanCode	String	Option JAN code.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
ShopId	Store account ID of your GMOMakeShop store.
OrdersAccessCode	Access code you get from your GMOMakeShop store account to access the Orders API.
ProductsAccessCode	Access code you get from your GMOMakeShop store account to access the Products API.
Password	Password of the currently authenticated user.
MembersAccessCode	Access code you get from your GMOMakeShop store account to access the Members API.
MemberAuthenticationCode	Authentication code you get from your GMOMakeShop store account to access the MemberAuthenticationConfirm stored procedure.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
ShopId	Store account ID of your GMOMakeShop store.
OrdersAccessCode	Access code you get from your GMOMakeShop store account to access the Orders API.
ProductsAccessCode	Access code you get from your GMOMakeShop store account to access the Products API.
Password	Password of the currently authenticated user.
MembersAccessCode	Access code you get from your GMOMakeShop store account to access the Members API.
MemberAuthenticationCode	Authentication code you get from your GMOMakeShop store account to access the MemberAuthenticationConfirm stored procedure.

Store account ID of your GMOMakeShop store.

Remarks

Store account ID of your GMOMakeShop store.

Access code you get from your GMOMakeShop store account to access the Orders API.

Remarks

Access code you get from your GMOMakeShop store account to access the Orders API.

Access code you get from your GMOMakeShop store account to access the Products API.

Remarks

Access code you get from your GMOMakeShop store account to access the Products API.

Password of the currently authenticated user.

Remarks

Password of the currently authenticated user. This property is required to execute product stored procedures.

Access code you get from your GMOMakeShop store account to access the Members API.

Remarks

Access code you get from your GMOMakeShop store account to access the Members API.

Authentication code you get from your GMOMakeShop store account to access the MemberAuthenticationConfirm stored procedure.

Remarks

Authentication code you get from your GMOMakeShop store account to access the MemberAuthenticationConfirm stored procedure.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to GMO MakeShop and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\GMOMakeShop Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Members WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.