Difference between revisions of "SOP-MES0029 Admin Document Control"

From 42Q
Jump to navigation Jump to search
Line 8: Line 8:
  
 
<br>  
 
<br>  
 
 
== Administration  ==
 
== Administration  ==
  
Line 14: Line 13:
  
 
This work instruction is intended to guide administrators on how to manage and maintain the Cirrus Portal, as well as to provide specific user groups a common sense of portal operation.  
 
This work instruction is intended to guide administrators on how to manage and maintain the Cirrus Portal, as well as to provide specific user groups a common sense of portal operation.  
 +
 +
<br>
 +
 +
=== System Requirements  ===
 +
 +
==== Hardware Requirements (minimum)  ====
 +
 +
'''Server requirement'''
 +
 +
*with VM ESXi
 +
*Preferably 64 bit machine
 +
*Core Duo processor
 +
*2GB RAM
 +
*80GB hard disk space
 +
 +
'''Client requirement'''
 +
 +
*Core Duo processor
 +
*1GB RAM
 +
*20GB hard disk space
 +
*Minimum resolution at 1024x768 (17"/19" monitor is recommended)
 +
*Support smart terminals (Linux LTSP, WYSE and Expension terminals)
 +
 +
==== Software Requirements<br>  ====
 +
 +
*Windows XP or Ubuntu
 +
*Chrome 12.0 or newer (Recommended browser)
 +
*Firefox 7.0 or newer, with Adobe Reader disabled (if it<nowiki>’</nowiki>s installed),&nbsp;and the extension '''pdf.js''' installed.
 +
*MDS deployed with at least 1&nbsp;SFDC Host PC
 +
 +
<br>
 +
 +
<br>
  
 
To access any of the Administration functionalities, the user must sign into the Cirrus Portal and then select the Administration expandable heading located in the menu on the left of the screen.  
 
To access any of the Administration functionalities, the user must sign into the Cirrus Portal and then select the Administration expandable heading located in the menu on the left of the screen.  
 +
 +
<br>
  
 
'''Figure 1: User Sign-In'''  
 
'''Figure 1: User Sign-In'''  
  
[[Image:SOP-5-I-MES150028-C RA1 Document Control 01.jpg|400px|SOP-5-I-MES150028-C RA1 Document Control 01.jpg]] <br> <br> <br> <br> '''Figure 2: Cirrus Welcome'''
 
  
[[Image:SOP-5-I-MES150028-C RA1 Document Control 02.jpg|border|left|700px|SOP-5-I-MES150028-C RA1 Document Control 02.jpg]] <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br> <br>  
+
 
 +
<br>  
 +
 
 +
<br> '''Figure 2: Cirrus Welcome'''
 +
 
 +
 
 +
<br>  
  
 
<br>  
 
<br>  
Line 27: Line 66:
 
== Document Control  ==
 
== Document Control  ==
  
This section covers how local administrators can maintain document file types. This is the prerequisite configuration before users can upload any documents, as all uploaded documents will be categorized and displayed by their document type.  
+
This section covers how local administrators can maintain document file types. This is the prerequisite configuration before users can upload documents in the Document Mapping portlet, as all uploaded documents will be categorized and displayed by its document type.  
  
 
=== Document Type  ===
 
=== Document Type  ===
Line 35: Line 74:
 
'''Figure 3: Document Type Main Page'''  
 
'''Figure 3: Document Type Main Page'''  
  
[[Image:SOP-5-I-MES150028-C RA1 Document Control 03.jpg|700px|SOP-5-I-MES150028-C RA1 Document Control 03.jpg]]
 
  
<br> All existing document types will be listed on the '''Document Type''' Main Page.
 
  
==== Add Document Type  ====
+
<br>
  
1. To add a new document type, select the '''Add''' button, and a new row will be added.  
+
All existing document types will be listed on the '''Document Type''' Main Page.  
  
 
<br>  
 
<br>  
  
'''Figure 4: Add Document'''
+
==== Add Document Type  ====
  
[[Image:SOP-5-I-MES150028-C RA1 Document Control 04.jpg|700px|SOP-5-I-MES150028-C RA1 Document Control 04.jpg]]
+
1. To add a new document type, select the '''Add''' button, and a new row will be added.  
  
<br>
+
'''Figure 4: Add Document'''
 +
  
*'''Document Type''': the document type name that you want to add into eManual.  
+
*'''Document Type''': the document type name to add into the local repository.  
*'''ExpireDate Required''': Allows user to define if there is a valid date required for the document type. If this option is checked, the '''Start Date''' and '''End Date''' options in Upload Agile/Local Document page will be activated.  
+
*'''ExpireDate Required''': Allows the user to define if there is a valid date required for the document type. If this option is checked, the '''Start Date''' and '''End Date''' options in the Document Mapping page will be activated.  
*'''Active''': Allows user to enable or disable the document type in eManual system. If this option is checked, the user can view and select the document type when uploading documents.
+
*'''Active''': Allows the user to enable or disable the document type in the system. If this option is checked, the user can view and select the document type when mapping documents.
  
 
2. Enter the appropriate information and select '''Update '''to confirm or '''Cancel '''to exit.  
 
