<\/a>Configure the Export to REST Web Service<\/h3>\n1. Fill in the Connection Details<\/strong> as described above. Provide REST Web Service URL and select REST as the Web Service Type.<\/p>\nOnce you select the type of Web Service, a new Authentication Type<\/strong> field is populated on the screen. For a REST Web Service, you can select one of the following authentication types:<\/p>\n\n- No authentication<\/li>\n
- Basic authentication<\/li>\n
- OAuth 2.0<\/li>\n<\/ul>\n
<\/p>\n
\n\n\nField<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n\nWeb Service URL<\/td>\n | This textbox is for configuring the target path of the Web Service where the exported files are to be placed. The path will depend on the type of the selected Web Service.<\/p>\n In case of REST Web Services, the URL will look like: http:\/\/<hostname>:<port>\/ dcma\/export\/uploadExportedFile<\/p>\n In case of SOAP Web Services, the URL will look like: http:\/\/<hostname>:<port>\/dcma\/soap\/UploadFile?wsdl<\/td>\n<\/tr>\n | \nWeb Service Type<\/td>\n | These radio buttons for selecting the type of Web Service.<\/p>\n Two types of Web Services are supported \u2013 REST and SOAP.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n <\/p>\n 2. Select Authentication type.<\/p>\n \n- If you select NONE<\/strong>, you will directly proceed to the Export Details<\/strong> section.<\/li>\n<\/ul>\n
<\/p>\n \n- If you select BASIC_AUTHENTICATION<\/strong>, you will see Basic Authentication Details <\/strong>section.<\/li>\n<\/ul>\n
<\/p>\n \n\n\nField<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n\nUsername<\/td>\n | For basic authentication, enter the username in the textbox which will be verified at the server end to authenticate the user.<\/td>\n<\/tr>\n | \nPassword<\/td>\n | For basic authentication, enter the password in the textbox which will be verified at the server end to authenticate the password of the user.<\/p>\n The connection is established only if the combination of username and password is authenticated at the server end.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n <\/p>\n After you provide the required information, click Add Export Details<\/strong>. the Basic Authentication details are saved and the Export Details<\/strong> section opens.<\/p>\n<\/p>\n \n- If you select OAUTH_2<\/strong>, you will see OAuth Configuration<\/strong> section.<\/li>\n<\/ul>\n
<\/p>\n \n\n\nField<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n\nClient ID<\/td>\n | Client ID is a public identifier for apps, similar to the username.<\/td>\n<\/tr>\n | \nAccess Token URL<\/td>\n | This is a URL from which authentication token is received.<\/td>\n<\/tr>\n | \nClient Secret<\/td>\n | Client Secret is\u00a0a secret known only to the application and the authorization server, similar to the password.<\/td>\n<\/tr>\n | \nGrant Type<\/td>\n | Grant types are used to authorize access to protected resources in many ways with different security credentials.<\/p>\n Currently, Client Credentials<\/strong> is the only supported Grant type.<\/td>\n<\/tr>\n\nAdd Token To<\/td>\n | Here you can choose whether you want to pass OAuth 2.0\u00a0authorization (access token) in the\u00a0Header or URL.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n <\/p>\n After you provide the required information, click Add Export Details.<\/strong> The OAuth 2.0 details are saved and the Export Details<\/strong> section opens.<\/p>\n<\/p>\n 3. After you have selected and configured your authentication type, fill in the Export Details<\/strong>.<\/p>\n<\/p>\n \n\n\nField<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n\nExport File(s)<\/td>\n | This drop-down contains the types of files that can be exported.<\/p>\n By default, PDF type is selected.<\/p>\n To export only TIFF files, select TIFF.<\/p>\n To export both PDF and TIFF files, select PDF and TIFF.<\/p>\n Note that the batch.xml is always exported along with the file.<\/p>\n The file type selected here must correspond to the file type specified in the Multipage File Creation Type<\/strong> field of CREATEMULTIPAGE_FILES<\/strong> plugin (see Export Module).<\/td>\n<\/tr>\n\nExport File Name<\/td>\n | This textbox is for generating the export file name.<\/p>\n By default, it follows the EDIT_MASK:<\/p>\n $BATCH_IDENTIFIER & _ & $DOCUMENT_ID<\/p>\n For example:<\/p>\n BI1A_DOC1<\/p>\n Below is the list of keywords that can be used to create Export File Name dynamically:<\/p>\n BATCH_IDENTIFIER<\/p>\n BATCH_CLASS<\/p>\n BATCH_FIELD_VALUE<\/p>\n DOCUMENT_ID<\/p>\n DOCUMENT_TYPE<\/p>\n SERVER_NAME<\/p>\n TIME<\/p>\n DATE<\/p>\n DLF<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n <\/p>\n 4. At this stage, you can either implement the defined functionality or add a custom jar file containing custom details for your Web Service.<\/p>\n \n- If you want to use the default functionality, click Apply<\/strong> to save your configuration.<\/li>\n
- If you want to import your own client for the Web Service, select Add Custom Jar for Client<\/strong>. This will take you to the Custom Jar Details<\/strong> section.<\/li>\n<\/ul>\n
<\/p>\n \n\n\nField<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n\nUpload Zip<\/td>\n | Click Browse<\/strong> to find and import a zip file containing all jar files required for the plugin execution.<\/p>\n The name of the zip file and the name of the jar which has the client implementation should be the same (e.g. custom.zip & custom.jar). All the dependencies for this jar. file should be zipped together.<\/td>\n<\/tr>\n \nClass Name<\/td>\n | This drop-down includes all the classes of the jar file placed on the server. Once you select the class, the field will become uneditable.<\/p>\n If you want to reload the class names, click Re-Deploy Jar<\/strong>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n <\/p>\n Once you\u2019ve filled the Custom Jar Details<\/strong>, click Apply<\/strong> and Deploy<\/strong> to save the configuration. The batches (PDF\/TIFF and Batch XML files) will be exported to the specified REST Web Service.<\/p>\nNote<\/em><\/strong>: If any input parameter of Export to Web Services plugin is entered incorrectly, the batch will go into the error state.<\/em><\/p>\nIn Ephesoft Transact, the SOAP\/REST client is implemented via the UI interface described above.<\/p>\n The Custom Client implementation can be done by using the ExportToWebService interface for both SOAP and REST Web Services.<\/p>\n <\/p>\n Sample client code of\u00a0CloseableHTTPClient<\/b>\u00a0of java with\u00a0NoAuth<\/b>\u00a0as authentication mechanism to send request of\u00a0Multipart\/form-data\u00a0<\/b>type<\/h5>\nCustomCloseableHttpClient<\/a><\/p>\n","protected":false},"featured_media":0,"parent":31772,"menu_order":14,"comment_status":"closed","ping_status":"open","template":"","doc_tag":[],"yoast_head":"\nExport to Web Service Plugin | Ephesoft Docs<\/title>\n\n\n\n\n\n\n\n\n\n\n\n\t\n | | | | | | | | | | | | | | | | | |