Obscure Data - Obscure Primary Document Service

The Obscure Data - Obscure Primary Document service masks the content of the primary document by replacing the original content with an unintelligible version of the original content.

The following table provides an overview of the Obscure Data - Obscure Primary Document service:

Category	Description
System name	ObscureDocument
Graphical Process Modeler (GPM) category	All Services (as ObscureDocument)
Description	The Obscure Data - Obscure Primary Document service masks (obscures) the content of the primary document by replacing the original content with an unintelligible version of the original content. The content of the primary document can be restored to its original form by using the Obscure Data - Reveal Primary Document service.
Business usage	In Sterling B2B Integrator, data processed by a business process (such as the contents of process data and the primary document), while or after it is executed, is normally available in plain text and is easily viewable. You can use the Obscure Data - Obscure Primary Document service to help restrict access to sensitive data, such as passwords, by masking the data into an unintelligible form.
Usage example	Assume that you use Sterling B2B Integrator to process and transmit payroll information to your payroll service provider. You do not want your system management personnel, who are responsible for initiating and monitoring the execution of your business processes, to have access to the data. You can place the sensitive payroll information in the primary document and use the Obscure Data - Obscure Primary Document service to obscure the entire content of the primary document.
Preconfigured?	Yes. A preconfigured instance of the Obscure Data - Obscure Primary Document service named ObscureDocument_Instance is available. There are no configuration parameters and no configuration is required. To use the service, just place ObscureDocument_Instance in a business process.
Requires third-party files?	No
Platform availability	All supported Sterling B2B Integrator platforms
Related services	This service works in conjunction with the Obscure Data - Reveal Primary Document service. The content of the primary document obscured by the Obscure Data - Obscure Primary Document service can be restored to its original intelligible form with the Obscure Data - Reveal Primary Document service. Note: If you want to obscure the contents of a document as it is being collected from the file system and becomes the primary document, you may be able to use the obscure parameter in the File System adapter. For more information, see File System Adapter.
Application requirements	None
Initiates business processes?	No
Invocation	This service is invoked from within a business process.
Business process context considerations	This service takes the primary document as the input and replaces it with an obscured version of the primary document.
Returned status values	N/A
Restrictions	None
Persistence level	System default
Testing considerations	Test as part of a business process

Example Business Processes

The first BPML example demonstrates the syntax and use of the preconfigured instances of the Obscure Data - Obscure Primary Document service and the Obscure Data - Reveal Primary Document service.

<process name="myBusinessProcess">
  <sequence>
    <operation name="ObscureDocument">
      <participant name="ObscureDocument_Instance"/>
      <output message="ObscureDocumentInputMessage">
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
      </input>
    </operation>
INSERT OTHER BUSINESS PROCESS OPERATIONS HERE
    <operation name="RevealDocument">
      <participant name="RevealDocument_Instance"/>
      <output message="RevealDocumentInputMessage">
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
INSERT OTHER BUSINESS PROCESS OPERATIONS HERE
  </sequence> 
</process>

The next example uses both the preconfigured instances of the Obscure Data - Obscure Primary Document service and the Obscure Data - Reveal Primary Document service and the File System adapter to obscure and unobscure data. For more information about the File System adapter, see File System Adapter.

      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
    <!-- Unobscure the collected document, using the Obscure Data - Reveal 
         Primary Document service, to extract information from it -->
    <operation name="RevealDocument">
      <participant name="RevealDocument_Instance"/>
      <output message="RevealDocumentInputMessage">
       <assign to="." from="*"></assign>
     </output>
      <input message="inmsg">
       <assign to="." from="*"></assign>
     </input>
    </operation>
    <!-- Extract the desired information from the unobscured document and use 
         it as needed in the business process -->
    <!-- Reobscure the document using the Obscure Data - Obscure Primary 
         Document service -->
    <operation name="ObscureDocument">
      <participant name="ObscureDocument_Instance"/>
      <output message="ObscureDocumentInputMessage">
       <assign to="." from="*"></assign>
     </output>
      <input message="inmsg">
       <assign to="." from="*"></assign>
     </input>
    </operation>
    <!-- Perform other business process operations, as needed -->
    <!-- Extract an unobscured version of the document to the file system using
         the File System adapter -->
   <operation name="File System Adapter">
     <participant name="FSA_Outbound"/>
     <output message="FileSystemInputMessage">
       <assign to="Action">FS_EXTRACT</assign>
       <assign to="assignedFilename">%^.txt</assign>
       <assign to="assignFilename">true</assign>
       <assign to="collectionFolder">/dir_path/collect</assign>
       <assign to="extractionFolder">/dir_path/extract</assign>
       <assign to="unobscure">true</assign>
       <assign to="." from="*"></assign>
     </output>
      <input message="inmsg">
       <assign to="." from="*"></assign>
     </input>
    </operation>
 </sequence> 
</process>