2. Enter the appropriate information and select '''Update '''to confirm or '''Cancel '''to exit.  
Line 61: Line 99:
 
==== Delete Document Type  ====
 
==== Delete Document Type  ====
  
1. To delete a new document type, select the document type and then select '''Delete'''. Deleting a document type will not affect the display of existing documents that are of this document type in eManual.  
+
1. To delete a document type, select the document type and then select '''Delete'''. Deleting a document type will not affect the display of existing documents that are of this document type in the repository.  
  
 
<br>  
 
<br>  
Line 67: Line 105:
 
'''Figure 5: Delete Document Type'''  
 
'''Figure 5: Delete Document Type'''  
  
[[Image:SOP-5-I-MES150028-C RA1 Document Control 05.jpg|700px|SOP-5-I-MES150028-C RA1 Document Control 05.jpg]] <br> <br> <br>
 
  
=== Upload Document  ===
+
<br>
 +
 
 +
=== Document Mapping ===
  
1. To access the Upload Document page, navigate to '''Administration <nowiki>></nowiki> Document Control <nowiki>></nowiki> Upload Document'''.  
+
The Document Mapping portlet allows users to maintain documentation by uploading documents via Agile, local networks, or URLs. It also allows users to map documents or deviation attachements to specific part numbers and processes.&nbsp;The goal of these instructions is to outline the steps to assign appropriate documentation to the end user regarding a process or part for which they require work instructions or deviation information.  
  
<br> '''Figure 6: Upload Document'''
+
<br>  
  
[[Image:SOP-5-I-MES150028-C RA1 Document Control 06.jpg|700px|SOP-5-I-MES150028-C RA1 Document Control 06.jpg]]
+
1. To access the Document Mapping page, navigate to'''Administration <nowiki>></nowiki> Document Control <nowiki>></nowiki> Document Mapping'''.  
  
 
<br>  
 
<br>  
  
<br> The Uploading Document page and portlets allow users to maintain their documentation by uploading documents via Agile, local networks, or URLs and assign them to certain part numbers and part families.&nbsp;To avoid repetition, it is noted only once that the goal of these instructions is to assign appropriate documentation to the end user regarding some process and part for which they require work instructions. The directions given below provide the set-by-step process for selecting and assigning documentation by means of the various portlets provided:
+
'''Figure 6: Document Mapping'''
 +
 
  
 
==== Document Selection: Agile Versus Local  ====
 
==== Document Selection: Agile Versus Local  ====
  
Selecting the Agile portlets allows documents to be uploaded from Agile. The benefit of uploading documents from Agile in general is that Agile documents are published in full compliance with company standards and procedures. Retrieving a document from Agile ensures that the document is the latest version of the given work instruction. However, users can upload documents from their local computer and network by selecting from the local portlets.  
+
The Document Mapping portlet allows documents and deviations (PDF attachments) to be uploaded from Agile as well as from a local drive. The benefit of uploading documents from Agile is that the documents are published in full compliance with company standards and procedures. Retrieving a document from Agile also ensures that it is the latest version. Documents can also be uploaded for display from a local computer or network. However, local documents are less controlled and it is difficult to ensure the latest version is available for display.  
  
===== Uploading from Agile  =====
+
<br>
  
Users can select to upload documents from Agile by using a document<nowiki>’</nowiki>s assigned Agile Document Number, Part Number, or Deviation Number. Regardless of the choice, the process is virtually the same:
+
===== Uploading By Agile =====
  
1. Under '''Document Selection''', click the dropdown box and select whether to search by Agile Doc Number, Agile Part Number, or Agile Deviation Number.  
+
Users can select to upload documents from Agile by using a document<nowiki>’</nowiki>s assigned Agile Document Number, Part Number, or Deviation Number.  
  
2. Enter the corresponding (Agile) document number, part number, or deviation number in the adjacent search field and select '''Next'''.  
+
1. Under the '''Document Selection '''panel , select whether to search by '''Agile Doc Number''','''Agile Part Number''','''or Agile Deviation Number'''.  
  
3. Select the appropriate document from the '''Agile Document List'''.  
+
2. Enter the corresponding Agile document number, part number, or deviation number in the adjacent search field and select '''Next'''.  
  
4. Now, select the (shop floor) part number or part family to which to upload the document under '''Upload Document''': select the Shop Floor ID from the dropdown box on the left; select whether you are uploading the Agile document to a part number or part family from the middle dropdown box; in the dropdown box on the right, select a part number or part family.  
+
3. Select the appropriate document from the '''Agile Document List '''panel.  
  
5. Select '''Search''' and select the appropriate item from the search results.  
+
4. From the '''Upload Document '''panel, select the Shop Floor ID. Select whether to map the Agile document to a part number or part family from the middle dropdown box. In the dropdown box on the right, select a part number or part family.
 +
 
 +
