Web Service Security (Window ID-53068)
Window: Web Service Security
Description:
Help:
Tab: Web Service Type
Description:
Help:
.png)
| Name | Description | Help | Technical Data |
|---|---|---|---|
| Tenant | Tenant for this installation. | A Tenant is a company or a legal entity. You cannot share data between Tenants. | WS_WebServiceType.AD_Client_ID numeric(10) Table Direct |
| Organization | Organizational entity within tenant | An organization is a unit of your tenant or legal entity - examples are store, department. You can share data between organizations. | WS_WebServiceType.AD_Org_ID numeric(10) Table Direct |
| Search Key | Search key for the record in the format required - must be unique | A search key allows you a fast method of finding a particular record.
If you leave the search key empty, the system automatically creates a numeric number. The document sequence used for this fallback number is defined in the "Maintain Sequence" window with the name "DocumentNo_<TableName>", where TableName is the actual name of the table (e.g. C_Order). |
WS_WebServiceType.Value character varying(40) String |
| Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
WS_WebServiceType.IsActive character(1) Yes-No |
| Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | WS_WebServiceType.Name character varying(60) String |
| Web Service | WS_WebServiceType.WS_WebService_ID numeric(10) Table Direct | ||
| Web Service Method | WS_WebServiceType.WS_WebServiceMethod_ID numeric(10) Table Direct | ||
| Table | Database Table information | The Database Table provides the information of the table definition | WS_WebServiceType.AD_Table_ID numeric(10) Table Direct |
| Description | Optional short description of the record | A description is limited to 255 characters. | WS_WebServiceType.Description character varying(255) String |
| Comment/Help | Comment or Hint | The Help field contains a hint, comment or help about the use of this item. | WS_WebServiceType.Help character varying(2000) Text |
| Create Default Parameters | This process will add required parameters for current web service type | WS_WebServiceType.InsertParameters character(1) Button |
Tab: Web Service Parameters
Description:
Help:
.png)
| Name | Description | Help | Technical Data |
|---|---|---|---|
| Tenant | Tenant for this installation. | A Tenant is a company or a legal entity. You cannot share data between Tenants. | WS_WebService_Para.AD_Client_ID numeric(10) Table Direct |
| Organization | Organizational entity within tenant | An organization is a unit of your tenant or legal entity - examples are store, department. You can share data between organizations. | WS_WebService_Para.AD_Org_ID numeric(10) Table Direct |
| Web Service Type | WS_WebService_Para.WS_WebServiceType_ID numeric(10) Table Direct | ||
| Parameter Name | WS_WebService_Para.ParameterName character varying(60) String | ||
| Parameter Type | WS_WebService_Para.ParameterType character(1) List | ||
| Constant Value | Constant value | WS_WebService_Para.ConstantValue character varying(2000) String | |
| Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
WS_WebService_Para.IsActive character(1) Yes-No |
Tab: Web Service Field Input
Description:
Help:
.png)
| Name | Description | Help | Technical Data |
|---|---|---|---|
| Tenant | Tenant for this installation. | A Tenant is a company or a legal entity. You cannot share data between Tenants. | WS_WebServiceFieldInput.AD_Client_ID numeric(10) Table Direct |
| Organization | Organizational entity within tenant | An organization is a unit of your tenant or legal entity - examples are store, department. You can share data between organizations. | WS_WebServiceFieldInput.AD_Org_ID numeric(10) Table Direct |
| Web Service Type | WS_WebServiceFieldInput.WS_WebServiceType_ID numeric(10) Table Direct | ||
| Column | Column in the table | Link to the database column of the table | WS_WebServiceFieldInput.AD_Column_ID numeric(10) Table Direct |
| DB Column Name | Name of the column in the database | The Column Name indicates the name of a column on a table as defined in the database. | WS_WebServiceFieldInput.ColumnName character varying(30) String |
| Reference | System Reference and Validation | The Reference could be a display type, list or table validation. | WS_WebServiceFieldInput.AD_Reference_ID numeric(10) Table |
| Reference Key | Required to specify, if data type is Table or List | The Reference Value indicates where the reference values are stored. It must be specified if the data type is Table or List. | WS_WebServiceFieldInput.AD_Reference_Value_ID numeric(10) Table |
| Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
WS_WebServiceFieldInput.IsActive character(1) Yes-No |
| Identifier | This column is part of the record identifier | The Identifier checkbox indicates that this column is part of the identifier or key for this table. | WS_WebServiceFieldInput.IsIdentifier character(1) Yes-No |
| Allow Null Value | Should allow null value for identifier field | WS_WebServiceFieldInput.IsNullIdentifier character(1) Yes-No | |
| Identifier Logic | WS_WebServiceFieldInput.IdentifierLogic character varying(2000) Text |
Tab: Web Service Field Output
Description:
Help:
.png)
| Name | Description | Help | Technical Data |
|---|---|---|---|
| Tenant | Tenant for this installation. | A Tenant is a company or a legal entity. You cannot share data between Tenants. | WS_WebServiceFieldOutput.AD_Client_ID numeric(10) Table Direct |
| Organization | Organizational entity within tenant | An organization is a unit of your tenant or legal entity - examples are store, department. You can share data between organizations. | WS_WebServiceFieldOutput.AD_Org_ID numeric(10) Table Direct |
| Web Service Type | WS_WebServiceFieldOutput.WS_WebServiceType_ID numeric(10) Table Direct | ||
| Column | Column in the table | Link to the database column of the table | WS_WebServiceFieldOutput.AD_Column_ID numeric(10) Table Direct |
| Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
WS_WebServiceFieldOutput.IsActive character(1) Yes-No |
Tab: Web Service Access
Description:
Help:
.png)
| Name | Description | Help | Technical Data |
|---|---|---|---|
| Tenant | Tenant for this installation. | A Tenant is a company or a legal entity. You cannot share data between Tenants. | WS_WebServiceTypeAccess.AD_Client_ID numeric(10) Table Direct |
| Organization | Organizational entity within tenant | An organization is a unit of your tenant or legal entity - examples are store, department. You can share data between organizations. | WS_WebServiceTypeAccess.AD_Org_ID numeric(10) Table Direct |
| Web Service Type | WS_WebServiceTypeAccess.WS_WebServiceType_ID numeric(10) Table Direct | ||
| Role | Responsibility Role | The Role determines security and access a user who has this Role will have in the System. | WS_WebServiceTypeAccess.AD_Role_ID numeric(10) Table |
| Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
WS_WebServiceTypeAccess.IsActive character(1) Yes-No |
Contributions / Posts
Process to generate default parameters
Adding parameters is a repetitive task, values can be guessed from the WS method ; see Web Services Security/How to get default parameters ?.
