Sincronización del servicio de organización
El servicio de sincronización de organización es un servicio web de entrada responsable de añadir o actualizar una organización en HCL Commerce para sincronizar HCL Commerce con el depósito maestro externo.
Casos de uso típico
- Creación o actualización de una organización
- Creación o actualización de una dirección para una organización
URL de punto final y operación
El URL de punto final predeterminado de este servicio web de entrada es https://hostname:8000/webapp/wcs/services/MemberServices. La operación del servicio es SyncOrganization, con BOD SyncOrganization como petición y BOD ConfirmBOD como respuesta.
Solicitud
Las peticiones de este servicio web de entrada están en formato de BOD SyncOrganization. Hay dos tipos de peticiones que se pueden realizar:
- Añadir o actualizar una organización
- Añadir o actualizar una dirección de una organización
Adición o actualización de una organización
Las peticiones para añadir o actualizar se correlacionan con com.ibm.commerce.usermanagement.commands.OrgEntityAddCmd y com.ibm.commerce.usermanagement.commands.OrgEntityUpdateCmd. Las peticiones deben contener la siguiente información:
| XPath* | Tipo | Se correlaciona con el siguiente parámetro de mandato | Descripción: | Obligatorio |
|---|---|---|---|---|
| ApplicationArea/BusinessContext/ContextData | USERDATA | - | Datos de contexto. Por ejemplo:
| N |
| DataArea/Sync/ActionCriteria/ActionExpression/@actionCode | string | action | El código de acción. Los valores válidos son los siguientes:
|
Y |
| DataArea/Sync/ActionCriteria/ActionExpression | string | commerceObject | Expresión de acción. Se debe especificar de la forma indicada a continuación:
| Y |
| DataArea/Organization/OrganizationIdentifier/DistinguishedName | string | distinguishedName | Nombre distinguido de la organización. | Y - al actualizar una organización N - al añadir una organización |
| DataArea/Organization/ParentIdentifier/DistinguishedName | string | parentDN | Nombre distinguido de la organización padre. | Y - al añadir una organización y OrganizationType es igual a 'OU'. Cuando OrganizationType =O, este parámetro no es obligatorio; por omisión, toma el valor de la Organización raíz. Este parámetro solo se aplica cuando se añade una organización. |
| DataArea/Organization/OrganizationName | string | orgEntityName | Nombre abreviado para la organización (O) o la unidad organizativa (OU). | Y - al añadir una organización N - al actualizar una organización |
| DataArea/Organization/OrganizationType | string | orgEntityType | Tipo de entidad de organización . Los valores válidos son los siguientes: O: OU de organización: unidad de organización | Y - al añadir una organización. Este parámetro solo se aplica cuando se añade una organización. |
| DataArea/Organization/BusinessCategory | string | businessCategory | La categoría de negocio, que describe el negocio de la entidad de organización (OrgEntity). | N |
| DataArea/Organization/Description | string | description | Una descripción de la entidad de organización. | N |
| DataArea/Organization/ContactInfo/Telephone[1] | string | phone1 | El número de teléfono primario de la organización. | N |
| DataArea/Organization/ContactInfo/Telephone[1]/@type | string | phone1Type | El tipo de teléfono que se utiliza para el número de teléfono primario de la organización. Por ejemplo, TTY para personas con problemas de audición, PCM para modulación por pulsos codificados o CEL para teléfono móvil. Este valor es un campo de 3 caracteres. | N |
| DataArea/Organization/ContactInfo/Telephone[1]/@publish | string | publishPhone1 | Especifica si el número de teléfono primario aparece en la lista. | N |
| DataArea/Organization/ContactInfo/Telephone[2] | string | phone2 | El número de teléfono secundario de la organización. | N |
| DataArea/Organization/ContactInfo/Telephone[2]/@type | string | phone2Type | El tipo de teléfono que se utiliza para el número de teléfono secundario de la organización. Por ejemplo, TTY para personas con problemas de audición, PCM para modulación por pulsos codificados o CEL para teléfono móvil. Este valor es un campo de 3 caracteres. | N |
| DataArea/Organization/ContactInfo/Telephone[2]/@publish | string | publishPhone2 | Especifica si el número de teléfono primario aparece en la lista. | N |
| DataArea/Organization/ContactInfo/Email[1] | string | email1 | Dirección de correo electrónico primaria de la organización. | N |
| DataArea/Organization/ContactInfo/Email[2] | string | email2 | Dirección de correo electrónico secundaria de la organización. | N |
| DataArea/Organization/ContactInfo/Fax[1] | string | fax1 | Número de fax primario de la organización. | N |
| DataArea/Organization/ContactInfo/Fax[2] | string | fax2 | Número de fax secundario de la organización. | N |
| DataArea/Organization/ContactInfo/Address/@type | string | addressType | La finalidad de la dirección. Los valores válidos son:
| N |
| DataArea/Organization/ContactInfo/Address/City | string | city | La ciudad. | N |
| DataArea/Organization/ContactInfo/Address/StateOrProvinceName | string | state | Estado o provincia. | N |
| DataArea/Organization/ContactInfo/Address/Country | string | country | País o región. | N |
| DataArea/Organization/ContactInfo/Address/PostalCode | string | zipCode | Código postal o ZIP. | N |
| DataArea/Organization/ContactInfo/Address/AddressLine[1] | string | address1 | Primera línea de la dirección. | N |
| DataArea/Organization/ContactInfo/Address/AddressLine[2] | string | address2 | Segunda línea de la dirección. | N |
| DataArea/Organization/ContactInfo/Address/AddressLine[3] | string | address3 | Tercera línea de la dirección. | N |
| DataArea/Organization/ContactInfo/Address/UserData/UserDataField | USERDATA | - | Se utiliza para pasar más parámetros al mandato de destino. | N |
| DataArea/Organization/ContactInfo/UserData/UserDataField | USERDATA | - | Se utiliza para pasar más parámetros al mandato de destino. | N |
| DataArea/Organization/ContextAttribute[j]/Name | string | attributeName parte de la especificación de atributos de miembro personalizado siguiente: &attributeName_storeId_r_n=value | Nombre de un atributo personalizable. | N |
| DataArea/Organization/ContextAttribute/AttributeValue[k]/Value[n] | string | value parte de la especificación de atributos de miembro personalizado siguiente: &attributeName_storeId_r_n=value | Valor del atributo personalizable. | N |
| DataArea/Organization/ContextAttribute/AttributeValue[k]/StoreID | string | storeId parte de la especificación de atributos de miembro personalizado siguiente: &attributeName_storeId_r_n=value | ID de tienda donde se aplica el valor de atributo. Si no se especifica, el valor se aplica en todas las tiendas. | N |
| DataArea/Organization/UserData/UserDataField | USERDATA | - | Se utiliza para pasar más parámetros al mandato de destino. | N |
Adición o actualización de una dirección para una organización:
Las peticiones para añadir o actualizar una dirección de una persona se correlacionan con com.ibm.commerce.usermanagement.commands.AddressAddCmd y com.ibm.commerce.usermanagement.commands.AddressUpdateCmd. Las peticiones deben contener la siguiente información:
| XPath* | Tipo | Se correlaciona con el siguiente parámetro de mandato | Descripción: | Obligatorio |
|---|---|---|---|---|
| ApplicationArea/BusinessContext/ContextData | USERDATA | - | Datos de contexto. Por ejemplo:
| N |
| DataArea/Sync/ActionCriteria/ActionExpression/@actionCode | string | action | El código de acción. Los valores válidos son los siguientes:
| Y |
| DataArea/Sync/ActionCriteria/ActionExpression | string | commerceObject | Expresión de acción. Se debe especificar de la forma indicada a continuación:
| Y |
| DataArea/Organization/OrganizationIdentifier/DistinguishedName | string | distinguishedName | Nombre distinguido de la organización. | Y |
| DataArea/Organization/ContactList/ContactEntry/@contactNickName | string | Apodo | El apodo o identificador de la dirección que se añade o actualiza. Una organización puede tener una colección de direcciones, cada una con un apodo. El sistema trata la dirección que proporciona una organización durante el registro como la dirección propia de la organización. El sistema establece el apodo de esa dirección en el orgEntityName de la organización. | Y |
| DataArea/Organization/ContactList/ContactEntry/ContactName/LastName | string | lastName | Apellido de la persona de contacto. | N |
| DataArea/Organization/ContactList/ContactEntry/ContactName/PersonTitle | string | personTitle | Tratamiento de la persona de contacto, por ejemplo, Dr., Sr. o Sra. | N |
| DataArea/Organization/ContactList/ContactEntry/ContactName/FirstName | string | firstName | Nombre de la persona de contacto proporcionado. | N |
| DataArea/Organization/ContactList/ContactEntry/ContactName/MiddleName | string | middleName | Segundo nombre de la persona de contacto. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[1] | string | phone1 | El número de teléfono primario de la organización. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[1]/@type | string | phone1Type | El tipo de teléfono que se utiliza para el número de teléfono primario de la organización. Por ejemplo, TTY para personas con problemas de audición, PCM para modulación por pulsos codificados o CEL para teléfono móvil. Este valor es un campo de 3 caracteres. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[1]/@publish | string | publishPhone1 | Especifica si el número de teléfono primario aparece en la lista. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[2] | string | phone2 | El número de teléfono secundario de la organización. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[2]/@type | string | phone2Type | El tipo de teléfono que se utiliza para el número de teléfono secundario de la organización. Por ejemplo, TTY para personas con problemas de audición, PCM para modulación por pulsos codificados o CEL para teléfono móvil. Este valor es un campo de 3 caracteres. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[2]/@publish | string | publishPhone2 | Especifica si el número de teléfono primario aparece en la lista. | N |
| DataArea/Organization/ContactList/ContactEntry/Email[1] | string | email1 | Dirección de correo electrónico primaria de la organización. | N |
| DataArea/Organization/ContactList/ContactEntry/Email[2] | string | email2 | Dirección de correo electrónico secundaria de la organización. | N |
| DataArea/Organization/ContactList/ContactEntry/Fax[1] | string | fax1 | Número de fax primario de la organización. | N |
| DataArea/Organization/ContactList/ContactEntry/Fax[2] | string | fax2 | Número de fax secundario de la organización. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/@type | string | addressType | La finalidad de la dirección. Los valores válidos son:
| N |
| DataArea/Organization/ContactList/ContactEntry/Address/City | string | city | La ciudad. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/StateOrProvinceName | string | state | Estado o provincia. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/Country | string | country | País o región. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/PostalCode | string | zipCode | Código postal o ZIP. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/AddressLine[1] | string | address1 | Primera línea de la dirección. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/AddressLine[2] | string | address2 | Segunda línea de la dirección. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/AddressLine[3] | string | address3 | Tercera línea de la dirección. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/UserData/UserDataField | USERDATA | - | Se utiliza para pasar más parámetros al mandato de destino. | N |
| DataArea/Organization/ContactList/ContactEntry/UserData/UserDataField | USERDATA | - | Se utiliza para pasar más parámetros al mandato de destino. | N |
* Los prefijos de espacios de nombres se ignoran para una mayor sencillez.
Ejemplos
- SyncOrganization.xml: añadir una organización
- SyncOrganizationAddress.xml: añadir una nueva dirección para una organización
Respuesta
Las respuestas de este servicio web de entrada están en formato de BOD ConfirmBOD.
Una respuesta a la adición o actualización de una organización contiene la información siguiente:
| XPath* | Tipo | Descripción: |
|---|---|---|
| DataArea/BOD/BODSuccessMessage | - | Este elemento está presente si la petición ha sido satisfactoria. |
| DataArea/BOD/BODSuccessMessage/UserArea/Organization/OrganizationIdentifier/UniqueID | string | ID de miembro de la organización |
Una respuesta para añadir o actualizar una dirección para la organización incluye la siguiente información:
| XPath* | Type | Descripción |
| DataArea/BOD/BODSuccessMessage | - | Este elemento está presente si la petición ha sido satisfactoria. |
* Los prefijos de espacios de nombres se ignoran para una mayor sencillez.
Ejemplos
- ConfirmBODOrganization.xml: respuesta de la adición o actualización satisfactoria de una organización
- ConfirmBODAddress.xml: respuesta de la adición o actualización satisfactoria de la dirección de una dirección
Excepciones
Todas las excepciones están en formato de BOD ConfirmBOD con un elemento ResponseCriteria debajo del verbo Confirm. Contienen la siguiente información:
| XPath* | Tipo | Descripción: |
|---|---|---|
DataArea/Confirm/ResponseCriteria/ChangeStatus/Code |
string | El identificador de correlación. Se puede utilizar para identificar de forma exclusiva una excepción en los registros de servidor. |
DataArea/Confirm/ResponseCriteria/ChangeStatus/ReasonCode |
string | El código de razón, que es un HCL Commercecódigo de error de sistema HCL Commercecódigo de error de sistema si se encuentra disponible o la clave de mensaje EC además de un código de error secundario opcional si el código de error de sistema de HCL Commerce no se encuentra disponible (normalmente en el caso de excepciones de aplicación). |
DataArea/Confirm/ResponseCriteria/ChangeStatus/Reason |
string | El mensaje de excepción. |
* Los prefijos de espacios de nombres se ignoran para una mayor sencillez.
Archivo de correlación de mensajes utilizado: SyncOrganizationBODMapping.xml
Ejemplos
- SyncOrganization.xml
- SyncOrganizationAddress.xml
- ConfirmBODOrganizationError.xml: respuesta de excepción cuando falta un parámetro necesario.