5. Select '''Search''' and then select the appropriate item from the search results.  
 +
 
 +
<br>
 +
 
 +
'''Figure 7: Map Agile Document'''
 +
 
 +
 
 +
<br>
  
 
6. Select '''Add'''.  
 
6. Select '''Add'''.  
Line 103: Line 152:
 
7. In the pop-up window provided, select '''Process''', '''Document Type''', '''Start Date''' (if applicable), '''End Date''' (if applicable), '''Convert to''', '''Start Page''', '''End Page''', and '''Show Default''' to apply to the document.  
 
7. In the pop-up window provided, select '''Process''', '''Document Type''', '''Start Date''' (if applicable), '''End Date''' (if applicable), '''Convert to''', '''Start Page''', '''End Page''', and '''Show Default''' to apply to the document.  
  
8. Select '''Save'''. This uploads the document according to the properties selected.  
+
8. Select '''Save'''.
 +
 
 +
<br>
 +
 
 +
'''Figure 8: Map Document Details'''
 +
 
 +
 
 +
 
 +
<br>
 +
 
 +
9. If mapped successfully, the document will be displayed in the list in the '''Upload Document '''panel.
 +
 
 +
<br>
 +
 
 +
'''Figure 9: Successful Mapping'''
 +
 
 +
 
 +
 
 +
<br> MES retrieves Agile deviation documents by using the Agile deviation number. Deviation attachments are displayed along with the work instructions, therefore each attachment has to be mapped to an existing &nbsp;MES (SFDC) process name and Part Number so that it can be displayed properly during production scanning. A deviation is a temporary change in the process, therefore, it requires an expiration date, along with other defined parameters.
 +
 
 +
<u>NOTE:</u> When uploading a deviation document, the Documentation Type selected must be Devation. This allows the deviation to be displayed to the end user by default.
 +
 
 +
===== Uploading By Local Computer or Network  =====
 +
 
 +
Users can select to upload documents from a local computer or network by document or deviation number.
 +
 
 +
1. Under Document Selection, select whether to search by '''Local Document''' or '''Local Deviation Number'''.
 +
 
 +
2. Enter the corresponding local deviation if that option was selected
 +
 
 +
3. Select the Deviation Document from the '''Agile Document List''', if a Local Deviation was selected.  
  
NOTE: When uploading a deviation document, the Documentation Type selected must be Devation.  
+
4. Select the Shop Floor ID from the '''Upload Document '''panel. Select whether to upload the document to a part number or part family in the middle dropdown box. In the dropdown box on the right, select a part number or part family.
 +
 
 +
5. Select '''Search '''and then select the appropriate item from the search results.  
  
 
<br>  
 
<br>  
  
'''Figure 7: Document Selection'''  
+
'''Figure 10: Map Local Document'''  
 +
 
  
[[Image:SOP-5-I-MES150028-C RA1 Document Control 07.jpg|700px|SOP-5-I-MES150028-C RA1 Document Control 07.jpg]]
 
  
 
<br>  
 
<br>  
 +
 +
6. Select '''Add'''.
 +
 +
7. In the pop-up window provided, select the '''File''', '''Process''', '''Document Type''', '''Start Date''' (if applicable),'''End Date''' (if applicable), '''Convert to''', '''Start Page''','''End Page''', and '''Show Default''' to apply to the document.
 +
 +
8. If '''Local Document '''was selected, select the '''Browse '''icon to search for the document on the Local Computer or Network. Select the desired document and then select '''Open'''.
  
 
<br>  
 
<br>  
  
===== Uploading from Local Computer or Network  =====
+
'''Figure 11: Browse for Local Document'''
  
Users can select to upload documents from a local computer or network by document or deviation number. Regardless of the choice, the process is virtually the same:
 
  
1. Under Document Selection, click the dropdown box and select whether to search by '''Local Document''' or '''Local Deviation Number'''.
+
<br> 9. If the file is a CAD, select the Part Number and Revision to map the document to and then select '''Save.'''<br>
  
2. Enter the corresponding local deviation (if applicable).
+
<br>
  
3. Now, select the path by which to upload the document under Upload Document: select the Shop Floor ID from the dropdown box on the left; select whether you are uploading the document to a part number or part family in the middle dropdown box; in the dropdown box on the right, select a part number or part family.
+
'''Figure 12: CAD Mapping'''
  
4. Select '''Search '''and then select the appropriate item from the search results.
 
  
5. Select '''Add'''.
 
  
6. In the pop-up window provided, select the '''File''', '''Process''', '''Document Type''', '''Start Date''' (if applicable),'''End Date''' (if applicable), '''Convert to''', '''Start Page''','''End Page''', and '''Show Default''' to apply to the document.  
+
<br> A deviation document can be uploaded into the MES document repository from a local drive without retrieving from the Agile system. This also requires the mapping of an MES part number and process name, as well as defining the shop order, or serial number.
 +
 
 +
<u>NOTE</u>: When uploading a deviation document, the Documentation Type selected must be Deviation. This allows the deviation to be displayed to the end user by default.
 +
 
 +
<u>NOTE: </u>The local deviation number needs to be entered by the user. The naming convention is usually different from the Agile deviation number, which is to be defined at the time of upload and may be inconsistent from one document to another.  
 +
 
 +
===== Uploading By Engineering Job Number or Engineering Notes  =====
  
7. Select '''Save'''. This uploads the document according to the properties just selected.  
+
Uploading by Engineering Job Order and By Engineering Notes are options that were implemented for PCB customers. The descriptions are as follows:
  
NOTE: When uploading a deviation document, the Documentation Type selected must be Deviation.  
+
*By Engineering Job Num: Will upload documents from a local defined directory and the lookup is by that Engineering Job Num (a PCB Item attribute).
 +
*By Engineering Notes: Will create a text note that will be displayed similar to a document for a specific Item, where the mapping is by Item<nowiki>+</nowiki>Location<nowiki>+</nowiki>Shop order.
  
 
<br>  
 
<br>  
  
===== By URL  =====
+
===== Uploading By URL  =====
  
 
A user may upload a document from a URL:  
 
A user may upload a document from a URL:  
  
1. Under '''Document Selection''', click the dropdown box and select whether to search by URL.  
+
1. Under '''Document Selection''', select '''By URL'''.  
  
2. Enter the corresponding URL path for the PDF document being uploaded, and click Check Validation.  
+
2. Enter the corresponding URL path for the PDF document being uploaded, and then select '''Next'''. Title the URL Document in the '''Title '''field.  
  
3. Now, select the path by which to upload the document under Upload Document: select the Shop Floor ID from the dropdown box on the left; select whether you are uploading the document to a part number or part family in the middle dropdown box; in the dropdown box on the right, select a part number or part family.  
+
3. Select the Shop Floor ID from the '''Upload Document '''panel. Select whether to upload the document to a part number or part family in the middle dropdown box. In the dropdown box on the right, select a part number or part family.  
  
 
4. Select '''Search''' and then select the appropriate item from the search results.  
 
4. Select '''Search''' and then select the appropriate item from the search results.  
Line 155: Line 246:
 
6. In the pop-up window provided, select the '''File''', '''Process''', '''Document Type''', '''Start Date''' (if applicable), '''End Date''' (if applicable), '''Convert to''', '''Start Page''', '''End Page''', and '''Show Default''' to apply to the document.  
 
6. In the pop-up window provided, select the '''File''', '''Process''', '''Document Type''', '''Start Date''' (if applicable), '''End Date''' (if applicable), '''Convert to''', '''Start Page''', '''End Page''', and '''Show Default''' to apply to the document.  
  
7. Select '''Save'''. This uploads the URL&nbsp;according to the properties selected.  
+
7. Select '''Save'''. This maps the URL&nbsp;according to the properties selected.  
  
 
<br>  
 
<br>  
Line 163: Line 254:
 
=== List Document  ===
 
=== List Document  ===
  
This section explains how a user can review all work instruction documents in eManual document repository and search work instruction documents by filtering using part number and/or process name.&nbsp; When user access List Document page, eManual will display a list of work instruction documents uploaded via Upload Agile Document/Upload Local Document, order by Created Date.  
+
This section explains how a user can review all work instruction documents in the document repository and search work instruction documents by filtering using part number and/or process name.&nbsp; When the user accesses the List Document page, work instruction documents uploaded in the Document Mapping portler will display by Created Date.  
  
 
1. To access the List Document page, navigate to '''Administration <nowiki>></nowiki> Document Control <nowiki>></nowiki> List Doc'''.  
 
1. To access the List Document page, navigate to '''Administration <nowiki>></nowiki> Document Control <nowiki>></nowiki> List Doc'''.  
 +
 +
'''Figure 13: List Doc'''
 +
  
 
<br>  
 
<br>  
  
'''Figure 8: List Doc'''  
+
'''Prerequisite Configuration'''
 +
 
 +
*Upload Agile Document / Deviation or Upload&nbsp;Local Document / Deviation
 +
 
 +
'''Below are features of the List Document page:'''  
 +
 
 +
*Lists all work instruction documents in the document repository.
 +
*Search capability. &nbsp;Allows users to enter the SFDC part number and/or process name. &nbsp;The system will return a list of documents with associated SFDC part number and/or process name.
 +
*Allows the user to view work instruction document PDF attachments.
 +
 
 +
2. To search for a specific document, select from the following categories:
  
[[Image:SOP-5-I-MES150028-C RA1 Document Control 08.jpg|700px|SOP-5-I-MES150028-C RA1 Document Control 08.jpg]]
+
*'''Shop Floor ID'''<br>
 +
*'''Part Family '''(optional): Input SFDC Part Family. Fuzzy Search is supported.
 +
*'''Part Number&nbsp;'''(optional): Input SFDC Part Number. Fuzzy Search is supported.
 +
*'''Process Name '''(optional): Input SFDC&nbsp;process name. Fuzzy Search is supported.
 +
*'''Category''': '''All, Agile Doc, Deviation Doc, Local Doc, URL Doc''' can be selected and fuzzy search is supported.
 +
*'''Agile Doc Number''': All documents uploaded from the Agile system have corresponding Agile document numbers listed in this column. For work instruction documents uploaded using Upload Local Document, this column will be left empty. This allows the user to differentiate between work instruction documents uploaded from the Agile system and those uploaded from a non-Agile system.
 +
*'''Agile deviation number''': Deviation number from Agile. Fuzzy search is supported.
  
 
<br>  
 
<br>  
  
<br>'''Prerequisite Configuration'''<br>• Upload Agile Document / Deviation or Upload Local Document / Deviation
+
3. Select '''Search '''to initiate a search based on the defined parameters.
  
'''Below are features of the List Document page: '''<br>• Lists all work instruction documents in the document repository. <br>• Search capability. Allows users to enter the SFDC part number and/or process name. System will return a list of documents with associated SFDC part number and/or process name. <br>• Allows the user to view work instruction document PDF attachments.  
+
4. Select '''Clear '''to clear all fields.  
  
<br>2. To search for a specific document, select from the following categories:
+
<br>  
  
<br>• '''Shop Floor ID''' <br>• '''Part Family''' (optional): Input SFDC Part Family. Fuzzy Search is supported.<br>• '''Part Number''' (optional): Input SFDC Part Number. Fuzzy Search is supported.<br>•'''Process Name''' (optional): Input SFDC process name. Fuzzy Search is supported.<br>• '''Category''': All, Agile Doc, Deviation Doc, Local Doc, URL Doc can be selected and fuzzy search is supported.<br>• '''Agile Doc Number''': All documents uploaded from Agile system have corresponding Agile document numbers listed out in this column. For work instruction documents uploaded using Upload Local Document, this column will be left empty. This is how user can differentiate between work instruction documents uploaded from Agile system or non Agile system. <br>•'''Agile deviation number''': Deviation number from Agile. Fuzzy search is supported.
+
The following are heading descriptions for the listed documents:  
  
<br>3. Select '''Search''' to initiate a search based on the defined parameters.<br>4. Select '''Clear''' to clear all fields.  
+
*'''Document Number'''
 +
*'''Deviation Number'''
 +
*'''Document''': Uploaded PDF attachments name. Single-click on the file name to view the content.
 +
*'''Part Family''': SFDC part family that has been pre-mapped with the PDF attachment. This column matches with the above Part family field entered by user if there<nowiki>’</nowiki>s any.  
 +
*'''Part Number''': SFDC part number that has been pre-mapped with the PDF attachment. This column matches with the above Part Number field entered by user if there<nowiki>’</nowiki>s any.
 +
*'''Process Name''': SFDC process which has been pre-mapped with the PDF attachment. This column matches with the above Process Name field entered by user if there<nowiki>’</nowiki>s any.
 +
*'''Revision''': Current revision number of the agile document number uploaded in eManual document repository. For work instruction documents uploaded using Upload Local Document, this column will be left empty. This is how user can differentiate between work instruction documents uploaded from Agile system or non Agile system.
 +
*'''Assign'''  
 +
*'''Value'''
 +
*'''Creator''': Indicate the user that uploaded the work instruction documents.
 +
*'''Created Date''': It refers to the date of uploading the work instruction documents.
  
<br>The following are heading descriptions for the listed documents:<br>•'''Document Number<br>• Deviation Number'''<br>•'''Document:''' Uploaded PDF attachments name. Single-click on the file name to view the content. <br>• '''Part Family:''' SFDC part family that has been pre-mapped with the PDF attachment. This column matches with the above Part family field entered by user if there's any. <br>•'''Part Number''': SFDC part number that has been pre-mapped with the PDF attachment. This column matches with the above Part Number field entered by user if there's any. <br>• '''Process Name''': SFDC process which has been pre-mapped with the PDF attachment. This column matches with the above Process Name field entered by user if there's any. <br>• '''Revision:''' Current revision number of the agile document number uploaded in eManual document repository. For work instruction documents uploaded using Upload Local Document, this column will be left empty. This is how user can differentiate between work instruction documents uploaded from Agile system or non Agile system. <br>• '''Assign'''<br>• '''Value'''<br>•'''Creator: '''Indicate the user that uploaded the work instruction documents.<br>• '''Created Date:''' It refers to the date of uploading the work instruction documents.
+
5. To view the document, select the Document title in the '''Document '''heading. (the title will be in blue)
  
<br>5. To view the document, select the Document title in the Document heading. (the title will be in blue)<br>6. Once selected, an Opening pop-up will display:
+
6. Once selected, the document will display in a new window.
  
'''<br>Figure 9: Open Document'''<br> [[Image:09 Admin Doc Control.jpg]]<br>  
+
<br>  
  
<br>7. Select the program to open the document and then select '''OK'''.<br>8. A PDF file will display for easy viewing, sharing, or printing.
+
'''Figure 14: Open Document'''  
  
<br>'''Figure 10: Document Example'''<br>
 
  
[[Image:10 Admin Doc Control.jpg]]<br>
 
  
 
<br>  
 
<br>  
  
Navigation controls. At the bottom of the window, there is a group of controls to ease navigation: <br>o&nbsp;: Back to the first page.<br>o&nbsp;: Go to the last page.<br>o&nbsp;: Back to previous page.<br>o&nbsp;: Go to next page.<br>o&nbsp;: Reload document list. <br>A more efficient way to reach a page is to enter the page number in the page field and select Enter. <br>
+
=== Search Doc  ===
 +
 
 +
1. To access the Search Doc page, navigate to '''Administration <nowiki>></nowiki> Document Control <nowiki>></nowiki> Search Doc'''.  
  
 
<br>  
 
<br>  
  
<br>  
+
'''Figure 15: Search Doc'''
 +
 
 +
 
 +
<br> 2. Select a '''Shop Floor ID''', '''Part Number''', and '''Process Name''', and then select '''Search.'''
 +
 
 +
3. The mapped document will display in the document viewer below the filtering fields. If there are multiple documents, the subsequent documents will be available in tabs located above the document viewer.
  
 
<br>  
 
<br>  
  
=== Search Doc  ===
+
'''Figure 16: Document Display'''
  
1. To access the Search Doc page, navigate to Administration &gt; Document Control &gt; Search Doc.
 
  
<br> '''Figure 11: Search Doc'''<br>  
+
<br>  
  
[[Image:11 Doc Control.jpg]]<br>  
+
<u>NOTE:</u> If the Shop Floor ID, Part Number, or Process Name is incorrect the following error will display:
 
 
2. Select a Shop Floor ID, Part Number, and Process Name, and then select Search.
 
  
 
<br>  
 
<br>  
  
NOTE: If the Shop Floor ID, Part Number, or Process Name is incorrect the following error will display:  
+
'''Figure 17: Error Message'''
  
<br> '''Figure 12: Error Message'''<br>
 
  
[[Image:12 Doc Control.jpg]]<br>  
+
<br>  
  
 
== Document Revision History  ==
 
== Document Revision History  ==
  
{| width="100%" cellspacing="0" cellpadding="4" border="2"
+
{| cellspacing="0" cellpadding="4" border="2" width="100%"
|-
 
| bgcolor="#00FFFF" align="center" | <font color="#FFFFFF">Date</font>
 
| bgcolor="#00FFFF" align="center" | <font color="#FFFFFF">Author</font>
 
| bgcolor="#00FFFF" align="center" | <font color="#FFFFFF">Title</font>
 
| bgcolor="#00FFFF" align="center" | <font color="#FFFFFF">Version</font>
 
| bgcolor="#00FFFF" align="center" | <font color="#FFFFFF">Change Reference</font>
 
|-
 
| 02/17/14
 
| Ashley Martin
 
| Technical Writer
 
| v 1.0
 
| This is the first revision of the Admin Document Control User Guide.
 
 
|-
 
|-
| 02/24/14
+
| bgcolor="#00FFFF" | <font color="#FFFFFF">Date</font>
| Elaine Fonaro
+
| bgcolor="#00FFFF" | <font color="#FFFFFF">Author</font>
| Technical Writer
+
| bgcolor="#00FFFF" | <font color="#FFFFFF">Title</font>
| v 1.0
+
| bgcolor="#00FFFF" | <font color="#FFFFFF">Version</font>
| Formatting for WIKI
+
| bgcolor="#00FFFF" | <font color="#FFFFFF">Change Reference</font>
 
|}
 
|}
  
[[Category:Cirrus]] [[Category:Uncategorized]]
+
[[Category:Uncategorized]]

Revision as of 20:29, 7 November 2014

Cirrus > Administration > Admin Document Control
Sanmina logo.png


Administration
Document Control
Version MES15 Portal 1.0
Work Instruction


This Work Instruction is Sanmina's corporate standard.
This document is under revision control. The latest revision is located on SanminaNet.
Once printed it is an uncontrolled copy. All alterations to this work instruction require approval.
Contact the IT Global Education and Training Department to submit suggested alterations and or updates.

This edition applies to MES15 Portal 1.0 and all subsequent releases and modifications until otherwise indicated in new revisions.


Administration

Administrative privileges for the Cirrus portal are located in the Administration menu heading. With the portal, Administrators are able to access privileges from one convenient location. Privileges include User Maintenance, Plant Maintenance, Site Maintenance, Profile Maintenance, and Generic Attribute Maintenance. Also located in the Administration menu heading are SFDC Administrator, Document Control, PTS Administrator, and LE Administration.

This work instruction is intended to guide administrators on how to manage and maintain the Cirrus Portal, as well as to provide specific user groups a common sense of portal operation.


System Requirements

Hardware Requirements (minimum)

Server requirement

  • with VM ESXi
  • Preferably 64 bit machine
  • Core Duo processor
  • 2GB RAM
  • 80GB hard disk space

Client requirement

  • Core Duo processor
  • 1GB RAM
  • 20GB hard disk space
  • Minimum resolution at 1024x768 (17"/19" monitor is recommended)
  • Support smart terminals (Linux LTSP, WYSE and Expension terminals)

Software Requirements

  • Windows XP or Ubuntu
  • Chrome 12.0 or newer (Recommended browser)
  • Firefox 7.0 or newer, with Adobe Reader disabled (if it’s installed), and the extension pdf.js installed.
  • MDS deployed with at least 1 SFDC Host PC



To access any of the Administration functionalities, the user must sign into the Cirrus Portal and then select the Administration expandable heading located in the menu on the left of the screen.


Figure 1: User Sign-In




Figure 2: Cirrus Welcome




Document Control

This section covers how local administrators can maintain document file types. This is the prerequisite configuration before users can upload documents in the Document Mapping portlet, as all uploaded documents will be categorized and displayed by its document type.

Document Type

1. To access the document type page, navigate to Administration > Document Control > Document Type.

Figure 3: Document Type Main Page



All existing document types will be listed on the Document Type Main Page.


Add Document Type

1. To add a new document type, select the Add button, and a new row will be added.

Figure 4: Add Document


  • Document Type: the document type name to add into the local repository.
  • ExpireDate Required: Allows the user to define if there is a valid date required for the document type. If this option is checked, the Start Date and End Date options in the Document Mapping page will be activated.
  • Active: Allows the user to enable or disable the document type in the system. If this option is checked, the user can view and select the document type when mapping documents.

2. Enter the appropriate information and select Update to confirm or Cancel to exit.


Delete Document Type

1. To delete a document type, select the document type and then select Delete. Deleting a document type will not affect the display of existing documents that are of this document type in the repository.


Figure 5: Delete Document Type



Document Mapping

The Document Mapping portlet allows users to maintain documentation by uploading documents via Agile, local networks, or URLs. It also allows users to map documents or deviation attachements to specific part numbers and processes. The goal of these instructions is to outline the steps to assign appropriate documentation to the end user regarding a process or part for which they require work instructions or deviation information.


1. To access the Document Mapping page, navigate toAdministration > Document Control > Document Mapping.


Figure 6: Document Mapping


Document Selection: Agile Versus Local

The Document Mapping portlet allows documents and deviations (PDF attachments) to be uploaded from Agile as well as from a local drive. The benefit of uploading documents from Agile is that the documents are published in full compliance with company standards and procedures. Retrieving a document from Agile also ensures that it is the latest version. Documents can also be uploaded for display from a local computer or network. However, local documents are less controlled and it is difficult to ensure the latest version is available for display.


Uploading By Agile

Users can select to upload documents from Agile by using a document’s assigned Agile Document Number, Part Number, or Deviation Number.

1. Under the Document Selection panel , select whether to search by Agile Doc Number,Agile Part Number,or Agile Deviation Number.

2. Enter the corresponding Agile document number, part number, or deviation number in the adjacent search field and select Next.

3. Select the appropriate document from the Agile Document List panel.

4. From the Upload Document panel, select the Shop Floor ID. Select whether to map the Agile document to a part number or part family from the middle dropdown box. In the dropdown box on the right, select a part number or part family.

5. Select Search and then select the appropriate item from the search results.


Figure 7: Map Agile Document



6. Select Add.

7. In the pop-up window provided, select Process, Document Type, Start Date (if applicable), End Date (if applicable), Convert to, Start Page, End Page, and Show Default to apply to the document.

8. Select Save.


Figure 8: Map Document Details



9. If mapped successfully, the document will be displayed in the list in the Upload Document panel.


Figure 9: Successful Mapping



MES retrieves Agile deviation documents by using the Agile deviation number. Deviation attachments are displayed along with the work instructions, therefore each attachment has to be mapped to an existing  MES (SFDC) process name and Part Number so that it can be displayed properly during production scanning. A deviation is a temporary change in the process, therefore, it requires an expiration date, along with other defined parameters.

NOTE: When uploading a deviation document, the Documentation Type selected must be Devation. This allows the deviation to be displayed to the end user by default.

Uploading By Local Computer or Network

Users can select to upload documents from a local computer or network by document or deviation number.

1. Under Document Selection, select whether to search by Local Document or Local Deviation Number.

2. Enter the corresponding local deviation if that option was selected

3. Select the Deviation Document from the Agile Document List, if a Local Deviation was selected.

4. Select the Shop Floor ID from the Upload Document panel. Select whether to upload the document to a part number or part family in the middle dropdown box. In the dropdown box on the right, select a part number or part family.

5. Select Search and then select the appropriate item from the search results.


Figure 10: Map Local Document



6. Select Add.

7. In the pop-up window provided, select the File, Process, Document Type, Start Date (if applicable),End Date (if applicable), Convert to, Start Page,End Page, and Show Default to apply to the document.

8. If Local Document was selected, select the Browse icon to search for the document on the Local Computer or Network. Select the desired document and then select Open.


Figure 11: Browse for Local Document



9. If the file is a CAD, select the Part Number and Revision to map the document to and then select Save.


Figure 12: CAD Mapping



A deviation document can be uploaded into the MES document repository from a local drive without retrieving from the Agile system. This also requires the mapping of an MES part number and process name, as well as defining the shop order, or serial number.

NOTE: When uploading a deviation document, the Documentation Type selected must be Deviation. This allows the deviation to be displayed to the end user by default.

NOTE: The local deviation number needs to be entered by the user. The naming convention is usually different from the Agile deviation number, which is to be defined at the time of upload and may be inconsistent from one document to another.

Uploading By Engineering Job Number or Engineering Notes

Uploading by Engineering Job Order and By Engineering Notes are options that were implemented for PCB customers. The descriptions are as follows:

  • By Engineering Job Num: Will upload documents from a local defined directory and the lookup is by that Engineering Job Num (a PCB Item attribute).
  • By Engineering Notes: Will create a text note that will be displayed similar to a document for a specific Item, where the mapping is by Item+Location+Shop order.


Uploading By URL

A user may upload a document from a URL:

1. Under Document Selection, select By URL.

2. Enter the corresponding URL path for the PDF document being uploaded, and then select Next. Title the URL Document in the Title field.

3. Select the Shop Floor ID from the Upload Document panel. Select whether to upload the document to a part number or part family in the middle dropdown box. In the dropdown box on the right, select a part number or part family.

4. Select Search and then select the appropriate item from the search results.

5. Select Add.

6. In the pop-up window provided, select the File, Process, Document Type, Start Date (if applicable), End Date (if applicable), Convert to, Start Page, End Page, and Show Default to apply to the document.

7. Select Save. This maps the URL according to the properties selected.



List Document

This section explains how a user can review all work instruction documents in the document repository and search work instruction documents by filtering using part number and/or process name.  When the user accesses the List Document page, work instruction documents uploaded in the Document Mapping portler will display by Created Date.

1. To access the List Document page, navigate to Administration > Document Control > List Doc.

Figure 13: List Doc



Prerequisite Configuration

  • Upload Agile Document / Deviation or Upload Local Document / Deviation

Below are features of the List Document page:

  • Lists all work instruction documents in the document repository.
  • Search capability.  Allows users to enter the SFDC part number and/or process name.  The system will return a list of documents with associated SFDC part number and/or process name.
  • Allows the user to view work instruction document PDF attachments.

2. To search for a specific document, select from the following categories:

  • Shop Floor ID
  • Part Family (optional): Input SFDC Part Family. Fuzzy Search is supported.
  • Part Number (optional): Input SFDC Part Number. Fuzzy Search is supported.
  • Process Name (optional): Input SFDC process name. Fuzzy Search is supported.
  • Category: All, Agile Doc, Deviation Doc, Local Doc, URL Doc can be selected and fuzzy search is supported.
  • Agile Doc Number: All documents uploaded from the Agile system have corresponding Agile document numbers listed in this column. For work instruction documents uploaded using Upload Local Document, this column will be left empty. This allows the user to differentiate between work instruction documents uploaded from the Agile system and those uploaded from a non-Agile system.
  • Agile deviation number: Deviation number from Agile. Fuzzy search is supported.


3. Select Search to initiate a search based on the defined parameters.

4. Select Clear to clear all fields.


The following are heading descriptions for the listed documents:

  • Document Number
  • Deviation Number
  • Document: Uploaded PDF attachments name. Single-click on the file name to view the content.
  • Part Family: SFDC part family that has been pre-mapped with the PDF attachment. This column matches with the above Part family field entered by user if there’s any.
  • Part Number: SFDC part number that has been pre-mapped with the PDF attachment. This column matches with the above Part Number field entered by user if there’s any.
  • Process Name: SFDC process which has been pre-mapped with the PDF attachment. This column matches with the above Process Name field entered by user if there’s any.
  • Revision: Current revision number of the agile document number uploaded in eManual document repository. For work instruction documents uploaded using Upload Local Document, this column will be left empty. This is how user can differentiate between work instruction documents uploaded from Agile system or non Agile system.
  • Assign
  • Value
  • Creator: Indicate the user that uploaded the work instruction documents.
  • Created Date: It refers to the date of uploading the work instruction documents.

5. To view the document, select the Document title in the Document heading. (the title will be in blue)

6. Once selected, the document will display in a new window.


Figure 14: Open Document



Search Doc

1. To access the Search Doc page, navigate to Administration > Document Control > Search Doc.


Figure 15: Search Doc



2. Select a Shop Floor ID, Part Number, and Process Name, and then select Search.

3. The mapped document will display in the document viewer below the filtering fields. If there are multiple documents, the subsequent documents will be available in tabs located above the document viewer.


Figure 16: Document Display



NOTE: If the Shop Floor ID, Part Number, or Process Name is incorrect the following error will display:


Figure 17: Error Message



Document Revision History

Date Author Title Version Change Reference